Struct plaid_openapi::TransferIntentCreateRequest

pub struct TransferIntentCreateRequest {
    pub client_id: APIClientID,
    pub secret: APISecret,
    pub account_id: Option<String>,
    pub mode: TransferIntentCreateMode,
    pub amount: TransferAmount,
    pub description: String,
    pub ach_class: ACHClass,
    pub origination_account_id: Option<String>,
    pub user: TransferUserInRequest,
    pub metadata: TransferMetadata,
    pub iso_currency_code: Option<String>,
}

Fields

client_id: APIClientID

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

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

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

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.

amount: TransferAmount

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

description: String

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

ach_class: ACHClass

Specifies the use case of the transfer. Required for transfers on an ACH network. In Sandbox, only ccd, ppd, or web can be used.

"arc" - Accounts Receivable Entry

"cbr“ - Cross Border Entry

"ccd" - Corporate Credit or Debit - fund transfer between two corporate bank accounts

"cie" - Customer Initiated Entry

"cor" - Automated Notification of Change

"ctx" - Corporate Trade Exchange

"iat" - International

"mte" - Machine Transfer Entry

"pbr" - Cross Border Entry

"pop" - Point-of-Purchase Entry

"pos" - Point-of-Sale Entry

"ppd" - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment

"rck" - Re-presented Check Entry

"tel" - Telephone-Initiated Entry

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

origination_account_id: Option<String>

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

user: TransferUserInRequest

The legal name and other information for the account holder.

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

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

Trait Implementations

impl Debug for TransferIntentCreateRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransferIntentCreateRequest

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

Deserialize this value from the given Serde deserializer.

impl Serialize for TransferIntentCreateRequest

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

Serialize this value into the given Serde serializer.