Struct plaid_openapi::TransferIntentGet

pub struct TransferIntentGet {

    pub id: String,
    pub created: String,
    pub status: String,
    pub transfer_id: Option<String>,
    pub failure_reason: TransferIntentGetFailureReason,
    pub authorization_decision: Option<String>,
    pub authorization_decision_rationale: TransferAuthorizationDecisionRationale,
    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: TransferMetadata,
    pub iso_currency_code: String,
}

Fields

id: String

Plaid’s unique identifier for a transfer intent object.

created: String

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

status: String

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.

transfer_id: Option<String>

Plaid’s unique identifier for the transfer created through the UI. Returned only if the transfer was successfully created. Null value otherwise.

failure_reason: TransferIntentGetFailureReason

The reason for a failed transfer intent. Returned only if the transfer intent status is failed. Null otherwise.

authorization_decision: Option<String>

A decision regarding the proposed transfer.

APPROVED – The proposed transfer has received the end user’s consent and has been approved for processing. Plaid has also reviewed the proposed transfer and has approved it for processing.

PERMITTED – Plaid was unable to fetch the information required to approve or decline the proposed transfer. You may proceed with the transfer, but further review is recommended. Plaid is awaiting further instructions from the client.

DECLINED – Plaid reviewed the proposed transfer and declined processing. Refer to the code field in the decision_rationale object for details. Null value otherwise.

authorization_decision_rationale: TransferAuthorizationDecisionRationale

The rationale for Plaid’s decision regarding a proposed transfer. Will be null for approved decisions.

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 used for the transfer.

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

The legal name and other information for the account holder.

description: String

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

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

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

Trait Implementations

impl Debug for TransferIntentGet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransferIntentGet

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

Deserialize this value from the given Serde deserializer.

impl Serialize for TransferIntentGet

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

Serialize this value into the given Serde serializer.