Apply a payment

POST/loans/{id}/payments

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

amountintegerRequired

currency_codestringRequired

Returns

201 Created

loanobjectRequired

30 child attributes

accrued_intereststringRequired

Decimal, major units, accrued and not yet collected

accrued_posted_amountintegerRequired

The whole cents of that recognised in the ledger's receivable

annual_rate_bpsintegerRequired

annual_rate_nanosintegerRequired

bucketstringRequired

Current, 1-29, 30-59, 60-89, 90+

charged_off_amountintegerRequired

Principal written off against the allowance

charged_off_atstring · date-time or nullOptional

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

day_countstringOptional

days_past_dueintegerRequired

As of the last delinquency sweep

decisionobjectRequired

8 child attributes

decided_atstringRequired

decided_bystringOptional

The credit officer who decided a file in review

dti_bpsintegerRequired

outcomestringRequired

payment_amountintegerRequired

rate_bpsintegerRequired

reasonsarray of stringsRequired

review_reasonsarray of stringsOptional

The automated triggers that sent it to review

escrow_balance_amountintegerOptional

escrow_monthly_amountintegerOptional

fees_due_amountintegerRequired

first_duestring · date or nullOptional

A business date, YYYY-MM-DD

guaranteeobject or nullOptional

Guarantee is a government guarantee on a loan or facility.

3 child attributes

guaranteed_bpsintegerRequired

numberstringOptional

programstringRequired

Sba_7a, sba_504, usda

idstringRequired

Example loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm

lead_bankstringOptional

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

nonaccrual_atstring · date-time or nullOptional

outstanding_amountintegerRequired

participations_sold_amountintegerRequired

principal_amountintegerRequired

product_codestringRequired

product_versionintegerRequired

recovered_amountintegerRequired

restored_atstring · date-time or nullOptional

statusstringRequired

Approved, declined, review, active, delinquent, nonaccrual, paid_off, charged_off

syndicateobject or nullOptional

Syndicate is the bank's share of a syndicated credit.

4 child attributes

agentstringRequired

our_share_bpsintegerRequired

referencestringOptional

total_commitment_amountintegerRequired

term_monthsintegerRequired

paymentobjectRequired

10 child attributes

amountintegerRequired

effective_datestring · date or nullOptional

A business date, YYYY-MM-DD

escrow_amountintegerRequired

fees_amountintegerRequired

idstringRequired

interest_amountintegerRequired

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

participants_amountintegerOptional

participants_interest_amountintegerOptional

principal_amountintegerRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503