POST /v1/events.
Funding a loan
place_hold is listed once the bureau check passes, and pay_out once the hold is placed and the draw on the credit line is approved. Neither is in the answer that triggers it, which is why you read the loan until it appears.
Loan status
overdue, delinquent, default and charged_off come with late-payment handling.
The loan view
Every answer that carries a loan view lists that loan’s pending instructions:- the
loanfield of the application view, from the acceptance and fromGET /v1/applications/{id} - the answer to every
POST /v1/eventsabout the loan GET /v1/loans/{loan_id}
Steps you have not yet confirmed or reported as failed. Perform each
instruction_id once. If you see the same id again, your confirmation hasn’t reached us: send it again instead of repeating the step.The current deduction instruction, from
payout.confirmed on. See Deductions.The steps
Confirming a step
Sending the same confirmation or failure again answers 202 and changes nothing. Any other event on a step that is alreadydone or failed answers 409 INVALID_STATE, such as a confirmation after a failure. Use the event_id as the Idempotency-Key.
The step you performed. It must belong to
data.loan_id and match the event type: hold.placed for place_hold, payout.confirmed for pay_out, hold.released for release_hold, refund.paid for refund.What you moved. It must equal the instruction’s amount for
place_hold, pay_out, release_hold and refund. Not sent on a failure.Your own id for the movement, for reconciliation: 1 to 128 characters. Not sent on a failure.
When you performed the step: at most 5 minutes ahead of our clock. A failure sends
failed_at instead.When a step fails
Deductions
Frompayout.confirmed on, the loan view carries a deduction object, and every later answer carries the current one:
- Deduct from each income deposit that matches
deposit_filter: an inbound bank transfer from another institution into the customer’s own account. - Deduct up to
amount_cents, and at mostmax_deposit_pctof the deposit. - Report each deduction as
deposit.settledwith theinstruction_versionyou applied. See Repayments. - The answer to that event carries the next version. Always apply the highest version you have seen.
status: cancelledmeans stop deducting.
When to read the loan
Some steps are issued after the call that causes them has been answered:place_hold after the bureau check, pay_out after the draw, and release_hold and refund seconds after the deposit.settled that causes them. Read GET /v1/loans/{loan_id} on this schedule:
If your platform takes webhooks, the dated steps can be pushed the moment they are due instead of read daily.
