plaid

Record a cash advance decision

Changed on

Use this endpoint to record a cash-advance decision as feedback. A decision is a determination of whether to approve a user's requested advance and on what terms.

post/protect/cash_advance/decision/create

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/protect/cash_advance/decision/create
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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.

secretstring

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.

client_advance_idstring nullable

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_type'FIRST' | 'REPEAT'

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.

previous_advance_countinteger nullable

The number of cash-advances a user has previously taken.

decision_timestring date-time required

The time the decision was made, in ISO 8601 / RFC 3339 format (YYYY-MM-DDTHH:mm:ssZ).

decision'APPROVED' | 'DECLINED' required

The outcome of a cash-advance decision.

APPROVED - The cash-advance was approved.

DECLINED - The cash-advance was declined.

is_takenboolean nullable

Whether the end user took the cash-advance. Required when decision is APPROVED. When true, client_advance_id and cash_advance are required.

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • 141de8aaaad2Revision changes
    • warning

      removed the request property /

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • e536704a333fRevision changes
    • info

      endpoint added