Struct plaid_openapi::ProcessorBankTransferCreateRequest

pub struct ProcessorBankTransferCreateRequest {

    pub client_id: Option<APIClientID>,
    pub secret: Option<APISecret>,
    pub idempotency_key: BankTransferIdempotencyKey,
    pub processor_token: ProcessorToken,
    pub type_: BankTransferType,
    pub network: BankTransferNetwork,
    pub amount: BankTransferAmount,
    pub iso_currency_code: String,
    pub description: String,
    pub ach_class: Option<ACHClass>,
    pub user: BankTransferUser,
    pub custom_tag: Option<String>,
    pub metadata: BankTransferMetadata,
    pub origination_account_id: Option<String>,
}

Fields

client_id: Option<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: Option<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.

idempotency_key: BankTransferIdempotencyKey

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

processor_token: ProcessorToken

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

type_: BankTransferType

The type of bank 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: BankTransferNetwork

The network or rails used for the transfer. Valid options are ach, same-day-ach, or wire.

amount: BankTransferAmount

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

iso_currency_code: String

The currency of the transfer amount – should be set to “USD”.

description: String

The transfer description. Maximum of 10 characters.

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

user: BankTransferUser

The legal name and other information for the account holder.

custom_tag: Option<String>

An arbitrary string provided by the client for storage with the bank transfer. May be up to 100 characters.

metadata: BankTransferMetadata

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.

Trait Implementations

impl Debug for ProcessorBankTransferCreateRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProcessorBankTransferCreateRequest

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

Deserialize this value from the given Serde deserializer.

impl Serialize for ProcessorBankTransferCreateRequest

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

Serialize this value into the given Serde serializer.