Struct plaid::model::RecurringTransfer

pub struct RecurringTransfer {

    pub account_id: String,
    pub ach_class: Option<String>,
    pub amount: String,
    pub created: DateTime<Utc>,
    pub description: String,
    pub funding_account_id: String,
    pub iso_currency_code: String,
    pub network: String,
    pub next_origination_date: Option<NaiveDate>,
    pub origination_account_id: String,
    pub recurring_transfer_id: String,
    pub schedule: TransferRecurringSchedule,
    pub status: String,
    pub test_clock_id: Option<String>,
    pub transfer_ids: Vec<String>,
    pub type_: String,
    pub user: TransferUserInResponse,
}

Represents a recurring transfer within the Transfers API.

Fields

account_id: String

The Plaid account_id corresponding to the end-user account that will be debited or credited.

ach_class: Option<String>

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, e.g. bill payment

"tel" - Telephone-Initiated Entry

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

amount: String

The amount of the transfer (decimal string with two digits of precision e.g. “10.00”). When calling /transfer/authorization/create, specify the maximum amount to authorize. When calling /transfer/create, specify the exact amount of the transfer, up to a maximum of the amount authorized. If this field is left blank when calling /transfer/create, the maximum amount authorized in the authorization_id will be sent.

created: DateTime<Utc>

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

description: String

The description of the recurring transfer.

funding_account_id: String

The id of the funding account to use, available in the Plaid Dashboard. This determines which of your business checking accounts will be credited or debited.

iso_currency_code: String

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

network: String

The network or rails used for the transfer.

For transfers submitted as ach, the next-day cutoff is 5:30 PM Eastern Time.

For transfers submitted as same-day-ach, the same-day cutoff is 3:30 PM Eastern Time. If the transfer is submitted after this cutoff but before the next-day cutoff, it will be sent over next-day rails and will not incur same-day charges; this will apply to both legs of the transfer if applicable.

For transfers submitted as rtp, Plaid will automatically route between Real Time Payment rail by TCH or FedNow rails as necessary. If a transfer is submitted as rtp and the counterparty account is not eligible for RTP, the /transfer/authorization/create request will fail with an INVALID_FIELD error code. To pre-check to determine whether a counterparty account can support RTP, call /transfer/capabilities/get before calling /transfer/authorization/create.

next_origination_date: Option<NaiveDate>

A date in ISO 8601 format (YYYY-MM-DD).

The next transfer origination date after bank holiday adjustment.

origination_account_id: String

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

recurring_transfer_id: String

Plaid’s unique identifier for a recurring transfer.

schedule: TransferRecurringSchedule

The schedule that the recurring transfer will be executed on.

status: String

The status of the recurring transfer.

active: The recurring transfer is currently active. cancelled: The recurring transfer was cancelled by the client or Plaid. expired: The recurring transfer has completed all originations according to its recurring schedule.

test_clock_id: Option<String>

Plaid’s unique identifier for a test clock.

transfer_ids: Vec<String>

type_: String

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.

Trait Implementations

impl Clone for RecurringTransfer

fn clone(&self) -> RecurringTransfer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RecurringTransfer

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

Formats the value using the given formatter.

impl Default for RecurringTransfer

fn default() -> RecurringTransfer

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RecurringTransfer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RecurringTransfer

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

Formats the value using the given formatter.

impl Serialize for RecurringTransfer

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

where __S: Serializer,

Serialize this value into the given Serde serializer.