Plaid::TransferCreateRequest
Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object
Defines the request schema for /transfer/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
Plaid’s unique identifier for a transfer authorization. This parameter also serves the purpose of acting as an idempotency identifier.
Custom attribute writer method checking allowed values (enum). @param [Object] authorization_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
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.
Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned
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.
Custom attribute writer method checking allowed values (enum). @param [Object] facilitator_fee 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
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.
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
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
Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned
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 transfer. If you have more than one origination account, this value must be specified. Otherwise, this field should be left blank.
Custom attribute writer method checking allowed values (enum). @param [Object] origination_account_id 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 transfer 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
Check to see if the all the properties in the model are valid @return true if the model is valid