Sample - Plaid API
POST/protect/cash_advance/repayment/create

Record a cash advance repayment

Records repayment feedback for a previously taken cash advance. Provide the user, the client's advance identifier, repayment status, and repayment details to record a full repayment, partial payment, or delinquency. Include the repayment time when the status indicates that a payment occurred.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

7 body fields

Request object recording repayment status and details for a cash advance.

client_idstringoptional
Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
secretstringoptional
Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
userobjectrequired
Represents an end user for `/protect/compute` requests.
client_advance_idstringrequired
The client's unique identifier for the cash-advance.
statusstringrequired
The repayment status of a cash-advance. `REPAID` - The cash-advance has been fully repaid. `PARTIAL_PAYMENT` - A payment has been made on the cash-advance, but there is still an outstanding balance. `UNPAID` - The cash-advance is past its due date and has not been repaid; the user is delinquent.
Allowed:REPAIDPARTIAL_PAYMENTUNPAID
repayment_timestringoptional
The time the repayment occurred. Required when `status` is `REPAID` or `PARTIAL_PAYMENT`. In ISO 8601 / RFC 3339 format (`YYYY-MM-DDTHH:mm:ssZ`).
repaymentobjectrequired
The repayment details for a cash-advance.

1 status code
200Returns a request identifier confirming that the cash-advance repayment was recorded.
request_idstringrequired
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Error handling

user, client_advance_id, status, and repayment are required, and status must be REPAID, PARTIAL_PAYMENT, or UNPAID. repayment.amount_due and repayment.due_date are required, repayment.due_date must be an ISO 8601 date, and repayment_time is required for REPAID or PARTIAL_PAYMENT.