class

Plaid::LinkTokenCreateRequestIncomeVerificationPayrollIncome

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

Specifies options for initializing Link for use with Payroll Income (including Document Income). Further customization options for Document Income, such as customizing which document types may be uploaded, are also available via the Link Customization pane in the Dashboard. (Requires Production enablement.)

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, flow_types : Array(IncomeVerificationPayrollFlowType) | Nil = nil, is_update_mode : Bool | Nil = false, item_id_to_update : String | Nil = nil, parsing_config : Array(IncomeVerificationDocParsingConfig) | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

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

flow_types

The types of payroll income verification to enable for the Link session. If none are specified, then users will see both document and digital payroll income.

flow_types=(new_value : Array(IncomeVerificationPayrollFlowType) | Nil)

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

flow_types_present=(flow_types_present : Bool)

flow_types_present?

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

is_update_mode

An identifier to indicate whether the income verification Link token will be used for update mode. This field is only relevant for participants in the Payroll Income Refresh beta.

is_update_mode=(new_value : Bool | Nil)

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

item_id_to_update

Uniquely identify a payroll income Item to update with. This field is only relevant for participants in the Payroll Income Refresh beta.

item_id_to_update=(new_value : String | Nil)

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

item_id_to_update_present=(item_id_to_update_present : Bool)

item_id_to_update_present?

list_invalid_properties

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

parsing_config

The types of analysis to enable for document uploads. If this field is not provided, then docs will undergo OCR parsing only.

parsing_config=(new_value : Array(IncomeVerificationDocParsingConfig) | Nil)

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

parsing_config_present=(parsing_config_present : Bool)

parsing_config_present?

valid?

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