Represents a transfer within the Transfers API.

Plaid’s unique identifier for a transfer.

Plaid’s unique identifier for a transfer authorization.

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 Plaid account_id corresponding to the end-user account that will be debited or credited.

The id of the associated funding account, available in the Plaid Dashboard. If present, this indicates which of your business checking accounts will be credited or debited.

Plaid’s unique identifier for a Plaid Ledger Balance.

The type of 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.

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”).

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 description of the transfer.

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

The status of the transfer. pending: A new transfer was created; it is in the pending state. posted: The transfer has been successfully submitted to the payment network. settled: The transfer was successfully completed by the payment network. Note that funds from received debits are not available to be moved out of the Ledger until the transfer reaches funds_available status. For credit transactions, settled means the funds have been delivered to the receiving bank account. This is the terminal state of a successful credit transfer. funds_available: Funds from the transfer have been released from hold and applied to the ledger’s available balance. (Only applicable to ACH debits.) This is the terminal state of a successful debit transfer. cancelled: The transfer was cancelled by the client. This is the terminal state of a cancelled transfer. failed: The transfer failed, no funds were moved. This is the terminal state of a failed transfer. returned: A posted transfer was returned. This is the terminal state of a returned transfer.

The status of the sweep for the transfer. unswept: The transfer hasn’t been swept yet. swept: The transfer was swept to the sweep account. swept_settled: Credits are available to be withdrawn or debits have been deducted from the customer’s business checking account. return_swept: The transfer was returned, funds were pulled back or pushed back to the sweep account. null: The transfer will never be swept (e.g. if the transfer is cancelled or returned before being swept)

The network or rails used for the transfer. For transfers submitted as ach or same-day-ach, the Standard ACH cutoff is 8:30 PM Eastern Time. For transfers submitted as 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; this will apply to both legs of the transfer if applicable. The transaction limit for a Same Day ACH transfer is $1,000,000. Authorization requests sent with an amount greater than $1,000,000 will fail. For transfers submitted as rtp, Plaid will automatically route between Real Time Payment rail by TCH or FedNow rails as necessary. If a transfer is submitted as rtp and the counterparty account is not eligible for RTP, the /transfer/authorization/create request will fail with an INVALID_FIELD error code. To pre-check to determine whether a counterparty account can support RTP, call /transfer/capabilities/get before calling /transfer/authorization/create. Wire transfers are currently in early availability. To request access to wire as a payment network, contact your Account Manager. For transfers submitted as wire, the type must be credit; wire debits are not supported. The cutoff to submit a wire payment is 6:30 PM Eastern Time on a business day; wires submitted after that time will be processed on the next business day. The transaction limit for a wire is $999,999.99. Authorization requests sent with an amount greater than $999,999.99 will fail.

Information specific to wire transfers.

Additional information from the wire originator to the beneficiary. Max 140 characters.

The fee amount deducted from the original transfer during a wire return, if applicable.

When true, you can still cancel this transfer.

The failure reason if the event type for a transfer is "failed" or "returned". Null value otherwise.

The failure code, e.g. R01. A failure code will be provided if and only if the transfer status is returned. See ACH return codes for a full listing of ACH return codes and RTP/RfP error codes for RTP error codes.

The ACH return code, e.g. R01. A return code will be provided if and only if the transfer status is returned. For a full listing of ACH return codes, see Transfer errors.

A human-readable description of the reason for the failure or reversal.

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

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

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.

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

The date 3 business days from settlement date indicating the following ACH returns can no longer happen: R01, R02, R03, R29. This will be of the form YYYY-MM-DD.

The date 61 business days from settlement date indicating the following ACH returns can no longer happen: R05, R07, R10, R11, R51, R33, R37, R38, R51, R52, R53. This will be of the form YYYY-MM-DD.

Deprecated for Plaid Ledger clients, use expected_funds_available_date instead.

The expected date when funds from a transfer will be made available and can be withdrawn from the associated ledger balance, assuming the debit does not return before this date. If the transfer does return before this date, this field will be null. Only applies to debit transfers. This will be of the form YYYY-MM-DD.

The Plaid client ID that is the originator of this transfer. Only present if created on behalf of another client as a Platform customer.

A list of refunds associated with this transfer.

Plaid’s unique identifier for a refund.

The ID of the transfer to refund.

The amount of the refund (decimal string with two digits of precision e.g. “10.00”).

The status of the refund. pending: A new refund was created; it is in the pending state. posted: The refund has been successfully submitted to the payment network. settled: Credits have been refunded to the Plaid linked account. cancelled: The refund was cancelled by the client. failed: The refund has failed. returned: The refund was returned.

The failure reason if the event type for a refund is "failed" or "returned". Null value otherwise.

The failure code, e.g. R01. A failure code will be provided if and only if the refund status is returned. See ACH return codes for a full listing of ACH return codes and RTP/RfP error codes for RTP error codes.

The ACH return code, e.g. R01. A return code will be provided if and only if the refund status is returned. For a full listing of ACH return codes, see Transfer errors. This field is deprecated in favor of the more versatile failure_code, which encompasses non-ACH failure codes as well.

A human-readable description of the reason for the failure or reversal.

Plaid’s unique identifier for a Plaid Ledger Balance.

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

The trace identifier for the transfer based on its network. This will only be set after the transfer has posted. For ach or same-day-ach transfers, this is the ACH trace number. For rtp transfers, this is the Transaction Identification number. For wire transfers, this is the IMAD (Input Message Accountability Data) number.

The id of the recurring transfer if this transfer belongs to a recurring transfer.

The expected sweep settlement schedule of this transfer, assuming this transfer is not returned. Only applies to ACH debit transfers.

The settlement date of a sweep for this transfer.

The accumulated amount that has been swept by sweep_settlement_date.

The amount to deduct from transfer.amount and distribute to the platform’s Ledger balance as a facilitator fee (decimal string with two digits of precision e.g. “10.00”). The remainder will go to the end-customer’s Ledger balance. This must be value greater than 0 and less than or equal to the transfer.amount.

The trace identifier for the transfer based on its network. This will only be set after the transfer has posted. For ach or same-day-ach transfers, this is the ACH trace number. For rtp transfers, this is the Transaction Identification number. For wire transfers, this is the IMAD (Input Message Accountability Data) number.

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