Lists historical repayments

POST /transfer/repayment/list

The /transfer/repayment/list endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given start_time.

Request Body

Required

Defines the request schema for /transfer/repayment/list

Parameters

client_id
string
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.
secret
string
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.
start_date
string
The start created datetime of repayments to return (RFC 3339 format).
end_date
string
The end created datetime of repayments to return (RFC 3339 format).
count
integer
The maximum number of repayments to return.
offset
integer
The number of repayments to skip before returning results.

Response

Defines the response schema for /transfer/repayments/list

Response Properties

repayments
required, array[object]
repayment_id
required, string
Identifier of the repayment.
created
required, string
The datetime when the repayment occurred, in RFC 3339 format.
amount
required, string
Decimal amount of the repayment as it appears on your account ledger.
iso_currency_code
required, string
The currency of the repayment, e.g. “USD”.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.