Struct plaid_openapi::model::TransferIntentCreate

pub struct TransferIntentCreate {

    pub id: String,
    pub created: String,
    pub status: TransferIntentStatus,
    pub account_id: Option<String>,
    pub origination_account_id: String,
    pub amount: TransferAmount,
    pub mode: TransferIntentCreateMode,
    pub ach_class: AchClass,
    pub user: TransferUserInResponse,
    pub description: String,
    pub metadata: Option<TransferMetadata>,
    pub iso_currency_code: String,
    pub require_guarantee: Option<bool>,
}

Fields

id: String

Plaid’s unique identifier for the transfer intent object.

created: String

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

status: TransferIntentStatus

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: Option<String>

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

origination_account_id: String

Plaid’s unique identifier for the origination account for the intent. If not provided, the default account will be used.

amount: TransferAmount

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

mode: TransferIntentCreateMode

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.

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: TransferUserInResponse

The legal name and other information for the account holder.

description: String

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

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

iso_currency_code: String

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

require_guarantee: Option<bool>

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

Trait Implementations

impl Debug for TransferIntentCreate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransferIntentCreate

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

Deserialize this value from the given Serde deserializer.

impl Serialize for TransferIntentCreate

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

Serialize this value into the given Serde serializer.