transferCreate
Use the /transfer/create endpoint to initiate a new transfer.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
Defines the request schema for /transfer/create
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.
A random key provided by the client, per unique transfer. Maximum of 50 characters.
The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single transfer is created.
length <= 50The Plaid access_token for the account that will be debited or credited.
The Plaid account_id for the account that will be debited or credited.
Plaid’s unique identifier for a transfer authorization.
The type of transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.
Value in
- "debit"
- "credit"
The network or rails used for the transfer. Valid options are ach or same-day-ach.
Value in
- "ach"
- "same-day-ach"
The amount of the transfer (decimal string with two digits of precision e.g. “10.00”).
The transfer description. Maximum of 10 characters.
length <= 10Specifies the use case of the transfer. Required for transfers on an ACH network.
"arc" - Accounts Receivable Entry
"cbr" - Cross Border Entry
"ccd" - Corporate Credit or Debit - fund transfer between two corporate bank accounts
"cie" - Customer Initiated Entry
"cor" - Automated Notification of Change
"ctx" - Corporate Trade Exchange
"iat" - International
"mte" - Machine Transfer Entry
"pbr" - Cross Border Entry
"pop" - Point-of-Purchase Entry
"pos" - Point-of-Sale Entry
"ppd" - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment
"rck" - Re-presented Check Entry
"tel" - Telephone-Initiated Entry
"web" - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet
Value in
- "arc"
- "cbr"
- "ccd"
- "cie"
- "cor"
- "ctx"
- "iat"
- "mte"
- "pbr"
- "pop"
- "pos"
- "ppd"
- "rck"
- "tel"
- "web"
The legal name and other information for the account holder.
The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
- The JSON values must be Strings (no nested JSON objects allowed)
- Only ASCII characters may be used
- Maximum of 50 key/value pairs
- Maximum key length of 40 characters
- Maximum value length of 500 characters
Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified.
Response Body
application/json
application/json
curl -X POST "https://example.com/transfer/create" \ -H "Content-Type: application/json" \ -d '{ "idempotency_key": "string", "access_token": "string", "account_id": "string", "authorization_id": "string", "type": "debit", "network": "ach", "amount": "string", "description": "string", "ach_class": "arc", "user": { "legal_name": "string" } }'{ "transfer": { "id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9", "ach_class": "ppd", "account_id": "6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B", "type": "credit", "user": { "legal_name": "Foo Bar", "phone_number": "123-456-7890", "email_address": "user@plaid.com", "address": { "street": "100 Market Street", "city": "San Francisco", "region": "California", "postal_code": "94103", "country": "US" } }, "amount": "12.34", "description": "A description of the transfer", "created": "2020-08-06T17:27:15Z", "status": "pending", "network": "ach", "cancellable": true, "failure_reason": null, "metadata": { "key1": "value1", "key2": "value2" }, "origination_account_id": "0123-4567-8901-2345-67890123" }, "request_id": "saKrIBuEB9qJZno"}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`.
transferAuthorizationCreate POST
Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer, make an authorization request with an `amount` less than the available balance in the account. - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To permit a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To permit a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). All username/password combinations other than the ones listed above will result in a decision of permitted and rationale code `ERROR`.