plaid

Report a return for an ACH transaction

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 trends into your scores and tune rule logic. If using a Balance-only ruleset, this endpoint will not impact scores (as Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard.

post/signal/return/report

Request body

client_idstring

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.

secretstring

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_idstring required

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

return_codestring required

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

If formatted incorrectly, this will result in an INVALID_FIELD error.

returned_atstring date-time nullable

Date and time when you receive the returns from your payment processors, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ).

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

Changed in 10 of the 52 revisions of this API.2815

    • added the new ASSETS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new IDEMPOTENCY_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new BASE_REPORT_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property provided_account_subtypes to the response with the default status

      response-optional-property-added

    • added the optional property required_account_subtypes to the response with the default status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the IDENTITY_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • added the new IDENTITY_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new USER_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new SIGNAL_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new CHECK_REPORT_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new CONSUMER_REPORT_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new PARTNER_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new SANDBOX_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new TRANSACTIONS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new TRANSACTION_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new TRANSFER_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the optional property error_code_reason to the response with the default status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5de70cc1e6ca311See the full diff
    • removed the optional property error_code_reason from the response with the default status

      response-optional-property-removed

    • removed the optional property provided_account_subtypes from the response with the default status

      response-optional-property-removed

    • removed the optional property required_account_subtypes from the response with the default status

      response-optional-property-removed

    • removed the BASE_REPORT_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • removed the CHECK_REPORT_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • removed the CONSUMER_REPORT_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • removed the IDEMPOTENCY_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • removed the PARTNER_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • removed the SANDBOX_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • removed the SIGNAL_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • removed the TRANSACTIONS_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • removed the TRANSACTION_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • removed the TRANSFER_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • removed the USER_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    This revision also has 699 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog