POST /signal/return/report
Call the /signal/return/report
endpoint to report a returned transaction that was previously sent to the /signal/evaluate
endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
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 |
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.