class

Plaid::Transfer

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

Represents a transfer within the Transfers API.

Constants

MAX_ITEMS_FOR_METADATA = 50

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, id : String | Nil = nil, authorization_id : String | Nil = nil, funding_account_id : String | Nil = nil, _type : Plaid::TransferType | Nil = nil, user : TransferUserInResponse | Nil = nil, amount : String | Nil = nil, description : String | Nil = nil, created : Time | Nil = nil, status : Plaid::TransferStatus | Nil = nil, network : Plaid::TransferNetwork | Nil = nil, cancellable : Bool | Nil = nil, failure_reason : TransferFailure | Nil = nil, metadata : Hash(String, String) | Nil = nil, origination_account_id : String | Nil = nil, guarantee_decision : Plaid::TransferAuthorizationGuaranteeDecision | Nil = nil, guarantee_decision_rationale : TransferAuthorizationGuaranteeDecisionRationale | Nil = nil, iso_currency_code : String | Nil = nil, standard_return_window : Time | Nil = nil, unauthorized_return_window : Time | Nil = nil, expected_settlement_date : Time | Nil = nil, originator_client_id : String | Nil = nil, refunds : Array(TransferRefund) | Nil = nil, recurring_transfer_id : String | Nil = nil, credit_funds_source : Plaid::TransferCreditFundsSource | Nil = nil, ach_class : Plaid::ACHClass | Nil = nil, account_id : String | Nil = nil, sweep_status : Plaid::TransferSweepStatus | Nil = nil, expected_sweep_settlement_schedule : Array(TransferExpectedSweepSettlementScheduleItem) | Nil = nil, facilitator_fee : String | Nil = nil, network_trace_id : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

_type
Source
_type=(new_value : Plaid::TransferType | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned

Source
account_id

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

Source
account_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] account_id Object to be assigned

Source
ach_class
Source
ach_class=(new_value : Plaid::ACHClass | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] ach_class Object to be assigned

Source
amount

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.

Source
amount=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amount Object to be assigned

Source
authorization_id

Plaid’s unique identifier for a transfer authorization.

Source
authorization_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] authorization_id Object to be assigned

Source
cancellable

When true, you can still cancel this transfer.

Source
cancellable=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] cancellable Object to be assigned

Source
created

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

Source
created=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

Source
credit_funds_source
Source
credit_funds_source=(new_value : Plaid::TransferCreditFundsSource | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] credit_funds_source Object to be assigned

Source
description

The description of the transfer.

Source
description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned

Source
expected_settlement_date

The expected date when the full amount of the transfer settles at the consumers’ account, if the transfer is credit; or at the customer's business checking account, if the transfer is debit. Only set for ACH transfers and is null for non-ACH transfers. Only set for ACH transfers. This will be of the form YYYY-MM-DD.

Source
expected_settlement_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] expected_settlement_date Object to be assigned

Source
expected_sweep_settlement_schedule

The expected sweep settlement schedule of this transfer, assuming this transfer is not returned. Only applies to ACH debit transfers.

Source
expected_sweep_settlement_schedule=(new_value : Array(TransferExpectedSweepSettlementScheduleItem) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] expected_sweep_settlement_schedule Object to be assigned

Source
facilitator_fee

The amount to deduct from transfer.amount and distribute to the platform’s Ledger balance as a facilitator fee (decimal string with two digits of precision e.g. "10.00"). The remainder will go to the end-customer’s Ledger balance. This must be less than or equal to the transfer.amount.

Source
facilitator_fee=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] facilitator_fee Object to be assigned

Source
failure_reason
Source
failure_reason=(new_value : TransferFailure | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] failure_reason Object to be assigned

Source
funding_account_id

The id of the associated funding account, available in the Plaid Dashboard. If present, this indicates which of your business checking accounts will be credited or debited.

Source
funding_account_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] funding_account_id Object to be assigned

Source
guarantee_decision
Source
guarantee_decision=(new_value : Plaid::TransferAuthorizationGuaranteeDecision | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] guarantee_decision Object to be assigned

Source
guarantee_decision_rationale
Source
guarantee_decision_rationale=(new_value : TransferAuthorizationGuaranteeDecisionRationale | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] guarantee_decision_rationale Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Plaid’s unique identifier for a transfer.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
iso_currency_code

The currency of the transfer amount, e.g. "USD"

Source
iso_currency_code=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] iso_currency_code Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
metadata

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

Source
metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

Source
network
Source
network=(new_value : Plaid::TransferNetwork | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] network Object to be assigned

Source
network_trace_id

The trace identifier for the transfer based on its network. This will only be set after the transfer has posted. For ach or same-day-ach transfers, this is the ACH trace number. Currently, the field will remain null for transfers on other rails.

Source
network_trace_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] network_trace_id Object to be assigned

Source
network_trace_id_present=(network_trace_id_present : Bool)
Source
network_trace_id_present?
Source
origination_account_id

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

Source
origination_account_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] origination_account_id Object to be assigned

Source
originator_client_id

The Plaid client ID that is the originator of this transfer. Only present if created on behalf of another client as a Platform customer.

Source
originator_client_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] originator_client_id Object to be assigned

Source
recurring_transfer_id

The id of the recurring transfer if this transfer belongs to a recurring transfer.

Source
recurring_transfer_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] recurring_transfer_id Object to be assigned

Source
refunds

A list of refunds associated with this transfer.

Source
refunds=(new_value : Array(TransferRefund) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] refunds Object to be assigned

Source
standard_return_window

The date 3 business days from settlement date indicating the following ACH returns can no longer happen: R01, R02, R03, R29. This will be of the form YYYY-MM-DD.

Source
standard_return_window=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] standard_return_window Object to be assigned

Source
status
Source
status=(new_value : Plaid::TransferStatus | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

Source
sweep_status
Source
sweep_status=(new_value : Plaid::TransferSweepStatus | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] sweep_status Object to be assigned

Source
sweep_status_present=(sweep_status_present : Bool)
Source
sweep_status_present?
Source
unauthorized_return_window

The date 61 business days from settlement date indicating the following ACH returns can no longer happen: R05, R07, R10, R11, R51, R33, R37, R38, R51, R52, R53. This will be of the form YYYY-MM-DD.

Source
unauthorized_return_window=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] unauthorized_return_window Object to be assigned

Source
user
Source
user=(new_value : TransferUserInResponse | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] user Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source