Report a return for an ACH transaction

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.

Request Body

Required

ProcessorSignalReturnReportRequest defines the request schema for /processor/signal/return/report

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.
processor_token
required, string
The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>
client_transaction_id
required, string
Must be the same as the client_transaction_id supplied when calling /processor/signal/evaluate
return_code
required, string
Must be a valid ACH return code (e.g. “R01”) If formatted incorrectly, this will result in an INVALID_FIELD error.
returned_at
string
Date and time when you receive the returns from your payment processors, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ).

Response

ProcessorSignalReturnReportResponse defines the response schema for /processor/signal/return/report

Response Properties

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.