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.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
count |
Integer | No |
The maximum number of repayments to return. Default value: 25 |
repayment_id |
String | Yes |
Identifier of the repayment to query. |
client_id |
String | No |
Your Plaid API |
secret |
String | No |
Your Plaid API |
offset |
Integer | No |
The number of repayments to skip before returning results. Default value: 0 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.