Atomically fence an unposted instruction or recover money that already committed

POST/lending-servicing/received-payments/{id}/cancellation

Bounded USD individual-loan servicing forwarding. Actual ledger receipt, approved transfer receiver and native payable source are immutable. Customer receipt initiation requires lending:write, verified borrower identity and fresh step-up, with the exact original single-owner DDA. Read requires that borrower with lending:read or dedicated servicing read. Recovery, notice-backed return proposal and execution require human lending:servicing:write and fresh step-up; return review requires independent human lending:servicing:approve. Cancellation atomically fences an absent journal or recovers committed money. No loan principal reduction or receiving-servicer application/timeliness claim. Forwarding and return do not end after 60 days; the separately recorded 60-day window alone does not establish contractual timeliness.

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

reasonstringRequired

Returns

200 OK

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

actorstringRequired

cancellationobject or nullOptional

3 child attributes

actorstringRequired

reasonstringRequired

requested_atstring · date-timeRequired

captured_atstring · date-timeRequired

content_sha256stringRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired

loan_idstringRequired

Example loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm

requestobjectRequired

ReceivePayment is a fresh, voluntary instruction from the verified individual borrower. The account is resolved from the loan; no replacement destination or client-supplied received date is accepted.

5 child attributes

amount_minorintegerRequired

currencystringRequired

forwarding_consentbooleanRequired

receiving_servicer_idstringRequired

transfer_action_idstringRequired

resultobject or nullOptional

12 child attributes

actorstringRequired

cancellation_reasonstringOptional

in_transfer_60_day_windowbooleanRequired

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_sha256stringOptional

obligationobject or nullOptional

22 child attributes

account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amount_minorintegerRequired

content_sha256stringRequired

created_atstring · date-timeRequired

currencystringRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

evidence_referencestringRequired

hold_idstringRequired

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired

issuerstringRequired

jurisdictionstringOptional

kindstringRequired

legal_entitystringRequired

loan_idstringOptional

Example loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payee_referencestringOptional

sourceobjectRequired

6 child attributes

closure_componentstringOptional

closure_ledger_account_idstringOptional

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_keystringRequired

journal_sha256stringRequired

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

source_datestring · dateRequired

A business date, YYYY-MM-DD

source_date_basisstringOptional

source_idstringRequired

source_sha256stringRequired

tax_customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

tax_periodstringOptional

received_atstring · date-time or nullOptional

Actual ledger commitment

received_datestring · date or nullOptional

Eastern calendar date

recorded_atstring · date-timeRequired

statestringRequired

Registered or cancelled; pending has no result

timeliness_statusstringRequired

Unassessed; no contractual due/grace test inferred

transfer_window_endsstring · dateRequired

A business date, YYYY-MM-DD

returnsarray of objectsRequired

8 child attributes

actorstringRequired

content_sha256stringRequired

created_atstring · date-timeRequired

decisionobject or nullOptional

5 child attributes

actorstringRequired

approvebooleanRequired

atstring · date-timeRequired

evidenceobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

2 child attributes

referencestringRequired

sha256stringRequired

reasonstringRequired

idstringRequired

received_payment_idstringRequired

Example lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm

requestobjectRequired

4 child attributes

amount_minorintegerRequired

evidenceobjectRequired

Evidence identifies the actual reviewed input, never an inferred geocode or identity.

2 child attributes

referencestringRequired

sha256stringRequired

proper_recipient_noticeobjectRequired

ProperRecipientNotice is actual retained notice evidence. Capturing it does not send a message or manufacture provider delivery confirmation.

5 child attributes

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

noticeobjectRequired

receiving_servicer_contactstringRequired

receiving_servicer_idstringRequired

receiving_servicer_namestringRequired

reasonstringRequired

resultobject or nullOptional

15 child attributes

actorstringRequired

amount_minorintegerRequired

content_sha256stringRequired

created_atstring · date-timeRequired

destination_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

evidence_referencestringRequired

idstringRequired

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_keystringRequired

obligation_idstringRequired

obligation_sha256stringRequired

reasonstringRequired

requested_bystringRequired

source_idstringRequired

source_sha256stringRequired

sourceobjectRequired

10 child attributes

receiving_servicer_contactstringRequired

receiving_servicer_idstringRequired

receiving_servicer_namestringRequired

transfer_action_idstringRequired

transfer_action_sha256stringRequired

transfer_effective_datestring · dateRequired

A business date, YYYY-MM-DD

transfer_review_sha256stringRequired

transfer_reviewed_atstring · date-timeRequired

transfer_reviewed_bystringRequired

transfer_snapshot_sha256stringRequired

Errors

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

400401403404409412413422424429500503