class

Plaid::CreditPayrollIncomePrecheckRequest

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

Defines the request schema for /credit/payroll_income/precheck.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, client_id : String | Nil = nil, secret : String | Nil = nil, user_token : String | Nil = nil, access_tokens : Array(String) | Nil = nil, employer : Plaid::IncomeVerificationPrecheckEmployer | Nil = nil, us_military_info : Plaid::IncomeVerificationPrecheckMilitaryInfo | Nil = nil, payroll_institution : Plaid::IncomeVerificationPrecheckPayrollInstitution | 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

access_tokens

An array of access tokens corresponding to Items belonging to the user whose eligibility is being checked. Note that if the Items specified here are not already initialized with transactions, providing them in this field will cause these Items to be initialized with (and billed for) the Transactions product.

Source
access_tokens=(new_value : Array(String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] access_tokens 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
employer
Source
employer=(new_value : Plaid::IncomeVerificationPrecheckEmployer | Nil)

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

Source
employer_present=(employer_present : Bool)
Source
employer_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

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
payroll_institution
Source
payroll_institution=(new_value : Plaid::IncomeVerificationPrecheckPayrollInstitution | Nil)

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

Source
payroll_institution_present=(payroll_institution_present : Bool)
Source
payroll_institution_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
us_military_info
Source
us_military_info=(new_value : Plaid::IncomeVerificationPrecheckMilitaryInfo | Nil)

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

Source
us_military_info_present=(us_military_info_present : Bool)
Source
us_military_info_present?
Source
user_token

The user token associated with the User data is being requested for.

Source
user_token=(new_value : String | Nil)

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