class

Plaid::TransferIntentCreateRequest

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

Defines the request schema for /transfer/intent/create

Constants

MAX_ITEMS_FOR_METADATA = 50
MAX_LENGTH_FOR_DESCRIPTION = 8
MIN_LENGTH_FOR_DESCRIPTION = 1

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, mode : Plaid::TransferIntentCreateMode | Nil = nil, amount : String | Nil = nil, description : String | Nil = nil, user : Plaid::TransferUserInRequest | Nil = nil, client_id : String | Nil = nil, secret : String | Nil = nil, account_id : String | Nil = nil, funding_account_id : String | Nil = nil, network : Plaid::TransferIntentCreateNetwork | Nil = Plaid::TransferIntentCreateNetwork.new("same-day-ach"), ach_class : Plaid::ACHClass | Nil = nil, origination_account_id : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, iso_currency_code : String | Nil = nil, require_guarantee : Bool | Nil = false)

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 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
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
client_id

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

Source
client_id=(new_value : String | Nil)

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

Specify the account used to fund the transfer. Customers can find a list of funding_account_ids in the Accounts page of your Plaid Dashboard, under the "Account ID" column. If this field is left blank, it will default to the default funding_account_id specified during onboarding.

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
funding_account_id_present=(funding_account_id_present : Bool)
Source
funding_account_id_present?
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

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 for the intent. If not provided, the default account will be used.

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
origination_account_id_present=(origination_account_id_present : Bool)
Source
origination_account_id_present?
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
secret

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

Source
secret=(new_value : String | Nil)

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

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