lithic 0.1.0.pre.alpha.39 → 0.1.0.pre.alpha.41
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +24 -0
- data/README.md +1 -1
- data/lib/lithic/client.rb +8 -0
- data/lib/lithic/internal/transport/base_client.rb +1 -1
- data/lib/lithic/internal/transport/pooled_net_requester.rb +1 -9
- data/lib/lithic/internal/type/array_of.rb +1 -0
- data/lib/lithic/internal/type/base_model.rb +3 -1
- data/lib/lithic/internal/type/converter.rb +27 -0
- data/lib/lithic/internal/type/hash_of.rb +1 -0
- data/lib/lithic/internal/type/union.rb +9 -7
- data/lib/lithic/internal/util.rb +1 -1
- data/lib/lithic/models/account.rb +88 -1
- data/lib/lithic/models/account_activity_list_params.rb +156 -0
- data/lib/lithic/models/account_activity_list_response.rb +1435 -0
- data/lib/lithic/models/account_activity_retrieve_transaction_params.rb +14 -0
- data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +1451 -0
- data/lib/lithic/models/account_holder.rb +16 -19
- data/lib/lithic/models/account_holder_create_params.rb +41 -47
- data/lib/lithic/models/account_holder_simulate_enrollment_review_params.rb +1 -3
- data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +25 -20
- data/lib/lithic/models/account_holder_update_params.rb +2 -6
- data/lib/lithic/models/account_holder_update_response.rb +25 -20
- data/lib/lithic/models/account_update_params.rb +86 -1
- data/lib/lithic/models/aggregate_balance.rb +1 -0
- data/lib/lithic/models/aggregate_balance_list_params.rb +1 -0
- data/lib/lithic/models/auth_rules/auth_rule_condition.rb +5 -1
- data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +12 -22
- data/lib/lithic/models/auth_rules/v2_list_params.rb +1 -0
- data/lib/lithic/models/auth_rules/velocity_limit_params.rb +3 -25
- data/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rb +226 -16
- data/lib/lithic/models/balance.rb +1 -0
- data/lib/lithic/models/balance_list_params.rb +1 -0
- data/lib/lithic/models/book_transfer_create_params.rb +34 -6
- data/lib/lithic/models/book_transfer_response.rb +124 -28
- data/lib/lithic/models/card_create_params.rb +90 -1
- data/lib/lithic/models/card_program.rb +10 -1
- data/lib/lithic/models/card_update_params.rb +98 -1
- data/lib/lithic/models/cards/balance_list_response.rb +1 -0
- data/lib/lithic/models/document.rb +1 -3
- data/lib/lithic/models/events/subscription_create_params.rb +1 -3
- data/lib/lithic/models/events/subscription_update_params.rb +1 -3
- data/lib/lithic/models/external_bank_account_list_params.rb +2 -6
- data/lib/lithic/models/external_payment.rb +89 -48
- data/lib/lithic/models/external_resource.rb +34 -0
- data/lib/lithic/models/external_resource_type.rb +18 -0
- data/lib/lithic/models/financial_account.rb +1 -0
- data/lib/lithic/models/financial_account_list_params.rb +1 -0
- data/lib/lithic/models/financial_accounts/balance_list_response.rb +1 -0
- data/lib/lithic/models/financial_accounts/loan_tape.rb +5 -18
- data/lib/lithic/models/financial_accounts/statement.rb +3 -10
- data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +2 -7
- data/lib/lithic/models/financial_transaction.rb +2 -0
- data/lib/lithic/models/instance_financial_account_type.rb +1 -0
- data/lib/lithic/models/kyb.rb +2 -2
- data/lib/lithic/models/management_operation_create_params.rb +30 -1
- data/lib/lithic/models/management_operation_transaction.rb +100 -52
- data/lib/lithic/models/network_program.rb +41 -0
- data/lib/lithic/models/network_program_list_params.rb +43 -0
- data/lib/lithic/models/network_program_retrieve_params.rb +14 -0
- data/lib/lithic/models/non_pci_card.rb +88 -1
- data/lib/lithic/models/payment.rb +60 -1
- data/lib/lithic/models/payment_simulate_action_params.rb +1 -0
- data/lib/lithic/models/reports/settlement_list_details_params.rb +2 -2
- data/lib/lithic/models/settlement_detail.rb +1 -0
- data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +145 -12
- data/lib/lithic/models/three_ds/authentication_simulate_params.rb +1 -4
- data/lib/lithic/models/tokenization.rb +1 -1
- data/lib/lithic/models/transaction.rb +31 -20
- data/lib/lithic/models/transactions/events/enhanced_data.rb +3 -11
- data/lib/lithic/models/transfer.rb +2 -0
- data/lib/lithic/models/wire_party_details.rb +40 -0
- data/lib/lithic/models.rb +16 -0
- data/lib/lithic/resources/account_activity.rb +80 -0
- data/lib/lithic/resources/account_holders.rb +9 -9
- data/lib/lithic/resources/accounts.rb +5 -1
- data/lib/lithic/resources/book_transfers.rb +7 -3
- data/lib/lithic/resources/cards.rb +12 -2
- data/lib/lithic/resources/management_operations.rb +13 -1
- data/lib/lithic/resources/network_programs.rb +64 -0
- data/lib/lithic/resources/reports/settlement.rb +1 -1
- data/lib/lithic/resources/tokenizations.rb +2 -2
- data/lib/lithic/version.rb +1 -1
- data/lib/lithic.rb +13 -2
- data/rbi/lithic/client.rbi +6 -0
- data/rbi/lithic/errors.rbi +2 -2
- data/rbi/lithic/internal/transport/base_client.rbi +1 -1
- data/rbi/lithic/internal/type/converter.rbi +46 -0
- data/rbi/lithic/internal/type/union.rbi +7 -2
- data/rbi/lithic/models/account.rbi +131 -0
- data/rbi/lithic/models/account_activity_list_params.rbi +359 -0
- data/rbi/lithic/models/account_activity_list_response.rbi +3367 -0
- data/rbi/lithic/models/account_activity_retrieve_transaction_params.rbi +30 -0
- data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +3369 -0
- data/rbi/lithic/models/account_holder.rbi +21 -23
- data/rbi/lithic/models/account_holder_create_params.rbi +87 -65
- data/rbi/lithic/models/account_holder_simulate_enrollment_review_response.rbi +36 -30
- data/rbi/lithic/models/account_holder_update_response.rbi +36 -30
- data/rbi/lithic/models/account_update_params.rbi +159 -0
- data/rbi/lithic/models/aggregate_balance.rbi +5 -0
- data/rbi/lithic/models/aggregate_balance_list_params.rbi +5 -0
- data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +20 -0
- data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +26 -15
- data/rbi/lithic/models/auth_rules/v2_list_params.rbi +2 -0
- data/rbi/lithic/models/auth_rules/velocity_limit_params.rbi +18 -25
- data/rbi/lithic/models/auth_rules/velocity_limit_params_period_window.rbi +527 -31
- data/rbi/lithic/models/balance.rbi +2 -0
- data/rbi/lithic/models/balance_list_params.rbi +5 -0
- data/rbi/lithic/models/book_transfer_create_params.rbi +75 -5
- data/rbi/lithic/models/book_transfer_response.rbi +320 -38
- data/rbi/lithic/models/card_create_params.rbi +190 -0
- data/rbi/lithic/models/card_program.rbi +13 -0
- data/rbi/lithic/models/card_update_params.rbi +168 -0
- data/rbi/lithic/models/cards/balance_list_response.rbi +5 -0
- data/rbi/lithic/models/external_payment.rbi +147 -60
- data/rbi/lithic/models/external_resource.rbi +57 -0
- data/rbi/lithic/models/external_resource_type.rbi +26 -0
- data/rbi/lithic/models/financial_account.rbi +5 -0
- data/rbi/lithic/models/financial_account_list_params.rbi +5 -0
- data/rbi/lithic/models/financial_accounts/balance_list_response.rbi +5 -0
- data/rbi/lithic/models/financial_transaction.rbi +1 -0
- data/rbi/lithic/models/instance_financial_account_type.rbi +5 -0
- data/rbi/lithic/models/kyb.rbi +2 -2
- data/rbi/lithic/models/management_operation_create_params.rbi +59 -0
- data/rbi/lithic/models/management_operation_transaction.rbi +230 -84
- data/rbi/lithic/models/network_program.rbi +61 -0
- data/rbi/lithic/models/network_program_list_params.rbi +72 -0
- data/rbi/lithic/models/network_program_retrieve_params.rbi +27 -0
- data/rbi/lithic/models/non_pci_card.rbi +133 -3
- data/rbi/lithic/models/payment.rbi +103 -3
- data/rbi/lithic/models/payment_simulate_action_params.rbi +5 -0
- data/rbi/lithic/models/reports/settlement_list_details_params.rbi +2 -2
- data/rbi/lithic/models/settlement_detail.rbi +2 -0
- data/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi +222 -19
- data/rbi/lithic/models/transaction.rbi +23 -31
- data/rbi/lithic/models/transfer.rbi +1 -0
- data/rbi/lithic/models/wire_party_details.rbi +61 -0
- data/rbi/lithic/models.rbi +17 -0
- data/rbi/lithic/resources/account_activity.rbi +80 -0
- data/rbi/lithic/resources/account_holders.rbi +28 -29
- data/rbi/lithic/resources/accounts.rbi +32 -0
- data/rbi/lithic/resources/book_transfers.rbi +9 -2
- data/rbi/lithic/resources/cards.rbi +70 -0
- data/rbi/lithic/resources/management_operations.rbi +4 -0
- data/rbi/lithic/resources/network_programs.rbi +48 -0
- data/rbi/lithic/resources/reports/settlement.rbi +1 -1
- data/rbi/lithic/resources/tokenizations.rbi +1 -1
- data/sig/lithic/client.rbs +4 -0
- data/sig/lithic/internal/transport/base_client.rbs +1 -1
- data/sig/lithic/internal/type/converter.rbs +17 -0
- data/sig/lithic/internal/type/union.rbs +2 -2
- data/sig/lithic/models/account.rbs +41 -0
- data/sig/lithic/models/account_activity_list_params.rbs +173 -0
- data/sig/lithic/models/account_activity_list_response.rbs +1353 -0
- data/sig/lithic/models/account_activity_retrieve_transaction_params.rbs +15 -0
- data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +1353 -0
- data/sig/lithic/models/account_holder_create_params.rbs +33 -19
- data/sig/lithic/models/account_holder_simulate_enrollment_review_response.rbs +10 -3
- data/sig/lithic/models/account_holder_update_response.rbs +10 -3
- data/sig/lithic/models/account_update_params.rbs +41 -0
- data/sig/lithic/models/aggregate_balance.rbs +2 -1
- data/sig/lithic/models/aggregate_balance_list_params.rbs +2 -1
- data/sig/lithic/models/auth_rules/auth_rule_condition.rbs +8 -0
- data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +8 -0
- data/sig/lithic/models/auth_rules/v2_list_params.rbs +2 -1
- data/sig/lithic/models/auth_rules/velocity_limit_params.rbs +4 -14
- data/sig/lithic/models/auth_rules/velocity_limit_params_period_window.rbs +212 -7
- data/sig/lithic/models/balance.rbs +2 -1
- data/sig/lithic/models/balance_list_params.rbs +2 -1
- data/sig/lithic/models/book_transfer_create_params.rbs +30 -1
- data/sig/lithic/models/book_transfer_response.rbs +134 -15
- data/sig/lithic/models/card_create_params.rbs +47 -0
- data/sig/lithic/models/card_program.rbs +7 -0
- data/sig/lithic/models/card_update_params.rbs +55 -1
- data/sig/lithic/models/cards/balance_list_response.rbs +2 -1
- data/sig/lithic/models/external_payment.rbs +91 -40
- data/sig/lithic/models/external_resource.rbs +32 -0
- data/sig/lithic/models/external_resource_type.rbs +16 -0
- data/sig/lithic/models/financial_account.rbs +2 -0
- data/sig/lithic/models/financial_account_list_params.rbs +2 -1
- data/sig/lithic/models/financial_accounts/balance_list_response.rbs +2 -1
- data/sig/lithic/models/instance_financial_account_type.rbs +2 -0
- data/sig/lithic/models/management_operation_create_params.rbs +20 -0
- data/sig/lithic/models/management_operation_transaction.rbs +98 -42
- data/sig/lithic/models/network_program.rbs +35 -0
- data/sig/lithic/models/network_program_list_params.rbs +38 -0
- data/sig/lithic/models/network_program_retrieve_params.rbs +15 -0
- data/sig/lithic/models/non_pci_card.rbs +55 -3
- data/sig/lithic/models/payment.rbs +61 -3
- data/sig/lithic/models/payment_simulate_action_params.rbs +2 -0
- data/sig/lithic/models/settlement_detail.rbs +2 -0
- data/sig/lithic/models/three_ds/authentication_retrieve_response.rbs +90 -3
- data/sig/lithic/models/transaction.rbs +2 -6
- data/sig/lithic/models/wire_party_details.rbs +35 -0
- data/sig/lithic/models.rbs +16 -0
- data/sig/lithic/resources/account_activity.rbs +27 -0
- data/sig/lithic/resources/account_holders.rbs +3 -3
- data/sig/lithic/resources/accounts.rbs +2 -0
- data/sig/lithic/resources/book_transfers.rbs +2 -0
- data/sig/lithic/resources/cards.rbs +5 -0
- data/sig/lithic/resources/management_operations.rbs +1 -0
- data/sig/lithic/resources/network_programs.rbs +19 -0
- data/sig/lithic/resources/tokenizations.rbs +1 -1
- metadata +38 -5
- data/lib/lithic/models/tokenization_retrieve_response.rb +0 -16
- data/rbi/lithic/models/tokenization_retrieve_response.rbi +0 -31
- data/sig/lithic/models/tokenization_retrieve_response.rbs +0 -15
@@ -70,10 +70,9 @@ module Lithic
|
|
70
70
|
optional :control_person, -> { Lithic::AccountHolder::ControlPerson }
|
71
71
|
|
72
72
|
# @!attribute email
|
73
|
-
#
|
74
|
-
# individual.phone_number when user_type == "INDIVIDUAL".
|
75
|
-
#
|
76
|
-
# > Primary email of Account Holder.
|
73
|
+
# (Deprecated. Use control_person.email when user_type == "BUSINESS". Use
|
74
|
+
# individual.phone_number when user_type == "INDIVIDUAL".) Primary email of
|
75
|
+
# Account Holder.
|
77
76
|
#
|
78
77
|
# @return [String, nil]
|
79
78
|
optional :email, String
|
@@ -106,10 +105,9 @@ module Lithic
|
|
106
105
|
optional :nature_of_business, String
|
107
106
|
|
108
107
|
# @!attribute phone_number
|
109
|
-
#
|
110
|
-
# individual.phone_number when user_type == "INDIVIDUAL".
|
111
|
-
#
|
112
|
-
# > Primary phone of Account Holder, entered in E.164 format.
|
108
|
+
# (Deprecated. Use control_person.phone_number when user_type == "BUSINESS". Use
|
109
|
+
# individual.phone_number when user_type == "INDIVIDUAL".) Primary phone of
|
110
|
+
# Account Holder, entered in E.164 format.
|
113
111
|
#
|
114
112
|
# @return [String, nil]
|
115
113
|
optional :phone_number, String
|
@@ -122,7 +120,7 @@ module Lithic
|
|
122
120
|
optional :required_documents, -> { Lithic::Internal::Type::ArrayOf[Lithic::RequiredDocument] }
|
123
121
|
|
124
122
|
# @!attribute status
|
125
|
-
#
|
123
|
+
# (Deprecated. Use verification_application.status instead)
|
126
124
|
#
|
127
125
|
# KYC and KYB evaluation states.
|
128
126
|
#
|
@@ -134,8 +132,9 @@ module Lithic
|
|
134
132
|
optional :status, enum: -> { Lithic::AccountHolder::Status }
|
135
133
|
|
136
134
|
# @!attribute status_reasons
|
137
|
-
#
|
138
|
-
#
|
135
|
+
# (Deprecated. Use verification_application.status_reasons)
|
136
|
+
#
|
137
|
+
# Reason for the evaluation status.
|
139
138
|
#
|
140
139
|
# @return [Array<Symbol, Lithic::Models::AccountHolder::StatusReason>, nil]
|
141
140
|
optional :status_reasons,
|
@@ -182,7 +181,7 @@ module Lithic
|
|
182
181
|
#
|
183
182
|
# @param control_person [Lithic::Models::AccountHolder::ControlPerson] Only present when user_type == "BUSINESS".
|
184
183
|
#
|
185
|
-
# @param email [String]
|
184
|
+
# @param email [String] (Deprecated. Use control_person.email when user_type == "BUSINESS". Use individu
|
186
185
|
#
|
187
186
|
# @param exemption_type [Symbol, Lithic::Models::AccountHolder::ExemptionType] The type of KYC exemption for a KYC-Exempt Account Holder.
|
188
187
|
#
|
@@ -192,13 +191,13 @@ module Lithic
|
|
192
191
|
#
|
193
192
|
# @param nature_of_business [String] Only present when user_type == "BUSINESS". User-submitted description of the bus
|
194
193
|
#
|
195
|
-
# @param phone_number [String]
|
194
|
+
# @param phone_number [String] (Deprecated. Use control_person.phone_number when user_type == "BUSINESS". Use i
|
196
195
|
#
|
197
196
|
# @param required_documents [Array<Lithic::Models::RequiredDocument>] Only present for "KYB_BASIC" workflow. A list of documents required for the acco
|
198
197
|
#
|
199
|
-
# @param status [Symbol, Lithic::Models::AccountHolder::Status]
|
198
|
+
# @param status [Symbol, Lithic::Models::AccountHolder::Status] (Deprecated. Use verification_application.status instead)
|
200
199
|
#
|
201
|
-
# @param status_reasons [Array<Symbol, Lithic::Models::AccountHolder::StatusReason>]
|
200
|
+
# @param status_reasons [Array<Symbol, Lithic::Models::AccountHolder::StatusReason>] (Deprecated. Use verification_application.status_reasons)
|
202
201
|
#
|
203
202
|
# @param user_type [Symbol, Lithic::Models::AccountHolder::UserType] The type of Account Holder. If the type is "INDIVIDUAL", the "individual" attrib
|
204
203
|
#
|
@@ -550,7 +549,7 @@ module Lithic
|
|
550
549
|
# @param phone_number [String] Individual's phone number, entered in E.164 format.
|
551
550
|
end
|
552
551
|
|
553
|
-
#
|
552
|
+
# (Deprecated. Use verification_application.status instead)
|
554
553
|
#
|
555
554
|
# KYC and KYB evaluation states.
|
556
555
|
#
|
@@ -630,9 +629,7 @@ module Lithic
|
|
630
629
|
#
|
631
630
|
# @return [Array<Symbol, Lithic::Models::AccountHolder::VerificationApplication::StatusReason>, nil]
|
632
631
|
optional :status_reasons,
|
633
|
-
-> {
|
634
|
-
Lithic::Internal::Type::ArrayOf[enum: Lithic::AccountHolder::VerificationApplication::StatusReason]
|
635
|
-
}
|
632
|
+
-> { Lithic::Internal::Type::ArrayOf[enum: Lithic::AccountHolder::VerificationApplication::StatusReason] }
|
636
633
|
|
637
634
|
# @!attribute updated
|
638
635
|
# Timestamp of when the application was last updated.
|
@@ -8,22 +8,19 @@ module Lithic
|
|
8
8
|
include Lithic::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
# @!attribute beneficial_owner_individuals
|
11
|
-
# You
|
11
|
+
# You can submit a list of all direct and indirect individuals with 25% or more
|
12
12
|
# ownership in the company. A maximum of 4 beneficial owners can be submitted. If
|
13
13
|
# no individual owns 25% of the company you do not need to send beneficial owner
|
14
14
|
# information. See
|
15
15
|
# [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
|
16
16
|
# (Section I) for more background on individuals that should be included.
|
17
17
|
#
|
18
|
-
# @return [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual
|
19
|
-
|
20
|
-
-> {
|
21
|
-
Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderCreateParams::BeneficialOwnerIndividual]
|
22
|
-
}
|
18
|
+
# @return [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual>, nil]
|
19
|
+
optional :beneficial_owner_individuals,
|
20
|
+
-> { Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderCreateParams::BeneficialOwnerIndividual] }
|
23
21
|
|
24
22
|
# @!attribute business_entity
|
25
|
-
# Information for business for which the account is being opened
|
26
|
-
# run.
|
23
|
+
# Information for business for which the account is being opened.
|
27
24
|
#
|
28
25
|
# @return [Lithic::Models::AccountHolderCreateParams::BusinessEntity]
|
29
26
|
required :business_entity, -> { Lithic::AccountHolderCreateParams::BusinessEntity }
|
@@ -38,15 +35,15 @@ module Lithic
|
|
38
35
|
# [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
|
39
36
|
# (Section II) for more background.
|
40
37
|
#
|
41
|
-
# @return [Lithic::Models::AccountHolderCreateParams::ControlPerson]
|
42
|
-
|
38
|
+
# @return [Lithic::Models::AccountHolderCreateParams::ControlPerson, nil]
|
39
|
+
optional :control_person, -> { Lithic::AccountHolderCreateParams::ControlPerson }
|
43
40
|
|
44
41
|
# @!attribute nature_of_business
|
45
42
|
# Short description of the company's line of business (i.e., what does the company
|
46
43
|
# do?).
|
47
44
|
#
|
48
|
-
# @return [String]
|
49
|
-
|
45
|
+
# @return [String, nil]
|
46
|
+
optional :nature_of_business, String
|
50
47
|
|
51
48
|
# @!attribute tos_timestamp
|
52
49
|
# An RFC 3339 timestamp indicating when the account holder accepted the applicable
|
@@ -69,9 +66,7 @@ module Lithic
|
|
69
66
|
#
|
70
67
|
# @return [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerEntity>, nil]
|
71
68
|
optional :beneficial_owner_entities,
|
72
|
-
-> {
|
73
|
-
Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderCreateParams::BeneficialOwnerEntity]
|
74
|
-
}
|
69
|
+
-> { Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderCreateParams::BeneficialOwnerEntity] }
|
75
70
|
|
76
71
|
# @!attribute external_id
|
77
72
|
# A user provided id that can be used to link an account holder with an external
|
@@ -81,7 +76,7 @@ module Lithic
|
|
81
76
|
optional :external_id, String
|
82
77
|
|
83
78
|
# @!attribute kyb_passed_timestamp
|
84
|
-
# An RFC 3339 timestamp indicating when precomputed
|
79
|
+
# An RFC 3339 timestamp indicating when precomputed KYB was completed on the
|
85
80
|
# business with a pass result.
|
86
81
|
#
|
87
82
|
# This field is required only if workflow type is `KYB_BYO`.
|
@@ -156,17 +151,11 @@ module Lithic
|
|
156
151
|
# @return [String, nil]
|
157
152
|
optional :business_account_token, String
|
158
153
|
|
159
|
-
# @!method initialize(
|
154
|
+
# @!method initialize(business_entity:, tos_timestamp:, workflow:, individual:, address:, email:, first_name:, kyc_exemption_type:, last_name:, phone_number:, beneficial_owner_individuals: nil, control_person: nil, nature_of_business: nil, beneficial_owner_entities: nil, external_id: nil, kyb_passed_timestamp: nil, website_url: nil, kyc_passed_timestamp: nil, business_account_token: nil, request_options: {})
|
160
155
|
# Some parameter documentations has been truncated, see
|
161
156
|
# {Lithic::Models::AccountHolderCreateParams} for more details.
|
162
157
|
#
|
163
|
-
# @param
|
164
|
-
#
|
165
|
-
# @param business_entity [Lithic::Models::AccountHolderCreateParams::BusinessEntity] Information for business for which the account is being opened and KYB is being
|
166
|
-
#
|
167
|
-
# @param control_person [Lithic::Models::AccountHolderCreateParams::ControlPerson] An individual with significant responsibility for managing the legal entity (e.g
|
168
|
-
#
|
169
|
-
# @param nature_of_business [String] Short description of the company's line of business (i.e., what does the company
|
158
|
+
# @param business_entity [Lithic::Models::AccountHolderCreateParams::BusinessEntity] Information for business for which the account is being opened.
|
170
159
|
#
|
171
160
|
# @param tos_timestamp [String] An RFC 3339 timestamp indicating when the account holder accepted the applicable
|
172
161
|
#
|
@@ -186,11 +175,17 @@ module Lithic
|
|
186
175
|
#
|
187
176
|
# @param phone_number [String] The KYC Exempt user's phone number, entered in E.164 format.
|
188
177
|
#
|
178
|
+
# @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual>] You can submit a list of all direct and indirect individuals with 25% or more ow
|
179
|
+
#
|
180
|
+
# @param control_person [Lithic::Models::AccountHolderCreateParams::ControlPerson] An individual with significant responsibility for managing the legal entity (e.g
|
181
|
+
#
|
182
|
+
# @param nature_of_business [String] Short description of the company's line of business (i.e., what does the company
|
183
|
+
#
|
189
184
|
# @param beneficial_owner_entities [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerEntity>] Deprecated.
|
190
185
|
#
|
191
186
|
# @param external_id [String] A user provided id that can be used to link an account holder with an external s
|
192
187
|
#
|
193
|
-
# @param kyb_passed_timestamp [String] An RFC 3339 timestamp indicating when precomputed
|
188
|
+
# @param kyb_passed_timestamp [String] An RFC 3339 timestamp indicating when precomputed KYB was completed on the busin
|
194
189
|
#
|
195
190
|
# @param website_url [String] Company website URL.
|
196
191
|
#
|
@@ -278,27 +273,12 @@ module Lithic
|
|
278
273
|
# @return [Lithic::Models::Address]
|
279
274
|
required :address, -> { Lithic::Address }
|
280
275
|
|
281
|
-
# @!attribute government_id
|
282
|
-
# Government-issued identification number. US Federal Employer Identification
|
283
|
-
# Numbers (EIN) are currently supported, entered as full nine-digits, with or
|
284
|
-
# without hyphens.
|
285
|
-
#
|
286
|
-
# @return [String]
|
287
|
-
required :government_id, String
|
288
|
-
|
289
276
|
# @!attribute legal_business_name
|
290
277
|
# Legal (formal) business name.
|
291
278
|
#
|
292
279
|
# @return [String]
|
293
280
|
required :legal_business_name, String
|
294
281
|
|
295
|
-
# @!attribute phone_numbers
|
296
|
-
# One or more of the business's phone number(s), entered as a list in E.164
|
297
|
-
# format.
|
298
|
-
#
|
299
|
-
# @return [Array<String>]
|
300
|
-
required :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
|
301
|
-
|
302
282
|
# @!attribute dba_business_name
|
303
283
|
# Any name that the business operates under that is not its legal business name
|
304
284
|
# (if applicable).
|
@@ -306,30 +286,44 @@ module Lithic
|
|
306
286
|
# @return [String, nil]
|
307
287
|
optional :dba_business_name, String
|
308
288
|
|
289
|
+
# @!attribute government_id
|
290
|
+
# Government-issued identification number. US Federal Employer Identification
|
291
|
+
# Numbers (EIN) are currently supported, entered as full nine-digits, with or
|
292
|
+
# without hyphens.
|
293
|
+
#
|
294
|
+
# @return [String, nil]
|
295
|
+
optional :government_id, String
|
296
|
+
|
309
297
|
# @!attribute parent_company
|
310
298
|
# Parent company name (if applicable).
|
311
299
|
#
|
312
300
|
# @return [String, nil]
|
313
301
|
optional :parent_company, String
|
314
302
|
|
315
|
-
# @!
|
303
|
+
# @!attribute phone_numbers
|
304
|
+
# One or more of the business's phone number(s), entered as a list in E.164
|
305
|
+
# format.
|
306
|
+
#
|
307
|
+
# @return [Array<String>, nil]
|
308
|
+
optional :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
|
309
|
+
|
310
|
+
# @!method initialize(address:, legal_business_name:, dba_business_name: nil, government_id: nil, parent_company: nil, phone_numbers: nil)
|
316
311
|
# Some parameter documentations has been truncated, see
|
317
312
|
# {Lithic::Models::AccountHolderCreateParams::BusinessEntity} for more details.
|
318
313
|
#
|
319
|
-
# Information for business for which the account is being opened
|
320
|
-
# run.
|
314
|
+
# Information for business for which the account is being opened.
|
321
315
|
#
|
322
316
|
# @param address [Lithic::Models::Address] Business's physical address - PO boxes, UPS drops, and FedEx drops are not accep
|
323
317
|
#
|
324
|
-
# @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
|
325
|
-
#
|
326
318
|
# @param legal_business_name [String] Legal (formal) business name.
|
327
319
|
#
|
328
|
-
# @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
|
329
|
-
#
|
330
320
|
# @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
|
331
321
|
#
|
322
|
+
# @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
|
323
|
+
#
|
332
324
|
# @param parent_company [String] Parent company name (if applicable).
|
325
|
+
#
|
326
|
+
# @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
|
333
327
|
end
|
334
328
|
|
335
329
|
class ControlPerson < Lithic::Internal::Type::BaseModel
|
@@ -25,9 +25,7 @@ module Lithic
|
|
25
25
|
#
|
26
26
|
# @return [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewParams::StatusReason>, nil]
|
27
27
|
optional :status_reasons,
|
28
|
-
-> {
|
29
|
-
Lithic::Internal::Type::ArrayOf[enum: Lithic::AccountHolderSimulateEnrollmentReviewParams::StatusReason]
|
30
|
-
}
|
28
|
+
-> { Lithic::Internal::Type::ArrayOf[enum: Lithic::AccountHolderSimulateEnrollmentReviewParams::StatusReason] }
|
31
29
|
|
32
30
|
# @!method initialize(account_holder_token: nil, status: nil, status_reasons: nil, request_options: {})
|
33
31
|
# Some parameter documentations has been truncated, see
|
@@ -73,10 +73,9 @@ module Lithic
|
|
73
73
|
optional :created, Time
|
74
74
|
|
75
75
|
# @!attribute email
|
76
|
-
#
|
77
|
-
# individual.phone_number when user_type == "INDIVIDUAL".
|
78
|
-
#
|
79
|
-
# > Primary email of Account Holder.
|
76
|
+
# (Deprecated. Use control_person.email when user_type == "BUSINESS". Use
|
77
|
+
# individual.phone_number when user_type == "INDIVIDUAL".) Primary email of
|
78
|
+
# Account Holder.
|
80
79
|
#
|
81
80
|
# @return [String, nil]
|
82
81
|
optional :email, String
|
@@ -111,10 +110,9 @@ module Lithic
|
|
111
110
|
optional :nature_of_business, String
|
112
111
|
|
113
112
|
# @!attribute phone_number
|
114
|
-
#
|
115
|
-
# individual.phone_number when user_type == "INDIVIDUAL".
|
116
|
-
#
|
117
|
-
# > Primary phone of Account Holder, entered in E.164 format.
|
113
|
+
# (Deprecated. Use control_person.phone_number when user_type == "BUSINESS". Use
|
114
|
+
# individual.phone_number when user_type == "INDIVIDUAL".) Primary phone of
|
115
|
+
# Account Holder, entered in E.164 format.
|
118
116
|
#
|
119
117
|
# @return [String, nil]
|
120
118
|
optional :phone_number, String
|
@@ -127,9 +125,8 @@ module Lithic
|
|
127
125
|
optional :required_documents, -> { Lithic::Internal::Type::ArrayOf[Lithic::RequiredDocument] }
|
128
126
|
|
129
127
|
# @!attribute status
|
130
|
-
#
|
131
|
-
#
|
132
|
-
# KYC and KYB evaluation states.
|
128
|
+
# (Deprecated. Use verification_application.status instead) KYC and KYB evaluation
|
129
|
+
# states.
|
133
130
|
#
|
134
131
|
# Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
|
135
132
|
# `ADVANCED` workflow.
|
@@ -138,7 +135,7 @@ module Lithic
|
|
138
135
|
optional :status, enum: -> { Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Status }
|
139
136
|
|
140
137
|
# @!attribute status_reasons
|
141
|
-
#
|
138
|
+
# (Deprecated. Use verification_application.status_reasons) Reason for the
|
142
139
|
# evaluation status.
|
143
140
|
#
|
144
141
|
# @return [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::StatusReason>, nil]
|
@@ -190,7 +187,7 @@ module Lithic
|
|
190
187
|
#
|
191
188
|
# @param created [Time] Timestamp of when the account holder was created.
|
192
189
|
#
|
193
|
-
# @param email [String]
|
190
|
+
# @param email [String] (Deprecated. Use control_person.email when user_type == "BUSINESS".
|
194
191
|
#
|
195
192
|
# @param exemption_type [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::ExemptionType] The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account
|
196
193
|
#
|
@@ -200,13 +197,13 @@ module Lithic
|
|
200
197
|
#
|
201
198
|
# @param nature_of_business [String] Only present when user_type == "BUSINESS". User-submitted description of the bus
|
202
199
|
#
|
203
|
-
# @param phone_number [String]
|
200
|
+
# @param phone_number [String] (Deprecated. Use control_person.phone_number when user_type == "BUSINESS".
|
204
201
|
#
|
205
202
|
# @param required_documents [Array<Lithic::Models::RequiredDocument>] Only present for "KYB_BASIC" and "KYC_ADVANCED" workflows. A list of documents r
|
206
203
|
#
|
207
|
-
# @param status [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Status]
|
204
|
+
# @param status [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::Status] (Deprecated. Use verification_application.status instead)
|
208
205
|
#
|
209
|
-
# @param status_reasons [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::StatusReason>]
|
206
|
+
# @param status_reasons [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::StatusReason>] (Deprecated. Use verification_application.status_reasons)
|
210
207
|
#
|
211
208
|
# @param user_type [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::UserType] The type of Account Holder. If the type is "INDIVIDUAL", the "individual" attrib
|
212
209
|
#
|
@@ -605,9 +602,8 @@ module Lithic
|
|
605
602
|
end
|
606
603
|
end
|
607
604
|
|
608
|
-
#
|
609
|
-
#
|
610
|
-
# KYC and KYB evaluation states.
|
605
|
+
# (Deprecated. Use verification_application.status instead) KYC and KYB evaluation
|
606
|
+
# states.
|
611
607
|
#
|
612
608
|
# Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
|
613
609
|
# `ADVANCED` workflow.
|
@@ -709,7 +705,14 @@ module Lithic
|
|
709
705
|
# @return [Time]
|
710
706
|
required :updated, Time
|
711
707
|
|
712
|
-
# @!
|
708
|
+
# @!attribute ky_passed_at
|
709
|
+
# Timestamp of when the application passed the verification process. Only present
|
710
|
+
# if `status` is `ACCEPTED`
|
711
|
+
#
|
712
|
+
# @return [Time, nil]
|
713
|
+
optional :ky_passed_at, Time
|
714
|
+
|
715
|
+
# @!method initialize(created:, status:, status_reasons:, updated:, ky_passed_at: nil)
|
713
716
|
# Some parameter documentations has been truncated, see
|
714
717
|
# {Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication}
|
715
718
|
# for more details.
|
@@ -723,6 +726,8 @@ module Lithic
|
|
723
726
|
# @param status_reasons [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse::VerificationApplication::StatusReason>] Reason for the evaluation status.
|
724
727
|
#
|
725
728
|
# @param updated [Time] Timestamp of when the application was last updated.
|
729
|
+
#
|
730
|
+
# @param ky_passed_at [Time] Timestamp of when the application passed the verification process. Only present
|
726
731
|
|
727
732
|
# KYC and KYB evaluation states.
|
728
733
|
#
|
@@ -14,9 +14,7 @@ module Lithic
|
|
14
14
|
#
|
15
15
|
# @return [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity>, nil]
|
16
16
|
optional :beneficial_owner_entities,
|
17
|
-
-> {
|
18
|
-
Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderUpdateParams::BeneficialOwnerEntity]
|
19
|
-
}
|
17
|
+
-> { Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderUpdateParams::BeneficialOwnerEntity] }
|
20
18
|
|
21
19
|
# @!attribute beneficial_owner_individuals
|
22
20
|
# You must submit a list of all direct and indirect individuals with 25% or more
|
@@ -28,9 +26,7 @@ module Lithic
|
|
28
26
|
#
|
29
27
|
# @return [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerIndividual>, nil]
|
30
28
|
optional :beneficial_owner_individuals,
|
31
|
-
-> {
|
32
|
-
Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderUpdateParams::BeneficialOwnerIndividual]
|
33
|
-
}
|
29
|
+
-> { Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderUpdateParams::BeneficialOwnerIndividual] }
|
34
30
|
|
35
31
|
# @!attribute business_entity
|
36
32
|
# Information for business for which the account is being opened and KYB is being
|
@@ -80,10 +80,9 @@ module Lithic
|
|
80
80
|
optional :created, Time
|
81
81
|
|
82
82
|
# @!attribute email
|
83
|
-
#
|
84
|
-
# individual.phone_number when user_type == "INDIVIDUAL".
|
85
|
-
#
|
86
|
-
# > Primary email of Account Holder.
|
83
|
+
# (Deprecated. Use control_person.email when user_type == "BUSINESS". Use
|
84
|
+
# individual.phone_number when user_type == "INDIVIDUAL".) Primary email of
|
85
|
+
# Account Holder.
|
87
86
|
#
|
88
87
|
# @return [String, nil]
|
89
88
|
optional :email, String
|
@@ -118,10 +117,9 @@ module Lithic
|
|
118
117
|
optional :nature_of_business, String
|
119
118
|
|
120
119
|
# @!attribute phone_number
|
121
|
-
#
|
122
|
-
# individual.phone_number when user_type == "INDIVIDUAL".
|
123
|
-
#
|
124
|
-
# > Primary phone of Account Holder, entered in E.164 format.
|
120
|
+
# (Deprecated. Use control_person.phone_number when user_type == "BUSINESS". Use
|
121
|
+
# individual.phone_number when user_type == "INDIVIDUAL".) Primary phone of
|
122
|
+
# Account Holder, entered in E.164 format.
|
125
123
|
#
|
126
124
|
# @return [String, nil]
|
127
125
|
optional :phone_number, String
|
@@ -134,9 +132,8 @@ module Lithic
|
|
134
132
|
optional :required_documents, -> { Lithic::Internal::Type::ArrayOf[Lithic::RequiredDocument] }
|
135
133
|
|
136
134
|
# @!attribute status
|
137
|
-
#
|
138
|
-
#
|
139
|
-
# KYC and KYB evaluation states.
|
135
|
+
# (Deprecated. Use verification_application.status instead) KYC and KYB evaluation
|
136
|
+
# states.
|
140
137
|
#
|
141
138
|
# Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
|
142
139
|
# `ADVANCED` workflow.
|
@@ -145,7 +142,7 @@ module Lithic
|
|
145
142
|
optional :status, enum: -> { Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::Status }
|
146
143
|
|
147
144
|
# @!attribute status_reasons
|
148
|
-
#
|
145
|
+
# (Deprecated. Use verification_application.status_reasons) Reason for the
|
149
146
|
# evaluation status.
|
150
147
|
#
|
151
148
|
# @return [Array<Symbol, Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::StatusReason>, nil]
|
@@ -198,7 +195,7 @@ module Lithic
|
|
198
195
|
#
|
199
196
|
# @param created [Time] Timestamp of when the account holder was created.
|
200
197
|
#
|
201
|
-
# @param email [String]
|
198
|
+
# @param email [String] (Deprecated. Use control_person.email when user_type == "BUSINESS".
|
202
199
|
#
|
203
200
|
# @param exemption_type [Symbol, Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::ExemptionType] The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account
|
204
201
|
#
|
@@ -208,13 +205,13 @@ module Lithic
|
|
208
205
|
#
|
209
206
|
# @param nature_of_business [String] Only present when user_type == "BUSINESS". User-submitted description of the bus
|
210
207
|
#
|
211
|
-
# @param phone_number [String]
|
208
|
+
# @param phone_number [String] (Deprecated. Use control_person.phone_number when user_type == "BUSINESS".
|
212
209
|
#
|
213
210
|
# @param required_documents [Array<Lithic::Models::RequiredDocument>] Only present for "KYB_BASIC" and "KYC_ADVANCED" workflows. A list of documents r
|
214
211
|
#
|
215
|
-
# @param status [Symbol, Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::Status]
|
212
|
+
# @param status [Symbol, Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::Status] (Deprecated. Use verification_application.status instead)
|
216
213
|
#
|
217
|
-
# @param status_reasons [Array<Symbol, Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::StatusReason>]
|
214
|
+
# @param status_reasons [Array<Symbol, Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::StatusReason>] (Deprecated. Use verification_application.status_reasons)
|
218
215
|
#
|
219
216
|
# @param user_type [Symbol, Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::UserType] The type of Account Holder. If the type is "INDIVIDUAL", the "individual" attrib
|
220
217
|
#
|
@@ -613,9 +610,8 @@ module Lithic
|
|
613
610
|
end
|
614
611
|
end
|
615
612
|
|
616
|
-
#
|
617
|
-
#
|
618
|
-
# KYC and KYB evaluation states.
|
613
|
+
# (Deprecated. Use verification_application.status instead) KYC and KYB evaluation
|
614
|
+
# states.
|
619
615
|
#
|
620
616
|
# Note: `PENDING_RESUBMIT` and `PENDING_DOCUMENT` are only applicable for the
|
621
617
|
# `ADVANCED` workflow.
|
@@ -721,7 +717,14 @@ module Lithic
|
|
721
717
|
# @return [Time]
|
722
718
|
required :updated, Time
|
723
719
|
|
724
|
-
# @!
|
720
|
+
# @!attribute ky_passed_at
|
721
|
+
# Timestamp of when the application passed the verification process. Only present
|
722
|
+
# if `status` is `ACCEPTED`
|
723
|
+
#
|
724
|
+
# @return [Time, nil]
|
725
|
+
optional :ky_passed_at, Time
|
726
|
+
|
727
|
+
# @!method initialize(created:, status:, status_reasons:, updated:, ky_passed_at: nil)
|
725
728
|
# Some parameter documentations has been truncated, see
|
726
729
|
# {Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::VerificationApplication}
|
727
730
|
# for more details.
|
@@ -735,6 +738,8 @@ module Lithic
|
|
735
738
|
# @param status_reasons [Array<Symbol, Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse::VerificationApplication::StatusReason>] Reason for the evaluation status.
|
736
739
|
#
|
737
740
|
# @param updated [Time] Timestamp of when the application was last updated.
|
741
|
+
#
|
742
|
+
# @param ky_passed_at [Time] Timestamp of when the application passed the verification process. Only present
|
738
743
|
|
739
744
|
# KYC and KYB evaluation states.
|
740
745
|
#
|
@@ -7,6 +7,12 @@ module Lithic
|
|
7
7
|
extend Lithic::Internal::Type::RequestParameters::Converter
|
8
8
|
include Lithic::Internal::Type::RequestParameters
|
9
9
|
|
10
|
+
# @!attribute comment
|
11
|
+
# Additional context or information related to the account.
|
12
|
+
#
|
13
|
+
# @return [String, nil]
|
14
|
+
optional :comment, String
|
15
|
+
|
10
16
|
# @!attribute daily_spend_limit
|
11
17
|
# Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a
|
12
18
|
# $1,000 limit). By default the daily spend limit is set to $1,250.
|
@@ -39,6 +45,38 @@ module Lithic
|
|
39
45
|
# @return [Symbol, Lithic::Models::AccountUpdateParams::State, nil]
|
40
46
|
optional :state, enum: -> { Lithic::AccountUpdateParams::State }
|
41
47
|
|
48
|
+
# @!attribute substatus
|
49
|
+
# Account state substatus values:
|
50
|
+
#
|
51
|
+
# - `FRAUD_IDENTIFIED` - The account has been recognized as being created or used
|
52
|
+
# with stolen or fabricated identity information, encompassing both true
|
53
|
+
# identity theft and synthetic identities.
|
54
|
+
# - `SUSPICIOUS_ACTIVITY` - The account has exhibited suspicious behavior, such as
|
55
|
+
# unauthorized access or fraudulent transactions, necessitating further
|
56
|
+
# investigation.
|
57
|
+
# - `RISK_VIOLATION` - The account has been involved in deliberate misuse by the
|
58
|
+
# legitimate account holder. Examples include disputing valid transactions
|
59
|
+
# without cause, falsely claiming non-receipt of goods, or engaging in
|
60
|
+
# intentional bust-out schemes to exploit account services.
|
61
|
+
# - `END_USER_REQUEST` - The account holder has voluntarily requested the closure
|
62
|
+
# of the account for personal reasons. This encompasses situations such as
|
63
|
+
# bankruptcy, other financial considerations, or the account holder's death.
|
64
|
+
# - `ISSUER_REQUEST` - The issuer has initiated the closure of the account due to
|
65
|
+
# business strategy, risk management, inactivity, product changes, regulatory
|
66
|
+
# concerns, or violations of terms and conditions.
|
67
|
+
# - `NOT_ACTIVE` - The account has not had any transactions or payment activity
|
68
|
+
# within a specified period. This status applies to accounts that are paused or
|
69
|
+
# closed due to inactivity.
|
70
|
+
# - `INTERNAL_REVIEW` - The account is temporarily paused pending further internal
|
71
|
+
# review. In future implementations, this status may prevent clients from
|
72
|
+
# activating the account via APIs until the review is completed.
|
73
|
+
# - `OTHER` - The reason for the account's current status does not fall into any
|
74
|
+
# of the above categories. A comment should be provided to specify the
|
75
|
+
# particular reason.
|
76
|
+
#
|
77
|
+
# @return [Symbol, Lithic::Models::AccountUpdateParams::Substatus, nil]
|
78
|
+
optional :substatus, enum: -> { Lithic::AccountUpdateParams::Substatus }
|
79
|
+
|
42
80
|
# @!attribute verification_address
|
43
81
|
# @deprecated
|
44
82
|
#
|
@@ -50,10 +88,12 @@ module Lithic
|
|
50
88
|
# @return [Lithic::Models::AccountUpdateParams::VerificationAddress, nil]
|
51
89
|
optional :verification_address, -> { Lithic::AccountUpdateParams::VerificationAddress }
|
52
90
|
|
53
|
-
# @!method initialize(daily_spend_limit: nil, lifetime_spend_limit: nil, monthly_spend_limit: nil, state: nil, verification_address: nil, request_options: {})
|
91
|
+
# @!method initialize(comment: nil, daily_spend_limit: nil, lifetime_spend_limit: nil, monthly_spend_limit: nil, state: nil, substatus: nil, verification_address: nil, request_options: {})
|
54
92
|
# Some parameter documentations has been truncated, see
|
55
93
|
# {Lithic::Models::AccountUpdateParams} for more details.
|
56
94
|
#
|
95
|
+
# @param comment [String] Additional context or information related to the account.
|
96
|
+
#
|
57
97
|
# @param daily_spend_limit [Integer] Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a $1
|
58
98
|
#
|
59
99
|
# @param lifetime_spend_limit [Integer] Amount (in cents) for the account's lifetime spend limit (e.g. 100000 would be a
|
@@ -62,6 +102,8 @@ module Lithic
|
|
62
102
|
#
|
63
103
|
# @param state [Symbol, Lithic::Models::AccountUpdateParams::State] Account states.
|
64
104
|
#
|
105
|
+
# @param substatus [Symbol, Lithic::Models::AccountUpdateParams::Substatus] Account state substatus values:
|
106
|
+
#
|
65
107
|
# @param verification_address [Lithic::Models::AccountUpdateParams::VerificationAddress] Address used during Address Verification Service (AVS) checks during transaction
|
66
108
|
#
|
67
109
|
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
|
@@ -78,6 +120,49 @@ module Lithic
|
|
78
120
|
# @return [Array<Symbol>]
|
79
121
|
end
|
80
122
|
|
123
|
+
# Account state substatus values:
|
124
|
+
#
|
125
|
+
# - `FRAUD_IDENTIFIED` - The account has been recognized as being created or used
|
126
|
+
# with stolen or fabricated identity information, encompassing both true
|
127
|
+
# identity theft and synthetic identities.
|
128
|
+
# - `SUSPICIOUS_ACTIVITY` - The account has exhibited suspicious behavior, such as
|
129
|
+
# unauthorized access or fraudulent transactions, necessitating further
|
130
|
+
# investigation.
|
131
|
+
# - `RISK_VIOLATION` - The account has been involved in deliberate misuse by the
|
132
|
+
# legitimate account holder. Examples include disputing valid transactions
|
133
|
+
# without cause, falsely claiming non-receipt of goods, or engaging in
|
134
|
+
# intentional bust-out schemes to exploit account services.
|
135
|
+
# - `END_USER_REQUEST` - The account holder has voluntarily requested the closure
|
136
|
+
# of the account for personal reasons. This encompasses situations such as
|
137
|
+
# bankruptcy, other financial considerations, or the account holder's death.
|
138
|
+
# - `ISSUER_REQUEST` - The issuer has initiated the closure of the account due to
|
139
|
+
# business strategy, risk management, inactivity, product changes, regulatory
|
140
|
+
# concerns, or violations of terms and conditions.
|
141
|
+
# - `NOT_ACTIVE` - The account has not had any transactions or payment activity
|
142
|
+
# within a specified period. This status applies to accounts that are paused or
|
143
|
+
# closed due to inactivity.
|
144
|
+
# - `INTERNAL_REVIEW` - The account is temporarily paused pending further internal
|
145
|
+
# review. In future implementations, this status may prevent clients from
|
146
|
+
# activating the account via APIs until the review is completed.
|
147
|
+
# - `OTHER` - The reason for the account's current status does not fall into any
|
148
|
+
# of the above categories. A comment should be provided to specify the
|
149
|
+
# particular reason.
|
150
|
+
module Substatus
|
151
|
+
extend Lithic::Internal::Type::Enum
|
152
|
+
|
153
|
+
FRAUD_IDENTIFIED = :FRAUD_IDENTIFIED
|
154
|
+
SUSPICIOUS_ACTIVITY = :SUSPICIOUS_ACTIVITY
|
155
|
+
RISK_VIOLATION = :RISK_VIOLATION
|
156
|
+
END_USER_REQUEST = :END_USER_REQUEST
|
157
|
+
ISSUER_REQUEST = :ISSUER_REQUEST
|
158
|
+
NOT_ACTIVE = :NOT_ACTIVE
|
159
|
+
INTERNAL_REVIEW = :INTERNAL_REVIEW
|
160
|
+
OTHER = :OTHER
|
161
|
+
|
162
|
+
# @!method self.values
|
163
|
+
# @return [Array<Symbol>]
|
164
|
+
end
|
165
|
+
|
81
166
|
# @deprecated
|
82
167
|
class VerificationAddress < Lithic::Internal::Type::BaseModel
|
83
168
|
# @!attribute address1
|