class

Plaid::BankTransfer

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

Represents a bank transfer within the Bank Transfers API.

Constants

MAX_ITEMS_FOR_METADATA = 50

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, id : String | Nil = nil, ach_class : Plaid::ACHClass | Nil = nil, account_id : String | Nil = nil, _type : Plaid::BankTransferType | Nil = nil, user : BankTransferUser | Nil = nil, amount : String | Nil = nil, iso_currency_code : String | Nil = nil, description : String | Nil = nil, created : Time | Nil = nil, status : Plaid::BankTransferStatus | Nil = nil, network : Plaid::BankTransferNetwork | Nil = nil, cancellable : Bool | Nil = nil, failure_reason : BankTransferFailure | Nil = nil, custom_tag : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, origination_account_id : String | Nil = nil, direction : Plaid::BankTransferDirection | 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::BankTransferType | Nil)

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

Source
account_id

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

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 bank transfer (decimal string with two digits of precision e.g. "10.00").

Source
amount=(new_value : String | Nil)

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

Source
cancellable

When true, you can still cancel this bank 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 bank 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
custom_tag

A string containing the custom tag provided by the client in the create request. Will be null if not provided.

Source
custom_tag=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] custom_tag 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
direction
Source
direction=(new_value : Plaid::BankTransferDirection | Nil)

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

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

Custom attribute writer method checking allowed values (enum). @param [Object] failure_reason 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 bank 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::BankTransferNetwork | Nil)

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

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
status
Source
status=(new_value : Plaid::BankTransferStatus | Nil)

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

Source
user
Source
user=(new_value : BankTransferUser | 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