Plaid::TransferAuthorizationCreateRequest
Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object
Defines the request schema for /transfer/authorization/create
Constants
Constructors
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance methods
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] access_token Object to be assigned
The Plaid account_id corresponding to the end-user account that will be debited or credited.
Custom attribute writer method checking allowed values (enum). @param [Object] account_id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] ach_class Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] amount Object to be assigned
The unique identifier returned by Plaid's beacon when it is run on your webpage.
Custom attribute writer method checking allowed values (enum). @param [Object] beacon_session_id Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] client_id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] credit_funds_source Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] device Object to be assigned
Specify the account used to fund the transfer. Should be specified if using legacy funding methods only. If using Plaid Ledger, leave this field blank. 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 and you are using legacy funding methods, this will default to the default funding_account_id specified during onboarding. Otherwise, Plaid Ledger will be used.
Custom attribute writer method checking allowed values (enum). @param [Object] funding_account_id Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
A random key provided by the client, per unique authorization, which expires after 48 hours. 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 an authorization fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single authorization is created. This idempotency key expires after 48 hours, after which the same key can be reused. Failure to provide this key may result in duplicate charges.
Custom attribute writer method checking allowed values (enum). @param [Object] idempotency_key Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] iso_currency_code Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Custom attribute writer method checking allowed values (enum). @param [Object] network Object to be assigned
Plaid's unique identifier for the origination account for this authorization. If not specified, the default account will be used.
Custom attribute writer method checking allowed values (enum). @param [Object] origination_account_id Object to be assigned
The Plaid client ID that is the originator of this transfer. Only needed if creating transfers on behalf of another client as a Platform customer.
Custom attribute writer method checking allowed values (enum). @param [Object] originator_client_id Object to be assigned
The payment profile token associated with the Payment Profile that will be debited or credited. Required if not using access_token.
Custom attribute writer method checking allowed values (enum). @param [Object] payment_profile_token Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] secret Object to be assigned
Plaid’s unique identifier for a test clock. This field may only be used when using sandbox environment. If provided, the authorization is created at the virtual_time on the provided test clock.
Custom attribute writer method checking allowed values (enum). @param [Object] test_clock_id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] user Object to be assigned
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. This field is not currently used and is present to support planned future functionality.
Custom attribute writer method checking allowed values (enum). @param [Object] user_present Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid
If set to false, Plaid will not offer a guarantee_decision for this request (Guarantee customers only).
Custom attribute writer method checking allowed values (enum). @param [Object] with_guarantee Object to be assigned