plaid

Record a cash advance repayment

Changed on

Use this endpoint to record a cash-advance repayment as feedback. A repayment is a record paying back all or some of a previously-taken cash-advance.

post/protect/cash_advance/repayment/create

Request

  • Base URL
    https://production.plaid.com
  • 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 required

The client's unique identifier for the cash-advance.

status'REPAID' | 'PARTIAL_PAYMENT' | 'UNPAID' required

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.

repayment_timestring date-time nullable

The time the repayment occurred. Required when status is REPAID or PARTIAL_PAYMENT. In ISO 8601 / RFC 3339 format (YYYY-MM-DDTHH:mm:ssZ).

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

    • breaking

      removed the enum value DELIVERED of the request property

    • info

      the request property / became nullable

    • info

      the request property / became optional

    • info

      added the new PARTIAL_PAYMENT enum value to the request property

    • info

      endpoint added