--- title: "Create a transfer intent object to invoke the Transfer UI" method: POST path: "/transfer/intent/create" tags: ["plaid"] --- # Create a transfer intent object to invoke the Transfer UI `POST /transfer/intent/create` Use the `/transfer/intent/create` endpoint to generate a transfer intent object and invoke the Transfer UI. ## Request body - TransferIntentCreateRequest — Defines the request schema for `/transfer/intent/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. - `account_id` string, nullable — The Plaid `account_id` corresponding to the end-user account that will be debited or credited. - `funding_account_id` string, nullable — 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. - `mode` 'PAYMENT' | 'DISBURSEMENT', required — 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. - `network` 'ach' | 'same-day-ach' | 'rtp' — The network or rails used for the transfer. Defaults to `same-day-ach`. For transfers submitted using `ach`, the Standard ACH cutoff is 8:30 PM Eastern Time. For transfers submitted using `same-day-ach`, the Same Day ACH cutoff is 3:00 PM Eastern Time. It is recommended to send the request 15 minutes prior to the cutoff to ensure that it will be processed in time for submission before the cutoff. If the transfer is processed after this cutoff but before the Standard ACH cutoff, it will be sent over Standard ACH 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. - `amount` string, required — 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. - `description` string, required — A description for the underlying transfer. Maximum of 15 characters. - `ach_class` 'ccd' | 'ppd' | 'tel' | 'web' — Specifies the use case of the transfer. Required for transfers on an ACH network. For more details, see [ACH SEC codes](https://plaid.com/docs/transfer/creating-transfers/#ach-sec-codes). Codes supported for credits: `ccd`, `ppd` Codes supported for debits: `ccd`, `ppd`, `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. - `origination_account_id` string, nullable — Plaid's unique identifier for the origination account for the intent. If not provided, the default account will be used. - `user` TransferUserInRequest, required — The legal name and other information for the account holder. - `legal_name` string, required — The user's legal name. - `phone_number` string — The user's phone number. Phone number input may be validated against valid number ranges; number strings that do not match a real-world phone numbering scheme may cause the request to fail, even in the Sandbox test environment. - `email_address` string — The user's email address. - `address` TransferUserAddressInRequest — The address associated with the account holder. - `street` string — The street number and name (i.e., "100 Market St."). - `city` string — Ex. "San Francisco" - `region` string — The state or province (e.g., "CA"). - `postal_code` string — The postal code (e.g., "94103"). - `country` string — A two-letter country code (e.g., "US"). - `metadata` TransferMetadata, nullable — 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 - `iso_currency_code` string — The currency of the transfer amount, e.g. "USD" - `require_guarantee` boolean, nullable — When `true`, the transfer requires a `GUARANTEED` decision by Plaid to proceed (Guarantee customers only). ## Response `200` OK - TransferIntentCreateResponse — Defines the response schema for `/transfer/intent/create` - `transfer_intent` TransferIntentCreate, required — Represents a transfer intent within Transfer UI. - `id` string, required — Plaid's unique identifier for the transfer intent object. - `created` string, date-time, required — The datetime the transfer was created. This will be of the form `2006-01-02T15:04:05Z`. - `status` 'PENDING' | 'SUCCEEDED' | 'FAILED', required — The status of the transfer intent. `PENDING`: The transfer intent is pending. `SUCCEEDED`: The transfer intent was successfully created. `FAILED`: The transfer intent was unable to be created. - `account_id` string, nullable — The Plaid `account_id` corresponding to the end-user account that will be debited or credited. Returned only if `account_id` was set on intent creation. - `origination_account_id` string, required — Plaid's unique identifier for the origination account for the intent. If not provided, the default account will be used. - `funding_account_id` string, required — The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited. - `amount` string, required — 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. - `mode` 'PAYMENT' | 'DISBURSEMENT', required — 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. - `network` 'ach' | 'same-day-ach' | 'rtp' — The network or rails used for the transfer. Defaults to `same-day-ach`. For transfers submitted using `ach`, the Standard ACH cutoff is 8:30 PM Eastern Time. For transfers submitted using `same-day-ach`, the Same Day ACH cutoff is 3:00 PM Eastern Time. It is recommended to send the request 15 minutes prior to the cutoff to ensure that it will be processed in time for submission before the cutoff. If the transfer is processed after this cutoff but before the Standard ACH cutoff, it will be sent over Standard ACH 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. - `ach_class` 'ccd' | 'ppd' | 'tel' | 'web' — Specifies the use case of the transfer. Required for transfers on an ACH network. For more details, see [ACH SEC codes](https://plaid.com/docs/transfer/creating-transfers/#ach-sec-codes). Codes supported for credits: `ccd`, `ppd` Codes supported for debits: `ccd`, `ppd`, `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` TransferUserInResponse, required — The legal name and other information for the account holder. - `legal_name` string, required — The user's legal name. - `phone_number` string, nullable, required — The user's phone number. - `email_address` string, nullable, required — The user's email address. - `address` TransferUserAddressInResponse, nullable, required — The address associated with the account holder. - `street` string, nullable, required — The street number and name (i.e., "100 Market St."). - `city` string, nullable, required — Ex. "San Francisco" - `region` string, nullable, required — The state or province (e.g., "CA"). - `postal_code` string, nullable, required — The postal code (e.g., "94103"). - `country` string, nullable, required — A two-letter country code (e.g., "US"). - `description` string, required — A description for the underlying transfer. Maximum of 15 characters. - `metadata` TransferMetadata, nullable — 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 - `iso_currency_code` string, required — The currency of the transfer amount, e.g. "USD" - `require_guarantee` boolean, nullable — When `true`, the transfer requires a `GUARANTEED` decision by Plaid to proceed (Guarantee customers only). - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. ## Other responses - `default` — Error response --- [API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/versions/64c4514ea59b/schema)