class

Plaid::TransferCreateRequest

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

Defines the request schema for /transfer/create

Constants

MAX_ITEMS_FOR_METADATA = 50
MAX_LENGTH_FOR_DESCRIPTION = 15
MAX_LENGTH_FOR_IDEMPOTENCY_KEY = 50

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, access_token : String | Nil = nil, account_id : String | Nil = nil, authorization_id : String | Nil = nil, description : String | Nil = nil, client_id : String | Nil = nil, secret : String | Nil = nil, idempotency_key : String | Nil = nil, _type : Plaid::TransferType | Nil = nil, network : Plaid::TransferNetwork | Nil = nil, amount : String | Nil = nil, ach_class : Plaid::ACHClass | Nil = nil, user : Plaid::TransferUserInRequestDeprecated | Nil = nil, metadata : Hash(String, String) | Nil = nil, origination_account_id : String | Nil = nil, iso_currency_code : String | Nil = nil, test_clock_id : String | Nil = nil, facilitator_fee : 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
access_token

The Plaid access_token for the account that will be debited or credited.

Source
access_token=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] access_token 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. This parameter also serves the purpose of acting as an idempotency identifier.

Source
authorization_id=(new_value : String | Nil)

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

The transfer description. Maximum of 15 characters. If reprocessing a returned transfer, please note that the description field must be \"Retry\" to indicate that it's a retry of a previously returned transfer. You may retry a transfer up to 2 times, within 180 days of creating the original transfer. Only transfers that were returned with code R01 or R09 may be retried. For a full listing of ACH return codes, see Transfer errors.

Source
description=(new_value : String | Nil)

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

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

idempotency_key

Deprecated. authorization_id is now used as idempotency instead. A random key provided by the client, per unique transfer. Maximum of 50 characters. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single transfer is created.

Source
idempotency_key=(new_value : String | Nil)

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

Source
iso_currency_code

The currency of the transfer amount. The default value is "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
network
Source
network=(new_value : Plaid::TransferNetwork | 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 this transfer. If you have more than one origination account, this value must be specified. Otherwise, this field should be left blank.

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

Plaid’s unique identifier for a test clock. This field may only be used when using sandbox environment. If provided, the transfer is created at the virtual_time on the provided test_clock.

Source
test_clock_id=(new_value : String | Nil)

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

Source
test_clock_id_present=(test_clock_id_present : Bool)
Source
test_clock_id_present?
Source
user
Source

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

Source
user_present=(user_present : Bool)
Source
user_present?
Source
valid?

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

Source