List the returns included in a repayment

POST /transfer/repayment/return/list

The /transfer/repayment/return/list endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of returns retrieved by this request equals the amount of the repayment.

Request Body

Required

Defines the request schema for /transfer/repayment/return/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.
repayment_id
required, string
Identifier of the repayment to query.
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/return/list

Response Properties

repayment_returns
required, array[object]
transfer_id
required, string
The unique identifier of the guaranteed transfer that was returned.
event_id
required, integer
The unique identifier of the corresponding returned transfer event.
amount
required, string
The value of the returned transfer.
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.