Signal

signalReturnReport

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.

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

SignalReturnReportRequest defines the request schema for /signal/return/report

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.

client_transaction_id*string

Must be the same as the client_transaction_id supplied when calling /signal/evaluate

return_code*string

Must be a valid ACH return code (e.g. "R01")

Response Body

application/json

application/json

curl -X POST "https://example.com/signal/return/report" \  -H "Content-Type: application/json" \  -d '{    "client_transaction_id": "string",    "return_code": "string"  }'
{  "request_id": "mdqfuVxeoza6mhu"}