transferGet
The /transfer/get fetches information about the transfer corresponding to the given transfer_id.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
Defines the request schema for /transfer/get
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.
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.
Plaid’s unique identifier for a transfer.
Response Body
application/json
application/json
curl -X POST "https://example.com/transfer/get" \ -H "Content-Type: application/json" \ -d '{ "transfer_id": "string" }'{ "transfer": { "account_id": "6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B", "ach_class": "ppd", "amount": "12.34", "cancellable": true, "created": "2020-08-06T17:27:15Z", "description": "Testing2", "failure_reason": { "ach_return_code": "R13", "description": "Invalid ACH routing number" }, "id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9", "metadata": { "key1": "value1", "key2": "value2" }, "network": "ach", "origination_account_id": "11111111-1111-1111-1111-111111111111", "status": "pending", "type": "credit", "user": { "email_address": "plaid@plaid.com", "legal_name": "John Smith", "phone_number": null, "address": null } }, "request_id": "saKrIBuEB9qJZno"}transferList POST
Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired transfers.
transferCancel POST
Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/transfer/get` is `true`.