POST /processor/signal/return/report
Call the /processor/signal/return/report endpoint to report a returned transaction that was previously sent to the /processor/signal/evaluate endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
If you are using the Plaid Transfer product to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was returned.
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 |
|---|---|---|---|
return_code |
String | Yes |
Must be a valid ACH return code (e.g. "R01") If formatted incorrectly, this will result in an |
client_id |
String | No |
Your Plaid API |
processor_token |
String | Yes |
The processor token obtained from the Plaid integration partner. Processor tokens are in the format: |
client_transaction_id |
String | Yes |
Must be the same as the |
secret |
String | No |
Your Plaid API |
returned_at |
String | No |
Date and time when you receive the returns from your payment processors, in ISO 8601 format ( |
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.