Struct plaid_openapi::Transfer

pub struct Transfer {

    pub id: TransferID,
    pub ach_class: ACHClass,
    pub account_id: String,
    pub type_: TransferType,
    pub user: TransferUserInResponse,
    pub amount: TransferAmount,
    pub description: String,
    pub created: String,
    pub status: TransferStatus,
    pub sweep_status: TransferSweepStatus,
    pub network: TransferNetwork,
    pub cancellable: bool,
    pub failure_reason: TransferFailure,
    pub metadata: TransferMetadata,
    pub origination_account_id: String,
    pub guarantee_decision: TransferAuthorizationGuaranteeDecision,
    pub guarantee_decision_rationale: TransferAuthorizationGuaranteeDecisionRationale,
    pub iso_currency_code: String,
}

Fields

id: TransferID

Plaid’s unique identifier for a transfer.

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

account_id: String

The account ID that should be credited/debited for this transfer.

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.

user: TransferUserInResponse

The legal name and other information for the account holder.

amount: TransferAmount

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

description: String

The description of the transfer.

created: String

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

status: TransferStatus

The status of the transfer.

sweep_status: TransferSweepStatus

The status of the sweep for the transfer. unswept: The transfer hasn’t been swept yet. swept: The transfer was swept to the sweep account. reverse_swept: The transfer was reversed, funds were pulled back or pushed back to the sweep account. null: The transfer will never be swept (e.g. if the transfer is cancelled or reversed before being swept)

network: TransferNetwork

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

cancellable: bool

When true, you can still cancel this transfer.

failure_reason: TransferFailure

The failure reason if the event type for a transfer is "failed" or "reversed". Null value otherwise.

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

origination_account_id: String

Plaid’s unique identifier for the origination account that was used for this transfer.

guarantee_decision: TransferAuthorizationGuaranteeDecision

Indicates whether the transfer is guaranteed by Plaid (Guaranteed ACH customers only). This field will contain either GUARANTEED or NOT_GUARANTEED indicating whether Plaid will guarantee the transfer. If the transfer is not guaranteed, additional information will be provided in the guarantee_decision_rationale field. Refer to the code field in guarantee_decision_rationale for details.

guarantee_decision_rationale: TransferAuthorizationGuaranteeDecisionRationale

The rationale for Plaid’s decision to not guarantee a transfer. Will be null unless guarantee_decision is NOT_GUARANTEED.

iso_currency_code: String

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

Trait Implementations

impl Debug for Transfer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Transfer

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Transfer

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

Serialize this value into the given Serde serializer.