class

Plaid::TransferIntentGet

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

Represents a transfer intent within Transfer UI.

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, created : Time | Nil = nil, status : Plaid::TransferIntentStatus | Nil = nil, transfer_id : String | Nil = nil, failure_reason : TransferIntentGetFailureReason | Nil = nil, authorization_decision : Plaid::TransferIntentAuthorizationDecision | Nil = nil, authorization_decision_rationale : TransferAuthorizationDecisionRationale | Nil = nil, origination_account_id : String | Nil = nil, funding_account_id : String | Nil = nil, amount : String | Nil = nil, mode : Plaid::TransferIntentCreateMode | Nil = nil, user : TransferUserInResponse | Nil = nil, description : String | Nil = nil, iso_currency_code : String | Nil = nil, guarantee_decision : Plaid::TransferAuthorizationGuaranteeDecision | Nil = nil, guarantee_decision_rationale : TransferAuthorizationGuaranteeDecisionRationale | Nil = nil, account_id : String | Nil = nil, network : Plaid::TransferIntentCreateNetwork | Nil = Plaid::TransferIntentCreateNetwork.new("same-day-ach"), ach_class : Plaid::ACHClass | Nil = nil, metadata : Hash(String, String) | Nil = nil, require_guarantee : Bool | 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

account_id

The Plaid account_id for the account that will be debited or credited. Returned only if account_id was set on intent creation.

Source
account_id=(new_value : String | Nil)

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

Source
account_id_present=(account_id_present : Bool)
Source
account_id_present?
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_decision
Source
authorization_decision=(new_value : Plaid::TransferIntentAuthorizationDecision | Nil)

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

Source
authorization_decision_rationale
Source
authorization_decision_rationale=(new_value : TransferAuthorizationDecisionRationale | Nil)

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

Source
created

The datetime the 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
description

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

Source
description=(new_value : String | Nil)

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

Source
failure_reason
Source
failure_reason=(new_value : TransferIntentGetFailureReason | 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 funding account to use, available in the Plaid Dashboard. This determines 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 intent object.

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
metadata_present=(metadata_present : Bool)
Source
metadata_present?
Source
mode
Source
mode=(new_value : Plaid::TransferIntentCreateMode | Nil)

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

Source
network
Source
network=(new_value : Plaid::TransferIntentCreateNetwork | 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 used for the 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
require_guarantee

When true, the transfer requires a GUARANTEED decision by Plaid to proceed (Guarantee customers only).

Source
require_guarantee=(new_value : Bool | Nil)

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

Source
require_guarantee_present=(require_guarantee_present : Bool)
Source
require_guarantee_present?
Source
status
Source
status=(new_value : Plaid::TransferIntentStatus | Nil)

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

Source
transfer_id

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

Source
transfer_id=(new_value : String | Nil)

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