Create a bank transfer as a processor

POST /processor/bank_transfer/create

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

Request Body

Required

Defines the request schema for /processor/bank_transfer/create

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.
idempotency_key
required, 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.
processor_token
required, string
The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>
type
required, string
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.
network
required, string
The network or rails used for the transfer. Valid options are ach, same-day-ach, or wire.
amount
required, string
The amount of the bank transfer (decimal string with two digits of precision e.g. “10.00”).
iso_currency_code
required, string
The currency of the transfer amount – should be set to “USD”.
description
required, string
The transfer description. Maximum of 10 characters.
ach_class
string
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.
user
required, object
The legal name and other information for the account holder.
legal_name
required, string
The account holder’s full legal name. If the transfer ach_class is ccd, this should be the business name of the account holder.
email_address
string
The account holder’s email.
routing_number
string
The account holder’s routing number. This field is only used in response data. Do not provide this field when making requests.
custom_tag
string
An arbitrary string provided by the client for storage with the bank transfer. May be up to 100 characters.
metadata
object
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
string
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

Defines the response schema for /processor/bank_transfer/create

Response Properties

bank_transfer
required, object
Represents a bank transfer within the Bank Transfers API.
id
required, string
Plaid’s unique identifier for a bank transfer.
ach_class
required, string
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.
account_id
required, string
The account ID that should be credited/debited for this bank transfer.
type
required, string
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.
user
required, object
The legal name and other information for the account holder.
legal_name
required, string
The account holder’s full legal name. If the transfer ach_class is ccd, this should be the business name of the account holder.
email_address
string
The account holder’s email.
routing_number
string
The account holder’s routing number. This field is only used in response data. Do not provide this field when making requests.
amount
required, string
The amount of the bank transfer (decimal string with two digits of precision e.g. “10.00”).
iso_currency_code
required, string
The currency of the transfer amount, e.g. “USD”
description
required, string
The description of the transfer.
created
required, string
The datetime when this bank transfer was created. This will be of the form 2006-01-02T15:04:05Z
status
required, string
The status of the transfer.
network
required, string
The network or rails used for the transfer. Valid options are ach, same-day-ach, or wire.
cancellable
required, boolean
When true, you can still cancel this bank transfer.
failure_reason
required, object
The failure reason if the type of this transfer is "failed" or "reversed". Null value otherwise.
ach_return_code
string
The ACH return code, e.g. R01. A return code will be provided if and only if the transfer status is reversed. For a full listing of ACH return codes, see Bank Transfers errors.
description
string
A human-readable description of the reason for the failure or reversal.
custom_tag
required, string
A string containing the custom tag provided by the client in the create request. Will be null if not provided.
metadata
required, object
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
required, string
Plaid’s unique identifier for the origination account that was used for this transfer.
direction
required, string
Indicates the direction of the transfer: outbound for API-initiated transfers, or inbound for payments received by the FBO account.
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.