Represents a transfer intent within Transfer UI.

Plaid’s unique identifier for a transfer intent object.

The datetime the transfer was created. This will be of the form 2006-01-02T15:04:05Z.

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.

Plaid’s unique identifier for the transfer created through the UI. Returned only if the transfer was successfully created. Null value otherwise.

The reason for a failed transfer intent. Returned only if the transfer intent status is failed. Null otherwise.

A broad categorization of the error.

A code representing the reason for a failed transfer intent (i.e., an API error or the authorization being declined).

A human-readable description of the code associated with a failed transfer intent.

A decision regarding the proposed transfer. APPROVED – The proposed transfer has received the end user’s consent and has been approved for processing by Plaid. The decision_rationale field is set if Plaid was unable to fetch the account information. You may proceed with the transfer, but further review is recommended (i.e., use Link in update mode to re-authenticate your user when decision_rationale.code is ITEM_LOGIN_REQUIRED). Refer to the code field in the decision_rationale object for details. DECLINED – Plaid reviewed the proposed transfer and declined processing. Refer to the code field in the decision_rationale object for details.

The rationale for Plaid’s decision regarding a proposed transfer. It is always set for declined decisions, and may or may not be null for approved decisions.

A code representing the rationale for approving or declining the proposed transfer. If the rationale_code is null, the transfer passed the authorization check. Any non-null value for an approved transfer indicates that the the authorization check could not be run and that you should perform your own risk assessment on the transfer. The code will indicate why the check could not be run. Possible values for an approved transfer are: MANUALLY_VERIFIED_ITEM – Item created via a manual entry flow (i.e. Same Day Micro-deposit, Instant Micro-deposit, or database-based verification), limited information available. ITEM_LOGIN_REQUIRED – Unable to collect the account information due to Item staleness. Can be resolved by using Link and setting transfer.authorization_id in the request to /link/token/create. MIGRATED_ACCOUNT_ITEM - Item created via /transfer/migrate_account endpoint, limited information available. ERROR – Unable to collect the account information due to an unspecified error. The following codes indicate that the authorization decision was declined: NSF – Transaction likely to result in a return due to insufficient funds. RISK - Transaction is high-risk. TRANSFER_LIMIT_REACHED - One or several transfer limits are reached, e.g. monthly transfer limit. Check the accompanying description field to understand which limit has been reached.

A human-readable description of the code associated with a transfer approval or transfer decline.

The Plaid account_id for the account that will be debited or credited. Returned only if account_id was set on intent creation.

Plaid’s unique identifier for the origination account used for the transfer.

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.

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.

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.

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:30 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.

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.

The legal name and other information for the account holder.

The user’s legal name.

The user’s phone number.

The user’s email address.

The address associated with the account holder.

The street number and name (i.e., “100 Market St.”).

Ex. “San Francisco”

The state or province (e.g., “CA”).

The postal code (e.g., “94103”).

A two-letter country code (e.g., “US”).

A description for the underlying transfer. Maximum of 8 characters.

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

The currency of the transfer amount, e.g. “USD”

When true, the transfer requires a GUARANTEED decision by Plaid to proceed (Guarantee customers only).

Indicates whether the transfer is guaranteed by Plaid (Guarantee customers only). This field will contain either GUARANTEED or NOT_GUARANTEED indicating whether Plaid will guarantee the transfer. If the transfer is not guaranteed, additional information will be provided in the guarantee_decision_rationale field. Refer to the code field in guarantee_decision_rationale for details.

The rationale for Plaid’s decision to not guarantee a transfer. Will be null unless guarantee_decision is NOT_GUARANTEED.

A code representing the reason Plaid declined to guarantee this transfer: RETURN_BANK: The risk of a bank-initiated return (for example, an R01/NSF) is too high to guarantee this transfer. RETURN_CUSTOMER: The risk of a customer-initiated return (for example, a R10/Unauthorized) is too high to guarantee this transfer. GUARANTEE_LIMIT_REACHED: This transfer is low-risk, but Guarantee has exhausted an internal limit on the number or rate of guarantees that applies to this transfer. RISK_ESTIMATE_UNAVAILABLE: A risk estimate is unavailable for this Item. REQUIRED_PARAM_MISSING: Required fields are missing.

A human-readable description of why the transfer cannot be guaranteed.

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.