class

Plaid::TransferRecurringCreateRequest

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

Defines the request schema for /transfer/recurring/create

Constants

MAX_LENGTH_FOR_IDEMPOTENCY_KEY = 50

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, access_token : String | Nil = nil, idempotency_key : String | Nil = nil, account_id : String | Nil = nil, _type : Plaid::TransferType | Nil = nil, network : Plaid::TransferNetwork | Nil = nil, amount : String | Nil = nil, description : String | Nil = nil, schedule : Plaid::TransferRecurringSchedule | Nil = nil, user : Plaid::TransferUserInRequest | Nil = nil, client_id : String | Nil = nil, secret : String | Nil = nil, funding_account_id : String | Nil = nil, ach_class : Plaid::ACHClass | Nil = nil, user_present : Bool | Nil = nil, iso_currency_code : String | Nil = nil, test_clock_id : String | Nil = nil, device : TransferDevice | 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
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 description of the recurring transfer.

Source
description=(new_value : String | Nil)

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

Source
device
Source
device=(new_value : TransferDevice | Nil)

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

idempotency_key

A random key provided by the client, per unique recurring 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 recurring fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single recurring 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
network
Source
network=(new_value : Plaid::TransferNetwork | Nil)

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

Source
schedule
Source
schedule=(new_value : Plaid::TransferRecurringSchedule | Nil)

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

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 created recurring_transfer is associated with the test_clock. New originations are automatically generated when the associated test_clock advances.

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

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

Source
user_present

If the end user is initiating the specific transfer themselves via an interactive UI, this should be true; for automatic recurring payments where the end user is not actually initiating each individual transfer, it should be false.

Source
user_present=(new_value : Bool | Nil)

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

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

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

Source