Plaid::DepositSwitchGetResponse
Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object
DepositSwitchGetResponse defines the response schema for /deposit_switch/get
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
When true, user’s direct deposit goes to multiple banks. When false, user’s direct deposit only goes to the target account. Always null if the deposit switch has not been completed.
Custom attribute writer method checking allowed values (enum). @param [Object] account_has_multiple_allocations Object to be assigned
The dollar amount of direct deposit allocated to the target account. Always null if the target account is not allocated an amount or if the deposit switch has not been completed.
Custom attribute writer method checking allowed values (enum). @param [Object] amount_allocated Object to be assigned
ISO 8601 date the deposit switch was completed. Always null if the deposit switch has not been completed.
Custom attribute writer method checking allowed values (enum). @param [Object] date_completed Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] date_created Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] deposit_switch_id Object to be assigned
The ID of the employer selected by the user. If the user did not select an employer, the value returned is null.
Custom attribute writer method checking allowed values (enum). @param [Object] employer_id Object to be assigned
The name of the employer selected by the user. If the user did not select an employer, the value returned is null.
Custom attribute writer method checking allowed values (enum). @param [Object] employer_name 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
The ID of the institution selected by the user. If the user did not select an institution, the value returned is null.
Custom attribute writer method checking allowed values (enum). @param [Object] institution_id Object to be assigned
The name of the institution selected by the user. If the user did not select an institution, the value returned is null.
Custom attribute writer method checking allowed values (enum). @param [Object] institution_name Object to be assigned
When true, the target account is allocated the remainder of direct deposit after all other allocations have been deducted. When false, user’s direct deposit is allocated as a percent or amount. Always null if the deposit switch has not been completed.
Custom attribute writer method checking allowed values (enum). @param [Object] is_allocated_remainder Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
The percentage of direct deposit allocated to the target account. Always null if the target account is not allocated a percentage or if the deposit switch has not been completed or if is_allocated_remainder is true.
Custom attribute writer method checking allowed values (enum). @param [Object] percent_allocated Object to be assigned
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
Custom attribute writer method checking allowed values (enum). @param [Object] request_id Object to be assigned
The state, or status, of the deposit switch. - initialized – The deposit switch has been initialized with the user entering the information required to submit the deposit switch request. - processing – The deposit switch request has been submitted and is being processed. - completed – The user's employer has fulfilled the deposit switch request. - error – There was an error processing the deposit switch request.
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
The method used to make the deposit switch. - instant – User instantly switched their direct deposit to a new or existing bank account by connecting their payroll or employer account. - mail – User requested that Plaid contact their employer by mail to make the direct deposit switch. - pdf – User generated a PDF or email to be sent to their employer with the information necessary to make the deposit switch.'
Custom attribute writer method checking allowed values (enum). @param [Object] switch_method Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] target_account_id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] target_item_id Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid