Apply a merchant's card-receipt holdback to a merchant cash advance
/facilities/{id}/remittancesPath parameters
idstringRequiredHeaders
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
amountintegerRequiredcurrency_codestringRequiredReturns
201 Created
facilityobjectRequiredFacility is a credit facility and its state.
39 child attributes
accrued_intereststringRequiredaccrued_posted_amountintegerRequiredactivated_atstring · date-time or nullOptionalannual_rate_bpsintegerRequiredavailable_amountintegerRequiredNet of active reservations
beneficiarystringOptionalborrowing_baseobject or nullOptionalBorrowingBase is a borrower's collateral certificate.
6 child attributes
base_amountintegerOptionalcertified_atstring · dateOptionalA business date, YYYY-MM-DD
inventory_advance_bpsintegerOptionalinventory_amountintegerRequiredreceivables_advance_bpsintegerOptionalreceivables_amountintegerRequiredbucketstringRequiredcharged_off_amountintegerRequiredcharged_off_atstring · date-time or nullOptionalconverted_to_loan_idstringOptionalExample loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm
created_atstring · date-timeRequiredcurrency_codestringRequiredcustomer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
days_past_dueintegerRequireddecisionobjectRequired8 child attributes
decided_atstringRequireddecided_bystringOptionalThe credit officer who decided a file in review
dti_bpsintegerRequiredoutcomestringRequiredpayment_amountintegerRequiredrate_bpsintegerRequiredreasonsarray of stringsRequiredreview_reasonsarray of stringsOptionalThe automated triggers that sent it to review
draw_period_endsstring · date or nullOptionalA business date, YYYY-MM-DD
drawn_amountintegerRequireddue_datestring · date or nullOptionalA business date, YYYY-MM-DD
expirystring · date or nullOptionalA business date, YYYY-MM-DD
fees_due_amountintegerRequiredguaranteeobject or nullOptionalGuarantee is a government guarantee on a loan or facility.
3 child attributes
guaranteed_bpsintegerRequirednumberstringOptionalprogramstringRequiredSba_7a, sba_504, usda
idstringRequiredkindstringRequiredRevolving, construction, letter_of_credit, factoring, floor_plan, merchant_cash_advance, warehouse
last_statementstringOptionalledger_account_idstringOptionalExample lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm
limit_amountintegerRequiredminimum_due_amountintegerRequirednonaccrual_atstring · date-time or nullOptionalowed_amountintegerOptionalproduct_codestringRequiredproduct_versionintegerRequiredpurchased_amountintegerOptionalrepayment_startsstring · date or nullOptionalA business date, YYYY-MM-DD
reserved_amountintegerOptionalActive, unexpired reservations holding room on the line
settlement_account_idstringRequiredExample acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm
statusstringRequiredtermsobjectRequiredFacilityTerms are the product's facility rules as snapshotted on the facility.
21 child attributes
advance_bpsintegerOptionalborrowing_basebooleanOptionalconverts_to_product_codestringOptionalcurtailment_bpsintegerOptionalcurtailment_daysintegerOptionaldraw_period_monthsintegerOptionalexpiry_monthsintegerOptionalfactor_rate_bpsintegerOptionalfee_bpsintegerOptionalholdback_bpsintegerOptionalinterest_onlybooleanOptionalinventory_advance_bpsintegerOptionalmax_days_on_lineintegerOptionalmin_payment_bpsintegerOptionalmin_payment_floor_minorintegerOptionalpayment_due_daysintegerOptionalreceivables_advance_bpsintegerOptionalrecoursebooleanOptionalrepayment_monthsintegerOptionalsecured_bystringOptionaltypestringRequiredupdated_atstring · date-timeRequiredpaymentobjectRequiredFacilityPayment is money applied to a facility.
10 child attributes
amountintegerRequiredcreated_atstring · date-timeRequiredfacility_idstringRequiredfees_amountintegerRequiredidstringRequiredincome_amountintegerRequiredinterest_amountintegerRequiredjournal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredprincipal_amountintegerRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503