Plaid Developer Portal
Plaid
HomeSDKsAPI ReferenceContext Plugin
Bank Transfer

bankTransferCreate

POST
/bank_transfer/create

Use the /bank_transfer/create endpoint to initiate a new bank transfer.

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

Defines the request schema for /bank_transfer/create

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.

idempotency_key*string

A random key provided by the client, per unique bank 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 bank transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single bank transfer is created.

Lengthlength <= 50
access_token*string

The Plaid access_token for the account that will be debited or credited.

account_id*string

The Plaid account_id for the account that will be debited or credited.

type*BankTransferType

The type of bank 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"
network*BankTransferNetwork

The network or rails used for the transfer. Valid options are ach, same-day-ach, or wire.

Value in

  • "ach"
  • "same-day-ach"
  • "wire"
amount*string

The amount of the bank transfer (decimal string with two digits of precision e.g. “10.00”).

iso_currency_code*string

The currency of the transfer amount – should be set to "USD".

description*string

The transfer description. Maximum of 10 characters.

Lengthlength <= 10
ach_class?ACHClass

Specifies 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"
user*

The legal name and other information for the account holder.

custom_tag?|

An arbitrary string provided by the client for storage with the bank transfer. May be up to 100 characters.

Lengthlength <= 100
metadata?

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
origination_account_id?|

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/bank_transfer/create" \  -H "Content-Type: application/json" \  -d '{    "idempotency_key": "string",    "access_token": "string",    "account_id": "string",    "type": "debit",    "network": "ach",    "amount": "string",    "iso_currency_code": "string",    "description": "string",    "user": {      "legal_name": "string"    }  }'
{  "bank_transfer": {    "account_id": "6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B",    "ach_class": "ppd",    "amount": "12.34",    "cancellable": true,    "created": "2020-08-06T17:27:15Z",    "custom_tag": "my tag",    "description": "Testing2",    "direction": "outbound",    "failure_reason": null,    "id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9",    "iso_currency_code": "USD",    "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",      "routing_number": "111111111"    }  },  "request_id": "saKrIBuEB9qJZno"}

bankTransferMigrateAccount POST

As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.

bankTransferSweepList POST

The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.