POST /processor/bank_transfer/create

Default value: "application/json"

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

Possible values:

• "ach"
• "same-day-ach"
• "wire"

The transfer description. Maximum of 10 characters.

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.

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

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.

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

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

The legal name and other information for the account holder.

The account holder’s email.

The account holder's routing number. This field is only used in response data. Do not provide this field when making requests.

The account holder’s full legal name. If the transfer ach_class is ccd, this should be the business name of the account holder.

Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified.

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

Specifies the use case of the transfer. Required for transfers on an ACH network. For more details, see ACH SEC codes.

Codes supported for credits: ccd, ppd Codes supported for debits: ccd, tel, web

"ccd" - Corporate Credit or Debit - fund transfer between two corporate bank accounts

"ppd" - Prearranged Payment or Deposit - The transfer is part of a pre-existing relationship with a consumer. Authorization was obtained in writing either in person or via an electronic document signing, e.g. Docusign, by the consumer. Can be used for credits or debits.

"web" - Internet-Initiated Entry. The transfer debits a consumer’s bank account. Authorization from the consumer is obtained over the Internet (e.g. a web or mobile application). Can be used for single debits or recurring debits.

"tel" - Telephone-Initiated Entry. The transfer debits a consumer. Debit authorization has been received orally over the telephone via a recorded call.

Possible values:

• "ppd"
• "web"
• "tel"
• "ccd"

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.

Possible values:

• "credit"
• "debit"

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.

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