Cancel a transfer

POST /transfer/cancel

Use the /transfer/cancel endpoint to cancel a transfer. A transfer is eligible for cancellation if the cancellable property returned by /transfer/get is true.

Request Body

Required

Defines the request schema for /transfer/cancel

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.
transfer_id
required, string
Plaid’s unique identifier for a transfer.
originator_client_id
string
The Plaid client ID of the transfer originator. Should only be present if client_id is a third-party sender (TPS).
reason_code
string
Specifies the reason for cancelling transfer. This is required for RfP transfers, and will be ignored for other networks. "AC03" - Invalid Creditor Account Number "AM09" - Incorrect Amount "CUST" - Requested By Customer - Cancellation requested "DUPL" - Duplicate Payment "FRAD" - Fraudulent Payment - Unauthorized or fraudulently induced "TECH" - Technical Problem - Cancellation due to system issues "UPAY" - Undue Payment - Payment was made through another channel "AC14" - Invalid or Missing Creditor Account Type "AM06" - Amount Too Low "BE05" - Unrecognized Initiating Party "FOCR" - Following Refund Request "MS02" - No Specified Reason - Customer "MS03" - No Specified Reason - Agent "RR04" - Regulatory Reason "RUTA" - Return Upon Unable To Apply

Response

Defines the response schema for /transfer/cancel

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.