POST /transfer/intent/create

Use the /transfer/intent/create endpoint to generate a transfer intent object and invoke the Transfer UI.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`network`	String	No	The network or rails used for the transfer. Defaults to `same-day-ach`. For transfers submitted using `ach`, the next-day cutoff is 8:30 PM Eastern Time. For transfers submitted using `same-day-ach`, the same-day cutoff is 3:30 PM Eastern Time. If the transfer is submitted after this cutoff but before the next-day cutoff, it will be sent over next-day rails and will not incur same-day charges. For transfers submitted using `rtp`, in the case that the account being credited does not support RTP, the transfer will be sent over ACH as long as an `ach_class` is provided in the request. If RTP isn't supported by the account and no `ach_class` is provided, the transfer will fail to be submitted. Possible values: `"ach"` `"rtp"` `"same-day-ach"` Default value: "same-day-ach"
`description`	String	Yes	A description for the underlying transfer. Maximum of 15 characters.
`client_id`	String	No	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.
`metadata`	Object	No	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
`mode`	String	Yes	The direction of the flow of transfer funds. `PAYMENT`: Transfers funds from an end user's account to your business account. `DISBURSEMENT`: Transfers funds from your business account to an end user's account. Possible values: `"DISBURSEMENT"` `"PAYMENT"`
`iso_currency_code`	String	No	The currency of the transfer amount, e.g. "USD"
`origination_account_id`	String	No	Plaid’s unique identifier for the origination account for the intent. If not provided, the default account will be used.
`user`	Object	Yes	The legal name and other information for the account holder.
`user.email_address`	String	No	The user's email address.
`user.legal_name`	String	Yes	The user's legal name.
`user.address`	Object	No	The address associated with the account holder.
`user.address.region`	String	No	The state or province (e.g., "CA").
`user.address.postal_code`	String	No	The postal code (e.g., "94103").
`user.address.country`	String	No	A two-letter country code (e.g., "US").
`user.address.street`	String	No	The street number and name (i.e., "100 Market St.").
`user.address.city`	String	No	Ex. "San Francisco"
`user.phone_number`	String	No	The user's phone number.
`amount`	String	Yes	The amount of the transfer (decimal string with two digits of precision e.g. "10.00"). When calling `/transfer/authorization/create`, specify the maximum amount to authorize. When calling `/transfer/create`, specify the exact amount of the transfer, up to a maximum of the amount authorized. If this field is left blank when calling `/transfer/create`, the maximum amount authorized in the `authorization_id` will be sent.
`ach_class`	String	No	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"`
`funding_account_id`	String	No	Specify the account used to fund the transfer. Should be specified if using legacy funding methods only. If using Plaid Ledger, leave this field blank. Customers can find a list of `funding_account_id`s in the Accounts page of your Plaid Dashboard, under the "Account ID" column. If this field is left blank and you are using legacy funding methods, this will default to the default `funding_account_id` specified during onboarding. Otherwise, Plaid Ledger will be used.
`account_id`	String	No	The Plaid `account_id` corresponding to the end-user account that will be debited or credited.
`require_guarantee`	Boolean	No	When `true`, the transfer requires a `GUARANTEED` decision by Plaid to proceed (Guarantee customers only). Default value: false
`secret`	String	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.