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

Record a cash advance decision

Records a cash-advance approval or decline as feedback for Protect. Provide the user, decision time, and decision outcome, then include the advance details required when the advance was taken. Use client_advance_id to correlate a taken advance with later repayment records.

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

10 body fields

Request object recording the outcome and terms of a cash-advance decision.

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_idstringoptional
Your unique identifier for a cash-advance. Required when `is_taken` is `true`. This should be the same identifier provided when recording a repayment.
advance_typestringoptional
Required when `is_taken` is `true`. Indicates if this would be a user's first or repeat cash-advance. `FIRST` - A user's first cash-advance. `REPEAT` - A user has previously taken out a cash-advance.
Allowed:FIRSTREPEAT
previous_advance_countintegeroptional
The number of cash-advances a user has previously taken.
decision_timestringrequired
The time the decision was made, in ISO 8601 / RFC 3339 format (`YYYY-MM-DDTHH:mm:ssZ`).
decisionstringrequired
The outcome of a cash-advance decision. `APPROVED` - The cash-advance was approved. `DECLINED` - The cash-advance was declined.
Allowed:APPROVEDDECLINED
is_takenbooleanoptional
Whether the end user took the cash-advance. Required when `decision` is APPROVED. When `true`, `client_advance_id` and `cash_advance` are required.
cash_advanceobjectoptional
The details of a cash-advance associated with the decision. Required when `is_taken` is `true`.

1 status code
200Returns a request identifier confirming that the cash-advance decision 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, decision_time, and decision are required; decision must be APPROVED or DECLINED, and decision_time must be an ISO 8601 date-time. When decision is APPROVED, provide is_taken; when is_taken is true, client_advance_id and cash_advance are required, and cash_advance.due_date must be an ISO 8601 date.