Struct plaid_openapi::model::TransferCreateRequest

pub struct TransferCreateRequest {

    pub idempotency_key: TransferCreateIdempotencyKey,
    pub access_token: TransferAccessToken,
    pub account_id: String,
    pub authorization_id: String,
    pub type_: TransferType,
    pub network: TransferNetwork,
    pub amount: TransferAmount,
    pub description: String,
    pub ach_class: AchClass,
    pub user: TransferUserInRequest,
    pub metadata: Option<TransferMetadata>,
    pub origination_account_id: Option<String>,
    pub iso_currency_code: String,
    pub payment_profile_id: PaymentProfileId,
}

Fields

idempotency_key: TransferCreateIdempotencyKey

Deprecated. authorization_id is now used as idempotency instead.

A random key provided by the client, per unique 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 transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single transfer is created.

access_token: TransferAccessToken

The Plaid access_token for the account that will be debited or credited.

account_id: String

The Plaid account_id for the account that will be debited or credited.

authorization_id: String

Plaid’s unique identifier for a transfer authorization. This parameter also serves the purpose of acting as an idempotency identifier.

type_: TransferType

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.

network: TransferNetwork

The network or rails used for the transfer. Valid options are ach or same-day-ach. The cutoff for same-day transfers is 7:45 AM Pacific Time and the cutoff for next-day transfers is 5:45 PM Pacific Time. It is recommended to submit a transfer at least 15 minutes before the cutoff time in order to ensure that it will be processed before the cutoff. Any transfer that is indicated as same-day-ach and that misses the same-day cutoff, but is submitted in time for the next-day cutoff, will be sent over next-day rails and will not incur same-day charges. Note that both legs of the transfer will be downgraded if applicable.

amount: TransferAmount

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

description: String

The transfer description. Maximum of 10 characters.

ach_class: AchClass

Specifies the use case of the transfer. Required for transfers on an ACH network.

"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, eg. bill payment

"tel" - Telephone-Initiated Entry

"web" - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet

user: TransferUserInRequest

The legal name and other information for the account holder.

metadata: Option<TransferMetadata>

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: Option<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. Otherwise, this field should be left blank.

iso_currency_code: String

The currency of the transfer amount. The default value is “USD”.

payment_profile_id: PaymentProfileId

Plaid’s unique identifier for a payment profile.

Trait Implementations

impl Debug for TransferCreateRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransferCreateRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for TransferCreateRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.