class

Plaid::TransferLedgerWithdrawRequest

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

Defines the request schema for /transfer/ledger/withdraw

Constants

MAX_LENGTH_FOR_DESCRIPTION = 10
MAX_LENGTH_FOR_IDEMPOTENCY_KEY = 50

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : String | Nil = nil, idempotency_key : String | Nil = nil, network : Plaid::TransferNetwork | Nil = nil, client_id : String | Nil = nil, secret : String | Nil = nil, originator_client_id : String | Nil = nil, funding_account_id : String | Nil = nil, description : 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

amount

A positive amount of how much will be withdrawn from the ledger balance (decimal string with two digits of precision e.g. "5.50").

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 deposit that will be passed to the receiving bank (up to 10 characters). Note that banks utilize this field differently, and may or may not show it on the bank statement.

Source
description=(new_value : String | Nil)

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

Source
description_present=(description_present : Bool)
Source
description_present?
Source
funding_account_id

Specify which funding account linked to this Plaid Ledger to use. 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, this will default to the default funding_account_id specified during onboarding. If an originator_client_id is specified, the funding_account_id must belong to the specified originator, and if funding_account_id is left blank, the originator's default funding_account_id will be used.

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 unique key provided by the client, per unique ledger withdraw. Maximum of 50 characters. The API supports idempotency for safely retrying the request without accidentally performing the same operation twice. For example, if a request to create a ledger withdraw fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single withdraw 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
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
originator_client_id

Client ID of the customer that owns the Ledger balance. This is so Plaid knows which of your customers to payout or collect funds. Only applicable for Platform customers. Do not include if you’re paying out to yourself.

Source
originator_client_id=(new_value : String | Nil)

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

Source
originator_client_id_present=(originator_client_id_present : Bool)
Source
originator_client_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
valid?

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

Source