lithic 0.1.0.pre.alpha.55 → 0.1.0
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 +53 -0
- data/README.md +1 -1
- data/lib/lithic/client.rb +12 -0
- data/lib/lithic/models/account_activity_list_params.rb +2 -0
- data/lib/lithic/models/account_activity_list_response.rb +62 -148
- data/lib/lithic/models/account_activity_retrieve_transaction_response.rb +62 -151
- data/lib/lithic/models/auth_rules/auth_rule.rb +208 -49
- data/lib/lithic/models/auth_rules/auth_rule_condition.rb +9 -52
- data/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +9 -52
- data/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb +260 -0
- data/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +9 -54
- data/lib/lithic/models/auth_rules/conditional_operation.rb +31 -0
- data/lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb +271 -0
- data/lib/lithic/models/auth_rules/conditional_value.rb +30 -0
- data/lib/lithic/models/auth_rules/event_stream.rb +21 -0
- data/lib/lithic/models/auth_rules/v2_create_params.rb +14 -19
- data/lib/lithic/models/auth_rules/v2_draft_params.rb +7 -3
- data/lib/lithic/models/auth_rules/v2_list_params.rb +16 -16
- data/lib/lithic/models/book_transfer_response.rb +1 -0
- data/lib/lithic/models/card_bulk_order.rb +106 -0
- data/lib/lithic/models/card_bulk_order_create_params.rb +52 -0
- data/lib/lithic/models/card_bulk_order_list_params.rb +61 -0
- data/lib/lithic/models/card_bulk_order_retrieve_params.rb +14 -0
- data/lib/lithic/models/card_bulk_order_update_params.rb +32 -0
- data/lib/lithic/models/card_convert_physical_params.rb +3 -0
- data/lib/lithic/models/card_create_params.rb +14 -1
- data/lib/lithic/models/card_program.rb +10 -10
- data/lib/lithic/models/card_reissue_params.rb +3 -0
- data/lib/lithic/models/card_renew_params.rb +3 -0
- data/lib/lithic/models/card_web_provision_params.rb +32 -1
- data/lib/lithic/models/card_web_provision_response.rb +98 -60
- data/lib/lithic/models/cardholder_authentication.rb +132 -0
- data/lib/lithic/models/category_details.rb +27 -0
- data/lib/lithic/models/device.rb +37 -0
- data/lib/lithic/models/digital_wallet_token_metadata.rb +141 -0
- data/lib/lithic/models/dispute.rb +242 -510
- data/lib/lithic/models/dispute_v2.rb +555 -0
- data/lib/lithic/models/disputes_v2_list_params.rb +84 -0
- data/lib/lithic/models/disputes_v2_retrieve_params.rb +14 -0
- data/lib/lithic/models/{external_bank_account_retry_prenote_response.rb → external_bank_account.rb} +32 -33
- data/lib/lithic/models/external_bank_account_address.rb +2 -2
- data/lib/lithic/models/external_bank_account_create_response.rb +18 -18
- data/lib/lithic/models/external_bank_account_list_response.rb +18 -18
- data/lib/lithic/models/external_bank_account_retrieve_response.rb +18 -18
- data/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb +18 -18
- data/lib/lithic/models/external_bank_account_unpause_params.rb +14 -0
- data/lib/lithic/models/external_bank_account_update_response.rb +18 -18
- data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb +18 -18
- data/lib/lithic/models/external_payment.rb +15 -2
- data/lib/lithic/models/external_payment_create_params.rb +2 -0
- data/lib/lithic/models/external_payment_list_params.rb +3 -0
- data/lib/lithic/models/financial_account.rb +4 -3
- data/lib/lithic/models/financial_account_balance.rb +112 -0
- data/lib/lithic/models/financial_accounts/category_balances.rb +29 -0
- data/lib/lithic/models/financial_accounts/loan_tape.rb +35 -520
- data/lib/lithic/models/financial_accounts/statement.rb +73 -275
- data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +18 -0
- data/lib/lithic/models/financial_event.rb +164 -0
- data/lib/lithic/models/financial_transaction.rb +3 -146
- data/lib/lithic/models/{funding_event_retrieve_response.rb → funding_event.rb} +9 -10
- data/lib/lithic/models/internal_transaction.rb +166 -0
- data/lib/lithic/models/management_operation_create_params.rb +6 -0
- data/lib/lithic/models/management_operation_list_params.rb +1 -0
- data/lib/lithic/models/management_operation_transaction.rb +11 -4
- data/lib/lithic/models/merchant.rb +70 -0
- data/lib/lithic/models/network_total.rb +169 -0
- data/lib/lithic/models/non_pci_card.rb +10 -1
- data/lib/lithic/models/payment.rb +18 -6
- data/lib/lithic/models/payment_create_params.rb +10 -1
- data/lib/lithic/models/payment_return_params.rb +62 -0
- data/lib/lithic/models/statement_totals.rb +100 -0
- data/lib/lithic/models/three_ds_authentication.rb +1259 -0
- data/lib/lithic/models/token_info.rb +42 -0
- data/lib/lithic/models/tokenization.rb +9 -111
- data/lib/lithic/models/tokenization_decline_reason.rb +27 -0
- data/lib/lithic/models/tokenization_rule_result.rb +61 -0
- data/lib/lithic/models/tokenization_tfa_reason.rb +29 -0
- data/lib/lithic/models/transaction.rb +9 -243
- data/lib/lithic/models/transactions/events/enhanced_data.rb +49 -40
- data/lib/lithic/models/transfer.rb +3 -146
- data/lib/lithic/models/wallet_decisioning_info.rb +44 -0
- data/lib/lithic/models.rb +56 -0
- data/lib/lithic/resources/auth_rules/v2.rb +19 -17
- data/lib/lithic/resources/card_bulk_orders.rb +127 -0
- data/lib/lithic/resources/cards/balances.rb +2 -2
- data/lib/lithic/resources/cards.rb +14 -3
- data/lib/lithic/resources/disputes.rb +10 -10
- data/lib/lithic/resources/disputes_v2.rb +74 -0
- data/lib/lithic/resources/external_bank_accounts.rb +21 -2
- data/lib/lithic/resources/financial_accounts/balances.rb +2 -2
- data/lib/lithic/resources/funding_events.rb +4 -4
- data/lib/lithic/resources/internal_transaction.rb +14 -0
- data/lib/lithic/resources/payments.rb +48 -0
- data/lib/lithic/resources/reports/settlement/network_totals.rb +4 -4
- data/lib/lithic/resources/three_ds/authentication.rb +2 -2
- data/lib/lithic/resources/tokenizations.rb +4 -4
- data/lib/lithic/version.rb +1 -1
- data/lib/lithic.rb +38 -21
- data/manifest.yaml +1 -0
- data/rbi/lithic/client.rbi +9 -0
- data/rbi/lithic/models/account_activity_list_params.rbi +10 -0
- data/rbi/lithic/models/account_activity_list_response.rbi +131 -544
- data/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +131 -544
- data/rbi/lithic/models/auth_rules/auth_rule.rbi +339 -80
- data/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +13 -139
- data/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +13 -153
- data/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi +789 -0
- data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +13 -153
- data/rbi/lithic/models/auth_rules/conditional_operation.rbi +99 -0
- data/rbi/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbi +703 -0
- data/rbi/lithic/models/auth_rules/conditional_value.rbi +29 -0
- data/rbi/lithic/models/auth_rules/event_stream.rbi +44 -0
- data/rbi/lithic/models/auth_rules/v2_create_params.rbi +22 -52
- data/rbi/lithic/models/auth_rules/v2_draft_params.rbi +12 -4
- data/rbi/lithic/models/auth_rules/v2_list_params.rbi +27 -44
- data/rbi/lithic/models/book_transfer_response.rbi +2 -0
- data/rbi/lithic/models/card_bulk_order.rbi +141 -0
- data/rbi/lithic/models/card_bulk_order_create_params.rbi +92 -0
- data/rbi/lithic/models/card_bulk_order_list_params.rbi +98 -0
- data/rbi/lithic/models/card_bulk_order_retrieve_params.rbi +27 -0
- data/rbi/lithic/models/card_bulk_order_update_params.rbi +68 -0
- data/rbi/lithic/models/card_convert_physical_params.rbi +8 -0
- data/rbi/lithic/models/card_create_params.rbi +23 -0
- data/rbi/lithic/models/card_program.rbi +10 -13
- data/rbi/lithic/models/card_reissue_params.rbi +8 -0
- data/rbi/lithic/models/card_renew_params.rbi +8 -0
- data/rbi/lithic/models/card_web_provision_params.rbi +44 -0
- data/rbi/lithic/models/card_web_provision_response.rbi +182 -102
- data/rbi/lithic/models/cardholder_authentication.rbi +296 -0
- data/rbi/lithic/models/category_details.rbi +43 -0
- data/rbi/lithic/models/device.rbi +54 -0
- data/rbi/lithic/models/digital_wallet_token_metadata.rbi +290 -0
- data/rbi/lithic/models/dispute.rbi +395 -942
- data/rbi/lithic/models/dispute_v2.rbi +965 -0
- data/rbi/lithic/models/disputes_v2_list_params.rbi +129 -0
- data/rbi/lithic/models/disputes_v2_retrieve_params.rbi +27 -0
- data/rbi/lithic/models/{external_bank_account_retry_prenote_response.rbi → external_bank_account.rbi} +57 -126
- data/rbi/lithic/models/external_bank_account_address.rbi +3 -6
- data/rbi/lithic/models/external_bank_account_create_response.rbi +31 -51
- data/rbi/lithic/models/external_bank_account_list_response.rbi +31 -51
- data/rbi/lithic/models/external_bank_account_retrieve_response.rbi +31 -51
- data/rbi/lithic/models/external_bank_account_retry_micro_deposits_response.rbi +31 -51
- data/rbi/lithic/models/external_bank_account_unpause_params.rbi +30 -0
- data/rbi/lithic/models/external_bank_account_update_response.rbi +31 -51
- data/rbi/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi +31 -51
- data/rbi/lithic/models/external_payment.rbi +62 -6
- data/rbi/lithic/models/external_payment_create_params.rbi +10 -0
- data/rbi/lithic/models/external_payment_list_params.rbi +15 -0
- data/rbi/lithic/models/financial_account.rbi +12 -4
- data/rbi/lithic/models/financial_account_balance.rbi +144 -0
- data/rbi/lithic/models/financial_accounts/category_balances.rbi +42 -0
- data/rbi/lithic/models/financial_accounts/loan_tape.rbi +47 -802
- data/rbi/lithic/models/financial_accounts/statement.rbi +118 -430
- data/rbi/lithic/models/financial_accounts/statements/statement_line_items.rbi +90 -0
- data/rbi/lithic/models/financial_event.rbi +469 -0
- data/rbi/lithic/models/financial_transaction.rbi +3 -509
- data/rbi/lithic/models/{funding_event_list_response.rbi → funding_event.rbi} +13 -35
- data/rbi/lithic/models/internal_transaction.rbi +277 -0
- data/rbi/lithic/models/management_operation_create_params.rbi +30 -0
- data/rbi/lithic/models/management_operation_list_params.rbi +5 -0
- data/rbi/lithic/models/management_operation_transaction.rbi +41 -12
- data/rbi/lithic/models/merchant.rbi +89 -0
- data/rbi/lithic/models/network_total.rbi +226 -0
- data/rbi/lithic/models/non_pci_card.rbi +10 -0
- data/rbi/lithic/models/payment.rbi +28 -7
- data/rbi/lithic/models/payment_create_params.rbi +15 -1
- data/rbi/lithic/models/payment_return_params.rbi +85 -0
- data/rbi/lithic/models/statement_totals.rbi +128 -0
- data/rbi/lithic/models/three_ds_authentication.rbi +2432 -0
- data/rbi/lithic/models/token_info.rbi +70 -0
- data/rbi/lithic/models/tokenization.rbi +12 -335
- data/rbi/lithic/models/tokenization_decline_reason.rbi +73 -0
- data/rbi/lithic/models/tokenization_rule_result.rbi +96 -0
- data/rbi/lithic/models/tokenization_tfa_reason.rbi +74 -0
- data/rbi/lithic/models/transaction.rbi +12 -500
- data/rbi/lithic/models/transactions/events/enhanced_data.rbi +74 -133
- data/rbi/lithic/models/transfer.rbi +4 -436
- data/rbi/lithic/models/wallet_decisioning_info.rbi +63 -0
- data/rbi/lithic/models.rbi +57 -0
- data/rbi/lithic/resources/auth_rules/v2.rbi +23 -18
- data/rbi/lithic/resources/card_bulk_orders.rbi +101 -0
- data/rbi/lithic/resources/cards/balances.rbi +1 -3
- data/rbi/lithic/resources/cards.rbi +22 -1
- data/rbi/lithic/resources/disputes.rbi +5 -7
- data/rbi/lithic/resources/disputes_v2.rbi +64 -0
- data/rbi/lithic/resources/external_bank_accounts.rbi +11 -1
- data/rbi/lithic/resources/financial_accounts/balances.rbi +1 -3
- data/rbi/lithic/resources/funding_events.rbi +2 -4
- data/rbi/lithic/resources/internal_transaction.rbi +12 -0
- data/rbi/lithic/resources/payments.rbi +46 -0
- data/rbi/lithic/resources/reports/settlement/network_totals.rbi +2 -8
- data/rbi/lithic/resources/three_ds/authentication.rbi +1 -1
- data/rbi/lithic/resources/tokenizations.rbi +2 -2
- data/sig/lithic/client.rbs +6 -0
- data/sig/lithic/models/account_activity_list_params.rbs +4 -0
- data/sig/lithic/models/account_activity_list_response.rbs +71 -221
- data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +71 -221
- data/sig/lithic/models/auth_rules/auth_rule.rbs +135 -36
- data/sig/lithic/models/auth_rules/auth_rule_condition.rbs +10 -61
- data/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +10 -61
- data/sig/lithic/models/auth_rules/conditional_ach_action_parameters.rbs +293 -0
- data/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +10 -61
- data/sig/lithic/models/auth_rules/conditional_operation.rbs +44 -0
- data/sig/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbs +239 -0
- data/sig/lithic/models/auth_rules/conditional_value.rbs +15 -0
- data/sig/lithic/models/auth_rules/event_stream.rbs +24 -0
- data/sig/lithic/models/auth_rules/v2_create_params.rbs +8 -17
- data/sig/lithic/models/auth_rules/v2_draft_params.rbs +2 -0
- data/sig/lithic/models/auth_rules/v2_list_params.rbs +15 -17
- data/sig/lithic/models/book_transfer_response.rbs +3 -1
- data/sig/lithic/models/card_bulk_order.rbs +76 -0
- data/sig/lithic/models/card_bulk_order_create_params.rbs +46 -0
- data/sig/lithic/models/card_bulk_order_list_params.rbs +56 -0
- data/sig/lithic/models/card_bulk_order_retrieve_params.rbs +15 -0
- data/sig/lithic/models/card_bulk_order_update_params.rbs +34 -0
- data/sig/lithic/models/card_convert_physical_params.rbs +2 -0
- data/sig/lithic/models/card_create_params.rbs +9 -0
- data/sig/lithic/models/card_program.rbs +5 -7
- data/sig/lithic/models/card_reissue_params.rbs +2 -0
- data/sig/lithic/models/card_renew_params.rbs +2 -0
- data/sig/lithic/models/card_web_provision_params.rbs +26 -2
- data/sig/lithic/models/card_web_provision_response.rbs +81 -51
- data/sig/lithic/models/cardholder_authentication.rbs +98 -0
- data/sig/lithic/models/category_details.rbs +26 -0
- data/sig/lithic/models/device.rbs +21 -0
- data/sig/lithic/models/digital_wallet_token_metadata.rbs +119 -0
- data/sig/lithic/models/dispute.rbs +157 -417
- data/sig/lithic/models/dispute_v2.rbs +438 -0
- data/sig/lithic/models/disputes_v2_list_params.rbs +77 -0
- data/sig/lithic/models/disputes_v2_retrieve_params.rbs +15 -0
- data/sig/lithic/models/external_bank_account.rbs +162 -0
- data/sig/lithic/models/external_bank_account_address.rbs +4 -6
- data/sig/lithic/models/external_bank_account_create_response.rbs +36 -56
- data/sig/lithic/models/external_bank_account_list_response.rbs +36 -56
- data/sig/lithic/models/external_bank_account_retrieve_response.rbs +36 -56
- data/sig/lithic/models/external_bank_account_retry_micro_deposits_response.rbs +36 -56
- data/sig/lithic/models/external_bank_account_unpause_params.rbs +15 -0
- data/sig/lithic/models/external_bank_account_update_response.rbs +36 -56
- data/sig/lithic/models/external_bank_accounts/micro_deposit_create_response.rbs +36 -56
- data/sig/lithic/models/external_payment.rbs +35 -8
- data/sig/lithic/models/external_payment_create_params.rbs +8 -1
- data/sig/lithic/models/external_payment_list_params.rbs +11 -2
- data/sig/lithic/models/financial_account.rbs +4 -4
- data/sig/lithic/models/financial_account_balance.rbs +78 -0
- data/sig/lithic/models/financial_accounts/category_balances.rbs +24 -0
- data/sig/lithic/models/financial_accounts/loan_tape.rbs +48 -464
- data/sig/lithic/models/financial_accounts/statement.rbs +59 -244
- data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +36 -0
- data/sig/lithic/models/financial_event.rbs +248 -0
- data/sig/lithic/models/financial_transaction.rbs +4 -217
- data/sig/lithic/models/{funding_event_list_response.rbs → funding_event.rbs} +11 -11
- data/sig/lithic/models/internal_transaction.rbs +165 -0
- data/sig/lithic/models/management_operation_create_params.rbs +12 -0
- data/sig/lithic/models/management_operation_list_params.rbs +3 -1
- data/sig/lithic/models/management_operation_transaction.rbs +23 -13
- data/sig/lithic/models/merchant.rbs +50 -0
- data/sig/lithic/models/network_total.rbs +125 -0
- data/sig/lithic/models/non_pci_card.rbs +5 -0
- data/sig/lithic/models/payment.rbs +18 -5
- data/sig/lithic/models/payment_create_params.rbs +7 -0
- data/sig/lithic/models/payment_return_params.rbs +46 -0
- data/sig/lithic/models/statement_totals.rbs +76 -0
- data/sig/lithic/models/three_ds_authentication.rbs +911 -0
- data/sig/lithic/models/token_info.rbs +36 -0
- data/sig/lithic/models/tokenization.rbs +18 -137
- data/sig/lithic/models/tokenization_decline_reason.rbs +38 -0
- data/sig/lithic/models/tokenization_rule_result.rbs +48 -0
- data/sig/lithic/models/tokenization_tfa_reason.rbs +42 -0
- data/sig/lithic/models/transaction.rbs +12 -191
- data/sig/lithic/models/transactions/events/enhanced_data.rbs +78 -124
- data/sig/lithic/models/transfer.rbs +6 -219
- data/sig/lithic/models/wallet_decisioning_info.rbs +35 -0
- data/sig/lithic/models.rbs +56 -0
- data/sig/lithic/resources/auth_rules/v2.rbs +9 -8
- data/sig/lithic/resources/card_bulk_orders.rbs +34 -0
- data/sig/lithic/resources/cards/balances.rbs +1 -1
- data/sig/lithic/resources/cards.rbs +5 -1
- data/sig/lithic/resources/disputes.rbs +5 -5
- data/sig/lithic/resources/disputes_v2.rbs +24 -0
- data/sig/lithic/resources/external_bank_accounts.rbs +6 -1
- data/sig/lithic/resources/financial_accounts/balances.rbs +1 -1
- data/sig/lithic/resources/funding_events.rbs +2 -2
- data/sig/lithic/resources/internal_transaction.rbs +7 -0
- data/sig/lithic/resources/payments.rbs +10 -0
- data/sig/lithic/resources/reports/settlement/network_totals.rbs +2 -2
- data/sig/lithic/resources/three_ds/authentication.rbs +1 -1
- data/sig/lithic/resources/tokenizations.rbs +2 -2
- metadata +115 -67
- data/lib/lithic/models/auth_rules/v2_create_response.rb +0 -267
- data/lib/lithic/models/auth_rules/v2_draft_response.rb +0 -266
- data/lib/lithic/models/auth_rules/v2_list_response.rb +0 -266
- data/lib/lithic/models/auth_rules/v2_promote_response.rb +0 -267
- data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +0 -271
- data/lib/lithic/models/auth_rules/v2_update_response.rb +0 -267
- data/lib/lithic/models/cards/balance_list_response.rb +0 -115
- data/lib/lithic/models/dispute_create_response.rb +0 -326
- data/lib/lithic/models/dispute_delete_response.rb +0 -326
- data/lib/lithic/models/dispute_list_response.rb +0 -326
- data/lib/lithic/models/dispute_retrieve_response.rb +0 -326
- data/lib/lithic/models/dispute_update_response.rb +0 -326
- data/lib/lithic/models/financial_accounts/balance_list_response.rb +0 -115
- data/lib/lithic/models/funding_event_list_response.rb +0 -108
- data/lib/lithic/models/reports/settlement/network_total_list_response.rb +0 -176
- data/lib/lithic/models/reports/settlement/network_total_retrieve_response.rb +0 -176
- data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +0 -1288
- data/lib/lithic/models/tokenization_simulate_response.rb +0 -16
- data/lib/lithic/models/tokenization_update_digital_card_art_response.rb +0 -16
- data/rbi/lithic/models/auth_rules/v2_create_response.rbi +0 -496
- data/rbi/lithic/models/auth_rules/v2_draft_response.rbi +0 -496
- data/rbi/lithic/models/auth_rules/v2_list_response.rbi +0 -492
- data/rbi/lithic/models/auth_rules/v2_promote_response.rbi +0 -499
- data/rbi/lithic/models/auth_rules/v2_retrieve_response.rbi +0 -502
- data/rbi/lithic/models/auth_rules/v2_update_response.rbi +0 -496
- data/rbi/lithic/models/cards/balance_list_response.rbi +0 -170
- data/rbi/lithic/models/dispute_create_response.rbi +0 -599
- data/rbi/lithic/models/dispute_delete_response.rbi +0 -599
- data/rbi/lithic/models/dispute_list_response.rbi +0 -582
- data/rbi/lithic/models/dispute_retrieve_response.rbi +0 -601
- data/rbi/lithic/models/dispute_update_response.rbi +0 -599
- data/rbi/lithic/models/financial_accounts/balance_list_response.rbi +0 -174
- data/rbi/lithic/models/funding_event_retrieve_response.rbi +0 -184
- data/rbi/lithic/models/reports/settlement/network_total_list_response.rbi +0 -280
- data/rbi/lithic/models/reports/settlement/network_total_retrieve_response.rbi +0 -280
- data/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi +0 -2580
- data/rbi/lithic/models/tokenization_simulate_response.rbi +0 -33
- data/rbi/lithic/models/tokenization_update_digital_card_art_response.rbi +0 -31
- data/sig/lithic/models/auth_rules/v2_create_response.rbs +0 -193
- data/sig/lithic/models/auth_rules/v2_draft_response.rbs +0 -193
- data/sig/lithic/models/auth_rules/v2_list_response.rbs +0 -193
- data/sig/lithic/models/auth_rules/v2_promote_response.rbs +0 -193
- data/sig/lithic/models/auth_rules/v2_retrieve_response.rbs +0 -193
- data/sig/lithic/models/auth_rules/v2_update_response.rbs +0 -193
- data/sig/lithic/models/cards/balance_list_response.rbs +0 -80
- data/sig/lithic/models/dispute_create_response.rbs +0 -210
- data/sig/lithic/models/dispute_delete_response.rbs +0 -210
- data/sig/lithic/models/dispute_list_response.rbs +0 -210
- data/sig/lithic/models/dispute_retrieve_response.rbs +0 -210
- data/sig/lithic/models/dispute_update_response.rbs +0 -210
- data/sig/lithic/models/external_bank_account_retry_prenote_response.rbs +0 -182
- data/sig/lithic/models/financial_accounts/balance_list_response.rbs +0 -80
- data/sig/lithic/models/funding_event_retrieve_response.rbs +0 -85
- data/sig/lithic/models/reports/settlement/network_total_list_response.rbs +0 -129
- data/sig/lithic/models/reports/settlement/network_total_retrieve_response.rbs +0 -129
- data/sig/lithic/models/three_ds/authentication_retrieve_response.rbs +0 -913
- data/sig/lithic/models/tokenization_simulate_response.rbs +0 -18
- data/sig/lithic/models/tokenization_update_digital_card_art_response.rbs +0 -16
|
@@ -1,1288 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Lithic
|
|
4
|
-
module Models
|
|
5
|
-
module ThreeDS
|
|
6
|
-
# @see Lithic::Resources::ThreeDS::Authentication#retrieve
|
|
7
|
-
class AuthenticationRetrieveResponse < Lithic::Internal::Type::BaseModel
|
|
8
|
-
# @!attribute token
|
|
9
|
-
# Globally unique identifier for the 3DS authentication. Permitted values:
|
|
10
|
-
# 36-digit version 4 UUID (including hyphens).
|
|
11
|
-
#
|
|
12
|
-
# @return [String]
|
|
13
|
-
required :token, String
|
|
14
|
-
|
|
15
|
-
# @!attribute account_type
|
|
16
|
-
# Type of account/card that is being used for the transaction. Maps to EMV 3DS
|
|
17
|
-
# field `acctType`.
|
|
18
|
-
#
|
|
19
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AccountType, nil]
|
|
20
|
-
required :account_type,
|
|
21
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AccountType },
|
|
22
|
-
nil?: true
|
|
23
|
-
|
|
24
|
-
# @!attribute authentication_result
|
|
25
|
-
# Indicates the outcome of the 3DS authentication process.
|
|
26
|
-
#
|
|
27
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AuthenticationResult]
|
|
28
|
-
required :authentication_result,
|
|
29
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AuthenticationResult }
|
|
30
|
-
|
|
31
|
-
# @!attribute card_expiry_check
|
|
32
|
-
# Indicates whether the expiration date provided by the cardholder during checkout
|
|
33
|
-
# matches Lithic's record of the card's expiration date.
|
|
34
|
-
#
|
|
35
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::CardExpiryCheck]
|
|
36
|
-
required :card_expiry_check,
|
|
37
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::CardExpiryCheck }
|
|
38
|
-
|
|
39
|
-
# @!attribute card_token
|
|
40
|
-
# Globally unique identifier for the card on which the 3DS authentication has
|
|
41
|
-
# occurred. Permitted values: 36-digit version 4 UUID (including hyphens).
|
|
42
|
-
#
|
|
43
|
-
# @return [String]
|
|
44
|
-
required :card_token, String
|
|
45
|
-
|
|
46
|
-
# @!attribute cardholder
|
|
47
|
-
# Object containing data about the cardholder provided during the transaction.
|
|
48
|
-
#
|
|
49
|
-
# @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder]
|
|
50
|
-
required :cardholder, -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder }
|
|
51
|
-
|
|
52
|
-
# @!attribute channel
|
|
53
|
-
# Channel in which the authentication occurs. Maps to EMV 3DS field
|
|
54
|
-
# `deviceChannel`.
|
|
55
|
-
#
|
|
56
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Channel]
|
|
57
|
-
required :channel, enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Channel }
|
|
58
|
-
|
|
59
|
-
# @!attribute created
|
|
60
|
-
# Date and time when the authentication was created in Lithic's system. Permitted
|
|
61
|
-
# values: Date string in the ISO 8601 format yyyy-MM-dd'T'hh:mm:ssZ.
|
|
62
|
-
#
|
|
63
|
-
# @return [Time]
|
|
64
|
-
required :created, Time
|
|
65
|
-
|
|
66
|
-
# @!attribute merchant
|
|
67
|
-
# Object containing data about the merchant involved in the e-commerce
|
|
68
|
-
# transaction.
|
|
69
|
-
#
|
|
70
|
-
# @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant]
|
|
71
|
-
required :merchant, -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant }
|
|
72
|
-
|
|
73
|
-
# @!attribute message_category
|
|
74
|
-
# Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For
|
|
75
|
-
# NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not
|
|
76
|
-
# populated.
|
|
77
|
-
#
|
|
78
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::MessageCategory]
|
|
79
|
-
required :message_category,
|
|
80
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::MessageCategory }
|
|
81
|
-
|
|
82
|
-
# @!attribute three_ds_requestor_challenge_indicator
|
|
83
|
-
# Indicates whether a challenge is requested for this transaction
|
|
84
|
-
#
|
|
85
|
-
# - `NO_PREFERENCE` - No Preference
|
|
86
|
-
# - `NO_CHALLENGE_REQUESTED` - No Challenge Requested
|
|
87
|
-
# - `CHALLENGE_PREFERENCE` - Challenge requested (3DS Requestor preference)
|
|
88
|
-
# - `CHALLENGE_MANDATE` - Challenge requested (Mandate)
|
|
89
|
-
# - `NO_CHALLENGE_RISK_ALREADY_ASSESSED` - No Challenge requested (Transactional
|
|
90
|
-
# risk analysis is already performed)
|
|
91
|
-
# - `DATA_SHARE_ONLY` - No Challenge requested (Data Share Only)
|
|
92
|
-
# - `OTHER` - Other indicators not captured by above. These are rarely used
|
|
93
|
-
#
|
|
94
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ThreeDSRequestorChallengeIndicator]
|
|
95
|
-
required :three_ds_requestor_challenge_indicator,
|
|
96
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ThreeDSRequestorChallengeIndicator }
|
|
97
|
-
|
|
98
|
-
# @!attribute additional_data
|
|
99
|
-
# Object containing additional data about the 3DS request that is beyond the EMV
|
|
100
|
-
# 3DS standard spec (e.g., specific fields that only certain card networks send
|
|
101
|
-
# but are not required across all 3DS requests).
|
|
102
|
-
#
|
|
103
|
-
# @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData, nil]
|
|
104
|
-
optional :additional_data,
|
|
105
|
-
-> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData },
|
|
106
|
-
nil?: true
|
|
107
|
-
|
|
108
|
-
# @!attribute app
|
|
109
|
-
# Object containing data about the app used in the e-commerce transaction. Present
|
|
110
|
-
# if the channel is 'APP_BASED'.
|
|
111
|
-
#
|
|
112
|
-
# @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::App, nil]
|
|
113
|
-
optional :app, -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::App }, nil?: true
|
|
114
|
-
|
|
115
|
-
# @!attribute authentication_request_type
|
|
116
|
-
# Type of authentication request - i.e., the type of transaction or interaction is
|
|
117
|
-
# causing the merchant to request an authentication. Maps to EMV 3DS field
|
|
118
|
-
# `threeDSRequestorAuthenticationInd`.
|
|
119
|
-
#
|
|
120
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AuthenticationRequestType, nil]
|
|
121
|
-
optional :authentication_request_type,
|
|
122
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AuthenticationRequestType },
|
|
123
|
-
nil?: true
|
|
124
|
-
|
|
125
|
-
# @!attribute browser
|
|
126
|
-
# Object containing data about the browser used in the e-commerce transaction.
|
|
127
|
-
# Present if the channel is 'BROWSER'.
|
|
128
|
-
#
|
|
129
|
-
# @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Browser, nil]
|
|
130
|
-
optional :browser, -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Browser }, nil?: true
|
|
131
|
-
|
|
132
|
-
# @!attribute challenge_metadata
|
|
133
|
-
# Metadata about the challenge method and delivery. Only present when a challenge
|
|
134
|
-
# is triggered.
|
|
135
|
-
#
|
|
136
|
-
# @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata, nil]
|
|
137
|
-
optional :challenge_metadata,
|
|
138
|
-
-> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata },
|
|
139
|
-
nil?: true
|
|
140
|
-
|
|
141
|
-
# @!attribute challenge_orchestrated_by
|
|
142
|
-
# Entity that orchestrates the challenge. This won't be set for authentications
|
|
143
|
-
# for which a decision has not yet been made (e.g. in-flight customer decisioning
|
|
144
|
-
# request).
|
|
145
|
-
#
|
|
146
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeOrchestratedBy, nil]
|
|
147
|
-
optional :challenge_orchestrated_by,
|
|
148
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeOrchestratedBy },
|
|
149
|
-
nil?: true
|
|
150
|
-
|
|
151
|
-
# @!attribute decision_made_by
|
|
152
|
-
# Entity that made the authentication decision. This won't be set for
|
|
153
|
-
# authentications for which a decision has not yet been made (e.g. in-flight
|
|
154
|
-
# customer decisioning request).
|
|
155
|
-
#
|
|
156
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::DecisionMadeBy, nil]
|
|
157
|
-
optional :decision_made_by,
|
|
158
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::DecisionMadeBy },
|
|
159
|
-
nil?: true
|
|
160
|
-
|
|
161
|
-
# @!attribute three_ri_request_type
|
|
162
|
-
# Type of 3DS Requestor Initiated (3RI) request — i.e., a 3DS authentication that
|
|
163
|
-
# takes place at the initiation of the merchant rather than the cardholder. The
|
|
164
|
-
# most common example of this is where a merchant is authenticating before billing
|
|
165
|
-
# for a recurring transaction such as a pay TV subscription or a utility bill.
|
|
166
|
-
# Maps to EMV 3DS field `threeRIInd`.
|
|
167
|
-
#
|
|
168
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ThreeRiRequestType, nil]
|
|
169
|
-
optional :three_ri_request_type,
|
|
170
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ThreeRiRequestType },
|
|
171
|
-
nil?: true
|
|
172
|
-
|
|
173
|
-
# @!attribute transaction
|
|
174
|
-
# Object containing data about the e-commerce transaction for which the merchant
|
|
175
|
-
# is requesting authentication.
|
|
176
|
-
#
|
|
177
|
-
# @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction, nil]
|
|
178
|
-
optional :transaction,
|
|
179
|
-
-> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction },
|
|
180
|
-
nil?: true
|
|
181
|
-
|
|
182
|
-
# @!method initialize(token:, account_type:, authentication_result:, card_expiry_check:, card_token:, cardholder:, channel:, created:, merchant:, message_category:, three_ds_requestor_challenge_indicator:, additional_data: nil, app: nil, authentication_request_type: nil, browser: nil, challenge_metadata: nil, challenge_orchestrated_by: nil, decision_made_by: nil, three_ri_request_type: nil, transaction: nil)
|
|
183
|
-
# Some parameter documentations has been truncated, see
|
|
184
|
-
# {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse} for more details.
|
|
185
|
-
#
|
|
186
|
-
# Represents a 3DS authentication
|
|
187
|
-
#
|
|
188
|
-
# @param token [String] Globally unique identifier for the 3DS authentication. Permitted values: 36-digi
|
|
189
|
-
#
|
|
190
|
-
# @param account_type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AccountType, nil] Type of account/card that is being used for the transaction. Maps to EMV 3DS fie
|
|
191
|
-
#
|
|
192
|
-
# @param authentication_result [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AuthenticationResult] Indicates the outcome of the 3DS authentication process.
|
|
193
|
-
#
|
|
194
|
-
# @param card_expiry_check [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::CardExpiryCheck] Indicates whether the expiration date provided by the cardholder during checkout
|
|
195
|
-
#
|
|
196
|
-
# @param card_token [String] Globally unique identifier for the card on which the 3DS authentication has occu
|
|
197
|
-
#
|
|
198
|
-
# @param cardholder [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder] Object containing data about the cardholder provided during the transaction.
|
|
199
|
-
#
|
|
200
|
-
# @param channel [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Channel] Channel in which the authentication occurs. Maps to EMV 3DS field `deviceChannel
|
|
201
|
-
#
|
|
202
|
-
# @param created [Time] Date and time when the authentication was created in Lithic's system. Permitted
|
|
203
|
-
#
|
|
204
|
-
# @param merchant [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant] Object containing data about the merchant involved in the e-commerce transaction
|
|
205
|
-
#
|
|
206
|
-
# @param message_category [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::MessageCategory] Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AUT
|
|
207
|
-
#
|
|
208
|
-
# @param three_ds_requestor_challenge_indicator [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ThreeDSRequestorChallengeIndicator] Indicates whether a challenge is requested for this transaction
|
|
209
|
-
#
|
|
210
|
-
# @param additional_data [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData, nil] Object containing additional data about the 3DS request that is beyond the EMV 3
|
|
211
|
-
#
|
|
212
|
-
# @param app [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::App, nil] Object containing data about the app used in the e-commerce transaction. Present
|
|
213
|
-
#
|
|
214
|
-
# @param authentication_request_type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AuthenticationRequestType, nil] Type of authentication request - i.e., the type of transaction or interaction is
|
|
215
|
-
#
|
|
216
|
-
# @param browser [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Browser, nil] Object containing data about the browser used in the e-commerce transaction. Pre
|
|
217
|
-
#
|
|
218
|
-
# @param challenge_metadata [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata, nil] Metadata about the challenge method and delivery. Only present when a challenge
|
|
219
|
-
#
|
|
220
|
-
# @param challenge_orchestrated_by [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeOrchestratedBy, nil] Entity that orchestrates the challenge. This won't be set for authentications fo
|
|
221
|
-
#
|
|
222
|
-
# @param decision_made_by [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::DecisionMadeBy, nil] Entity that made the authentication decision. This won't be set for authenticati
|
|
223
|
-
#
|
|
224
|
-
# @param three_ri_request_type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ThreeRiRequestType, nil] Type of 3DS Requestor Initiated (3RI) request — i.e., a 3DS authentication that
|
|
225
|
-
#
|
|
226
|
-
# @param transaction [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction, nil] Object containing data about the e-commerce transaction for which the merchant i
|
|
227
|
-
|
|
228
|
-
# Type of account/card that is being used for the transaction. Maps to EMV 3DS
|
|
229
|
-
# field `acctType`.
|
|
230
|
-
#
|
|
231
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#account_type
|
|
232
|
-
module AccountType
|
|
233
|
-
extend Lithic::Internal::Type::Enum
|
|
234
|
-
|
|
235
|
-
CREDIT = :CREDIT
|
|
236
|
-
DEBIT = :DEBIT
|
|
237
|
-
NOT_APPLICABLE = :NOT_APPLICABLE
|
|
238
|
-
|
|
239
|
-
# @!method self.values
|
|
240
|
-
# @return [Array<Symbol>]
|
|
241
|
-
end
|
|
242
|
-
|
|
243
|
-
# Indicates the outcome of the 3DS authentication process.
|
|
244
|
-
#
|
|
245
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#authentication_result
|
|
246
|
-
module AuthenticationResult
|
|
247
|
-
extend Lithic::Internal::Type::Enum
|
|
248
|
-
|
|
249
|
-
DECLINE = :DECLINE
|
|
250
|
-
SUCCESS = :SUCCESS
|
|
251
|
-
PENDING_CHALLENGE = :PENDING_CHALLENGE
|
|
252
|
-
PENDING_DECISION = :PENDING_DECISION
|
|
253
|
-
|
|
254
|
-
# @!method self.values
|
|
255
|
-
# @return [Array<Symbol>]
|
|
256
|
-
end
|
|
257
|
-
|
|
258
|
-
# Indicates whether the expiration date provided by the cardholder during checkout
|
|
259
|
-
# matches Lithic's record of the card's expiration date.
|
|
260
|
-
#
|
|
261
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#card_expiry_check
|
|
262
|
-
module CardExpiryCheck
|
|
263
|
-
extend Lithic::Internal::Type::Enum
|
|
264
|
-
|
|
265
|
-
MATCH = :MATCH
|
|
266
|
-
MISMATCH = :MISMATCH
|
|
267
|
-
NOT_PRESENT = :NOT_PRESENT
|
|
268
|
-
|
|
269
|
-
# @!method self.values
|
|
270
|
-
# @return [Array<Symbol>]
|
|
271
|
-
end
|
|
272
|
-
|
|
273
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#cardholder
|
|
274
|
-
class Cardholder < Lithic::Internal::Type::BaseModel
|
|
275
|
-
# @!attribute address_match
|
|
276
|
-
# Indicates whether the shipping address and billing address provided by the
|
|
277
|
-
# cardholder are the same. This value - and assessment of whether the addresses
|
|
278
|
-
# match - is provided directly in the 3DS request and is not determined by Lithic.
|
|
279
|
-
# Maps to EMV 3DS field `addrMatch`.
|
|
280
|
-
#
|
|
281
|
-
# @return [Boolean, nil]
|
|
282
|
-
optional :address_match, Lithic::Internal::Type::Boolean, nil?: true
|
|
283
|
-
|
|
284
|
-
# @!attribute address_on_file_match
|
|
285
|
-
# Lithic's evaluation result comparing the transaction's address data with the
|
|
286
|
-
# cardholder KYC data if it exists. In the event Lithic does not have any
|
|
287
|
-
# Cardholder KYC data, or the transaction does not contain any address data,
|
|
288
|
-
# NOT_PRESENT will be returned
|
|
289
|
-
#
|
|
290
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::AddressOnFileMatch, nil]
|
|
291
|
-
optional :address_on_file_match,
|
|
292
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::AddressOnFileMatch }
|
|
293
|
-
|
|
294
|
-
# @!attribute billing_address
|
|
295
|
-
# Object containing data on the billing address provided during the transaction.
|
|
296
|
-
#
|
|
297
|
-
# @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::BillingAddress, nil]
|
|
298
|
-
optional :billing_address,
|
|
299
|
-
-> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::BillingAddress }
|
|
300
|
-
|
|
301
|
-
# @!attribute email
|
|
302
|
-
# Email address that is either provided by the cardholder or is on file with the
|
|
303
|
-
# merchant in a 3RI request. Maps to EMV 3DS field `email`.
|
|
304
|
-
#
|
|
305
|
-
# @return [String, nil]
|
|
306
|
-
optional :email, String, nil?: true
|
|
307
|
-
|
|
308
|
-
# @!attribute name
|
|
309
|
-
# Name of the cardholder. Maps to EMV 3DS field `cardholderName`.
|
|
310
|
-
#
|
|
311
|
-
# @return [String, nil]
|
|
312
|
-
optional :name, String, nil?: true
|
|
313
|
-
|
|
314
|
-
# @!attribute phone_number_home
|
|
315
|
-
# Home phone number provided by the cardholder. Maps to EMV 3DS fields
|
|
316
|
-
# `homePhone.cc` and `homePhone.subscriber`.
|
|
317
|
-
#
|
|
318
|
-
# @return [String, nil]
|
|
319
|
-
optional :phone_number_home, String, nil?: true
|
|
320
|
-
|
|
321
|
-
# @!attribute phone_number_mobile
|
|
322
|
-
# Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields
|
|
323
|
-
# `mobilePhone.cc` and `mobilePhone.subscriber`.
|
|
324
|
-
#
|
|
325
|
-
# @return [String, nil]
|
|
326
|
-
optional :phone_number_mobile, String, nil?: true
|
|
327
|
-
|
|
328
|
-
# @!attribute phone_number_work
|
|
329
|
-
# Work phone number provided by the cardholder. Maps to EMV 3DS fields
|
|
330
|
-
# `workPhone.cc` and `workPhone.subscriber`.
|
|
331
|
-
#
|
|
332
|
-
# @return [String, nil]
|
|
333
|
-
optional :phone_number_work, String, nil?: true
|
|
334
|
-
|
|
335
|
-
# @!attribute shipping_address
|
|
336
|
-
# Object containing data on the shipping address provided during the transaction.
|
|
337
|
-
#
|
|
338
|
-
# @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::ShippingAddress, nil]
|
|
339
|
-
optional :shipping_address,
|
|
340
|
-
-> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::ShippingAddress }
|
|
341
|
-
|
|
342
|
-
# @!method initialize(address_match: nil, address_on_file_match: nil, billing_address: nil, email: nil, name: nil, phone_number_home: nil, phone_number_mobile: nil, phone_number_work: nil, shipping_address: nil)
|
|
343
|
-
# Some parameter documentations has been truncated, see
|
|
344
|
-
# {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder} for more
|
|
345
|
-
# details.
|
|
346
|
-
#
|
|
347
|
-
# Object containing data about the cardholder provided during the transaction.
|
|
348
|
-
#
|
|
349
|
-
# @param address_match [Boolean, nil] Indicates whether the shipping address and billing address provided by the cardh
|
|
350
|
-
#
|
|
351
|
-
# @param address_on_file_match [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::AddressOnFileMatch] Lithic's evaluation result comparing the transaction's address data with the car
|
|
352
|
-
#
|
|
353
|
-
# @param billing_address [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::BillingAddress] Object containing data on the billing address provided during the transaction.
|
|
354
|
-
#
|
|
355
|
-
# @param email [String, nil] Email address that is either provided by the cardholder or is on file with the m
|
|
356
|
-
#
|
|
357
|
-
# @param name [String, nil] Name of the cardholder. Maps to EMV 3DS field `cardholderName`.
|
|
358
|
-
#
|
|
359
|
-
# @param phone_number_home [String, nil] Home phone number provided by the cardholder. Maps to EMV 3DS fields `homePhone.
|
|
360
|
-
#
|
|
361
|
-
# @param phone_number_mobile [String, nil] Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields `mob
|
|
362
|
-
#
|
|
363
|
-
# @param phone_number_work [String, nil] Work phone number provided by the cardholder. Maps to EMV 3DS fields `workPhone.
|
|
364
|
-
#
|
|
365
|
-
# @param shipping_address [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::ShippingAddress] Object containing data on the shipping address provided during the transaction.
|
|
366
|
-
|
|
367
|
-
# Lithic's evaluation result comparing the transaction's address data with the
|
|
368
|
-
# cardholder KYC data if it exists. In the event Lithic does not have any
|
|
369
|
-
# Cardholder KYC data, or the transaction does not contain any address data,
|
|
370
|
-
# NOT_PRESENT will be returned
|
|
371
|
-
#
|
|
372
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder#address_on_file_match
|
|
373
|
-
module AddressOnFileMatch
|
|
374
|
-
extend Lithic::Internal::Type::Enum
|
|
375
|
-
|
|
376
|
-
MATCH = :MATCH
|
|
377
|
-
MATCH_ADDRESS_ONLY = :MATCH_ADDRESS_ONLY
|
|
378
|
-
MATCH_ZIP_ONLY = :MATCH_ZIP_ONLY
|
|
379
|
-
MISMATCH = :MISMATCH
|
|
380
|
-
NOT_PRESENT = :NOT_PRESENT
|
|
381
|
-
|
|
382
|
-
# @!method self.values
|
|
383
|
-
# @return [Array<Symbol>]
|
|
384
|
-
end
|
|
385
|
-
|
|
386
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder#billing_address
|
|
387
|
-
class BillingAddress < Lithic::Internal::Type::BaseModel
|
|
388
|
-
# @!attribute address1
|
|
389
|
-
# First line of the street address provided by the cardholder.
|
|
390
|
-
#
|
|
391
|
-
# @return [String, nil]
|
|
392
|
-
optional :address1, String, nil?: true
|
|
393
|
-
|
|
394
|
-
# @!attribute address2
|
|
395
|
-
# Second line of the street address provided by the cardholder.
|
|
396
|
-
#
|
|
397
|
-
# @return [String, nil]
|
|
398
|
-
optional :address2, String, nil?: true
|
|
399
|
-
|
|
400
|
-
# @!attribute address3
|
|
401
|
-
# Third line of the street address provided by the cardholder.
|
|
402
|
-
#
|
|
403
|
-
# @return [String, nil]
|
|
404
|
-
optional :address3, String, nil?: true
|
|
405
|
-
|
|
406
|
-
# @!attribute city
|
|
407
|
-
# City of the address provided by the cardholder.
|
|
408
|
-
#
|
|
409
|
-
# @return [String, nil]
|
|
410
|
-
optional :city, String, nil?: true
|
|
411
|
-
|
|
412
|
-
# @!attribute country
|
|
413
|
-
# Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format
|
|
414
|
-
# (e.g. USA)
|
|
415
|
-
#
|
|
416
|
-
# @return [String, nil]
|
|
417
|
-
optional :country, String, nil?: true
|
|
418
|
-
|
|
419
|
-
# @!attribute postal_code
|
|
420
|
-
# Postal code (e.g., ZIP code) of the address provided by the cardholder
|
|
421
|
-
#
|
|
422
|
-
# @return [String, nil]
|
|
423
|
-
optional :postal_code, String, nil?: true
|
|
424
|
-
|
|
425
|
-
# @!method initialize(address1: nil, address2: nil, address3: nil, city: nil, country: nil, postal_code: nil)
|
|
426
|
-
# Some parameter documentations has been truncated, see
|
|
427
|
-
# {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::BillingAddress}
|
|
428
|
-
# for more details.
|
|
429
|
-
#
|
|
430
|
-
# Object containing data on the billing address provided during the transaction.
|
|
431
|
-
#
|
|
432
|
-
# @param address1 [String, nil] First line of the street address provided by the cardholder.
|
|
433
|
-
#
|
|
434
|
-
# @param address2 [String, nil] Second line of the street address provided by the cardholder.
|
|
435
|
-
#
|
|
436
|
-
# @param address3 [String, nil] Third line of the street address provided by the cardholder.
|
|
437
|
-
#
|
|
438
|
-
# @param city [String, nil] City of the address provided by the cardholder.
|
|
439
|
-
#
|
|
440
|
-
# @param country [String, nil] Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format (
|
|
441
|
-
#
|
|
442
|
-
# @param postal_code [String, nil] Postal code (e.g., ZIP code) of the address provided by the cardholder
|
|
443
|
-
end
|
|
444
|
-
|
|
445
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder#shipping_address
|
|
446
|
-
class ShippingAddress < Lithic::Internal::Type::BaseModel
|
|
447
|
-
# @!attribute address1
|
|
448
|
-
# First line of the street address provided by the cardholder.
|
|
449
|
-
#
|
|
450
|
-
# @return [String, nil]
|
|
451
|
-
optional :address1, String, nil?: true
|
|
452
|
-
|
|
453
|
-
# @!attribute address2
|
|
454
|
-
# Second line of the street address provided by the cardholder.
|
|
455
|
-
#
|
|
456
|
-
# @return [String, nil]
|
|
457
|
-
optional :address2, String, nil?: true
|
|
458
|
-
|
|
459
|
-
# @!attribute address3
|
|
460
|
-
# Third line of the street address provided by the cardholder.
|
|
461
|
-
#
|
|
462
|
-
# @return [String, nil]
|
|
463
|
-
optional :address3, String, nil?: true
|
|
464
|
-
|
|
465
|
-
# @!attribute city
|
|
466
|
-
# City of the address provided by the cardholder.
|
|
467
|
-
#
|
|
468
|
-
# @return [String, nil]
|
|
469
|
-
optional :city, String, nil?: true
|
|
470
|
-
|
|
471
|
-
# @!attribute country
|
|
472
|
-
# Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format
|
|
473
|
-
# (e.g. USA)
|
|
474
|
-
#
|
|
475
|
-
# @return [String, nil]
|
|
476
|
-
optional :country, String, nil?: true
|
|
477
|
-
|
|
478
|
-
# @!attribute postal_code
|
|
479
|
-
# Postal code (e.g., ZIP code) of the address provided by the cardholder
|
|
480
|
-
#
|
|
481
|
-
# @return [String, nil]
|
|
482
|
-
optional :postal_code, String, nil?: true
|
|
483
|
-
|
|
484
|
-
# @!method initialize(address1: nil, address2: nil, address3: nil, city: nil, country: nil, postal_code: nil)
|
|
485
|
-
# Some parameter documentations has been truncated, see
|
|
486
|
-
# {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::ShippingAddress}
|
|
487
|
-
# for more details.
|
|
488
|
-
#
|
|
489
|
-
# Object containing data on the shipping address provided during the transaction.
|
|
490
|
-
#
|
|
491
|
-
# @param address1 [String, nil] First line of the street address provided by the cardholder.
|
|
492
|
-
#
|
|
493
|
-
# @param address2 [String, nil] Second line of the street address provided by the cardholder.
|
|
494
|
-
#
|
|
495
|
-
# @param address3 [String, nil] Third line of the street address provided by the cardholder.
|
|
496
|
-
#
|
|
497
|
-
# @param city [String, nil] City of the address provided by the cardholder.
|
|
498
|
-
#
|
|
499
|
-
# @param country [String, nil] Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format (
|
|
500
|
-
#
|
|
501
|
-
# @param postal_code [String, nil] Postal code (e.g., ZIP code) of the address provided by the cardholder
|
|
502
|
-
end
|
|
503
|
-
end
|
|
504
|
-
|
|
505
|
-
# Channel in which the authentication occurs. Maps to EMV 3DS field
|
|
506
|
-
# `deviceChannel`.
|
|
507
|
-
#
|
|
508
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#channel
|
|
509
|
-
module Channel
|
|
510
|
-
extend Lithic::Internal::Type::Enum
|
|
511
|
-
|
|
512
|
-
APP_BASED = :APP_BASED
|
|
513
|
-
BROWSER = :BROWSER
|
|
514
|
-
THREE_DS_REQUESTOR_INITIATED = :THREE_DS_REQUESTOR_INITIATED
|
|
515
|
-
|
|
516
|
-
# @!method self.values
|
|
517
|
-
# @return [Array<Symbol>]
|
|
518
|
-
end
|
|
519
|
-
|
|
520
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#merchant
|
|
521
|
-
class Merchant < Lithic::Internal::Type::BaseModel
|
|
522
|
-
# @!attribute risk_indicator
|
|
523
|
-
# Object containing additional data indicating additional risk factors related to
|
|
524
|
-
# the e-commerce transaction.
|
|
525
|
-
#
|
|
526
|
-
# @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator]
|
|
527
|
-
required :risk_indicator,
|
|
528
|
-
-> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator }
|
|
529
|
-
|
|
530
|
-
# @!attribute id
|
|
531
|
-
# Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
|
|
532
|
-
# `acquirerMerchantId`. May not be present for non-payment authentications.
|
|
533
|
-
#
|
|
534
|
-
# @return [String, nil]
|
|
535
|
-
optional :id, String, nil?: true
|
|
536
|
-
|
|
537
|
-
# @!attribute country
|
|
538
|
-
# Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS
|
|
539
|
-
# field `merchantCountryCode`. Permitted values: ISO 3166-1 alpha-3 country code
|
|
540
|
-
# (e.g., USA). May not be present for non-payment authentications.
|
|
541
|
-
#
|
|
542
|
-
# @return [String, nil]
|
|
543
|
-
optional :country, String, nil?: true
|
|
544
|
-
|
|
545
|
-
# @!attribute mcc
|
|
546
|
-
# Merchant category code assigned to the merchant that describes its business
|
|
547
|
-
# activity type. Maps to EMV 3DS field `mcc`. May not be present for non-payment
|
|
548
|
-
# authentications.
|
|
549
|
-
#
|
|
550
|
-
# @return [String, nil]
|
|
551
|
-
optional :mcc, String, nil?: true
|
|
552
|
-
|
|
553
|
-
# @!attribute name
|
|
554
|
-
# Name of the merchant. Maps to EMV 3DS field `merchantName`. May not be present
|
|
555
|
-
# for non-payment authentications.
|
|
556
|
-
#
|
|
557
|
-
# @return [String, nil]
|
|
558
|
-
optional :name, String, nil?: true
|
|
559
|
-
|
|
560
|
-
# @!method initialize(risk_indicator:, id: nil, country: nil, mcc: nil, name: nil)
|
|
561
|
-
# Some parameter documentations has been truncated, see
|
|
562
|
-
# {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant} for more
|
|
563
|
-
# details.
|
|
564
|
-
#
|
|
565
|
-
# Object containing data about the merchant involved in the e-commerce
|
|
566
|
-
# transaction.
|
|
567
|
-
#
|
|
568
|
-
# @param risk_indicator [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator] Object containing additional data indicating additional risk factors related to
|
|
569
|
-
#
|
|
570
|
-
# @param id [String, nil] Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field `acquirer
|
|
571
|
-
#
|
|
572
|
-
# @param country [String, nil] Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS fiel
|
|
573
|
-
#
|
|
574
|
-
# @param mcc [String, nil] Merchant category code assigned to the merchant that describes its business acti
|
|
575
|
-
#
|
|
576
|
-
# @param name [String, nil] Name of the merchant. Maps to EMV 3DS field `merchantName`. May not be present f
|
|
577
|
-
|
|
578
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant#risk_indicator
|
|
579
|
-
class RiskIndicator < Lithic::Internal::Type::BaseModel
|
|
580
|
-
# @!attribute delivery_email_address
|
|
581
|
-
# In transactions with electronic delivery, email address to which merchandise is
|
|
582
|
-
# delivered. Maps to EMV 3DS field `deliveryEmailAddress`.
|
|
583
|
-
#
|
|
584
|
-
# @return [String, nil]
|
|
585
|
-
optional :delivery_email_address, String, nil?: true
|
|
586
|
-
|
|
587
|
-
# @!attribute delivery_time_frame
|
|
588
|
-
# The delivery time frame for the merchandise. Maps to EMV 3DS field
|
|
589
|
-
# `deliveryTimeframe`.
|
|
590
|
-
#
|
|
591
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::DeliveryTimeFrame, nil]
|
|
592
|
-
optional :delivery_time_frame,
|
|
593
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::DeliveryTimeFrame },
|
|
594
|
-
nil?: true
|
|
595
|
-
|
|
596
|
-
# @!attribute gift_card_amount
|
|
597
|
-
# In prepaid or gift card purchase transactions, purchase amount total in major
|
|
598
|
-
# units (e.g., a purchase of USD $205.10 would be 205). Maps to EMV 3DS field
|
|
599
|
-
# `giftCardAmount`.
|
|
600
|
-
#
|
|
601
|
-
# @return [Integer, nil]
|
|
602
|
-
optional :gift_card_amount, Integer, nil?: true
|
|
603
|
-
|
|
604
|
-
# @!attribute gift_card_count
|
|
605
|
-
# In prepaid or gift card purchase transactions, count of individual prepaid or
|
|
606
|
-
# gift cards/codes purchased. Maps to EMV 3DS field `giftCardCount`.
|
|
607
|
-
#
|
|
608
|
-
# @return [Integer, nil]
|
|
609
|
-
optional :gift_card_count, Integer, nil?: true
|
|
610
|
-
|
|
611
|
-
# @!attribute gift_card_currency
|
|
612
|
-
# In prepaid or gift card purchase transactions, currency code of the gift card.
|
|
613
|
-
# Maps to EMV 3DS field `giftCardCurr`. Permitted values: ISO 4217 three-character
|
|
614
|
-
# currency code (e.g., USD).
|
|
615
|
-
#
|
|
616
|
-
# @return [String, nil]
|
|
617
|
-
optional :gift_card_currency, String, nil?: true
|
|
618
|
-
|
|
619
|
-
# @!attribute order_availability
|
|
620
|
-
# Indicates whether the purchase is for merchandise that is available now or at a
|
|
621
|
-
# future date. Maps to EMV 3DS field `preOrderPurchaseInd`.
|
|
622
|
-
#
|
|
623
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::OrderAvailability, nil]
|
|
624
|
-
optional :order_availability,
|
|
625
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::OrderAvailability },
|
|
626
|
-
nil?: true
|
|
627
|
-
|
|
628
|
-
# @!attribute pre_order_available_date
|
|
629
|
-
# In pre-order purchase transactions, the expected date that the merchandise will
|
|
630
|
-
# be available. Maps to EMV 3DS field `preOrderDate`. Permitted values: Date
|
|
631
|
-
# string in the ISO 8601 format yyyy-MM-dd'T'hh:mm:ssZ
|
|
632
|
-
#
|
|
633
|
-
# @return [Time, nil]
|
|
634
|
-
optional :pre_order_available_date, Time, nil?: true
|
|
635
|
-
|
|
636
|
-
# @!attribute reorder_items
|
|
637
|
-
# Indicates whether the cardholder is reordering previously purchased merchandise.
|
|
638
|
-
# Maps to EMV 3DS field `reorderItemsInd`.
|
|
639
|
-
#
|
|
640
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::ReorderItems, nil]
|
|
641
|
-
optional :reorder_items,
|
|
642
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::ReorderItems },
|
|
643
|
-
nil?: true
|
|
644
|
-
|
|
645
|
-
# @!attribute shipping_method
|
|
646
|
-
# Shipping method that the cardholder chose for the transaction. If purchase
|
|
647
|
-
# includes one or more item, this indicator is used for the physical goods; if the
|
|
648
|
-
# purchase only includes digital goods, this indicator is used to describe the
|
|
649
|
-
# most expensive item purchased. Maps to EMV 3DS field `shipIndicator`.
|
|
650
|
-
#
|
|
651
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::ShippingMethod, nil]
|
|
652
|
-
optional :shipping_method,
|
|
653
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::ShippingMethod },
|
|
654
|
-
nil?: true
|
|
655
|
-
|
|
656
|
-
# @!method initialize(delivery_email_address: nil, delivery_time_frame: nil, gift_card_amount: nil, gift_card_count: nil, gift_card_currency: nil, order_availability: nil, pre_order_available_date: nil, reorder_items: nil, shipping_method: nil)
|
|
657
|
-
# Some parameter documentations has been truncated, see
|
|
658
|
-
# {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator}
|
|
659
|
-
# for more details.
|
|
660
|
-
#
|
|
661
|
-
# Object containing additional data indicating additional risk factors related to
|
|
662
|
-
# the e-commerce transaction.
|
|
663
|
-
#
|
|
664
|
-
# @param delivery_email_address [String, nil] In transactions with electronic delivery, email address to which merchandise is
|
|
665
|
-
#
|
|
666
|
-
# @param delivery_time_frame [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::DeliveryTimeFrame, nil] The delivery time frame for the merchandise. Maps to EMV 3DS field `deliveryTime
|
|
667
|
-
#
|
|
668
|
-
# @param gift_card_amount [Integer, nil] In prepaid or gift card purchase transactions, purchase amount total in major un
|
|
669
|
-
#
|
|
670
|
-
# @param gift_card_count [Integer, nil] In prepaid or gift card purchase transactions, count of individual prepaid or gi
|
|
671
|
-
#
|
|
672
|
-
# @param gift_card_currency [String, nil] In prepaid or gift card purchase transactions, currency code of the gift card. M
|
|
673
|
-
#
|
|
674
|
-
# @param order_availability [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::OrderAvailability, nil] Indicates whether the purchase is for merchandise that is available now or at a
|
|
675
|
-
#
|
|
676
|
-
# @param pre_order_available_date [Time, nil] In pre-order purchase transactions, the expected date that the merchandise will
|
|
677
|
-
#
|
|
678
|
-
# @param reorder_items [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::ReorderItems, nil] Indicates whether the cardholder is reordering previously purchased merchandise.
|
|
679
|
-
#
|
|
680
|
-
# @param shipping_method [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator::ShippingMethod, nil] Shipping method that the cardholder chose for the transaction. If purchase inclu
|
|
681
|
-
|
|
682
|
-
# The delivery time frame for the merchandise. Maps to EMV 3DS field
|
|
683
|
-
# `deliveryTimeframe`.
|
|
684
|
-
#
|
|
685
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator#delivery_time_frame
|
|
686
|
-
module DeliveryTimeFrame
|
|
687
|
-
extend Lithic::Internal::Type::Enum
|
|
688
|
-
|
|
689
|
-
ELECTRONIC_DELIVERY = :ELECTRONIC_DELIVERY
|
|
690
|
-
OVERNIGHT_SHIPPING = :OVERNIGHT_SHIPPING
|
|
691
|
-
SAME_DAY_SHIPPING = :SAME_DAY_SHIPPING
|
|
692
|
-
TWO_DAY_OR_MORE_SHIPPING = :TWO_DAY_OR_MORE_SHIPPING
|
|
693
|
-
|
|
694
|
-
# @!method self.values
|
|
695
|
-
# @return [Array<Symbol>]
|
|
696
|
-
end
|
|
697
|
-
|
|
698
|
-
# Indicates whether the purchase is for merchandise that is available now or at a
|
|
699
|
-
# future date. Maps to EMV 3DS field `preOrderPurchaseInd`.
|
|
700
|
-
#
|
|
701
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator#order_availability
|
|
702
|
-
module OrderAvailability
|
|
703
|
-
extend Lithic::Internal::Type::Enum
|
|
704
|
-
|
|
705
|
-
FUTURE_AVAILABILITY = :FUTURE_AVAILABILITY
|
|
706
|
-
MERCHANDISE_AVAILABLE = :MERCHANDISE_AVAILABLE
|
|
707
|
-
|
|
708
|
-
# @!method self.values
|
|
709
|
-
# @return [Array<Symbol>]
|
|
710
|
-
end
|
|
711
|
-
|
|
712
|
-
# Indicates whether the cardholder is reordering previously purchased merchandise.
|
|
713
|
-
# Maps to EMV 3DS field `reorderItemsInd`.
|
|
714
|
-
#
|
|
715
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator#reorder_items
|
|
716
|
-
module ReorderItems
|
|
717
|
-
extend Lithic::Internal::Type::Enum
|
|
718
|
-
|
|
719
|
-
FIRST_TIME_ORDERED = :FIRST_TIME_ORDERED
|
|
720
|
-
REORDERED = :REORDERED
|
|
721
|
-
|
|
722
|
-
# @!method self.values
|
|
723
|
-
# @return [Array<Symbol>]
|
|
724
|
-
end
|
|
725
|
-
|
|
726
|
-
# Shipping method that the cardholder chose for the transaction. If purchase
|
|
727
|
-
# includes one or more item, this indicator is used for the physical goods; if the
|
|
728
|
-
# purchase only includes digital goods, this indicator is used to describe the
|
|
729
|
-
# most expensive item purchased. Maps to EMV 3DS field `shipIndicator`.
|
|
730
|
-
#
|
|
731
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Merchant::RiskIndicator#shipping_method
|
|
732
|
-
module ShippingMethod
|
|
733
|
-
extend Lithic::Internal::Type::Enum
|
|
734
|
-
|
|
735
|
-
DIGITAL_GOODS = :DIGITAL_GOODS
|
|
736
|
-
LOCKER_DELIVERY = :LOCKER_DELIVERY
|
|
737
|
-
OTHER = :OTHER
|
|
738
|
-
PICK_UP_AND_GO_DELIVERY = :PICK_UP_AND_GO_DELIVERY
|
|
739
|
-
SHIP_TO_BILLING_ADDRESS = :SHIP_TO_BILLING_ADDRESS
|
|
740
|
-
SHIP_TO_NON_BILLING_ADDRESS = :SHIP_TO_NON_BILLING_ADDRESS
|
|
741
|
-
SHIP_TO_OTHER_VERIFIED_ADDRESS = :SHIP_TO_OTHER_VERIFIED_ADDRESS
|
|
742
|
-
SHIP_TO_STORE = :SHIP_TO_STORE
|
|
743
|
-
TRAVEL_AND_EVENT_TICKETS = :TRAVEL_AND_EVENT_TICKETS
|
|
744
|
-
|
|
745
|
-
# @!method self.values
|
|
746
|
-
# @return [Array<Symbol>]
|
|
747
|
-
end
|
|
748
|
-
end
|
|
749
|
-
end
|
|
750
|
-
|
|
751
|
-
# Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For
|
|
752
|
-
# NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not
|
|
753
|
-
# populated.
|
|
754
|
-
#
|
|
755
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#message_category
|
|
756
|
-
module MessageCategory
|
|
757
|
-
extend Lithic::Internal::Type::Enum
|
|
758
|
-
|
|
759
|
-
NON_PAYMENT_AUTHENTICATION = :NON_PAYMENT_AUTHENTICATION
|
|
760
|
-
PAYMENT_AUTHENTICATION = :PAYMENT_AUTHENTICATION
|
|
761
|
-
|
|
762
|
-
# @!method self.values
|
|
763
|
-
# @return [Array<Symbol>]
|
|
764
|
-
end
|
|
765
|
-
|
|
766
|
-
# Indicates whether a challenge is requested for this transaction
|
|
767
|
-
#
|
|
768
|
-
# - `NO_PREFERENCE` - No Preference
|
|
769
|
-
# - `NO_CHALLENGE_REQUESTED` - No Challenge Requested
|
|
770
|
-
# - `CHALLENGE_PREFERENCE` - Challenge requested (3DS Requestor preference)
|
|
771
|
-
# - `CHALLENGE_MANDATE` - Challenge requested (Mandate)
|
|
772
|
-
# - `NO_CHALLENGE_RISK_ALREADY_ASSESSED` - No Challenge requested (Transactional
|
|
773
|
-
# risk analysis is already performed)
|
|
774
|
-
# - `DATA_SHARE_ONLY` - No Challenge requested (Data Share Only)
|
|
775
|
-
# - `OTHER` - Other indicators not captured by above. These are rarely used
|
|
776
|
-
#
|
|
777
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#three_ds_requestor_challenge_indicator
|
|
778
|
-
module ThreeDSRequestorChallengeIndicator
|
|
779
|
-
extend Lithic::Internal::Type::Enum
|
|
780
|
-
|
|
781
|
-
NO_PREFERENCE = :NO_PREFERENCE
|
|
782
|
-
NO_CHALLENGE_REQUESTED = :NO_CHALLENGE_REQUESTED
|
|
783
|
-
CHALLENGE_PREFERENCE = :CHALLENGE_PREFERENCE
|
|
784
|
-
CHALLENGE_MANDATE = :CHALLENGE_MANDATE
|
|
785
|
-
NO_CHALLENGE_RISK_ALREADY_ASSESSED = :NO_CHALLENGE_RISK_ALREADY_ASSESSED
|
|
786
|
-
DATA_SHARE_ONLY = :DATA_SHARE_ONLY
|
|
787
|
-
OTHER = :OTHER
|
|
788
|
-
|
|
789
|
-
# @!method self.values
|
|
790
|
-
# @return [Array<Symbol>]
|
|
791
|
-
end
|
|
792
|
-
|
|
793
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#additional_data
|
|
794
|
-
class AdditionalData < Lithic::Internal::Type::BaseModel
|
|
795
|
-
# @!attribute network_decision
|
|
796
|
-
# Mastercard only: Indicates whether the network would have considered the
|
|
797
|
-
# authentication request to be low risk or not.
|
|
798
|
-
#
|
|
799
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData::NetworkDecision, nil]
|
|
800
|
-
optional :network_decision,
|
|
801
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData::NetworkDecision },
|
|
802
|
-
nil?: true
|
|
803
|
-
|
|
804
|
-
# @!attribute network_risk_score
|
|
805
|
-
# Mastercard only: Assessment by the network of the authentication risk level,
|
|
806
|
-
# with a higher value indicating a higher amount of risk. Permitted values:
|
|
807
|
-
# Integer between 0-950, in increments of 50.
|
|
808
|
-
#
|
|
809
|
-
# @return [Integer, nil]
|
|
810
|
-
optional :network_risk_score, Integer, nil?: true
|
|
811
|
-
|
|
812
|
-
# @!method initialize(network_decision: nil, network_risk_score: nil)
|
|
813
|
-
# Some parameter documentations has been truncated, see
|
|
814
|
-
# {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData} for
|
|
815
|
-
# more details.
|
|
816
|
-
#
|
|
817
|
-
# Object containing additional data about the 3DS request that is beyond the EMV
|
|
818
|
-
# 3DS standard spec (e.g., specific fields that only certain card networks send
|
|
819
|
-
# but are not required across all 3DS requests).
|
|
820
|
-
#
|
|
821
|
-
# @param network_decision [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData::NetworkDecision, nil] Mastercard only: Indicates whether the network would have considered the authent
|
|
822
|
-
#
|
|
823
|
-
# @param network_risk_score [Integer, nil] Mastercard only: Assessment by the network of the authentication risk level, wit
|
|
824
|
-
|
|
825
|
-
# Mastercard only: Indicates whether the network would have considered the
|
|
826
|
-
# authentication request to be low risk or not.
|
|
827
|
-
#
|
|
828
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::AdditionalData#network_decision
|
|
829
|
-
module NetworkDecision
|
|
830
|
-
extend Lithic::Internal::Type::Enum
|
|
831
|
-
|
|
832
|
-
LOW_RISK = :LOW_RISK
|
|
833
|
-
NOT_LOW_RISK = :NOT_LOW_RISK
|
|
834
|
-
|
|
835
|
-
# @!method self.values
|
|
836
|
-
# @return [Array<Symbol>]
|
|
837
|
-
end
|
|
838
|
-
end
|
|
839
|
-
|
|
840
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#app
|
|
841
|
-
class App < Lithic::Internal::Type::BaseModel
|
|
842
|
-
# @!attribute device
|
|
843
|
-
# Device model: e.g. "Apple iPhone 16".
|
|
844
|
-
#
|
|
845
|
-
# @return [String, nil]
|
|
846
|
-
optional :device, String, nil?: true
|
|
847
|
-
|
|
848
|
-
# @!attribute device_info
|
|
849
|
-
# Raw device information - base64-encoded JSON object. Maps to EMV 3DS field
|
|
850
|
-
# `deviceInfo`.
|
|
851
|
-
#
|
|
852
|
-
# @return [String, nil]
|
|
853
|
-
optional :device_info, String, nil?: true
|
|
854
|
-
|
|
855
|
-
# @!attribute ip
|
|
856
|
-
# IP address of the device.
|
|
857
|
-
#
|
|
858
|
-
# @return [String, nil]
|
|
859
|
-
optional :ip, String
|
|
860
|
-
|
|
861
|
-
# @!attribute latitude
|
|
862
|
-
# Latitude coordinate of current device location.
|
|
863
|
-
#
|
|
864
|
-
# @return [Float, nil]
|
|
865
|
-
optional :latitude, Float, nil?: true
|
|
866
|
-
|
|
867
|
-
# @!attribute locale
|
|
868
|
-
# Device locale: e.g. "en-US".
|
|
869
|
-
#
|
|
870
|
-
# @return [String, nil]
|
|
871
|
-
optional :locale, String, nil?: true
|
|
872
|
-
|
|
873
|
-
# @!attribute longitude
|
|
874
|
-
# Longitude coordinate of current device location.
|
|
875
|
-
#
|
|
876
|
-
# @return [Float, nil]
|
|
877
|
-
optional :longitude, Float, nil?: true
|
|
878
|
-
|
|
879
|
-
# @!attribute os
|
|
880
|
-
# Operating System: e.g. "Android 12", "iOS 17.1".
|
|
881
|
-
#
|
|
882
|
-
# @return [String, nil]
|
|
883
|
-
optional :os, String, nil?: true
|
|
884
|
-
|
|
885
|
-
# @!attribute platform
|
|
886
|
-
# Device platform: Android, iOS, Windows, etc.
|
|
887
|
-
#
|
|
888
|
-
# @return [String, nil]
|
|
889
|
-
optional :platform, String, nil?: true
|
|
890
|
-
|
|
891
|
-
# @!attribute screen_height
|
|
892
|
-
# Screen height in pixels.
|
|
893
|
-
#
|
|
894
|
-
# @return [Integer, nil]
|
|
895
|
-
optional :screen_height, Integer, nil?: true
|
|
896
|
-
|
|
897
|
-
# @!attribute screen_width
|
|
898
|
-
# Screen width in pixels.
|
|
899
|
-
#
|
|
900
|
-
# @return [Integer, nil]
|
|
901
|
-
optional :screen_width, Integer, nil?: true
|
|
902
|
-
|
|
903
|
-
# @!attribute time_zone
|
|
904
|
-
# Time zone offset in minutes between UTC and device local time.
|
|
905
|
-
#
|
|
906
|
-
# @return [String, nil]
|
|
907
|
-
optional :time_zone, String, nil?: true
|
|
908
|
-
|
|
909
|
-
# @!method initialize(device: nil, device_info: nil, ip: nil, latitude: nil, locale: nil, longitude: nil, os: nil, platform: nil, screen_height: nil, screen_width: nil, time_zone: nil)
|
|
910
|
-
# Some parameter documentations has been truncated, see
|
|
911
|
-
# {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::App} for more details.
|
|
912
|
-
#
|
|
913
|
-
# Object containing data about the app used in the e-commerce transaction. Present
|
|
914
|
-
# if the channel is 'APP_BASED'.
|
|
915
|
-
#
|
|
916
|
-
# @param device [String, nil] Device model: e.g. "Apple iPhone 16".
|
|
917
|
-
#
|
|
918
|
-
# @param device_info [String, nil] Raw device information - base64-encoded JSON object. Maps to EMV 3DS field `devi
|
|
919
|
-
#
|
|
920
|
-
# @param ip [String] IP address of the device.
|
|
921
|
-
#
|
|
922
|
-
# @param latitude [Float, nil] Latitude coordinate of current device location.
|
|
923
|
-
#
|
|
924
|
-
# @param locale [String, nil] Device locale: e.g. "en-US".
|
|
925
|
-
#
|
|
926
|
-
# @param longitude [Float, nil] Longitude coordinate of current device location.
|
|
927
|
-
#
|
|
928
|
-
# @param os [String, nil] Operating System: e.g. "Android 12", "iOS 17.1".
|
|
929
|
-
#
|
|
930
|
-
# @param platform [String, nil] Device platform: Android, iOS, Windows, etc.
|
|
931
|
-
#
|
|
932
|
-
# @param screen_height [Integer, nil] Screen height in pixels.
|
|
933
|
-
#
|
|
934
|
-
# @param screen_width [Integer, nil] Screen width in pixels.
|
|
935
|
-
#
|
|
936
|
-
# @param time_zone [String, nil] Time zone offset in minutes between UTC and device local time.
|
|
937
|
-
end
|
|
938
|
-
|
|
939
|
-
# Type of authentication request - i.e., the type of transaction or interaction is
|
|
940
|
-
# causing the merchant to request an authentication. Maps to EMV 3DS field
|
|
941
|
-
# `threeDSRequestorAuthenticationInd`.
|
|
942
|
-
#
|
|
943
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#authentication_request_type
|
|
944
|
-
module AuthenticationRequestType
|
|
945
|
-
extend Lithic::Internal::Type::Enum
|
|
946
|
-
|
|
947
|
-
ADD_CARD = :ADD_CARD
|
|
948
|
-
BILLING_AGREEMENT = :BILLING_AGREEMENT
|
|
949
|
-
DELAYED_SHIPMENT = :DELAYED_SHIPMENT
|
|
950
|
-
EMV_TOKEN_CARDHOLDER_VERIFICATION = :EMV_TOKEN_CARDHOLDER_VERIFICATION
|
|
951
|
-
INSTALLMENT_TRANSACTION = :INSTALLMENT_TRANSACTION
|
|
952
|
-
MAINTAIN_CARD = :MAINTAIN_CARD
|
|
953
|
-
PAYMENT_TRANSACTION = :PAYMENT_TRANSACTION
|
|
954
|
-
RECURRING_TRANSACTION = :RECURRING_TRANSACTION
|
|
955
|
-
SPLIT_PAYMENT = :SPLIT_PAYMENT
|
|
956
|
-
SPLIT_SHIPMENT = :SPLIT_SHIPMENT
|
|
957
|
-
|
|
958
|
-
# @!method self.values
|
|
959
|
-
# @return [Array<Symbol>]
|
|
960
|
-
end
|
|
961
|
-
|
|
962
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#browser
|
|
963
|
-
class Browser < Lithic::Internal::Type::BaseModel
|
|
964
|
-
# @!attribute accept_header
|
|
965
|
-
# Content of the HTTP accept headers as sent from the cardholder's browser to the
|
|
966
|
-
# 3DS requestor (e.g., merchant or digital wallet).
|
|
967
|
-
#
|
|
968
|
-
# @return [String, nil]
|
|
969
|
-
optional :accept_header, String, nil?: true
|
|
970
|
-
|
|
971
|
-
# @!attribute ip
|
|
972
|
-
# IP address of the browser as returned by the HTTP headers to the 3DS requestor
|
|
973
|
-
# (e.g., merchant or digital wallet). Maps to EMV 3DS field `browserIP`.
|
|
974
|
-
#
|
|
975
|
-
# @return [String, nil]
|
|
976
|
-
optional :ip, String, nil?: true
|
|
977
|
-
|
|
978
|
-
# @!attribute java_enabled
|
|
979
|
-
# Indicates whether the cardholder's browser has the ability to execute Java. Maps
|
|
980
|
-
# to EMV 3DS field `browserJavaEnabled`.
|
|
981
|
-
#
|
|
982
|
-
# @return [Boolean, nil]
|
|
983
|
-
optional :java_enabled, Lithic::Internal::Type::Boolean, nil?: true
|
|
984
|
-
|
|
985
|
-
# @!attribute javascript_enabled
|
|
986
|
-
# Indicates whether the cardholder's browser has the ability to execute
|
|
987
|
-
# JavaScript. Maps to EMV 3DS field `browserJavascriptEnabled`.
|
|
988
|
-
#
|
|
989
|
-
# @return [Boolean, nil]
|
|
990
|
-
optional :javascript_enabled, Lithic::Internal::Type::Boolean, nil?: true
|
|
991
|
-
|
|
992
|
-
# @!attribute language
|
|
993
|
-
# Language of the cardholder's browser as defined in IETF BCP47. Maps to EMV 3DS
|
|
994
|
-
# field `browserLanguage`.
|
|
995
|
-
#
|
|
996
|
-
# @return [String, nil]
|
|
997
|
-
optional :language, String, nil?: true
|
|
998
|
-
|
|
999
|
-
# @!attribute time_zone
|
|
1000
|
-
# Time zone offset in minutes between UTC and browser local time. Maps to EMV 3DS
|
|
1001
|
-
# field `browserTz`.
|
|
1002
|
-
#
|
|
1003
|
-
# @return [String, nil]
|
|
1004
|
-
optional :time_zone, String, nil?: true
|
|
1005
|
-
|
|
1006
|
-
# @!attribute user_agent
|
|
1007
|
-
# Content of the HTTP user-agent header. Maps to EMV 3DS field `browserUserAgent`.
|
|
1008
|
-
#
|
|
1009
|
-
# @return [String, nil]
|
|
1010
|
-
optional :user_agent, String, nil?: true
|
|
1011
|
-
|
|
1012
|
-
# @!method initialize(accept_header: nil, ip: nil, java_enabled: nil, javascript_enabled: nil, language: nil, time_zone: nil, user_agent: nil)
|
|
1013
|
-
# Some parameter documentations has been truncated, see
|
|
1014
|
-
# {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Browser} for more
|
|
1015
|
-
# details.
|
|
1016
|
-
#
|
|
1017
|
-
# Object containing data about the browser used in the e-commerce transaction.
|
|
1018
|
-
# Present if the channel is 'BROWSER'.
|
|
1019
|
-
#
|
|
1020
|
-
# @param accept_header [String, nil] Content of the HTTP accept headers as sent from the cardholder's browser to the
|
|
1021
|
-
#
|
|
1022
|
-
# @param ip [String, nil] IP address of the browser as returned by the HTTP headers to the 3DS requestor (
|
|
1023
|
-
#
|
|
1024
|
-
# @param java_enabled [Boolean, nil] Indicates whether the cardholder's browser has the ability to execute Java. Maps
|
|
1025
|
-
#
|
|
1026
|
-
# @param javascript_enabled [Boolean, nil] Indicates whether the cardholder's browser has the ability to execute JavaScript
|
|
1027
|
-
#
|
|
1028
|
-
# @param language [String, nil] Language of the cardholder's browser as defined in IETF BCP47. Maps to EMV 3DS f
|
|
1029
|
-
#
|
|
1030
|
-
# @param time_zone [String, nil] Time zone offset in minutes between UTC and browser local time. Maps to EMV 3DS
|
|
1031
|
-
#
|
|
1032
|
-
# @param user_agent [String, nil] Content of the HTTP user-agent header. Maps to EMV 3DS field `browserUserAgent`.
|
|
1033
|
-
end
|
|
1034
|
-
|
|
1035
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#challenge_metadata
|
|
1036
|
-
class ChallengeMetadata < Lithic::Internal::Type::BaseModel
|
|
1037
|
-
# @!attribute method_type
|
|
1038
|
-
# The type of challenge method used for authentication.
|
|
1039
|
-
#
|
|
1040
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::MethodType]
|
|
1041
|
-
required :method_type,
|
|
1042
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::MethodType }
|
|
1043
|
-
|
|
1044
|
-
# @!attribute status
|
|
1045
|
-
# Indicates the status of the challenge
|
|
1046
|
-
#
|
|
1047
|
-
# - SUCCESS - Cardholder completed the challenge successfully
|
|
1048
|
-
# - PENDING - Challenge was issued to the cardholder and was not completed yet
|
|
1049
|
-
# - SMS_DELIVERY_FAILED - Lithic confirmed undeliverability of the SMS to the
|
|
1050
|
-
# provided phone number. Relevant only for SMS_OTP method
|
|
1051
|
-
# - CARDHOLDER_TIMEOUT - Cardholder failed to complete the challenge within the
|
|
1052
|
-
# given challenge TTL
|
|
1053
|
-
# - CANCELED_VIA_CHALLENGE_UI - Cardholder canceled the challenge by selecting
|
|
1054
|
-
# "cancel" on the challenge UI
|
|
1055
|
-
# - CANCELED_OOB - Cardholder canceled the challenge out of band
|
|
1056
|
-
# - ATTEMPTS_EXCEEDED - Cardholder failed the challenge by either entering an
|
|
1057
|
-
# incorrect OTP more than the allowed number of times or requesting a new OTP
|
|
1058
|
-
# more than the allowed number of times
|
|
1059
|
-
# - ABORTED - Merchant aborted authentication after a challenge was requested
|
|
1060
|
-
# - ERROR - The challenge failed for a reason different than those documented
|
|
1061
|
-
#
|
|
1062
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status]
|
|
1063
|
-
required :status,
|
|
1064
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status }
|
|
1065
|
-
|
|
1066
|
-
# @!attribute phone_number
|
|
1067
|
-
# The phone number used for delivering the OTP. Relevant only for SMS_OTP method.
|
|
1068
|
-
#
|
|
1069
|
-
# @return [String, nil]
|
|
1070
|
-
optional :phone_number, String, nil?: true
|
|
1071
|
-
|
|
1072
|
-
# @!method initialize(method_type:, status:, phone_number: nil)
|
|
1073
|
-
# Some parameter documentations has been truncated, see
|
|
1074
|
-
# {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata} for
|
|
1075
|
-
# more details.
|
|
1076
|
-
#
|
|
1077
|
-
# Metadata about the challenge method and delivery. Only present when a challenge
|
|
1078
|
-
# is triggered.
|
|
1079
|
-
#
|
|
1080
|
-
# @param method_type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::MethodType] The type of challenge method used for authentication.
|
|
1081
|
-
#
|
|
1082
|
-
# @param status [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata::Status] Indicates the status of the challenge
|
|
1083
|
-
#
|
|
1084
|
-
# @param phone_number [String, nil] The phone number used for delivering the OTP. Relevant only for SMS_OTP method.
|
|
1085
|
-
|
|
1086
|
-
# The type of challenge method used for authentication.
|
|
1087
|
-
#
|
|
1088
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata#method_type
|
|
1089
|
-
module MethodType
|
|
1090
|
-
extend Lithic::Internal::Type::Enum
|
|
1091
|
-
|
|
1092
|
-
SMS_OTP = :SMS_OTP
|
|
1093
|
-
OUT_OF_BAND = :OUT_OF_BAND
|
|
1094
|
-
|
|
1095
|
-
# @!method self.values
|
|
1096
|
-
# @return [Array<Symbol>]
|
|
1097
|
-
end
|
|
1098
|
-
|
|
1099
|
-
# Indicates the status of the challenge
|
|
1100
|
-
#
|
|
1101
|
-
# - SUCCESS - Cardholder completed the challenge successfully
|
|
1102
|
-
# - PENDING - Challenge was issued to the cardholder and was not completed yet
|
|
1103
|
-
# - SMS_DELIVERY_FAILED - Lithic confirmed undeliverability of the SMS to the
|
|
1104
|
-
# provided phone number. Relevant only for SMS_OTP method
|
|
1105
|
-
# - CARDHOLDER_TIMEOUT - Cardholder failed to complete the challenge within the
|
|
1106
|
-
# given challenge TTL
|
|
1107
|
-
# - CANCELED_VIA_CHALLENGE_UI - Cardholder canceled the challenge by selecting
|
|
1108
|
-
# "cancel" on the challenge UI
|
|
1109
|
-
# - CANCELED_OOB - Cardholder canceled the challenge out of band
|
|
1110
|
-
# - ATTEMPTS_EXCEEDED - Cardholder failed the challenge by either entering an
|
|
1111
|
-
# incorrect OTP more than the allowed number of times or requesting a new OTP
|
|
1112
|
-
# more than the allowed number of times
|
|
1113
|
-
# - ABORTED - Merchant aborted authentication after a challenge was requested
|
|
1114
|
-
# - ERROR - The challenge failed for a reason different than those documented
|
|
1115
|
-
#
|
|
1116
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::ChallengeMetadata#status
|
|
1117
|
-
module Status
|
|
1118
|
-
extend Lithic::Internal::Type::Enum
|
|
1119
|
-
|
|
1120
|
-
SUCCESS = :SUCCESS
|
|
1121
|
-
PENDING = :PENDING
|
|
1122
|
-
SMS_DELIVERY_FAILED = :SMS_DELIVERY_FAILED
|
|
1123
|
-
CARDHOLDER_TIMEOUT = :CARDHOLDER_TIMEOUT
|
|
1124
|
-
CANCELED_VIA_CHALLENGE_UI = :CANCELED_VIA_CHALLENGE_UI
|
|
1125
|
-
CANCELED_OOB = :CANCELED_OOB
|
|
1126
|
-
ATTEMPTS_EXCEEDED = :ATTEMPTS_EXCEEDED
|
|
1127
|
-
ABORTED = :ABORTED
|
|
1128
|
-
ERROR = :ERROR
|
|
1129
|
-
|
|
1130
|
-
# @!method self.values
|
|
1131
|
-
# @return [Array<Symbol>]
|
|
1132
|
-
end
|
|
1133
|
-
end
|
|
1134
|
-
|
|
1135
|
-
# Entity that orchestrates the challenge. This won't be set for authentications
|
|
1136
|
-
# for which a decision has not yet been made (e.g. in-flight customer decisioning
|
|
1137
|
-
# request).
|
|
1138
|
-
#
|
|
1139
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#challenge_orchestrated_by
|
|
1140
|
-
module ChallengeOrchestratedBy
|
|
1141
|
-
extend Lithic::Internal::Type::Enum
|
|
1142
|
-
|
|
1143
|
-
LITHIC = :LITHIC
|
|
1144
|
-
CUSTOMER = :CUSTOMER
|
|
1145
|
-
NO_CHALLENGE = :NO_CHALLENGE
|
|
1146
|
-
|
|
1147
|
-
# @!method self.values
|
|
1148
|
-
# @return [Array<Symbol>]
|
|
1149
|
-
end
|
|
1150
|
-
|
|
1151
|
-
# Entity that made the authentication decision. This won't be set for
|
|
1152
|
-
# authentications for which a decision has not yet been made (e.g. in-flight
|
|
1153
|
-
# customer decisioning request).
|
|
1154
|
-
#
|
|
1155
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#decision_made_by
|
|
1156
|
-
module DecisionMadeBy
|
|
1157
|
-
extend Lithic::Internal::Type::Enum
|
|
1158
|
-
|
|
1159
|
-
LITHIC_RULES = :LITHIC_RULES
|
|
1160
|
-
LITHIC_DEFAULT = :LITHIC_DEFAULT
|
|
1161
|
-
CUSTOMER_RULES = :CUSTOMER_RULES
|
|
1162
|
-
CUSTOMER_ENDPOINT = :CUSTOMER_ENDPOINT
|
|
1163
|
-
NETWORK = :NETWORK
|
|
1164
|
-
UNKNOWN = :UNKNOWN
|
|
1165
|
-
|
|
1166
|
-
# @!method self.values
|
|
1167
|
-
# @return [Array<Symbol>]
|
|
1168
|
-
end
|
|
1169
|
-
|
|
1170
|
-
# Type of 3DS Requestor Initiated (3RI) request — i.e., a 3DS authentication that
|
|
1171
|
-
# takes place at the initiation of the merchant rather than the cardholder. The
|
|
1172
|
-
# most common example of this is where a merchant is authenticating before billing
|
|
1173
|
-
# for a recurring transaction such as a pay TV subscription or a utility bill.
|
|
1174
|
-
# Maps to EMV 3DS field `threeRIInd`.
|
|
1175
|
-
#
|
|
1176
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#three_ri_request_type
|
|
1177
|
-
module ThreeRiRequestType
|
|
1178
|
-
extend Lithic::Internal::Type::Enum
|
|
1179
|
-
|
|
1180
|
-
ACCOUNT_VERIFICATION = :ACCOUNT_VERIFICATION
|
|
1181
|
-
ADD_CARD = :ADD_CARD
|
|
1182
|
-
BILLING_AGREEMENT = :BILLING_AGREEMENT
|
|
1183
|
-
CARD_SECURITY_CODE_STATUS_CHECK = :CARD_SECURITY_CODE_STATUS_CHECK
|
|
1184
|
-
DELAYED_SHIPMENT = :DELAYED_SHIPMENT
|
|
1185
|
-
DEVICE_BINDING_STATUS_CHECK = :DEVICE_BINDING_STATUS_CHECK
|
|
1186
|
-
INSTALLMENT_TRANSACTION = :INSTALLMENT_TRANSACTION
|
|
1187
|
-
MAIL_ORDER = :MAIL_ORDER
|
|
1188
|
-
MAINTAIN_CARD_INFO = :MAINTAIN_CARD_INFO
|
|
1189
|
-
OTHER_PAYMENT = :OTHER_PAYMENT
|
|
1190
|
-
RECURRING_TRANSACTION = :RECURRING_TRANSACTION
|
|
1191
|
-
SPLIT_PAYMENT = :SPLIT_PAYMENT
|
|
1192
|
-
SPLIT_SHIPMENT = :SPLIT_SHIPMENT
|
|
1193
|
-
TELEPHONE_ORDER = :TELEPHONE_ORDER
|
|
1194
|
-
TOP_UP = :TOP_UP
|
|
1195
|
-
TRUST_LIST_STATUS_CHECK = :TRUST_LIST_STATUS_CHECK
|
|
1196
|
-
|
|
1197
|
-
# @!method self.values
|
|
1198
|
-
# @return [Array<Symbol>]
|
|
1199
|
-
end
|
|
1200
|
-
|
|
1201
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse#transaction
|
|
1202
|
-
class Transaction < Lithic::Internal::Type::BaseModel
|
|
1203
|
-
# @!attribute amount
|
|
1204
|
-
# Amount of the purchase in minor units of currency with all punctuation removed.
|
|
1205
|
-
# Maps to EMV 3DS field `purchaseAmount`.
|
|
1206
|
-
#
|
|
1207
|
-
# @return [Float]
|
|
1208
|
-
required :amount, Float
|
|
1209
|
-
|
|
1210
|
-
# @!attribute cardholder_amount
|
|
1211
|
-
# Approximate amount of the purchase in minor units of cardholder currency.
|
|
1212
|
-
# Derived from `amount` using a daily conversion rate.
|
|
1213
|
-
#
|
|
1214
|
-
# @return [Float, nil]
|
|
1215
|
-
required :cardholder_amount, Float, nil?: true
|
|
1216
|
-
|
|
1217
|
-
# @!attribute currency
|
|
1218
|
-
# Currency of the purchase. Maps to EMV 3DS field `purchaseCurrency`. Permitted
|
|
1219
|
-
# values: ISO 4217 three-character currency code (e.g., USD).
|
|
1220
|
-
#
|
|
1221
|
-
# @return [String]
|
|
1222
|
-
required :currency, String
|
|
1223
|
-
|
|
1224
|
-
# @!attribute currency_exponent
|
|
1225
|
-
# Minor units of currency, as specified in ISO 4217 currency exponent. Maps to EMV
|
|
1226
|
-
# 3DS field `purchaseExponent`.
|
|
1227
|
-
#
|
|
1228
|
-
# @return [Float]
|
|
1229
|
-
required :currency_exponent, Float
|
|
1230
|
-
|
|
1231
|
-
# @!attribute date_time
|
|
1232
|
-
# Date and time when the authentication was generated by the merchant/acquirer's
|
|
1233
|
-
# 3DS server. Maps to EMV 3DS field `purchaseDate`. Permitted values: Date string
|
|
1234
|
-
# in the ISO 8601 format yyyy-MM-dd'T'hh:mm:ssZ.
|
|
1235
|
-
#
|
|
1236
|
-
# @return [Time]
|
|
1237
|
-
required :date_time, Time
|
|
1238
|
-
|
|
1239
|
-
# @!attribute type
|
|
1240
|
-
# Type of the transaction for which a 3DS authentication request is occurring.
|
|
1241
|
-
# Maps to EMV 3DS field `transType`.
|
|
1242
|
-
#
|
|
1243
|
-
# @return [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction::Type, nil]
|
|
1244
|
-
required :type,
|
|
1245
|
-
enum: -> { Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction::Type },
|
|
1246
|
-
nil?: true
|
|
1247
|
-
|
|
1248
|
-
# @!method initialize(amount:, cardholder_amount:, currency:, currency_exponent:, date_time:, type:)
|
|
1249
|
-
# Some parameter documentations has been truncated, see
|
|
1250
|
-
# {Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction} for more
|
|
1251
|
-
# details.
|
|
1252
|
-
#
|
|
1253
|
-
# Object containing data about the e-commerce transaction for which the merchant
|
|
1254
|
-
# is requesting authentication.
|
|
1255
|
-
#
|
|
1256
|
-
# @param amount [Float] Amount of the purchase in minor units of currency with all punctuation removed.
|
|
1257
|
-
#
|
|
1258
|
-
# @param cardholder_amount [Float, nil] Approximate amount of the purchase in minor units of cardholder currency. Derive
|
|
1259
|
-
#
|
|
1260
|
-
# @param currency [String] Currency of the purchase. Maps to EMV 3DS field `purchaseCurrency`. Permitted va
|
|
1261
|
-
#
|
|
1262
|
-
# @param currency_exponent [Float] Minor units of currency, as specified in ISO 4217 currency exponent. Maps to EMV
|
|
1263
|
-
#
|
|
1264
|
-
# @param date_time [Time] Date and time when the authentication was generated by the merchant/acquirer's 3
|
|
1265
|
-
#
|
|
1266
|
-
# @param type [Symbol, Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction::Type, nil] Type of the transaction for which a 3DS authentication request is occurring. Map
|
|
1267
|
-
|
|
1268
|
-
# Type of the transaction for which a 3DS authentication request is occurring.
|
|
1269
|
-
# Maps to EMV 3DS field `transType`.
|
|
1270
|
-
#
|
|
1271
|
-
# @see Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Transaction#type
|
|
1272
|
-
module Type
|
|
1273
|
-
extend Lithic::Internal::Type::Enum
|
|
1274
|
-
|
|
1275
|
-
ACCOUNT_FUNDING = :ACCOUNT_FUNDING
|
|
1276
|
-
CHECK_ACCEPTANCE = :CHECK_ACCEPTANCE
|
|
1277
|
-
GOODS_SERVICE_PURCHASE = :GOODS_SERVICE_PURCHASE
|
|
1278
|
-
PREPAID_ACTIVATION_AND_LOAD = :PREPAID_ACTIVATION_AND_LOAD
|
|
1279
|
-
QUASI_CASH_TRANSACTION = :QUASI_CASH_TRANSACTION
|
|
1280
|
-
|
|
1281
|
-
# @!method self.values
|
|
1282
|
-
# @return [Array<Symbol>]
|
|
1283
|
-
end
|
|
1284
|
-
end
|
|
1285
|
-
end
|
|
1286
|
-
end
|
|
1287
|
-
end
|
|
1288
|
-
end
|