lithic 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.7
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/README.md +29 -5
- data/lib/lithic/client.rb +3 -3
- data/lib/lithic/internal/cursor_page.rb +5 -1
- data/lib/lithic/internal/single_page.rb +5 -1
- data/lib/lithic/internal/transport/base_client.rb +3 -3
- data/lib/lithic/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/lithic/internal/type/array_of.rb +5 -3
- data/lib/lithic/internal/type/base_model.rb +19 -16
- data/lib/lithic/internal/type/base_page.rb +4 -1
- data/lib/lithic/internal/type/{boolean_model.rb → boolean.rb} +2 -2
- data/lib/lithic/internal/type/converter.rb +26 -23
- data/lib/lithic/internal/type/enum.rb +10 -8
- data/lib/lithic/internal/type/hash_of.rb +3 -1
- data/lib/lithic/internal/util.rb +29 -50
- data/lib/lithic/models/account.rb +37 -37
- data/lib/lithic/models/account_holder.rb +58 -56
- data/lib/lithic/models/account_holder_create_params.rb +140 -144
- data/lib/lithic/models/account_holder_create_response.rb +6 -6
- data/lib/lithic/models/account_holder_list_params.rb +10 -10
- data/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rb +2 -2
- data/lib/lithic/models/account_holder_simulate_enrollment_review_params.rb +1 -1
- data/lib/lithic/models/account_holder_simulate_enrollment_review_response.rb +71 -71
- data/lib/lithic/models/account_holder_update_params.rb +56 -64
- data/lib/lithic/models/account_holder_update_response.rb +75 -75
- data/lib/lithic/models/account_list_params.rb +6 -6
- data/lib/lithic/models/account_spend_limits.rb +6 -6
- data/lib/lithic/models/account_update_params.rb +14 -14
- data/lib/lithic/models/address.rb +5 -5
- data/lib/lithic/models/address_update.rb +3 -3
- data/lib/lithic/models/aggregate_balance.rb +4 -4
- data/lib/lithic/models/auth_rules/auth_rule.rb +7 -7
- data/lib/lithic/models/auth_rules/auth_rule_condition.rb +44 -44
- data/lib/lithic/models/auth_rules/conditional_attribute.rb +44 -44
- data/lib/lithic/models/auth_rules/v2/backtest_results.rb +12 -12
- data/lib/lithic/models/auth_rules/v2_apply_params.rb +1 -1
- data/lib/lithic/models/auth_rules/v2_apply_response.rb +3 -3
- data/lib/lithic/models/auth_rules/v2_create_params.rb +1 -1
- data/lib/lithic/models/auth_rules/v2_create_response.rb +3 -3
- data/lib/lithic/models/auth_rules/v2_draft_response.rb +3 -3
- data/lib/lithic/models/auth_rules/v2_list_params.rb +2 -2
- data/lib/lithic/models/auth_rules/v2_list_response.rb +3 -3
- data/lib/lithic/models/auth_rules/v2_promote_response.rb +3 -3
- data/lib/lithic/models/auth_rules/v2_retrieve_response.rb +3 -3
- data/lib/lithic/models/auth_rules/v2_update_params.rb +7 -7
- data/lib/lithic/models/auth_rules/v2_update_response.rb +3 -3
- data/lib/lithic/models/auth_rules/velocity_limit_params.rb +14 -14
- data/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rb +5 -5
- data/lib/lithic/models/balance.rb +4 -4
- data/lib/lithic/models/balance_list_params.rb +1 -1
- data/lib/lithic/models/book_transfer_create_params.rb +4 -4
- data/lib/lithic/models/book_transfer_list_params.rb +7 -7
- data/lib/lithic/models/book_transfer_response.rb +14 -14
- data/lib/lithic/models/card.rb +110 -110
- data/lib/lithic/models/card_convert_physical_params.rb +25 -25
- data/lib/lithic/models/card_create_params.rb +93 -93
- data/lib/lithic/models/card_list_params.rb +6 -6
- data/lib/lithic/models/card_program.rb +1 -1
- data/lib/lithic/models/card_program_list_params.rb +2 -2
- data/lib/lithic/models/card_provision_params.rb +11 -11
- data/lib/lithic/models/card_reissue_params.rb +25 -25
- data/lib/lithic/models/card_renew_params.rb +27 -27
- data/lib/lithic/models/card_spend_limits.rb +6 -6
- data/lib/lithic/models/card_update_params.rb +33 -33
- data/lib/lithic/models/cards/aggregate_balance_list_response.rb +4 -4
- data/lib/lithic/models/cards/balance_list_params.rb +2 -2
- data/lib/lithic/models/cards/balance_list_response.rb +4 -4
- data/lib/lithic/models/cards/financial_transaction_list_params.rb +6 -6
- data/lib/lithic/models/credit_products/prime_rate_retrieve_response.rb +1 -1
- data/lib/lithic/models/digital_card_art.rb +2 -2
- data/lib/lithic/models/digital_card_art_list_params.rb +2 -2
- data/lib/lithic/models/dispute.rb +88 -88
- data/lib/lithic/models/dispute_evidence.rb +11 -11
- data/lib/lithic/models/dispute_list_evidences_params.rb +6 -6
- data/lib/lithic/models/dispute_list_params.rb +6 -6
- data/lib/lithic/models/document.rb +6 -6
- data/lib/lithic/models/event.rb +51 -51
- data/lib/lithic/models/event_list_attempts_params.rb +6 -6
- data/lib/lithic/models/event_list_params.rb +7 -7
- data/lib/lithic/models/event_subscription.rb +1 -1
- data/lib/lithic/models/events/event_subscription_resend_params.rb +27 -0
- data/lib/lithic/models/events/subscription_create_params.rb +2 -2
- data/lib/lithic/models/events/subscription_list_attempts_params.rb +6 -6
- data/lib/lithic/models/events/subscription_list_params.rb +2 -2
- data/lib/lithic/models/events/subscription_recover_params.rb +4 -4
- data/lib/lithic/models/events/subscription_replay_missing_params.rb +4 -4
- data/lib/lithic/models/events/subscription_update_params.rb +2 -2
- data/lib/lithic/models/external_bank_account_create_params.rb +5 -5
- data/lib/lithic/models/external_bank_account_create_response.rb +11 -11
- data/lib/lithic/models/external_bank_account_list_params.rb +2 -2
- data/lib/lithic/models/external_bank_account_list_response.rb +11 -11
- data/lib/lithic/models/external_bank_account_retrieve_response.rb +11 -11
- data/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb +11 -11
- data/lib/lithic/models/external_bank_account_retry_prenote_response.rb +11 -11
- data/lib/lithic/models/external_bank_account_update_params.rb +1 -1
- data/lib/lithic/models/external_bank_account_update_response.rb +11 -11
- data/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb +11 -11
- data/lib/lithic/models/external_payment_list_params.rb +7 -7
- data/lib/lithic/models/financial_account.rb +11 -13
- data/lib/lithic/models/financial_account_create_params.rb +2 -2
- data/lib/lithic/models/financial_account_update_status_params.rb +9 -9
- data/lib/lithic/models/financial_accounts/balance_list_params.rb +2 -2
- data/lib/lithic/models/financial_accounts/balance_list_response.rb +4 -4
- data/lib/lithic/models/financial_accounts/financial_account_credit_config.rb +1 -1
- data/lib/lithic/models/financial_accounts/financial_transaction_list_params.rb +6 -6
- data/lib/lithic/models/financial_accounts/loan_tape.rb +24 -24
- data/lib/lithic/models/financial_accounts/loan_tape_list_params.rb +6 -6
- data/lib/lithic/models/financial_accounts/statement.rb +17 -17
- data/lib/lithic/models/financial_accounts/statement_list_params.rb +7 -7
- data/lib/lithic/models/financial_accounts/statements/line_item_list_params.rb +2 -2
- data/lib/lithic/models/financial_accounts/statements/statement_line_items.rb +3 -2
- data/lib/lithic/models/financial_accounts/statements.rb +1 -1
- data/lib/lithic/models/financial_transaction.rb +35 -34
- data/lib/lithic/models/kyb.rb +128 -132
- data/lib/lithic/models/kyb_business_entity.rb +9 -9
- data/lib/lithic/models/kyc.rb +12 -12
- data/lib/lithic/models/kyc_exempt.rb +4 -4
- data/lib/lithic/models/management_operation_list_params.rb +7 -7
- data/lib/lithic/models/management_operation_transaction.rb +36 -0
- data/lib/lithic/models/message_attempt.rb +1 -1
- data/lib/lithic/models/payment.rb +66 -54
- data/lib/lithic/models/payment_create_params.rb +1 -1
- data/lib/lithic/models/payment_list_params.rb +6 -6
- data/lib/lithic/models/reports/settlement/network_total_list_params.rb +7 -7
- data/lib/lithic/models/reports/settlement/network_total_list_response.rb +7 -7
- data/lib/lithic/models/reports/settlement/network_total_retrieve_response.rb +7 -7
- data/lib/lithic/models/reports/settlement_list_details_params.rb +2 -2
- data/lib/lithic/models/required_document.rb +2 -2
- data/lib/lithic/models/responder_endpoint_create_response.rb +1 -1
- data/lib/lithic/models/responder_endpoint_status.rb +1 -1
- data/lib/lithic/models/settlement_detail.rb +5 -5
- data/lib/lithic/models/settlement_report.rb +16 -16
- data/lib/lithic/models/settlement_summary_details.rb +3 -3
- data/lib/lithic/models/shipping_address.rb +9 -9
- data/lib/lithic/models/spend_limit_duration.rb +10 -10
- data/lib/lithic/models/three_ds/authentication_retrieve_response.rb +100 -100
- data/lib/lithic/models/three_ds/authentication_simulate_otp_entry_params.rb +1 -1
- data/lib/lithic/models/three_ds/authentication_simulate_params.rb +7 -7
- data/lib/lithic/models/three_ds/authentication_simulate_response.rb +1 -1
- data/lib/lithic/models/three_ds/challenge_response.rb +3 -3
- data/lib/lithic/models/tokenization.rb +5 -5
- data/lib/lithic/models/tokenization_list_params.rb +6 -6
- data/lib/lithic/models/tokenization_resend_activation_code_params.rb +4 -4
- data/lib/lithic/models/tokenization_simulate_params.rb +3 -3
- data/lib/lithic/models/tokenization_update_digital_card_art_params.rb +3 -3
- data/lib/lithic/models/transaction.rb +100 -100
- data/lib/lithic/models/transaction_list_params.rb +8 -8
- data/lib/lithic/models/transaction_simulate_authorization_advice_params.rb +1 -1
- data/lib/lithic/models/transaction_simulate_authorization_params.rb +39 -39
- data/lib/lithic/models/transaction_simulate_authorization_response.rb +1 -1
- data/lib/lithic/models/transaction_simulate_clearing_params.rb +7 -7
- data/lib/lithic/models/transaction_simulate_credit_authorization_params.rb +4 -4
- data/lib/lithic/models/transaction_simulate_void_params.rb +7 -7
- data/lib/lithic/models/transactions/events/enhanced_data.rb +2 -2
- data/lib/lithic/models/transfer.rb +25 -24
- data/lib/lithic/models/transfer_create_params.rb +4 -4
- data/lib/lithic/request_options.rb +7 -7
- data/lib/lithic/resources/account_holders.rb +54 -54
- data/lib/lithic/resources/accounts.rb +7 -7
- data/lib/lithic/resources/aggregate_balances.rb +1 -1
- data/lib/lithic/resources/auth_rules/v2/backtests.rb +37 -37
- data/lib/lithic/resources/auth_rules/v2.rb +58 -58
- data/lib/lithic/resources/auth_stream_enrollment.rb +8 -8
- data/lib/lithic/resources/book_transfers.rb +2 -2
- data/lib/lithic/resources/cards/financial_transactions.rb +1 -1
- data/lib/lithic/resources/cards.rb +64 -61
- data/lib/lithic/resources/disputes.rb +6 -6
- data/lib/lithic/resources/events/event_subscriptions.rb +41 -0
- data/lib/lithic/resources/events/subscriptions.rb +8 -8
- data/lib/lithic/resources/events.rb +6 -2
- data/lib/lithic/resources/external_payments.rb +1 -1
- data/lib/lithic/resources/financial_accounts/financial_transactions.rb +1 -1
- data/lib/lithic/resources/financial_accounts/loan_tapes.rb +1 -1
- data/lib/lithic/resources/financial_accounts/statements.rb +1 -1
- data/lib/lithic/resources/financial_accounts.rb +6 -6
- data/lib/lithic/resources/management_operations.rb +1 -1
- data/lib/lithic/resources/payments.rb +1 -1
- data/lib/lithic/resources/reports/settlement/network_totals.rb +1 -1
- data/lib/lithic/resources/three_ds/authentication.rb +6 -6
- data/lib/lithic/resources/three_ds/decisioning.rb +8 -8
- data/lib/lithic/resources/tokenization_decisioning.rb +7 -7
- data/lib/lithic/resources/tokenizations.rb +46 -46
- data/lib/lithic/resources/transactions/enhanced_commercial_data.rb +1 -1
- data/lib/lithic/resources/transactions/events/enhanced_commercial_data.rb +1 -1
- data/lib/lithic/resources/transactions.rb +24 -24
- data/lib/lithic/resources/transfers.rb +1 -1
- data/lib/lithic/version.rb +1 -1
- data/lib/lithic.rb +3 -1
- data/rbi/lib/lithic/client.rbi +6 -9
- data/rbi/lib/lithic/errors.rbi +3 -6
- data/rbi/lib/lithic/internal/cursor_page.rbi +1 -2
- data/rbi/lib/lithic/internal/single_page.rbi +1 -2
- data/rbi/lib/lithic/internal/transport/base_client.rbi +13 -27
- data/rbi/lib/lithic/internal/transport/pooled_net_requester.rbi +7 -13
- data/rbi/lib/lithic/internal/type/array_of.rbi +10 -18
- data/rbi/lib/lithic/internal/type/base_model.rbi +45 -64
- data/rbi/lib/lithic/internal/type/base_page.rbi +5 -10
- data/rbi/lib/lithic/internal/type/{boolean_model.rbi → boolean.rbi} +5 -9
- data/rbi/lib/lithic/internal/type/converter.rbi +25 -31
- data/rbi/lib/lithic/internal/type/enum.rbi +14 -20
- data/rbi/lib/lithic/internal/type/hash_of.rbi +8 -16
- data/rbi/lib/lithic/internal/type/request_parameters.rbi +1 -2
- data/rbi/lib/lithic/internal/type/union.rbi +10 -20
- data/rbi/lib/lithic/internal/type/unknown.rbi +4 -8
- data/rbi/lib/lithic/internal/util.rbi +40 -72
- data/rbi/lib/lithic/internal.rbi +1 -1
- data/rbi/lib/lithic/models/account.rbi +46 -56
- data/rbi/lib/lithic/models/account_financial_account_type.rbi +1 -2
- data/rbi/lib/lithic/models/account_holder.rbi +81 -100
- data/rbi/lib/lithic/models/account_holder_create_params.rbi +154 -171
- data/rbi/lib/lithic/models/account_holder_create_response.rbi +9 -12
- data/rbi/lib/lithic/models/account_holder_list_documents_params.rbi +2 -4
- data/rbi/lib/lithic/models/account_holder_list_documents_response.rbi +2 -4
- data/rbi/lib/lithic/models/account_holder_list_params.rbi +10 -13
- data/rbi/lib/lithic/models/account_holder_retrieve_document_params.rbi +2 -4
- data/rbi/lib/lithic/models/account_holder_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/account_holder_simulate_enrollment_document_review_params.rbi +6 -11
- data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_params.rbi +5 -9
- data/rbi/lib/lithic/models/account_holder_simulate_enrollment_review_response.rbi +103 -123
- data/rbi/lib/lithic/models/account_holder_update_params.rbi +68 -94
- data/rbi/lib/lithic/models/account_holder_update_response.rbi +135 -140
- data/rbi/lib/lithic/models/account_holder_upload_document_params.rbi +3 -6
- data/rbi/lib/lithic/models/account_list_params.rbi +5 -6
- data/rbi/lib/lithic/models/account_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/account_retrieve_spend_limits_params.rbi +2 -4
- data/rbi/lib/lithic/models/account_spend_limits.rbi +14 -22
- data/rbi/lib/lithic/models/account_update_params.rbi +19 -25
- data/rbi/lib/lithic/models/address.rbi +7 -9
- data/rbi/lib/lithic/models/address_update.rbi +5 -7
- data/rbi/lib/lithic/models/aggregate_balance.rbi +7 -11
- data/rbi/lib/lithic/models/aggregate_balance_list_params.rbi +3 -6
- data/rbi/lib/lithic/models/api_status.rbi +2 -4
- data/rbi/lib/lithic/models/auth_rules/auth_rule.rbi +9 -13
- data/rbi/lib/lithic/models/auth_rules/auth_rule_condition.rbi +48 -52
- data/rbi/lib/lithic/models/auth_rules/conditional_attribute.rbi +45 -46
- data/rbi/lib/lithic/models/auth_rules/conditional_block_parameters.rbi +2 -4
- data/rbi/lib/lithic/models/auth_rules/v2/backtest_create_params.rbi +2 -4
- data/rbi/lib/lithic/models/auth_rules/v2/backtest_create_response.rbi +2 -4
- data/rbi/lib/lithic/models/auth_rules/v2/backtest_results.rbi +40 -54
- data/rbi/lib/lithic/models/auth_rules/v2/backtest_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/auth_rules/v2_apply_params.rbi +1 -2
- data/rbi/lib/lithic/models/auth_rules/v2_apply_response.rbi +12 -23
- data/rbi/lib/lithic/models/auth_rules/v2_create_params.rbi +4 -9
- data/rbi/lib/lithic/models/auth_rules/v2_create_response.rbi +12 -23
- data/rbi/lib/lithic/models/auth_rules/v2_delete_params.rbi +2 -4
- data/rbi/lib/lithic/models/auth_rules/v2_draft_params.rbi +3 -6
- data/rbi/lib/lithic/models/auth_rules/v2_draft_response.rbi +12 -23
- data/rbi/lib/lithic/models/auth_rules/v2_list_params.rbi +4 -7
- data/rbi/lib/lithic/models/auth_rules/v2_list_response.rbi +12 -23
- data/rbi/lib/lithic/models/auth_rules/v2_promote_params.rbi +2 -4
- data/rbi/lib/lithic/models/auth_rules/v2_promote_response.rbi +12 -23
- data/rbi/lib/lithic/models/auth_rules/v2_report_params.rbi +2 -4
- data/rbi/lib/lithic/models/auth_rules/v2_report_response.rbi +2 -4
- data/rbi/lib/lithic/models/auth_rules/v2_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/auth_rules/v2_retrieve_response.rbi +12 -23
- data/rbi/lib/lithic/models/auth_rules/v2_update_params.rbi +9 -13
- data/rbi/lib/lithic/models/auth_rules/v2_update_response.rbi +12 -23
- data/rbi/lib/lithic/models/auth_rules/velocity_limit_params.rbi +19 -24
- data/rbi/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rbi +6 -7
- data/rbi/lib/lithic/models/auth_stream_enrollment_retrieve_secret_params.rbi +2 -4
- data/rbi/lib/lithic/models/auth_stream_enrollment_rotate_secret_params.rbi +2 -4
- data/rbi/lib/lithic/models/auth_stream_secret.rbi +2 -4
- data/rbi/lib/lithic/models/balance.rbi +7 -11
- data/rbi/lib/lithic/models/balance_list_params.rbi +4 -8
- data/rbi/lib/lithic/models/book_transfer_create_params.rbi +8 -13
- data/rbi/lib/lithic/models/book_transfer_list_params.rbi +10 -16
- data/rbi/lib/lithic/models/book_transfer_response.rbi +23 -33
- data/rbi/lib/lithic/models/book_transfer_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/book_transfer_reverse_params.rbi +2 -4
- data/rbi/lib/lithic/models/card.rbi +117 -127
- data/rbi/lib/lithic/models/card_convert_physical_params.rbi +27 -29
- data/rbi/lib/lithic/models/card_create_params.rbi +98 -104
- data/rbi/lib/lithic/models/card_embed_params.rbi +2 -4
- data/rbi/lib/lithic/models/card_list_params.rbi +7 -11
- data/rbi/lib/lithic/models/card_program.rbi +3 -6
- data/rbi/lib/lithic/models/card_program_list_params.rbi +4 -6
- data/rbi/lib/lithic/models/card_program_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/card_provision_params.rbi +14 -18
- data/rbi/lib/lithic/models/card_provision_response.rbi +2 -4
- data/rbi/lib/lithic/models/card_reissue_params.rbi +27 -29
- data/rbi/lib/lithic/models/card_renew_params.rbi +30 -34
- data/rbi/lib/lithic/models/card_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/card_retrieve_spend_limits_params.rbi +2 -4
- data/rbi/lib/lithic/models/card_search_by_pan_params.rbi +2 -4
- data/rbi/lib/lithic/models/card_spend_limits.rbi +14 -22
- data/rbi/lib/lithic/models/card_update_params.rbi +37 -42
- data/rbi/lib/lithic/models/cards/aggregate_balance_list_params.rbi +2 -4
- data/rbi/lib/lithic/models/cards/aggregate_balance_list_response.rbi +6 -9
- data/rbi/lib/lithic/models/cards/balance_list_params.rbi +4 -6
- data/rbi/lib/lithic/models/cards/balance_list_response.rbi +7 -11
- data/rbi/lib/lithic/models/cards/financial_transaction_list_params.rbi +9 -15
- data/rbi/lib/lithic/models/cards/financial_transaction_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/carrier.rbi +2 -4
- data/rbi/lib/lithic/models/client_api_status_params.rbi +2 -4
- data/rbi/lib/lithic/models/credit_products/extended_credit.rbi +2 -4
- data/rbi/lib/lithic/models/credit_products/extended_credit_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/credit_products/prime_rate_create_params.rbi +2 -4
- data/rbi/lib/lithic/models/credit_products/prime_rate_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/credit_products/prime_rate_retrieve_response.rbi +4 -8
- data/rbi/lib/lithic/models/digital_card_art.rbi +2 -4
- data/rbi/lib/lithic/models/digital_card_art_list_params.rbi +4 -6
- data/rbi/lib/lithic/models/digital_card_art_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/dispute.rbi +93 -99
- data/rbi/lib/lithic/models/dispute_create_params.rbi +2 -4
- data/rbi/lib/lithic/models/dispute_delete_evidence_params.rbi +2 -4
- data/rbi/lib/lithic/models/dispute_delete_params.rbi +2 -4
- data/rbi/lib/lithic/models/dispute_evidence.rbi +13 -15
- data/rbi/lib/lithic/models/dispute_initiate_evidence_upload_params.rbi +2 -4
- data/rbi/lib/lithic/models/dispute_list_evidences_params.rbi +5 -6
- data/rbi/lib/lithic/models/dispute_list_params.rbi +7 -11
- data/rbi/lib/lithic/models/dispute_retrieve_evidence_params.rbi +2 -4
- data/rbi/lib/lithic/models/dispute_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/dispute_update_params.rbi +2 -4
- data/rbi/lib/lithic/models/document.rbi +13 -21
- data/rbi/lib/lithic/models/event.rbi +58 -61
- data/rbi/lib/lithic/models/event_list_attempts_params.rbi +7 -11
- data/rbi/lib/lithic/models/event_list_params.rbi +7 -11
- data/rbi/lib/lithic/models/event_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/event_subscription.rbi +3 -6
- data/rbi/lib/lithic/models/events/event_subscription_resend_params.rbi +27 -0
- data/rbi/lib/lithic/models/events/subscription_create_params.rbi +4 -7
- data/rbi/lib/lithic/models/events/subscription_delete_params.rbi +2 -4
- data/rbi/lib/lithic/models/events/subscription_list_attempts_params.rbi +7 -11
- data/rbi/lib/lithic/models/events/subscription_list_params.rbi +4 -6
- data/rbi/lib/lithic/models/events/subscription_recover_params.rbi +4 -6
- data/rbi/lib/lithic/models/events/subscription_replay_missing_params.rbi +4 -6
- data/rbi/lib/lithic/models/events/subscription_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/events/subscription_retrieve_secret_params.rbi +2 -4
- data/rbi/lib/lithic/models/events/subscription_retrieve_secret_response.rbi +2 -4
- data/rbi/lib/lithic/models/events/subscription_rotate_secret_params.rbi +2 -4
- data/rbi/lib/lithic/models/events/subscription_send_simulated_example_params.rbi +3 -6
- data/rbi/lib/lithic/models/events/subscription_update_params.rbi +4 -7
- data/rbi/lib/lithic/models/external_bank_account_address.rbi +2 -4
- data/rbi/lib/lithic/models/external_bank_account_create_params.rbi +8 -13
- data/rbi/lib/lithic/models/external_bank_account_create_response.rbi +18 -26
- data/rbi/lib/lithic/models/external_bank_account_list_params.rbi +7 -13
- data/rbi/lib/lithic/models/external_bank_account_list_response.rbi +18 -26
- data/rbi/lib/lithic/models/external_bank_account_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/external_bank_account_retrieve_response.rbi +18 -26
- data/rbi/lib/lithic/models/external_bank_account_retry_micro_deposits_params.rbi +2 -4
- data/rbi/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rbi +18 -26
- data/rbi/lib/lithic/models/external_bank_account_retry_prenote_params.rbi +2 -4
- data/rbi/lib/lithic/models/external_bank_account_retry_prenote_response.rbi +16 -22
- data/rbi/lib/lithic/models/external_bank_account_update_params.rbi +4 -8
- data/rbi/lib/lithic/models/external_bank_account_update_response.rbi +18 -26
- data/rbi/lib/lithic/models/external_bank_accounts/micro_deposit_create_params.rbi +2 -4
- data/rbi/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi +18 -26
- data/rbi/lib/lithic/models/external_payment.rbi +10 -21
- data/rbi/lib/lithic/models/external_payment_cancel_params.rbi +2 -4
- data/rbi/lib/lithic/models/external_payment_create_params.rbi +5 -11
- data/rbi/lib/lithic/models/external_payment_list_params.rbi +10 -16
- data/rbi/lib/lithic/models/external_payment_release_params.rbi +2 -4
- data/rbi/lib/lithic/models/external_payment_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/external_payment_reverse_params.rbi +2 -4
- data/rbi/lib/lithic/models/external_payment_settle_params.rbi +3 -6
- data/rbi/lib/lithic/models/financial_account.rbi +26 -39
- data/rbi/lib/lithic/models/financial_account_create_params.rbi +2 -4
- data/rbi/lib/lithic/models/financial_account_list_params.rbi +3 -6
- data/rbi/lib/lithic/models/financial_account_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/financial_account_update_params.rbi +2 -4
- data/rbi/lib/lithic/models/financial_account_update_status_params.rbi +18 -37
- data/rbi/lib/lithic/models/financial_accounts/balance_list_params.rbi +4 -6
- data/rbi/lib/lithic/models/financial_accounts/balance_list_response.rbi +7 -11
- data/rbi/lib/lithic/models/financial_accounts/credit_configuration_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/financial_accounts/credit_configuration_update_params.rbi +2 -5
- data/rbi/lib/lithic/models/financial_accounts/financial_account_credit_config.rbi +4 -9
- data/rbi/lib/lithic/models/financial_accounts/financial_transaction_list_params.rbi +9 -15
- data/rbi/lib/lithic/models/financial_accounts/financial_transaction_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/financial_accounts/loan_tape.rbi +67 -107
- data/rbi/lib/lithic/models/financial_accounts/loan_tape_list_params.rbi +5 -6
- data/rbi/lib/lithic/models/financial_accounts/loan_tape_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/financial_accounts/statement.rbi +46 -72
- data/rbi/lib/lithic/models/financial_accounts/statement_list_params.rbi +6 -9
- data/rbi/lib/lithic/models/financial_accounts/statement_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/financial_accounts/statements/line_item_list_params.rbi +3 -4
- data/rbi/lib/lithic/models/financial_accounts/statements/statement_line_items.rbi +12 -14
- data/rbi/lib/lithic/models/financial_accounts/statements.rbi +2 -4
- data/rbi/lib/lithic/models/financial_transaction.rbi +44 -53
- data/rbi/lib/lithic/models/instance_financial_account_type.rbi +1 -2
- data/rbi/lib/lithic/models/kyb.rbi +139 -153
- data/rbi/lib/lithic/models/kyb_business_entity.rbi +13 -18
- data/rbi/lib/lithic/models/kyc.rbi +17 -22
- data/rbi/lib/lithic/models/kyc_exempt.rbi +8 -13
- data/rbi/lib/lithic/models/management_operation_create_params.rbi +5 -11
- data/rbi/lib/lithic/models/management_operation_list_params.rbi +9 -14
- data/rbi/lib/lithic/models/management_operation_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/management_operation_reverse_params.rbi +2 -4
- data/rbi/lib/lithic/models/management_operation_transaction.rbi +60 -20
- data/rbi/lib/lithic/models/message_attempt.rbi +3 -5
- data/rbi/lib/lithic/models/owner_type.rbi +1 -2
- data/rbi/lib/lithic/models/payment.rbi +85 -89
- data/rbi/lib/lithic/models/payment_create_params.rbi +8 -16
- data/rbi/lib/lithic/models/payment_create_response.rbi +2 -4
- data/rbi/lib/lithic/models/payment_list_params.rbi +9 -15
- data/rbi/lib/lithic/models/payment_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/payment_retry_params.rbi +2 -4
- data/rbi/lib/lithic/models/payment_retry_response.rbi +2 -4
- data/rbi/lib/lithic/models/payment_simulate_action_params.rbi +4 -8
- data/rbi/lib/lithic/models/payment_simulate_action_response.rbi +3 -6
- data/rbi/lib/lithic/models/payment_simulate_receipt_params.rbi +2 -4
- data/rbi/lib/lithic/models/payment_simulate_receipt_response.rbi +3 -6
- data/rbi/lib/lithic/models/payment_simulate_release_params.rbi +2 -4
- data/rbi/lib/lithic/models/payment_simulate_release_response.rbi +3 -6
- data/rbi/lib/lithic/models/payment_simulate_return_params.rbi +2 -4
- data/rbi/lib/lithic/models/payment_simulate_return_response.rbi +3 -6
- data/rbi/lib/lithic/models/reports/settlement/network_total_list_params.rbi +8 -12
- data/rbi/lib/lithic/models/reports/settlement/network_total_list_response.rbi +12 -18
- data/rbi/lib/lithic/models/reports/settlement/network_total_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/reports/settlement/network_total_retrieve_response.rbi +12 -18
- data/rbi/lib/lithic/models/reports/settlement_list_details_params.rbi +4 -6
- data/rbi/lib/lithic/models/reports/settlement_summary_params.rbi +2 -4
- data/rbi/lib/lithic/models/required_document.rbi +4 -6
- data/rbi/lib/lithic/models/responder_endpoint_check_status_params.rbi +3 -6
- data/rbi/lib/lithic/models/responder_endpoint_create_params.rbi +3 -6
- data/rbi/lib/lithic/models/responder_endpoint_create_response.rbi +2 -4
- data/rbi/lib/lithic/models/responder_endpoint_delete_params.rbi +3 -6
- data/rbi/lib/lithic/models/responder_endpoint_status.rbi +2 -4
- data/rbi/lib/lithic/models/settlement_detail.rbi +11 -18
- data/rbi/lib/lithic/models/settlement_report.rbi +17 -20
- data/rbi/lib/lithic/models/settlement_summary_details.rbi +6 -10
- data/rbi/lib/lithic/models/shipping_address.rbi +11 -14
- data/rbi/lib/lithic/models/spend_limit_duration.rbi +11 -12
- data/rbi/lib/lithic/models/three_ds/authentication_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/three_ds/authentication_retrieve_response.rbi +137 -176
- data/rbi/lib/lithic/models/three_ds/authentication_simulate_otp_entry_params.rbi +3 -5
- data/rbi/lib/lithic/models/three_ds/authentication_simulate_params.rbi +14 -21
- data/rbi/lib/lithic/models/three_ds/authentication_simulate_response.rbi +3 -5
- data/rbi/lib/lithic/models/three_ds/challenge_response.rbi +5 -7
- data/rbi/lib/lithic/models/three_ds/challenge_result.rbi +1 -2
- data/rbi/lib/lithic/models/three_ds/decisioning_challenge_response_params.rbi +2 -4
- data/rbi/lib/lithic/models/three_ds/decisioning_retrieve_secret_params.rbi +2 -4
- data/rbi/lib/lithic/models/three_ds/decisioning_retrieve_secret_response.rbi +2 -4
- data/rbi/lib/lithic/models/three_ds/decisioning_rotate_secret_params.rbi +2 -4
- data/rbi/lib/lithic/models/tokenization.rbi +14 -24
- data/rbi/lib/lithic/models/tokenization_activate_params.rbi +2 -4
- data/rbi/lib/lithic/models/tokenization_deactivate_params.rbi +2 -4
- data/rbi/lib/lithic/models/tokenization_decisioning_retrieve_secret_params.rbi +2 -4
- data/rbi/lib/lithic/models/tokenization_decisioning_rotate_secret_params.rbi +2 -4
- data/rbi/lib/lithic/models/tokenization_decisioning_rotate_secret_response.rbi +2 -4
- data/rbi/lib/lithic/models/tokenization_list_params.rbi +7 -11
- data/rbi/lib/lithic/models/tokenization_pause_params.rbi +2 -4
- data/rbi/lib/lithic/models/tokenization_resend_activation_code_params.rbi +7 -10
- data/rbi/lib/lithic/models/tokenization_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/tokenization_retrieve_response.rbi +2 -4
- data/rbi/lib/lithic/models/tokenization_secret.rbi +2 -4
- data/rbi/lib/lithic/models/tokenization_simulate_params.rbi +7 -12
- data/rbi/lib/lithic/models/tokenization_simulate_response.rbi +2 -4
- data/rbi/lib/lithic/models/tokenization_unpause_params.rbi +2 -4
- data/rbi/lib/lithic/models/tokenization_update_digital_card_art_params.rbi +5 -7
- data/rbi/lib/lithic/models/tokenization_update_digital_card_art_response.rbi +2 -4
- data/rbi/lib/lithic/models/transaction.rbi +168 -236
- data/rbi/lib/lithic/models/transaction_expire_authorization_params.rbi +2 -4
- data/rbi/lib/lithic/models/transaction_list_params.rbi +10 -15
- data/rbi/lib/lithic/models/transaction_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/transaction_simulate_authorization_advice_params.rbi +3 -5
- data/rbi/lib/lithic/models/transaction_simulate_authorization_advice_response.rbi +2 -4
- data/rbi/lib/lithic/models/transaction_simulate_authorization_params.rbi +41 -45
- data/rbi/lib/lithic/models/transaction_simulate_authorization_response.rbi +3 -5
- data/rbi/lib/lithic/models/transaction_simulate_clearing_params.rbi +9 -11
- data/rbi/lib/lithic/models/transaction_simulate_clearing_response.rbi +2 -4
- data/rbi/lib/lithic/models/transaction_simulate_credit_authorization_params.rbi +6 -8
- data/rbi/lib/lithic/models/transaction_simulate_credit_authorization_response.rbi +2 -4
- data/rbi/lib/lithic/models/transaction_simulate_return_params.rbi +2 -4
- data/rbi/lib/lithic/models/transaction_simulate_return_response.rbi +2 -4
- data/rbi/lib/lithic/models/transaction_simulate_return_reversal_params.rbi +2 -4
- data/rbi/lib/lithic/models/transaction_simulate_return_reversal_response.rbi +2 -4
- data/rbi/lib/lithic/models/transaction_simulate_void_params.rbi +10 -13
- data/rbi/lib/lithic/models/transaction_simulate_void_response.rbi +2 -4
- data/rbi/lib/lithic/models/transactions/enhanced_commercial_data_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/transactions/enhanced_commercial_data_retrieve_response.rbi +2 -4
- data/rbi/lib/lithic/models/transactions/events/enhanced_commercial_data_retrieve_params.rbi +2 -4
- data/rbi/lib/lithic/models/transactions/events/enhanced_data.rbi +21 -35
- data/rbi/lib/lithic/models/transfer.rbi +34 -43
- data/rbi/lib/lithic/models/transfer_create_params.rbi +6 -8
- data/rbi/lib/lithic/models/verification_method.rbi +1 -2
- data/rbi/lib/lithic/request_options.rbi +9 -11
- data/rbi/lib/lithic/resources/account_holders.rbi +121 -156
- data/rbi/lib/lithic/resources/accounts.rbi +26 -35
- data/rbi/lib/lithic/resources/aggregate_balances.rbi +3 -6
- data/rbi/lib/lithic/resources/auth_rules/v2/backtests.rbi +40 -45
- data/rbi/lib/lithic/resources/auth_rules/v2.rbi +69 -88
- data/rbi/lib/lithic/resources/auth_rules.rbi +1 -2
- data/rbi/lib/lithic/resources/auth_stream_enrollment.rbi +11 -14
- data/rbi/lib/lithic/resources/balances.rbi +3 -6
- data/rbi/lib/lithic/resources/book_transfers.rbi +15 -24
- data/rbi/lib/lithic/resources/card_programs.rbi +5 -10
- data/rbi/lib/lithic/resources/cards/aggregate_balances.rbi +2 -5
- data/rbi/lib/lithic/resources/cards/balances.rbi +4 -7
- data/rbi/lib/lithic/resources/cards/financial_transactions.rbi +7 -12
- data/rbi/lib/lithic/resources/cards.rbi +219 -237
- data/rbi/lib/lithic/resources/credit_products/extended_credit.rbi +2 -5
- data/rbi/lib/lithic/resources/credit_products/prime_rates.rbi +3 -8
- data/rbi/lib/lithic/resources/credit_products.rbi +1 -2
- data/rbi/lib/lithic/resources/digital_card_art.rbi +8 -13
- data/rbi/lib/lithic/resources/disputes.rbi +22 -37
- data/rbi/lib/lithic/resources/events/event_subscriptions.rbi +24 -0
- data/rbi/lib/lithic/resources/events/subscriptions.rbi +29 -48
- data/rbi/lib/lithic/resources/events.rbi +15 -18
- data/rbi/lib/lithic/resources/external_bank_accounts/micro_deposits.rbi +2 -4
- data/rbi/lib/lithic/resources/external_bank_accounts.rbi +18 -23
- data/rbi/lib/lithic/resources/external_payments.rbi +13 -28
- data/rbi/lib/lithic/resources/financial_accounts/balances.rbi +4 -7
- data/rbi/lib/lithic/resources/financial_accounts/credit_configuration.rbi +3 -8
- data/rbi/lib/lithic/resources/financial_accounts/financial_transactions.rbi +7 -12
- data/rbi/lib/lithic/resources/financial_accounts/loan_tapes.rbi +7 -12
- data/rbi/lib/lithic/resources/financial_accounts/statements/line_items.rbi +5 -8
- data/rbi/lib/lithic/resources/financial_accounts/statements.rbi +7 -12
- data/rbi/lib/lithic/resources/financial_accounts.rbi +10 -19
- data/rbi/lib/lithic/resources/management_operations.rbi +10 -19
- data/rbi/lib/lithic/resources/payments.rbi +14 -29
- data/rbi/lib/lithic/resources/reports/settlement/network_totals.rbi +8 -13
- data/rbi/lib/lithic/resources/reports/settlement.rbi +5 -10
- data/rbi/lib/lithic/resources/reports.rbi +1 -2
- data/rbi/lib/lithic/resources/responder_endpoints.rbi +4 -11
- data/rbi/lib/lithic/resources/three_ds/authentication.rbi +12 -19
- data/rbi/lib/lithic/resources/three_ds/decisioning.rbi +15 -20
- data/rbi/lib/lithic/resources/three_ds.rbi +1 -2
- data/rbi/lib/lithic/resources/tokenization_decisioning.rbi +10 -13
- data/rbi/lib/lithic/resources/tokenizations.rbi +66 -85
- data/rbi/lib/lithic/resources/transactions/enhanced_commercial_data.rbi +3 -6
- data/rbi/lib/lithic/resources/transactions/events/enhanced_commercial_data.rbi +3 -6
- data/rbi/lib/lithic/resources/transactions/events.rbi +1 -2
- data/rbi/lib/lithic/resources/transactions.rbi +79 -100
- data/rbi/lib/lithic/resources/transfers.rbi +7 -10
- data/rbi/lib/lithic/version.rbi +1 -1
- data/sig/lithic/internal/type/array_of.rbs +2 -2
- data/sig/lithic/internal/type/{boolean_model.rbs → boolean.rbs} +1 -1
- data/sig/lithic/internal/util.rbs +5 -5
- data/sig/lithic/models/account_holder_create_params.rbs +47 -43
- data/sig/lithic/models/card_convert_physical_params.rbs +2 -2
- data/sig/lithic/models/card_reissue_params.rbs +2 -2
- data/sig/lithic/models/card_renew_params.rbs +2 -2
- data/sig/lithic/models/events/event_subscription_resend_params.rbs +22 -0
- data/sig/lithic/models/financial_account.rbs +6 -6
- data/sig/lithic/models/financial_account_update_status_params.rbs +6 -6
- data/sig/lithic/models/financial_accounts/loan_tape.rbs +6 -6
- data/sig/lithic/models/financial_accounts/statement.rbs +6 -6
- data/sig/lithic/models/financial_accounts/statements/statement_line_items.rbs +2 -0
- data/sig/lithic/models/financial_transaction.rbs +2 -0
- data/sig/lithic/models/kyb.rbs +47 -43
- data/sig/lithic/models/management_operation_transaction.rbs +27 -0
- data/sig/lithic/models/payment.rbs +8 -2
- data/sig/lithic/models/transfer.rbs +2 -0
- data/sig/lithic/resources/account_holders.rbs +1 -1
- data/sig/lithic/resources/events/event_subscriptions.rbs +15 -0
- data/sig/lithic/resources/events.rbs +2 -0
- data/sig/lithic/resources/financial_accounts.rbs +1 -1
- data/sig/lithic/version.rbs +1 -1
- metadata +11 -5
@@ -10,10 +10,10 @@ module Lithic
|
|
10
10
|
|
11
11
|
# @!attribute amount
|
12
12
|
# Amount (in cents) to authorize. For credit authorizations and financial credit
|
13
|
-
#
|
14
|
-
#
|
15
|
-
#
|
16
|
-
#
|
13
|
+
# authorizations, any value entered will be converted into a negative amount in
|
14
|
+
# the simulated transaction. For example, entering 100 in this field will result
|
15
|
+
# in a -100 amount in the transaction. For balance inquiries, this field must be
|
16
|
+
# set to 0.
|
17
17
|
#
|
18
18
|
# @return [Integer]
|
19
19
|
required :amount, Integer
|
@@ -32,8 +32,8 @@ module Lithic
|
|
32
32
|
|
33
33
|
# @!attribute [r] mcc
|
34
34
|
# Merchant category code for the transaction to be simulated. A four-digit number
|
35
|
-
#
|
36
|
-
#
|
35
|
+
# listed in ISO 18245. Supported merchant category codes can be found
|
36
|
+
# [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
|
37
37
|
#
|
38
38
|
# @return [String, nil]
|
39
39
|
optional :mcc, String
|
@@ -54,7 +54,7 @@ module Lithic
|
|
54
54
|
|
55
55
|
# @!attribute [r] merchant_amount
|
56
56
|
# Amount of the transaction to be simulated in currency specified in
|
57
|
-
#
|
57
|
+
# merchant_currency, including any acquirer fees.
|
58
58
|
#
|
59
59
|
# @return [Integer, nil]
|
60
60
|
optional :merchant_amount, Integer
|
@@ -65,7 +65,7 @@ module Lithic
|
|
65
65
|
|
66
66
|
# @!attribute [r] merchant_currency
|
67
67
|
# 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
|
68
|
-
#
|
68
|
+
# GBP, EUR and defaults to GBP if another ISO 4217 code is provided
|
69
69
|
#
|
70
70
|
# @return [String, nil]
|
71
71
|
optional :merchant_currency, String
|
@@ -76,11 +76,11 @@ module Lithic
|
|
76
76
|
|
77
77
|
# @!attribute [r] partial_approval_capable
|
78
78
|
# Set to true if the terminal is capable of partial approval otherwise false.
|
79
|
-
#
|
80
|
-
#
|
79
|
+
# Partial approval is when part of a transaction is approved and another payment
|
80
|
+
# must be used for the remainder.
|
81
81
|
#
|
82
82
|
# @return [Boolean, nil]
|
83
|
-
optional :partial_approval_capable, Lithic::Internal::Type::
|
83
|
+
optional :partial_approval_capable, Lithic::Internal::Type::Boolean
|
84
84
|
|
85
85
|
# @!parse
|
86
86
|
# # @return [Boolean]
|
@@ -99,20 +99,20 @@ module Lithic
|
|
99
99
|
# @!attribute [r] status
|
100
100
|
# Type of event to simulate.
|
101
101
|
#
|
102
|
-
#
|
103
|
-
#
|
104
|
-
#
|
105
|
-
#
|
106
|
-
#
|
107
|
-
#
|
108
|
-
#
|
109
|
-
#
|
110
|
-
#
|
111
|
-
#
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
115
|
-
#
|
102
|
+
# - `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent
|
103
|
+
# clearing step is required to settle the transaction.
|
104
|
+
# - `BALANCE_INQUIRY` is a $0 authorization requesting the balance held on the
|
105
|
+
# card, and is most often observed when a cardholder requests to view a card's
|
106
|
+
# balance at an ATM.
|
107
|
+
# - `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize
|
108
|
+
# a refund, meaning a subsequent clearing step is required to settle the
|
109
|
+
# transaction.
|
110
|
+
# - `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit
|
111
|
+
# funds immediately (such as an ATM withdrawal), and no subsequent clearing is
|
112
|
+
# required to settle the transaction.
|
113
|
+
# - `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant
|
114
|
+
# to credit funds immediately, and no subsequent clearing is required to settle
|
115
|
+
# the transaction.
|
116
116
|
#
|
117
117
|
# @return [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status, nil]
|
118
118
|
optional :status, enum: -> { Lithic::Models::TransactionSimulateAuthorizationParams::Status }
|
@@ -155,20 +155,20 @@ module Lithic
|
|
155
155
|
|
156
156
|
# Type of event to simulate.
|
157
157
|
#
|
158
|
-
#
|
159
|
-
#
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
166
|
-
#
|
167
|
-
#
|
168
|
-
#
|
169
|
-
#
|
170
|
-
#
|
171
|
-
#
|
158
|
+
# - `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent
|
159
|
+
# clearing step is required to settle the transaction.
|
160
|
+
# - `BALANCE_INQUIRY` is a $0 authorization requesting the balance held on the
|
161
|
+
# card, and is most often observed when a cardholder requests to view a card's
|
162
|
+
# balance at an ATM.
|
163
|
+
# - `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize
|
164
|
+
# a refund, meaning a subsequent clearing step is required to settle the
|
165
|
+
# transaction.
|
166
|
+
# - `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit
|
167
|
+
# funds immediately (such as an ATM withdrawal), and no subsequent clearing is
|
168
|
+
# required to settle the transaction.
|
169
|
+
# - `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant
|
170
|
+
# to credit funds immediately, and no subsequent clearing is required to settle
|
171
|
+
# the transaction.
|
172
172
|
module Status
|
173
173
|
extend Lithic::Internal::Type::Enum
|
174
174
|
|
@@ -6,7 +6,7 @@ module Lithic
|
|
6
6
|
class TransactionSimulateAuthorizationResponse < Lithic::Internal::Type::BaseModel
|
7
7
|
# @!attribute [r] token
|
8
8
|
# A unique token to reference this transaction with later calls to void or clear
|
9
|
-
#
|
9
|
+
# the authorization.
|
10
10
|
#
|
11
11
|
# @return [String, nil]
|
12
12
|
optional :token, String
|
@@ -16,14 +16,14 @@ module Lithic
|
|
16
16
|
|
17
17
|
# @!attribute [r] amount
|
18
18
|
# Amount (in cents) to clear. Typically this will match the amount in the original
|
19
|
-
#
|
20
|
-
#
|
21
|
-
#
|
22
|
-
#
|
19
|
+
# authorization, but can be higher or lower. The sign of this amount will
|
20
|
+
# automatically match the sign of the original authorization's amount. For
|
21
|
+
# example, entering 100 in this field will result in a -100 amount in the
|
22
|
+
# transaction, if the original authorization is a credit authorization.
|
23
23
|
#
|
24
|
-
#
|
25
|
-
#
|
26
|
-
#
|
24
|
+
# If `amount` is not set, the full amount of the transaction will be cleared.
|
25
|
+
# Transactions that have already cleared, either partially or fully, cannot be
|
26
|
+
# cleared again using this endpoint.
|
27
27
|
#
|
28
28
|
# @return [Integer, nil]
|
29
29
|
optional :amount, Integer
|
@@ -10,8 +10,8 @@ module Lithic
|
|
10
10
|
|
11
11
|
# @!attribute amount
|
12
12
|
# Amount (in cents). Any value entered will be converted into a negative amount in
|
13
|
-
#
|
14
|
-
#
|
13
|
+
# the simulated transaction. For example, entering 100 in this field will appear
|
14
|
+
# as a -100 amount in the transaction.
|
15
15
|
#
|
16
16
|
# @return [Integer]
|
17
17
|
required :amount, Integer
|
@@ -30,8 +30,8 @@ module Lithic
|
|
30
30
|
|
31
31
|
# @!attribute [r] mcc
|
32
32
|
# Merchant category code for the transaction to be simulated. A four-digit number
|
33
|
-
#
|
34
|
-
#
|
33
|
+
# listed in ISO 18245. Supported merchant category codes can be found
|
34
|
+
# [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
|
35
35
|
#
|
36
36
|
# @return [String, nil]
|
37
37
|
optional :mcc, String
|
@@ -16,7 +16,7 @@ module Lithic
|
|
16
16
|
|
17
17
|
# @!attribute [r] amount
|
18
18
|
# Amount (in cents) to void. Typically this will match the amount in the original
|
19
|
-
#
|
19
|
+
# authorization, but can be less.
|
20
20
|
#
|
21
21
|
# @return [Integer, nil]
|
22
22
|
optional :amount, Integer
|
@@ -28,9 +28,9 @@ module Lithic
|
|
28
28
|
# @!attribute [r] type
|
29
29
|
# Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.
|
30
30
|
#
|
31
|
-
#
|
32
|
-
#
|
33
|
-
#
|
31
|
+
# - `AUTHORIZATION_EXPIRY` indicates authorization has expired and been reversed
|
32
|
+
# by Lithic.
|
33
|
+
# - `AUTHORIZATION_REVERSAL` indicates authorization was reversed by the merchant.
|
34
34
|
#
|
35
35
|
# @return [Symbol, Lithic::Models::TransactionSimulateVoidParams::Type, nil]
|
36
36
|
optional :type, enum: -> { Lithic::Models::TransactionSimulateVoidParams::Type }
|
@@ -51,9 +51,9 @@ module Lithic
|
|
51
51
|
|
52
52
|
# Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.
|
53
53
|
#
|
54
|
-
#
|
55
|
-
#
|
56
|
-
#
|
54
|
+
# - `AUTHORIZATION_EXPIRY` indicates authorization has expired and been reversed
|
55
|
+
# by Lithic.
|
56
|
+
# - `AUTHORIZATION_REVERSAL` indicates authorization was reversed by the merchant.
|
57
57
|
module Type
|
58
58
|
extend Lithic::Internal::Type::Enum
|
59
59
|
|
@@ -227,7 +227,7 @@ module Lithic
|
|
227
227
|
|
228
228
|
# @!attribute [r] driver_number
|
229
229
|
# The driver number entered into the terminal at the time of sale, with leading
|
230
|
-
#
|
230
|
+
# zeros stripped.
|
231
231
|
#
|
232
232
|
# @return [String, nil]
|
233
233
|
optional :driver_number, String
|
@@ -259,7 +259,7 @@ module Lithic
|
|
259
259
|
|
260
260
|
# @!attribute [r] vehicle_number
|
261
261
|
# The vehicle number entered into the terminal at the time of sale, with leading
|
262
|
-
#
|
262
|
+
# zeros stripped.
|
263
263
|
#
|
264
264
|
# @return [String, nil]
|
265
265
|
optional :vehicle_number, String
|
@@ -17,8 +17,8 @@ module Lithic
|
|
17
17
|
# @!attribute [r] category
|
18
18
|
# Status types:
|
19
19
|
#
|
20
|
-
#
|
21
|
-
#
|
20
|
+
# - `TRANSFER` - Internal transfer of funds between financial accounts in your
|
21
|
+
# program.
|
22
22
|
#
|
23
23
|
# @return [Symbol, Lithic::Models::Transfer::Category, nil]
|
24
24
|
optional :category, enum: -> { Lithic::Models::Transfer::Category }
|
@@ -39,7 +39,7 @@ module Lithic
|
|
39
39
|
|
40
40
|
# @!attribute [r] currency
|
41
41
|
# 3-character alphabetic ISO 4217 code for the settling currency of the
|
42
|
-
#
|
42
|
+
# transaction.
|
43
43
|
#
|
44
44
|
# @return [String, nil]
|
45
45
|
optional :currency, String
|
@@ -50,7 +50,7 @@ module Lithic
|
|
50
50
|
|
51
51
|
# @!attribute [r] descriptor
|
52
52
|
# A string that provides a description of the transfer; may be useful to display
|
53
|
-
#
|
53
|
+
# to users.
|
54
54
|
#
|
55
55
|
# @return [String, nil]
|
56
56
|
optional :descriptor, String
|
@@ -81,8 +81,8 @@ module Lithic
|
|
81
81
|
|
82
82
|
# @!attribute [r] pending_amount
|
83
83
|
# Pending amount of the transaction in the currency's smallest unit (e.g., cents),
|
84
|
-
#
|
85
|
-
#
|
84
|
+
# including any acquirer fees. The value of this field will go to zero over time
|
85
|
+
# once the financial transaction is settled.
|
86
86
|
#
|
87
87
|
# @return [Integer, nil]
|
88
88
|
optional :pending_amount, Integer
|
@@ -93,7 +93,7 @@ module Lithic
|
|
93
93
|
|
94
94
|
# @!attribute [r] result
|
95
95
|
# APPROVED transactions were successful while DECLINED transactions were declined
|
96
|
-
#
|
96
|
+
# by user, Lithic, or the network.
|
97
97
|
#
|
98
98
|
# @return [Symbol, Lithic::Models::Transfer::Result, nil]
|
99
99
|
optional :result, enum: -> { Lithic::Models::Transfer::Result }
|
@@ -104,7 +104,7 @@ module Lithic
|
|
104
104
|
|
105
105
|
# @!attribute [r] settled_amount
|
106
106
|
# Amount of the transaction that has been settled in the currency's smallest unit
|
107
|
-
#
|
107
|
+
# (e.g., cents).
|
108
108
|
#
|
109
109
|
# @return [Integer, nil]
|
110
110
|
optional :settled_amount, Integer
|
@@ -116,11 +116,11 @@ module Lithic
|
|
116
116
|
# @!attribute [r] status
|
117
117
|
# Status types:
|
118
118
|
#
|
119
|
-
#
|
120
|
-
#
|
121
|
-
#
|
122
|
-
#
|
123
|
-
#
|
119
|
+
# - `DECLINED` - The transfer was declined.
|
120
|
+
# - `EXPIRED` - The transfer was held in pending for too long and expired.
|
121
|
+
# - `PENDING` - The transfer is pending release from a hold.
|
122
|
+
# - `SETTLED` - The transfer is completed.
|
123
|
+
# - `VOIDED` - The transfer was reversed before it settled.
|
124
124
|
#
|
125
125
|
# @return [Symbol, Lithic::Models::Transfer::Status, nil]
|
126
126
|
optional :status, enum: -> { Lithic::Models::Transfer::Status }
|
@@ -187,8 +187,8 @@ module Lithic
|
|
187
187
|
|
188
188
|
# Status types:
|
189
189
|
#
|
190
|
-
#
|
191
|
-
#
|
190
|
+
# - `TRANSFER` - Internal transfer of funds between financial accounts in your
|
191
|
+
# program.
|
192
192
|
#
|
193
193
|
# @see Lithic::Models::Transfer#category
|
194
194
|
module Category
|
@@ -216,7 +216,7 @@ module Lithic
|
|
216
216
|
|
217
217
|
# @!attribute [r] amount
|
218
218
|
# Amount of the financial event that has been settled in the currency's smallest
|
219
|
-
#
|
219
|
+
# unit (e.g., cents).
|
220
220
|
#
|
221
221
|
# @return [Integer, nil]
|
222
222
|
optional :amount, Integer
|
@@ -237,7 +237,7 @@ module Lithic
|
|
237
237
|
|
238
238
|
# @!attribute [r] result
|
239
239
|
# APPROVED financial events were successful while DECLINED financial events were
|
240
|
-
#
|
240
|
+
# declined by user, Lithic, or the network.
|
241
241
|
#
|
242
242
|
# @return [Symbol, Lithic::Models::Transfer::Event::Result, nil]
|
243
243
|
optional :result, enum: -> { Lithic::Models::Transfer::Event::Result }
|
@@ -267,7 +267,7 @@ module Lithic
|
|
267
267
|
# def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
|
268
268
|
|
269
269
|
# APPROVED financial events were successful while DECLINED financial events were
|
270
|
-
#
|
270
|
+
# declined by user, Lithic, or the network.
|
271
271
|
#
|
272
272
|
# @see Lithic::Models::Transfer::Event#result
|
273
273
|
module Result
|
@@ -343,6 +343,7 @@ module Lithic
|
|
343
343
|
INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
|
344
344
|
LATE_PAYMENT = :LATE_PAYMENT
|
345
345
|
LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL
|
346
|
+
LOSS_WRITE_OFF = :LOSS_WRITE_OFF
|
346
347
|
PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT
|
347
348
|
PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL
|
348
349
|
RETURN = :RETURN
|
@@ -361,7 +362,7 @@ module Lithic
|
|
361
362
|
end
|
362
363
|
|
363
364
|
# APPROVED transactions were successful while DECLINED transactions were declined
|
364
|
-
#
|
365
|
+
# by user, Lithic, or the network.
|
365
366
|
#
|
366
367
|
# @see Lithic::Models::Transfer#result
|
367
368
|
module Result
|
@@ -379,11 +380,11 @@ module Lithic
|
|
379
380
|
|
380
381
|
# Status types:
|
381
382
|
#
|
382
|
-
#
|
383
|
-
#
|
384
|
-
#
|
385
|
-
#
|
386
|
-
#
|
383
|
+
# - `DECLINED` - The transfer was declined.
|
384
|
+
# - `EXPIRED` - The transfer was held in pending for too long and expired.
|
385
|
+
# - `PENDING` - The transfer is pending release from a hold.
|
386
|
+
# - `SETTLED` - The transfer is completed.
|
387
|
+
# - `VOIDED` - The transfer was reversed before it settled.
|
387
388
|
#
|
388
389
|
# @see Lithic::Models::Transfer#status
|
389
390
|
module Status
|
@@ -10,28 +10,28 @@ module Lithic
|
|
10
10
|
|
11
11
|
# @!attribute amount
|
12
12
|
# Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
|
13
|
-
#
|
13
|
+
# This should always be a positive value.
|
14
14
|
#
|
15
15
|
# @return [Integer]
|
16
16
|
required :amount, Integer
|
17
17
|
|
18
18
|
# @!attribute from
|
19
19
|
# Globally unique identifier for the financial account or card that will send the
|
20
|
-
#
|
20
|
+
# funds. Accepted type dependent on the program's use case.
|
21
21
|
#
|
22
22
|
# @return [String]
|
23
23
|
required :from, String
|
24
24
|
|
25
25
|
# @!attribute to
|
26
26
|
# Globally unique identifier for the financial account or card that will receive
|
27
|
-
#
|
27
|
+
# the funds. Accepted type dependent on the program's use case.
|
28
28
|
#
|
29
29
|
# @return [String]
|
30
30
|
required :to, String
|
31
31
|
|
32
32
|
# @!attribute [r] token
|
33
33
|
# Customer-provided token that will serve as an idempotency token. This token will
|
34
|
-
#
|
34
|
+
# become the transaction token.
|
35
35
|
#
|
36
36
|
# @return [String, nil]
|
37
37
|
optional :token, String
|
@@ -2,10 +2,10 @@
|
|
2
2
|
|
3
3
|
module Lithic
|
4
4
|
# Specify HTTP behaviour to use for a specific request. These options supplement
|
5
|
-
#
|
5
|
+
# or override those provided at the client level.
|
6
6
|
#
|
7
|
-
#
|
8
|
-
#
|
7
|
+
# When making a request, you can pass an actual {RequestOptions} instance, or
|
8
|
+
# simply pass a Hash with symbol keys matching the attributes on this class.
|
9
9
|
class RequestOptions < Lithic::Internal::Type::BaseModel
|
10
10
|
# @api private
|
11
11
|
#
|
@@ -27,28 +27,28 @@ module Lithic
|
|
27
27
|
|
28
28
|
# @!attribute idempotency_key
|
29
29
|
# Idempotency key to send with request and all associated retries. Will only be
|
30
|
-
#
|
30
|
+
# sent for write requests.
|
31
31
|
#
|
32
32
|
# @return [String, nil]
|
33
33
|
optional :idempotency_key, String
|
34
34
|
|
35
35
|
# @!attribute extra_query
|
36
36
|
# Extra query params to send with the request. These are `.merge`’d into any
|
37
|
-
#
|
37
|
+
# `query` given at the client level.
|
38
38
|
#
|
39
39
|
# @return [Hash{String=>Array<String>, String, nil}, nil]
|
40
40
|
optional :extra_query, Lithic::Internal::Type::HashOf[Lithic::Internal::Type::ArrayOf[String]]
|
41
41
|
|
42
42
|
# @!attribute extra_headers
|
43
43
|
# Extra headers to send with the request. These are `.merged`’d into any
|
44
|
-
#
|
44
|
+
# `extra_headers` given at the client level.
|
45
45
|
#
|
46
46
|
# @return [Hash{String=>String, nil}, nil]
|
47
47
|
optional :extra_headers, Lithic::Internal::Type::HashOf[String, nil?: true]
|
48
48
|
|
49
49
|
# @!attribute extra_body
|
50
50
|
# Extra data to send with the request. These are deep merged into any data
|
51
|
-
#
|
51
|
+
# generated as part of the normal request.
|
52
52
|
#
|
53
53
|
# @return [Object, nil]
|
54
54
|
optional :extra_body, Lithic::Internal::Type::HashOf[Lithic::Internal::Type::Unknown]
|
@@ -4,16 +4,15 @@ module Lithic
|
|
4
4
|
module Resources
|
5
5
|
class AccountHolders
|
6
6
|
# Create an account holder and initiate the appropriate onboarding workflow.
|
7
|
-
#
|
8
|
-
#
|
9
|
-
#
|
10
|
-
#
|
11
|
-
#
|
12
|
-
#
|
7
|
+
# Account holders and accounts have a 1:1 relationship. When an account holder is
|
8
|
+
# successfully created an associated account is also created. All calls to this
|
9
|
+
# endpoint will return an immediate response - though in some cases, the response
|
10
|
+
# may indicate the enrollment is under review or further action will be needed to
|
11
|
+
# complete the account enrollment process. This endpoint can only be used on
|
12
|
+
# accounts that are part of the program that the calling API key manages.
|
13
13
|
#
|
14
|
-
# @overload create(
|
14
|
+
# @overload create(beneficial_owner_individuals:, business_entity:, control_person:, nature_of_business:, tos_timestamp:, workflow:, individual:, address:, email:, first_name:, kyc_exemption_type:, last_name:, phone_number:, beneficial_owner_entities: nil, external_id: nil, kyb_passed_timestamp: nil, website_url: nil, kyc_passed_timestamp: nil, business_account_token: nil, request_options: {})
|
15
15
|
#
|
16
|
-
# @param beneficial_owner_entities [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerEntity>]
|
17
16
|
# @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual>]
|
18
17
|
# @param business_entity [Lithic::Models::AccountHolderCreateParams::BusinessEntity]
|
19
18
|
# @param control_person [Lithic::Models::AccountHolderCreateParams::ControlPerson]
|
@@ -27,6 +26,7 @@ module Lithic
|
|
27
26
|
# @param kyc_exemption_type [Symbol, Lithic::Models::AccountHolderCreateParams::KYCExemptionType]
|
28
27
|
# @param last_name [String]
|
29
28
|
# @param phone_number [String]
|
29
|
+
# @param beneficial_owner_entities [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerEntity>]
|
30
30
|
# @param external_id [String]
|
31
31
|
# @param kyb_passed_timestamp [String]
|
32
32
|
# @param website_url [String]
|
@@ -49,7 +49,7 @@ module Lithic
|
|
49
49
|
end
|
50
50
|
|
51
51
|
# Get an Individual or Business Account Holder and/or their KYC or KYB evaluation
|
52
|
-
#
|
52
|
+
# status.
|
53
53
|
#
|
54
54
|
# @overload retrieve(account_holder_token, request_options: {})
|
55
55
|
#
|
@@ -69,14 +69,14 @@ module Lithic
|
|
69
69
|
end
|
70
70
|
|
71
71
|
# Update the information associated with a particular account holder (including
|
72
|
-
#
|
73
|
-
#
|
74
|
-
#
|
75
|
-
#
|
76
|
-
#
|
77
|
-
#
|
78
|
-
#
|
79
|
-
#
|
72
|
+
# business owners and control persons associated to a business account). If Lithic
|
73
|
+
# is performing KYB or KYC and additional verification is required we will run the
|
74
|
+
# individual's or business's updated information again and return whether the
|
75
|
+
# status is accepted or pending (i.e., further action required). All calls to this
|
76
|
+
# endpoint will return an immediate response - though in some cases, the response
|
77
|
+
# may indicate the workflow is under review or further action will be needed to
|
78
|
+
# complete the evaluation process. This endpoint can only be used on existing
|
79
|
+
# accounts that are part of the program that the calling API key manages.
|
80
80
|
#
|
81
81
|
# @overload update(account_holder_token, beneficial_owner_entities: nil, beneficial_owner_individuals: nil, business_entity: nil, control_person: nil, external_id: nil, nature_of_business: nil, website_url: nil, individual: nil, address: nil, business_account_token: nil, email: nil, first_name: nil, last_name: nil, legal_business_name: nil, phone_number: nil, request_options: {})
|
82
82
|
#
|
@@ -113,7 +113,7 @@ module Lithic
|
|
113
113
|
end
|
114
114
|
|
115
115
|
# Get a list of individual or business account holders and their KYC or KYB
|
116
|
-
#
|
116
|
+
# evaluation status.
|
117
117
|
#
|
118
118
|
# @overload list(begin_: nil, email: nil, end_: nil, ending_before: nil, external_id: nil, first_name: nil, last_name: nil, legal_business_name: nil, limit: nil, phone_number: nil, starting_after: nil, request_options: {})
|
119
119
|
#
|
@@ -138,7 +138,7 @@ module Lithic
|
|
138
138
|
@client.request(
|
139
139
|
method: :get,
|
140
140
|
path: "v1/account_holders",
|
141
|
-
query: parsed,
|
141
|
+
query: parsed.transform_keys(begin_: "begin", end_: "end"),
|
142
142
|
page: Lithic::Internal::SinglePage,
|
143
143
|
model: Lithic::Models::AccountHolder,
|
144
144
|
options: options
|
@@ -146,20 +146,20 @@ module Lithic
|
|
146
146
|
end
|
147
147
|
|
148
148
|
# Retrieve the status of account holder document uploads, or retrieve the upload
|
149
|
-
#
|
149
|
+
# URLs to process your image uploads.
|
150
150
|
#
|
151
|
-
#
|
152
|
-
#
|
153
|
-
#
|
151
|
+
# Note that this is not equivalent to checking the status of the KYC evaluation
|
152
|
+
# overall (a document may be successfully uploaded but not be sufficient for KYC
|
153
|
+
# to pass).
|
154
154
|
#
|
155
|
-
#
|
156
|
-
#
|
157
|
-
#
|
158
|
-
#
|
155
|
+
# In the event your upload URLs have expired, calling this endpoint will refresh
|
156
|
+
# them. Similarly, in the event a previous account holder document upload has
|
157
|
+
# failed, you can use this endpoint to get a new upload URL for the failed image
|
158
|
+
# upload.
|
159
159
|
#
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
160
|
+
# When a new document upload is generated for a failed attempt, the response will
|
161
|
+
# show an additional entry in the `required_document_uploads` list in a `PENDING`
|
162
|
+
# state for the corresponding `image_type`.
|
163
163
|
#
|
164
164
|
# @overload list_documents(account_holder_token, request_options: {})
|
165
165
|
#
|
@@ -179,19 +179,19 @@ module Lithic
|
|
179
179
|
end
|
180
180
|
|
181
181
|
# Check the status of an account holder document upload, or retrieve the upload
|
182
|
-
#
|
182
|
+
# URLs to process your image uploads.
|
183
183
|
#
|
184
|
-
#
|
185
|
-
#
|
186
|
-
#
|
184
|
+
# Note that this is not equivalent to checking the status of the KYC evaluation
|
185
|
+
# overall (a document may be successfully uploaded but not be sufficient for KYC
|
186
|
+
# to pass).
|
187
187
|
#
|
188
|
-
#
|
189
|
-
#
|
190
|
-
#
|
188
|
+
# In the event your upload URLs have expired, calling this endpoint will refresh
|
189
|
+
# them. Similarly, in the event a document upload has failed, you can use this
|
190
|
+
# endpoint to get a new upload URL for the failed image upload.
|
191
191
|
#
|
192
|
-
#
|
193
|
-
#
|
194
|
-
#
|
192
|
+
# When a new account holder document upload is generated for a failed attempt, the
|
193
|
+
# response will show an additional entry in the `required_document_uploads` array
|
194
|
+
# in a `PENDING` state for the corresponding `image_type`.
|
195
195
|
#
|
196
196
|
# @overload retrieve_document(document_token, account_holder_token:, request_options: {})
|
197
197
|
#
|
@@ -242,7 +242,7 @@ module Lithic
|
|
242
242
|
end
|
243
243
|
|
244
244
|
# Simulates an enrollment review for an account holder. This endpoint is only
|
245
|
-
#
|
245
|
+
# applicable for workflows that may required intervention such as `KYB_BASIC`.
|
246
246
|
#
|
247
247
|
# @overload simulate_enrollment_review(account_holder_token: nil, status: nil, status_reasons: nil, request_options: {})
|
248
248
|
#
|
@@ -266,23 +266,23 @@ module Lithic
|
|
266
266
|
end
|
267
267
|
|
268
268
|
# Use this endpoint to identify which type of supported government-issued
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
269
|
+
# documentation you will upload for further verification. It will return two URLs
|
270
|
+
# to upload your document images to - one for the front image and one for the back
|
271
|
+
# image.
|
272
272
|
#
|
273
|
-
#
|
273
|
+
# This endpoint is only valid for evaluations in a `PENDING_DOCUMENT` state.
|
274
274
|
#
|
275
|
-
#
|
276
|
-
#
|
277
|
-
#
|
275
|
+
# Uploaded images must either be a `jpg` or `png` file, and each must be less than
|
276
|
+
# 15 MiB. Once both required uploads have been successfully completed, your
|
277
|
+
# document will be run through KYC verification.
|
278
278
|
#
|
279
|
-
#
|
280
|
-
#
|
279
|
+
# If you have registered a webhook, you will receive evaluation updates for any
|
280
|
+
# document submission evaluations, as well as for any failed document uploads.
|
281
281
|
#
|
282
|
-
#
|
283
|
-
#
|
284
|
-
#
|
285
|
-
#
|
282
|
+
# Two document submission attempts are permitted via this endpoint before a
|
283
|
+
# `REJECTED` status is returned and the account creation process is ended.
|
284
|
+
# Currently only one type of account holder document is supported per KYC
|
285
|
+
# verification.
|
286
286
|
#
|
287
287
|
# @overload upload_document(account_holder_token, document_type:, entity_token:, request_options: {})
|
288
288
|
#
|