increase 1.340.0 → 1.341.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/README.md +1 -1
- data/lib/increase/client.rb +8 -6
- data/lib/increase/internal/type/converter.rb +13 -12
- data/lib/increase/models/account.rb +40 -19
- data/lib/increase/models/account_create_params.rb +14 -11
- data/lib/increase/models/account_list_params.rb +25 -17
- data/lib/increase/models/account_number.rb +22 -14
- data/lib/increase/models/account_number_create_params.rb +12 -13
- data/lib/increase/models/account_number_list_params.rb +26 -20
- data/lib/increase/models/account_number_update_params.rb +12 -11
- data/lib/increase/models/account_statement.rb +15 -11
- data/lib/increase/models/account_statement_list_params.rb +15 -12
- data/lib/increase/models/account_transfer.rb +58 -29
- data/lib/increase/models/account_transfer_create_params.rb +12 -7
- data/lib/increase/models/account_transfer_list_params.rb +20 -12
- data/lib/increase/models/ach_prenotification.rb +48 -27
- data/lib/increase/models/ach_prenotification_create_params.rb +15 -8
- data/lib/increase/models/ach_prenotification_list_params.rb +20 -12
- data/lib/increase/models/ach_transfer.rb +199 -103
- data/lib/increase/models/ach_transfer_create_params.rb +110 -61
- data/lib/increase/models/ach_transfer_list_params.rb +23 -16
- data/lib/increase/models/balance_lookup.rb +14 -11
- data/lib/increase/models/beneficial_owner_create_params.rb +48 -37
- data/lib/increase/models/beneficial_owner_list_params.rb +11 -6
- data/lib/increase/models/beneficial_owner_update_params.rb +44 -31
- data/lib/increase/models/card.rb +69 -47
- data/lib/increase/models/card_create_details_iframe_params.rb +3 -4
- data/lib/increase/models/card_create_params.rb +65 -56
- data/lib/increase/models/card_details.rb +7 -5
- data/lib/increase/models/card_dispute.rb +530 -306
- data/lib/increase/models/card_dispute_create_params.rb +271 -175
- data/lib/increase/models/card_dispute_list_params.rb +24 -16
- data/lib/increase/models/card_dispute_submit_user_submission_params.rb +288 -191
- data/lib/increase/models/card_iframe_url.rb +3 -4
- data/lib/increase/models/card_list_params.rb +23 -16
- data/lib/increase/models/card_payment.rb +1941 -1200
- data/lib/increase/models/card_payment_list_params.rb +15 -11
- data/lib/increase/models/card_purchase_supplement.rb +37 -25
- data/lib/increase/models/card_purchase_supplement_list_params.rb +18 -13
- data/lib/increase/models/card_push_transfer.rb +121 -65
- data/lib/increase/models/card_push_transfer_create_params.rb +55 -25
- data/lib/increase/models/card_push_transfer_list_params.rb +23 -16
- data/lib/increase/models/card_token.rb +9 -6
- data/lib/increase/models/card_token_capabilities.rb +11 -8
- data/lib/increase/models/card_token_list_params.rb +15 -11
- data/lib/increase/models/card_update_params.rb +65 -57
- data/lib/increase/models/card_validation.rb +76 -43
- data/lib/increase/models/card_validation_create_params.rb +11 -7
- data/lib/increase/models/card_validation_list_params.rb +23 -16
- data/lib/increase/models/check_deposit.rb +103 -52
- data/lib/increase/models/check_deposit_create_params.rb +2 -4
- data/lib/increase/models/check_deposit_list_params.rb +20 -12
- data/lib/increase/models/check_transfer.rb +124 -75
- data/lib/increase/models/check_transfer_create_params.rb +91 -51
- data/lib/increase/models/check_transfer_list_params.rb +24 -16
- data/lib/increase/models/check_transfer_stop_payment_params.rb +2 -1
- data/lib/increase/models/declined_transaction.rb +339 -206
- data/lib/increase/models/declined_transaction_list_params.rb +18 -15
- data/lib/increase/models/digital_card_profile.rb +16 -9
- data/lib/increase/models/digital_card_profile_clone_params.rb +2 -1
- data/lib/increase/models/digital_card_profile_create_params.rb +2 -1
- data/lib/increase/models/digital_card_profile_list_params.rb +12 -9
- data/lib/increase/models/digital_wallet_token.rb +26 -17
- data/lib/increase/models/digital_wallet_token_list_params.rb +15 -11
- data/lib/increase/models/entity.rb +175 -135
- data/lib/increase/models/entity_archive_params.rb +3 -4
- data/lib/increase/models/entity_beneficial_owner.rb +24 -19
- data/lib/increase/models/entity_create_params.rb +323 -236
- data/lib/increase/models/entity_list_params.rb +67 -16
- data/lib/increase/models/entity_onboarding_session.rb +25 -11
- data/lib/increase/models/entity_onboarding_session_create_params.rb +8 -5
- data/lib/increase/models/entity_onboarding_session_list_params.rb +12 -9
- data/lib/increase/models/entity_supplemental_document.rb +10 -6
- data/lib/increase/models/entity_update_params.rb +112 -86
- data/lib/increase/models/event.rb +6 -5
- data/lib/increase/models/event_list_params.rb +23 -17
- data/lib/increase/models/event_subscription.rb +17 -9
- data/lib/increase/models/event_subscription_create_params.rb +14 -8
- data/lib/increase/models/event_subscription_list_params.rb +8 -5
- data/lib/increase/models/event_subscription_update_params.rb +2 -1
- data/lib/increase/models/export.rb +69 -30
- data/lib/increase/models/export_create_params.rb +76 -46
- data/lib/increase/models/export_list_params.rb +26 -17
- data/lib/increase/models/external_account.rb +14 -8
- data/lib/increase/models/external_account_create_params.rb +7 -6
- data/lib/increase/models/external_account_list_params.rb +12 -9
- data/lib/increase/models/external_account_update_params.rb +6 -3
- data/lib/increase/models/fednow_transfer.rb +62 -32
- data/lib/increase/models/fednow_transfer_create_params.rb +11 -8
- data/lib/increase/models/fednow_transfer_list_params.rb +25 -17
- data/lib/increase/models/file.rb +13 -7
- data/lib/increase/models/file_create_params.rb +6 -5
- data/lib/increase/models/file_link.rb +17 -8
- data/lib/increase/models/file_link_create_params.rb +3 -4
- data/lib/increase/models/file_list_params.rb +23 -16
- data/lib/increase/models/group.rb +6 -5
- data/lib/increase/models/inbound_ach_transfer.rb +115 -51
- data/lib/increase/models/inbound_ach_transfer_create_notification_of_change_params.rb +3 -5
- data/lib/increase/models/inbound_ach_transfer_decline_params.rb +4 -4
- data/lib/increase/models/inbound_ach_transfer_list_params.rb +21 -16
- data/lib/increase/models/inbound_ach_transfer_transfer_return_params.rb +6 -5
- data/lib/increase/models/inbound_check_deposit.rb +46 -19
- data/lib/increase/models/inbound_check_deposit_list_params.rb +18 -12
- data/lib/increase/models/inbound_check_deposit_return_params.rb +2 -1
- data/lib/increase/models/inbound_fednow_transfer.rb +28 -14
- data/lib/increase/models/inbound_fednow_transfer_list_params.rb +18 -12
- data/lib/increase/models/inbound_fednow_transfer_retrieve_params.rb +2 -1
- data/lib/increase/models/inbound_mail_item.rb +13 -8
- data/lib/increase/models/inbound_mail_item_action_params.rb +4 -2
- data/lib/increase/models/inbound_mail_item_list_params.rb +17 -12
- data/lib/increase/models/inbound_real_time_payments_transfer.rb +21 -12
- data/lib/increase/models/inbound_real_time_payments_transfer_list_params.rb +21 -14
- data/lib/increase/models/inbound_real_time_payments_transfer_retrieve_params.rb +2 -1
- data/lib/increase/models/inbound_wire_drawdown_request.rb +23 -10
- data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb +3 -4
- data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb +2 -1
- data/lib/increase/models/inbound_wire_transfer.rb +33 -21
- data/lib/increase/models/inbound_wire_transfer_list_params.rb +24 -17
- data/lib/increase/models/inbound_wire_transfer_reverse_params.rb +2 -1
- data/lib/increase/models/intrafi_account_enrollment.rb +16 -8
- data/lib/increase/models/intrafi_account_enrollment_list_params.rb +12 -9
- data/lib/increase/models/intrafi_account_enrollment_retrieve_params.rb +2 -1
- data/lib/increase/models/intrafi_account_enrollment_unenroll_params.rb +2 -1
- data/lib/increase/models/intrafi_balance.rb +18 -12
- data/lib/increase/models/intrafi_exclusion.rb +13 -7
- data/lib/increase/models/intrafi_exclusion_archive_params.rb +4 -4
- data/lib/increase/models/intrafi_exclusion_create_params.rb +5 -4
- data/lib/increase/models/intrafi_exclusion_list_params.rb +8 -5
- data/lib/increase/models/lockbox_address.rb +16 -11
- data/lib/increase/models/lockbox_address_list_params.rb +20 -12
- data/lib/increase/models/lockbox_address_update_params.rb +2 -1
- data/lib/increase/models/lockbox_recipient.rb +22 -10
- data/lib/increase/models/lockbox_recipient_create_params.rb +5 -5
- data/lib/increase/models/lockbox_recipient_list_params.rb +22 -13
- data/lib/increase/models/lockbox_recipient_update_params.rb +2 -1
- data/lib/increase/models/oauth_application.rb +12 -7
- data/lib/increase/models/oauth_application_list_params.rb +18 -15
- data/lib/increase/models/oauth_connection.rb +9 -6
- data/lib/increase/models/oauth_connection_list_params.rb +10 -9
- data/lib/increase/models/oauth_token.rb +6 -5
- data/lib/increase/models/oauth_token_create_params.rb +14 -7
- data/lib/increase/models/pending_transaction.rb +392 -239
- data/lib/increase/models/pending_transaction_create_params.rb +6 -6
- data/lib/increase/models/pending_transaction_list_params.rb +23 -19
- data/lib/increase/models/physical_card.rb +36 -24
- data/lib/increase/models/physical_card_create_params.rb +22 -17
- data/lib/increase/models/physical_card_list_params.rb +20 -12
- data/lib/increase/models/physical_card_profile.rb +33 -17
- data/lib/increase/models/physical_card_profile_clone_params.rb +9 -9
- data/lib/increase/models/physical_card_profile_create_params.rb +9 -9
- data/lib/increase/models/physical_card_profile_list_params.rb +12 -9
- data/lib/increase/models/physical_card_update_params.rb +2 -1
- data/lib/increase/models/program.rb +15 -8
- data/lib/increase/models/program_list_params.rb +3 -4
- data/lib/increase/models/real_time_decision.rb +561 -370
- data/lib/increase/models/real_time_decision_action_params.rb +86 -75
- data/lib/increase/models/real_time_payments_transfer.rb +90 -47
- data/lib/increase/models/real_time_payments_transfer_approve_params.rb +2 -1
- data/lib/increase/models/real_time_payments_transfer_cancel_params.rb +2 -1
- data/lib/increase/models/real_time_payments_transfer_create_params.rb +24 -12
- data/lib/increase/models/real_time_payments_transfer_list_params.rb +28 -19
- data/lib/increase/models/routing_number_list_params.rb +3 -4
- data/lib/increase/models/routing_number_list_response.rb +11 -8
- data/lib/increase/models/simulations/account_revenue_payment_create_params.rb +9 -7
- data/lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb +5 -6
- data/lib/increase/models/simulations/ach_transfer_return_params.rb +3 -4
- data/lib/increase/models/simulations/ach_transfer_settle_params.rb +4 -4
- data/lib/increase/models/simulations/card_authentication_create_params.rb +10 -8
- data/lib/increase/models/simulations/card_authorization_create_params.rb +50 -27
- data/lib/increase/models/simulations/card_authorization_create_response.rb +11 -7
- data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +26 -13
- data/lib/increase/models/simulations/card_dispute_action_params.rb +39 -19
- data/lib/increase/models/simulations/card_fuel_confirmation_create_params.rb +3 -5
- data/lib/increase/models/simulations/card_increment_create_params.rb +5 -4
- data/lib/increase/models/simulations/card_purchase_supplement_create_params.rb +7 -7
- data/lib/increase/models/simulations/card_refund_create_params.rb +10 -6
- data/lib/increase/models/simulations/card_reversal_create_params.rb +3 -4
- data/lib/increase/models/simulations/card_settlement_create_params.rb +6 -5
- data/lib/increase/models/simulations/card_token_create_params.rb +18 -9
- data/lib/increase/models/simulations/check_deposit_adjustment_params.rb +8 -5
- data/lib/increase/models/simulations/check_deposit_submit_params.rb +9 -10
- data/lib/increase/models/simulations/digital_wallet_token_request_create_response.rb +9 -7
- data/lib/increase/models/simulations/entity_onboarding_session_submit_params.rb +2 -1
- data/lib/increase/models/simulations/entity_update_validation_params.rb +5 -5
- data/lib/increase/models/simulations/export_create_params.rb +5 -5
- data/lib/increase/models/simulations/inbound_ach_transfer_create_params.rb +20 -12
- data/lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb +5 -6
- data/lib/increase/models/simulations/inbound_check_deposit_create_params.rb +6 -6
- data/lib/increase/models/simulations/inbound_mail_item_create_params.rb +9 -6
- data/lib/increase/models/simulations/inbound_real_time_payments_transfer_create_params.rb +5 -6
- data/lib/increase/models/simulations/inbound_wire_drawdown_request_create_params.rb +27 -13
- data/lib/increase/models/simulations/inbound_wire_transfer_create_params.rb +45 -19
- data/lib/increase/models/simulations/interest_payment_create_params.rb +4 -5
- data/lib/increase/models/simulations/pending_transaction_release_inbound_funds_hold_params.rb +3 -5
- data/lib/increase/models/simulations/physical_card_advance_shipment_params.rb +2 -1
- data/lib/increase/models/simulations/physical_card_create_params.rb +5 -5
- data/lib/increase/models/simulations/program_create_params.rb +4 -2
- data/lib/increase/models/simulations/real_time_payments_transfer_complete_params.rb +6 -3
- data/lib/increase/models/supplemental_document_list_params.rb +8 -5
- data/lib/increase/models/swift_transfer.rb +48 -26
- data/lib/increase/models/swift_transfer_create_params.rb +28 -19
- data/lib/increase/models/swift_transfer_list_params.rb +23 -16
- data/lib/increase/models/transaction.rb +995 -534
- data/lib/increase/models/transaction_list_params.rb +21 -16
- data/lib/increase/models/unwrap_webhook_event.rb +6 -5
- data/lib/increase/models/wire_drawdown_request.rb +44 -26
- data/lib/increase/models/wire_drawdown_request_create_params.rb +23 -19
- data/lib/increase/models/wire_drawdown_request_list_params.rb +12 -9
- data/lib/increase/models/wire_transfer.rb +100 -55
- data/lib/increase/models/wire_transfer_create_params.rb +43 -26
- data/lib/increase/models/wire_transfer_list_params.rb +23 -16
- data/lib/increase/resources/account_numbers.rb +20 -16
- data/lib/increase/resources/account_statements.rb +3 -4
- data/lib/increase/resources/account_transfers.rb +20 -12
- data/lib/increase/resources/accounts.rb +19 -12
- data/lib/increase/resources/ach_prenotifications.rb +23 -13
- data/lib/increase/resources/ach_transfers.rb +93 -43
- data/lib/increase/resources/beneficial_owners.rb +35 -19
- data/lib/increase/resources/card_disputes.rb +43 -22
- data/lib/increase/resources/card_payments.rb +3 -4
- data/lib/increase/resources/card_purchase_supplements.rb +6 -5
- data/lib/increase/resources/card_push_transfers.rb +55 -24
- data/lib/increase/resources/card_tokens.rb +3 -4
- data/lib/increase/resources/card_validations.rb +19 -12
- data/lib/increase/resources/cards.rb +33 -22
- data/lib/increase/resources/check_deposits.rb +10 -9
- data/lib/increase/resources/check_transfers.rb +37 -17
- data/lib/increase/resources/declined_transactions.rb +3 -4
- data/lib/increase/resources/digital_card_profiles.rb +12 -7
- data/lib/increase/resources/digital_wallet_tokens.rb +3 -4
- data/lib/increase/resources/entities.rb +69 -33
- data/lib/increase/resources/entity_onboarding_sessions.rb +16 -10
- data/lib/increase/resources/event_subscriptions.rb +22 -13
- data/lib/increase/resources/events.rb +10 -9
- data/lib/increase/resources/exports.rb +40 -22
- data/lib/increase/resources/external_accounts.rb +21 -14
- data/lib/increase/resources/fednow_transfers.rb +21 -14
- data/lib/increase/resources/file_links.rb +3 -4
- data/lib/increase/resources/files.rb +14 -10
- data/lib/increase/resources/inbound_ach_transfers.rb +18 -19
- data/lib/increase/resources/inbound_check_deposits.rb +8 -6
- data/lib/increase/resources/inbound_fednow_transfers.rb +8 -6
- data/lib/increase/resources/inbound_mail_items.rb +7 -6
- data/lib/increase/resources/inbound_real_time_payments_transfers.rb +11 -7
- data/lib/increase/resources/inbound_wire_drawdown_requests.rb +5 -5
- data/lib/increase/resources/inbound_wire_transfers.rb +10 -7
- data/lib/increase/resources/intrafi_account_enrollments.rb +12 -7
- data/lib/increase/resources/intrafi_exclusions.rb +17 -13
- data/lib/increase/resources/lockbox_addresses.rb +10 -6
- data/lib/increase/resources/lockbox_recipients.rb +17 -12
- data/lib/increase/resources/oauth_applications.rb +3 -4
- data/lib/increase/resources/oauth_connections.rb +6 -5
- data/lib/increase/resources/oauth_tokens.rb +14 -7
- data/lib/increase/resources/pending_transactions.rb +7 -8
- data/lib/increase/resources/physical_card_profiles.rb +18 -15
- data/lib/increase/resources/physical_cards.rb +17 -12
- data/lib/increase/resources/programs.rb +3 -4
- data/lib/increase/resources/real_time_decisions.rb +18 -9
- data/lib/increase/resources/real_time_payments_transfers.rb +41 -21
- data/lib/increase/resources/routing_numbers.rb +3 -4
- data/lib/increase/resources/simulations/account_revenue_payments.rb +9 -7
- data/lib/increase/resources/simulations/ach_transfers.rb +12 -14
- data/lib/increase/resources/simulations/card_authentications.rb +10 -8
- data/lib/increase/resources/simulations/card_authorizations.rb +28 -12
- data/lib/increase/resources/simulations/card_balance_inquiries.rb +22 -11
- data/lib/increase/resources/simulations/card_disputes.rb +6 -5
- data/lib/increase/resources/simulations/card_fuel_confirmations.rb +3 -5
- data/lib/increase/resources/simulations/card_increments.rb +5 -4
- data/lib/increase/resources/simulations/card_purchase_supplements.rb +7 -7
- data/lib/increase/resources/simulations/card_refunds.rb +10 -6
- data/lib/increase/resources/simulations/card_reversals.rb +3 -4
- data/lib/increase/resources/simulations/card_settlements.rb +6 -5
- data/lib/increase/resources/simulations/card_tokens.rb +6 -3
- data/lib/increase/resources/simulations/check_deposits.rb +11 -9
- data/lib/increase/resources/simulations/entities.rb +3 -4
- data/lib/increase/resources/simulations/entity_onboarding_sessions.rb +2 -1
- data/lib/increase/resources/simulations/exports.rb +5 -5
- data/lib/increase/resources/simulations/inbound_ach_transfers.rb +14 -9
- data/lib/increase/resources/simulations/inbound_check_deposits.rb +11 -12
- data/lib/increase/resources/simulations/inbound_mail_items.rb +9 -6
- data/lib/increase/resources/simulations/inbound_real_time_payments_transfers.rb +5 -6
- data/lib/increase/resources/simulations/inbound_wire_drawdown_requests.rb +27 -13
- data/lib/increase/resources/simulations/inbound_wire_transfers.rb +45 -19
- data/lib/increase/resources/simulations/interest_payments.rb +4 -5
- data/lib/increase/resources/simulations/pending_transactions.rb +3 -5
- data/lib/increase/resources/simulations/physical_cards.rb +7 -6
- data/lib/increase/resources/simulations/programs.rb +4 -2
- data/lib/increase/resources/simulations/real_time_payments_transfers.rb +4 -2
- data/lib/increase/resources/supplemental_documents.rb +8 -5
- data/lib/increase/resources/swift_transfers.rb +28 -16
- data/lib/increase/resources/transactions.rb +6 -5
- data/lib/increase/resources/wire_drawdown_requests.rb +23 -14
- data/lib/increase/resources/wire_transfers.rb +29 -16
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/check_transfer.rbi +8 -0
- data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
- data/rbi/increase/models/entity_list_params.rbi +119 -0
- data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
- data/rbi/increase/resources/entities.rbi +3 -0
- data/rbi/increase/resources/pending_transactions.rbi +2 -2
- data/sig/increase/models/check_transfer.rbs +5 -0
- data/sig/increase/models/check_transfer_create_params.rbs +12 -9
- data/sig/increase/models/entity_list_params.rbs +48 -1
- data/sig/increase/resources/entities.rbs +1 -0
- metadata +2 -2
|
@@ -53,20 +53,26 @@ module Increase
|
|
|
53
53
|
optional :status, -> { Increase::RealTimePaymentsTransferListParams::Status }
|
|
54
54
|
|
|
55
55
|
# @!method initialize(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
56
|
-
#
|
|
57
|
-
#
|
|
58
|
-
#
|
|
59
|
-
# @param account_id [String] Filter Real-Time Payments Transfers to those belonging to the specified Account.
|
|
56
|
+
# @param account_id [String]
|
|
57
|
+
# Filter Real-Time Payments Transfers to those belonging to the specified Account.
|
|
60
58
|
#
|
|
61
59
|
# @param created_at [Increase::Models::RealTimePaymentsTransferListParams::CreatedAt]
|
|
62
60
|
#
|
|
63
61
|
# @param cursor [String] Return the page of entries after this one.
|
|
64
62
|
#
|
|
65
|
-
# @param external_account_id [String]
|
|
63
|
+
# @param external_account_id [String]
|
|
64
|
+
# Filter Real-Time Payments Transfers to those made to the specified External
|
|
65
|
+
# Account.
|
|
66
66
|
#
|
|
67
|
-
# @param idempotency_key [String]
|
|
67
|
+
# @param idempotency_key [String]
|
|
68
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
69
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
70
|
+
# request is only processed once. Learn more about
|
|
71
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
68
72
|
#
|
|
69
|
-
# @param limit [Integer]
|
|
73
|
+
# @param limit [Integer]
|
|
74
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
75
|
+
# objects.
|
|
70
76
|
#
|
|
71
77
|
# @param status [Increase::Models::RealTimePaymentsTransferListParams::Status]
|
|
72
78
|
#
|
|
@@ -102,17 +108,21 @@ module Increase
|
|
|
102
108
|
optional :on_or_before, Time
|
|
103
109
|
|
|
104
110
|
# @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
|
|
105
|
-
#
|
|
106
|
-
#
|
|
107
|
-
#
|
|
108
|
-
#
|
|
109
|
-
# @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
|
|
111
|
+
# @param after [Time]
|
|
112
|
+
# Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
113
|
+
# timestamp.
|
|
110
114
|
#
|
|
111
|
-
# @param before [Time]
|
|
115
|
+
# @param before [Time]
|
|
116
|
+
# Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
117
|
+
# timestamp.
|
|
112
118
|
#
|
|
113
|
-
# @param on_or_after [Time]
|
|
119
|
+
# @param on_or_after [Time]
|
|
120
|
+
# Return results on or after this
|
|
121
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
114
122
|
#
|
|
115
|
-
# @param on_or_before [Time]
|
|
123
|
+
# @param on_or_before [Time]
|
|
124
|
+
# Return results on or before this
|
|
125
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
116
126
|
end
|
|
117
127
|
|
|
118
128
|
class Status < Increase::Internal::Type::BaseModel
|
|
@@ -128,10 +138,9 @@ module Increase
|
|
|
128
138
|
api_name: :in
|
|
129
139
|
|
|
130
140
|
# @!method initialize(in_: nil)
|
|
131
|
-
#
|
|
132
|
-
#
|
|
133
|
-
#
|
|
134
|
-
# @param in_ [Array<Symbol, Increase::Models::RealTimePaymentsTransferListParams::Status::In>] Return results whose value is in the provided list. For GET requests, this shoul
|
|
141
|
+
# @param in_ [Array<Symbol, Increase::Models::RealTimePaymentsTransferListParams::Status::In>]
|
|
142
|
+
# Return results whose value is in the provided list. For GET requests, this
|
|
143
|
+
# should be encoded as a comma-delimited string, such as `?in=one,two,three`.
|
|
135
144
|
|
|
136
145
|
module In
|
|
137
146
|
extend Increase::Internal::Type::Enum
|
|
@@ -27,14 +27,13 @@ module Increase
|
|
|
27
27
|
optional :limit, Integer
|
|
28
28
|
|
|
29
29
|
# @!method initialize(routing_number:, cursor: nil, limit: nil, request_options: {})
|
|
30
|
-
# Some parameter documentations has been truncated, see
|
|
31
|
-
# {Increase::Models::RoutingNumberListParams} for more details.
|
|
32
|
-
#
|
|
33
30
|
# @param routing_number [String] Filter financial institutions by routing number.
|
|
34
31
|
#
|
|
35
32
|
# @param cursor [String] Return the page of entries after this one.
|
|
36
33
|
#
|
|
37
|
-
# @param limit [Integer]
|
|
34
|
+
# @param limit [Integer]
|
|
35
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
36
|
+
# objects.
|
|
38
37
|
#
|
|
39
38
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
40
39
|
end
|
|
@@ -49,24 +49,27 @@ module Increase
|
|
|
49
49
|
required :wire_transfers, enum: -> { Increase::Models::RoutingNumberListResponse::WireTransfers }
|
|
50
50
|
|
|
51
51
|
# @!method initialize(ach_transfers:, fednow_transfers:, name:, real_time_payments_transfers:, routing_number:, type:, wire_transfers:)
|
|
52
|
-
# Some parameter documentations has been truncated, see
|
|
53
|
-
# {Increase::Models::RoutingNumberListResponse} for more details.
|
|
54
|
-
#
|
|
55
52
|
# Routing numbers are used to identify your bank in a financial transaction.
|
|
56
53
|
#
|
|
57
|
-
# @param ach_transfers [Symbol, Increase::Models::RoutingNumberListResponse::ACHTransfers]
|
|
54
|
+
# @param ach_transfers [Symbol, Increase::Models::RoutingNumberListResponse::ACHTransfers]
|
|
55
|
+
# This routing number's support for ACH Transfers.
|
|
58
56
|
#
|
|
59
|
-
# @param fednow_transfers [Symbol, Increase::Models::RoutingNumberListResponse::FednowTransfers]
|
|
57
|
+
# @param fednow_transfers [Symbol, Increase::Models::RoutingNumberListResponse::FednowTransfers]
|
|
58
|
+
# This routing number's support for FedNow Transfers.
|
|
60
59
|
#
|
|
61
60
|
# @param name [String] The name of the financial institution belonging to a routing number.
|
|
62
61
|
#
|
|
63
|
-
# @param real_time_payments_transfers [Symbol, Increase::Models::RoutingNumberListResponse::RealTimePaymentsTransfers]
|
|
62
|
+
# @param real_time_payments_transfers [Symbol, Increase::Models::RoutingNumberListResponse::RealTimePaymentsTransfers]
|
|
63
|
+
# This routing number's support for Real-Time Payments Transfers.
|
|
64
64
|
#
|
|
65
65
|
# @param routing_number [String] The nine digit routing number identifier.
|
|
66
66
|
#
|
|
67
|
-
# @param type [Symbol, Increase::Models::RoutingNumberListResponse::Type]
|
|
67
|
+
# @param type [Symbol, Increase::Models::RoutingNumberListResponse::Type]
|
|
68
|
+
# A constant representing the object's type. For this resource it will always be
|
|
69
|
+
# `routing_number`.
|
|
68
70
|
#
|
|
69
|
-
# @param wire_transfers [Symbol, Increase::Models::RoutingNumberListResponse::WireTransfers]
|
|
71
|
+
# @param wire_transfers [Symbol, Increase::Models::RoutingNumberListResponse::WireTransfers]
|
|
72
|
+
# This routing number's support for Wire Transfers.
|
|
70
73
|
|
|
71
74
|
# This routing number's support for ACH Transfers.
|
|
72
75
|
#
|
|
@@ -42,19 +42,21 @@ module Increase
|
|
|
42
42
|
optional :period_start, Time
|
|
43
43
|
|
|
44
44
|
# @!method initialize(account_id:, amount:, accrued_on_account_id: nil, period_end: nil, period_start: nil, request_options: {})
|
|
45
|
-
# Some parameter documentations has been truncated, see
|
|
46
|
-
# {Increase::Models::Simulations::AccountRevenuePaymentCreateParams} for more
|
|
47
|
-
# details.
|
|
48
|
-
#
|
|
49
45
|
# @param account_id [String] The identifier of the Account the Account Revenue Payment should be paid to.
|
|
50
46
|
#
|
|
51
47
|
# @param amount [Integer] The account revenue amount in cents. Must be positive.
|
|
52
48
|
#
|
|
53
|
-
# @param accrued_on_account_id [String]
|
|
49
|
+
# @param accrued_on_account_id [String]
|
|
50
|
+
# The identifier of the Account the account revenue accrued on. Defaults to
|
|
51
|
+
# `account_id`.
|
|
54
52
|
#
|
|
55
|
-
# @param period_end [Time]
|
|
53
|
+
# @param period_end [Time]
|
|
54
|
+
# The end of the account revenue period. If not provided, defaults to the current
|
|
55
|
+
# time.
|
|
56
56
|
#
|
|
57
|
-
# @param period_start [Time]
|
|
57
|
+
# @param period_start [Time]
|
|
58
|
+
# The start of the account revenue period. If not provided, defaults to the
|
|
59
|
+
# current time.
|
|
58
60
|
#
|
|
59
61
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
60
62
|
end
|
|
@@ -41,13 +41,12 @@ module Increase
|
|
|
41
41
|
optional :corrected_routing_number, String
|
|
42
42
|
|
|
43
43
|
# @!method initialize(ach_transfer_id:, corrected_account_funding: nil, corrected_account_number: nil, corrected_individual_id: nil, corrected_routing_number: nil, request_options: {})
|
|
44
|
-
#
|
|
45
|
-
#
|
|
46
|
-
#
|
|
44
|
+
# @param ach_transfer_id [String]
|
|
45
|
+
# The identifier of the ACH Transfer you wish to create a notification of change
|
|
46
|
+
# for.
|
|
47
47
|
#
|
|
48
|
-
# @param
|
|
49
|
-
#
|
|
50
|
-
# @param corrected_account_funding [Symbol, Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::CorrectedAccountFunding] The corrected account funding type.
|
|
48
|
+
# @param corrected_account_funding [Symbol, Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::CorrectedAccountFunding]
|
|
49
|
+
# The corrected account funding type.
|
|
51
50
|
#
|
|
52
51
|
# @param corrected_account_number [String] The corrected account number.
|
|
53
52
|
#
|
|
@@ -22,12 +22,11 @@ module Increase
|
|
|
22
22
|
optional :reason, enum: -> { Increase::Simulations::ACHTransferReturnParams::Reason }
|
|
23
23
|
|
|
24
24
|
# @!method initialize(ach_transfer_id:, reason: nil, request_options: {})
|
|
25
|
-
# Some parameter documentations has been truncated, see
|
|
26
|
-
# {Increase::Models::Simulations::ACHTransferReturnParams} for more details.
|
|
27
|
-
#
|
|
28
25
|
# @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to return.
|
|
29
26
|
#
|
|
30
|
-
# @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason]
|
|
27
|
+
# @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason]
|
|
28
|
+
# The reason why the Federal Reserve or destination bank returned this transfer.
|
|
29
|
+
# Defaults to `no_account`.
|
|
31
30
|
#
|
|
32
31
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
33
32
|
|
|
@@ -24,12 +24,12 @@ module Increase
|
|
|
24
24
|
enum: -> { Increase::Simulations::ACHTransferSettleParams::InboundFundsHoldBehavior }
|
|
25
25
|
|
|
26
26
|
# @!method initialize(ach_transfer_id:, inbound_funds_hold_behavior: nil, request_options: {})
|
|
27
|
-
# Some parameter documentations has been truncated, see
|
|
28
|
-
# {Increase::Models::Simulations::ACHTransferSettleParams} for more details.
|
|
29
|
-
#
|
|
30
27
|
# @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to become settled.
|
|
31
28
|
#
|
|
32
|
-
# @param inbound_funds_hold_behavior [Symbol, Increase::Models::Simulations::ACHTransferSettleParams::InboundFundsHoldBehavior]
|
|
29
|
+
# @param inbound_funds_hold_behavior [Symbol, Increase::Models::Simulations::ACHTransferSettleParams::InboundFundsHoldBehavior]
|
|
30
|
+
# The behavior of the inbound funds hold that is created when the ACH Transfer is
|
|
31
|
+
# settled. If no behavior is specified, the inbound funds hold will be released
|
|
32
|
+
# immediately in order for the funds to be available for use.
|
|
33
33
|
#
|
|
34
34
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
35
35
|
|
|
@@ -60,19 +60,21 @@ module Increase
|
|
|
60
60
|
optional :purchase_amount, Integer
|
|
61
61
|
|
|
62
62
|
# @!method initialize(card_id:, category: nil, device_channel: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_country: nil, merchant_name: nil, purchase_amount: nil, request_options: {})
|
|
63
|
-
# Some parameter documentations has been truncated, see
|
|
64
|
-
# {Increase::Models::Simulations::CardAuthenticationCreateParams} for more
|
|
65
|
-
# details.
|
|
66
|
-
#
|
|
67
63
|
# @param card_id [String] The identifier of the Card to be authorized.
|
|
68
64
|
#
|
|
69
|
-
# @param category [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::Category]
|
|
65
|
+
# @param category [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::Category]
|
|
66
|
+
# The category of the card authentication attempt.
|
|
70
67
|
#
|
|
71
|
-
# @param device_channel [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::DeviceChannel]
|
|
68
|
+
# @param device_channel [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::DeviceChannel]
|
|
69
|
+
# The device channel of the card authentication attempt.
|
|
72
70
|
#
|
|
73
|
-
# @param merchant_acceptor_id [String]
|
|
71
|
+
# @param merchant_acceptor_id [String]
|
|
72
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
73
|
+
# is transacting with.
|
|
74
74
|
#
|
|
75
|
-
# @param merchant_category_code [String]
|
|
75
|
+
# @param merchant_category_code [String]
|
|
76
|
+
# The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
77
|
+
# card is transacting with.
|
|
76
78
|
#
|
|
77
79
|
# @param merchant_country [String] The country the merchant resides in.
|
|
78
80
|
#
|
|
@@ -122,24 +122,33 @@ module Increase
|
|
|
122
122
|
optional :terminal_id, String
|
|
123
123
|
|
|
124
124
|
# @!method initialize(amount:, authenticated_card_payment_id: nil, card_id: nil, decline_reason: nil, digital_wallet_token_id: nil, event_subscription_id: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_city: nil, merchant_country: nil, merchant_descriptor: nil, merchant_state: nil, network_details: nil, network_risk_score: nil, physical_card_id: nil, processing_category: nil, terminal_id: nil, request_options: {})
|
|
125
|
-
# Some parameter documentations has been truncated, see
|
|
126
|
-
# {Increase::Models::Simulations::CardAuthorizationCreateParams} for more details.
|
|
127
|
-
#
|
|
128
125
|
# @param amount [Integer] The authorization amount in cents.
|
|
129
126
|
#
|
|
130
|
-
# @param authenticated_card_payment_id [String]
|
|
127
|
+
# @param authenticated_card_payment_id [String]
|
|
128
|
+
# The identifier of a Card Payment with a `card_authentication` if you want to
|
|
129
|
+
# simulate an authenticated authorization.
|
|
131
130
|
#
|
|
132
131
|
# @param card_id [String] The identifier of the Card to be authorized.
|
|
133
132
|
#
|
|
134
|
-
# @param decline_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason]
|
|
133
|
+
# @param decline_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason]
|
|
134
|
+
# Forces a card decline with a specific reason. No real time decision will be
|
|
135
|
+
# sent.
|
|
135
136
|
#
|
|
136
137
|
# @param digital_wallet_token_id [String] The identifier of the Digital Wallet Token to be authorized.
|
|
137
138
|
#
|
|
138
|
-
# @param event_subscription_id [String]
|
|
139
|
+
# @param event_subscription_id [String]
|
|
140
|
+
# The identifier of the Event Subscription to use. If provided, will override the
|
|
141
|
+
# default real time event subscription. Because you can only create one real time
|
|
142
|
+
# decision event subscription, you can use this field to route events to any
|
|
143
|
+
# specified event subscription for testing purposes.
|
|
139
144
|
#
|
|
140
|
-
# @param merchant_acceptor_id [String]
|
|
145
|
+
# @param merchant_acceptor_id [String]
|
|
146
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
147
|
+
# is transacting with.
|
|
141
148
|
#
|
|
142
|
-
# @param merchant_category_code [String]
|
|
149
|
+
# @param merchant_category_code [String]
|
|
150
|
+
# The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
151
|
+
# card is transacting with.
|
|
143
152
|
#
|
|
144
153
|
# @param merchant_city [String] The city the merchant resides in.
|
|
145
154
|
#
|
|
@@ -149,15 +158,22 @@ module Increase
|
|
|
149
158
|
#
|
|
150
159
|
# @param merchant_state [String] The state the merchant resides in.
|
|
151
160
|
#
|
|
152
|
-
# @param network_details [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails]
|
|
161
|
+
# @param network_details [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails]
|
|
162
|
+
# Fields specific to a given card network.
|
|
153
163
|
#
|
|
154
|
-
# @param network_risk_score [Integer]
|
|
164
|
+
# @param network_risk_score [Integer]
|
|
165
|
+
# The risk score generated by the card network. For Visa this is the Visa Advanced
|
|
166
|
+
# Authorization risk score, from 0 to 99, where 99 is the riskiest.
|
|
155
167
|
#
|
|
156
168
|
# @param physical_card_id [String] The identifier of the Physical Card to be authorized.
|
|
157
169
|
#
|
|
158
|
-
# @param processing_category [Increase::Models::Simulations::CardAuthorizationCreateParams::ProcessingCategory]
|
|
170
|
+
# @param processing_category [Increase::Models::Simulations::CardAuthorizationCreateParams::ProcessingCategory]
|
|
171
|
+
# Fields specific to a specific type of authorization, such as Automatic Fuel
|
|
172
|
+
# Dispensers, Refund Authorizations, or Cash Disbursements.
|
|
159
173
|
#
|
|
160
|
-
# @param terminal_id [String]
|
|
174
|
+
# @param terminal_id [String]
|
|
175
|
+
# The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
|
176
|
+
# is transacting with.
|
|
161
177
|
#
|
|
162
178
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
163
179
|
|
|
@@ -243,7 +259,8 @@ module Increase
|
|
|
243
259
|
# @!method initialize(visa:)
|
|
244
260
|
# Fields specific to a given card network.
|
|
245
261
|
#
|
|
246
|
-
# @param visa [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa]
|
|
262
|
+
# @param visa [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa]
|
|
263
|
+
# Fields specific to the Visa network.
|
|
247
264
|
|
|
248
265
|
# @see Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails#visa
|
|
249
266
|
class Visa < Increase::Internal::Type::BaseModel
|
|
@@ -283,19 +300,26 @@ module Increase
|
|
|
283
300
|
enum: -> { Increase::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::TerminalEntryCapability }
|
|
284
301
|
|
|
285
302
|
# @!method initialize(electronic_commerce_indicator: nil, point_of_service_entry_mode: nil, stand_in_processing_reason: nil, terminal_entry_capability: nil)
|
|
286
|
-
# Some parameter documentations has been truncated, see
|
|
287
|
-
# {Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa}
|
|
288
|
-
# for more details.
|
|
289
|
-
#
|
|
290
303
|
# Fields specific to the Visa network.
|
|
291
304
|
#
|
|
292
|
-
# @param electronic_commerce_indicator [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::ElectronicCommerceIndicator]
|
|
305
|
+
# @param electronic_commerce_indicator [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::ElectronicCommerceIndicator]
|
|
306
|
+
# For electronic commerce transactions, this identifies the level of security used
|
|
307
|
+
# in obtaining the customer's payment credential. For mail or telephone order
|
|
308
|
+
# transactions, identifies the type of mail or telephone order.
|
|
293
309
|
#
|
|
294
|
-
# @param point_of_service_entry_mode [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::PointOfServiceEntryMode]
|
|
310
|
+
# @param point_of_service_entry_mode [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::PointOfServiceEntryMode]
|
|
311
|
+
# The method used to enter the cardholder's primary account number and card
|
|
312
|
+
# expiration date.
|
|
295
313
|
#
|
|
296
|
-
# @param stand_in_processing_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::StandInProcessingReason]
|
|
314
|
+
# @param stand_in_processing_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::StandInProcessingReason]
|
|
315
|
+
# The reason code for the stand-in processing.
|
|
297
316
|
#
|
|
298
|
-
# @param terminal_entry_capability [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::TerminalEntryCapability]
|
|
317
|
+
# @param terminal_entry_capability [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails::Visa::TerminalEntryCapability]
|
|
318
|
+
# The capability of the terminal being used to read the card. Shows whether a
|
|
319
|
+
# terminal can e.g., accept chip cards or if it only supports magnetic stripe
|
|
320
|
+
# reads. This reflects the highest capability of the terminal — for example, a
|
|
321
|
+
# terminal that supports both chip and magnetic stripe will be identified as
|
|
322
|
+
# chip-capable.
|
|
299
323
|
|
|
300
324
|
# For electronic commerce transactions, this identifies the level of security used
|
|
301
325
|
# in obtaining the customer's payment credential. For mail or telephone order
|
|
@@ -467,16 +491,15 @@ module Increase
|
|
|
467
491
|
optional :refund, -> { Increase::Simulations::CardAuthorizationCreateParams::ProcessingCategory::Refund }
|
|
468
492
|
|
|
469
493
|
# @!method initialize(category:, refund: nil)
|
|
470
|
-
# Some parameter documentations has been truncated, see
|
|
471
|
-
# {Increase::Models::Simulations::CardAuthorizationCreateParams::ProcessingCategory}
|
|
472
|
-
# for more details.
|
|
473
|
-
#
|
|
474
494
|
# Fields specific to a specific type of authorization, such as Automatic Fuel
|
|
475
495
|
# Dispensers, Refund Authorizations, or Cash Disbursements.
|
|
476
496
|
#
|
|
477
|
-
# @param category [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::ProcessingCategory::Category]
|
|
497
|
+
# @param category [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::ProcessingCategory::Category]
|
|
498
|
+
# The processing category describes the intent behind the authorization, such as
|
|
499
|
+
# whether it was used for bill payments or an automatic fuel dispenser.
|
|
478
500
|
#
|
|
479
|
-
# @param refund [Increase::Models::Simulations::CardAuthorizationCreateParams::ProcessingCategory::Refund]
|
|
501
|
+
# @param refund [Increase::Models::Simulations::CardAuthorizationCreateParams::ProcessingCategory::Refund]
|
|
502
|
+
# Details related to refund authorizations.
|
|
480
503
|
|
|
481
504
|
# The processing category describes the intent behind the authorization, such as
|
|
482
505
|
# whether it was used for bill payments or an automatic fuel dispenser.
|
|
@@ -29,17 +29,21 @@ module Increase
|
|
|
29
29
|
required :type, enum: -> { Increase::Models::Simulations::CardAuthorizationCreateResponse::Type }
|
|
30
30
|
|
|
31
31
|
# @!method initialize(declined_transaction:, pending_transaction:, type:)
|
|
32
|
-
# Some parameter documentations has been truncated, see
|
|
33
|
-
# {Increase::Models::Simulations::CardAuthorizationCreateResponse} for more
|
|
34
|
-
# details.
|
|
35
|
-
#
|
|
36
32
|
# The results of a Card Authorization simulation.
|
|
37
33
|
#
|
|
38
|
-
# @param declined_transaction [Increase::Models::DeclinedTransaction, nil]
|
|
34
|
+
# @param declined_transaction [Increase::Models::DeclinedTransaction, nil]
|
|
35
|
+
# If the authorization attempt fails, this will contain the resulting
|
|
36
|
+
# [Declined Transaction](#declined-transactions) object. The Declined
|
|
37
|
+
# Transaction's `source` will be of `category: card_decline`.
|
|
39
38
|
#
|
|
40
|
-
# @param pending_transaction [Increase::Models::PendingTransaction, nil]
|
|
39
|
+
# @param pending_transaction [Increase::Models::PendingTransaction, nil]
|
|
40
|
+
# If the authorization attempt succeeds, this will contain the resulting Pending
|
|
41
|
+
# Transaction object. The Pending Transaction's `source` will be of
|
|
42
|
+
# `category: card_authorization`.
|
|
41
43
|
#
|
|
42
|
-
# @param type [Symbol, Increase::Models::Simulations::CardAuthorizationCreateResponse::Type]
|
|
44
|
+
# @param type [Symbol, Increase::Models::Simulations::CardAuthorizationCreateResponse::Type]
|
|
45
|
+
# A constant representing the object's type. For this resource it will always be
|
|
46
|
+
# `inbound_card_authorization_simulation_result`.
|
|
43
47
|
|
|
44
48
|
# A constant representing the object's type. For this resource it will always be
|
|
45
49
|
# `inbound_card_authorization_simulation_result`.
|
|
@@ -108,23 +108,29 @@ module Increase
|
|
|
108
108
|
optional :terminal_id, String
|
|
109
109
|
|
|
110
110
|
# @!method initialize(balance: nil, card_id: nil, decline_reason: nil, digital_wallet_token_id: nil, event_subscription_id: nil, merchant_acceptor_id: nil, merchant_category_code: nil, merchant_city: nil, merchant_country: nil, merchant_descriptor: nil, merchant_state: nil, network_details: nil, network_risk_score: nil, physical_card_id: nil, terminal_id: nil, request_options: {})
|
|
111
|
-
# Some parameter documentations has been truncated, see
|
|
112
|
-
# {Increase::Models::Simulations::CardBalanceInquiryCreateParams} for more
|
|
113
|
-
# details.
|
|
114
|
-
#
|
|
115
111
|
# @param balance [Integer] The balance amount in cents. The account balance will be used if not provided.
|
|
116
112
|
#
|
|
117
113
|
# @param card_id [String] The identifier of the Card to be authorized.
|
|
118
114
|
#
|
|
119
|
-
# @param decline_reason [Symbol, Increase::Models::Simulations::CardBalanceInquiryCreateParams::DeclineReason]
|
|
115
|
+
# @param decline_reason [Symbol, Increase::Models::Simulations::CardBalanceInquiryCreateParams::DeclineReason]
|
|
116
|
+
# Forces a card decline with a specific reason. No real time decision will be
|
|
117
|
+
# sent.
|
|
120
118
|
#
|
|
121
119
|
# @param digital_wallet_token_id [String] The identifier of the Digital Wallet Token to be authorized.
|
|
122
120
|
#
|
|
123
|
-
# @param event_subscription_id [String]
|
|
121
|
+
# @param event_subscription_id [String]
|
|
122
|
+
# The identifier of the Event Subscription to use. If provided, will override the
|
|
123
|
+
# default real time event subscription. Because you can only create one real time
|
|
124
|
+
# decision event subscription, you can use this field to route events to any
|
|
125
|
+
# specified event subscription for testing purposes.
|
|
124
126
|
#
|
|
125
|
-
# @param merchant_acceptor_id [String]
|
|
127
|
+
# @param merchant_acceptor_id [String]
|
|
128
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
129
|
+
# is transacting with.
|
|
126
130
|
#
|
|
127
|
-
# @param merchant_category_code [String]
|
|
131
|
+
# @param merchant_category_code [String]
|
|
132
|
+
# The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
133
|
+
# card is transacting with.
|
|
128
134
|
#
|
|
129
135
|
# @param merchant_city [String] The city the merchant resides in.
|
|
130
136
|
#
|
|
@@ -134,13 +140,18 @@ module Increase
|
|
|
134
140
|
#
|
|
135
141
|
# @param merchant_state [String] The state the merchant resides in.
|
|
136
142
|
#
|
|
137
|
-
# @param network_details [Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails]
|
|
143
|
+
# @param network_details [Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails]
|
|
144
|
+
# Fields specific to a given card network.
|
|
138
145
|
#
|
|
139
|
-
# @param network_risk_score [Integer]
|
|
146
|
+
# @param network_risk_score [Integer]
|
|
147
|
+
# The risk score generated by the card network. For Visa this is the Visa Advanced
|
|
148
|
+
# Authorization risk score, from 0 to 99, where 99 is the riskiest.
|
|
140
149
|
#
|
|
141
150
|
# @param physical_card_id [String] The identifier of the Physical Card to be authorized.
|
|
142
151
|
#
|
|
143
|
-
# @param terminal_id [String]
|
|
152
|
+
# @param terminal_id [String]
|
|
153
|
+
# The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
|
154
|
+
# is transacting with.
|
|
144
155
|
#
|
|
145
156
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
146
157
|
|
|
@@ -226,7 +237,8 @@ module Increase
|
|
|
226
237
|
# @!method initialize(visa:)
|
|
227
238
|
# Fields specific to a given card network.
|
|
228
239
|
#
|
|
229
|
-
# @param visa [Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails::Visa]
|
|
240
|
+
# @param visa [Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails::Visa]
|
|
241
|
+
# Fields specific to the Visa network.
|
|
230
242
|
|
|
231
243
|
# @see Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails#visa
|
|
232
244
|
class Visa < Increase::Internal::Type::BaseModel
|
|
@@ -240,7 +252,8 @@ module Increase
|
|
|
240
252
|
# @!method initialize(stand_in_processing_reason: nil)
|
|
241
253
|
# Fields specific to the Visa network.
|
|
242
254
|
#
|
|
243
|
-
# @param stand_in_processing_reason [Symbol, Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails::Visa::StandInProcessingReason]
|
|
255
|
+
# @param stand_in_processing_reason [Symbol, Increase::Models::Simulations::CardBalanceInquiryCreateParams::NetworkDetails::Visa::StandInProcessingReason]
|
|
256
|
+
# The reason code for the stand-in processing.
|
|
244
257
|
|
|
245
258
|
# The reason code for the stand-in processing.
|
|
246
259
|
#
|
|
@@ -29,14 +29,15 @@ module Increase
|
|
|
29
29
|
optional :visa, -> { Increase::Simulations::CardDisputeActionParams::Visa }
|
|
30
30
|
|
|
31
31
|
# @!method initialize(card_dispute_id:, network:, visa: nil, request_options: {})
|
|
32
|
-
# Some parameter documentations has been truncated, see
|
|
33
|
-
# {Increase::Models::Simulations::CardDisputeActionParams} for more details.
|
|
34
|
-
#
|
|
35
32
|
# @param card_dispute_id [String] The dispute you would like to action.
|
|
36
33
|
#
|
|
37
|
-
# @param network [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Network]
|
|
34
|
+
# @param network [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Network]
|
|
35
|
+
# The network of the Card Dispute. Details specific to the network are required
|
|
36
|
+
# under the sub-object with the same identifier as the network.
|
|
38
37
|
#
|
|
39
|
-
# @param visa [Increase::Models::Simulations::CardDisputeActionParams::Visa]
|
|
38
|
+
# @param visa [Increase::Models::Simulations::CardDisputeActionParams::Visa]
|
|
39
|
+
# The Visa-specific parameters for the taking action on the dispute. Required if
|
|
40
|
+
# and only if `network` is `visa`.
|
|
40
41
|
#
|
|
41
42
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
42
43
|
|
|
@@ -139,33 +140,52 @@ module Increase
|
|
|
139
140
|
-> { Increase::Simulations::CardDisputeActionParams::Visa::TimeOutUserPrearbitration }
|
|
140
141
|
|
|
141
142
|
# @!method initialize(action:, accept_chargeback: nil, accept_user_submission: nil, decline_user_prearbitration: nil, receive_merchant_prearbitration: nil, represent: nil, request_further_information: nil, time_out_chargeback: nil, time_out_merchant_prearbitration: nil, time_out_representment: nil, time_out_user_prearbitration: nil)
|
|
142
|
-
# Some parameter documentations has been truncated, see
|
|
143
|
-
# {Increase::Models::Simulations::CardDisputeActionParams::Visa} for more details.
|
|
144
|
-
#
|
|
145
143
|
# The Visa-specific parameters for the taking action on the dispute. Required if
|
|
146
144
|
# and only if `network` is `visa`.
|
|
147
145
|
#
|
|
148
|
-
# @param action [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Visa::Action]
|
|
146
|
+
# @param action [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Visa::Action]
|
|
147
|
+
# The action to take. Details specific to the action are required under the
|
|
148
|
+
# sub-object with the same identifier as the action.
|
|
149
149
|
#
|
|
150
|
-
# @param accept_chargeback [Increase::Models::Simulations::CardDisputeActionParams::Visa::AcceptChargeback]
|
|
150
|
+
# @param accept_chargeback [Increase::Models::Simulations::CardDisputeActionParams::Visa::AcceptChargeback]
|
|
151
|
+
# The parameters for accepting the chargeback. Required if and only if `action` is
|
|
152
|
+
# `accept_chargeback`.
|
|
151
153
|
#
|
|
152
|
-
# @param accept_user_submission [Increase::Models::Simulations::CardDisputeActionParams::Visa::AcceptUserSubmission]
|
|
154
|
+
# @param accept_user_submission [Increase::Models::Simulations::CardDisputeActionParams::Visa::AcceptUserSubmission]
|
|
155
|
+
# The parameters for accepting the user submission. Required if and only if
|
|
156
|
+
# `action` is `accept_user_submission`.
|
|
153
157
|
#
|
|
154
|
-
# @param decline_user_prearbitration [Increase::Models::Simulations::CardDisputeActionParams::Visa::DeclineUserPrearbitration]
|
|
158
|
+
# @param decline_user_prearbitration [Increase::Models::Simulations::CardDisputeActionParams::Visa::DeclineUserPrearbitration]
|
|
159
|
+
# The parameters for declining the prearbitration. Required if and only if
|
|
160
|
+
# `action` is `decline_user_prearbitration`.
|
|
155
161
|
#
|
|
156
|
-
# @param receive_merchant_prearbitration [Increase::Models::Simulations::CardDisputeActionParams::Visa::ReceiveMerchantPrearbitration]
|
|
162
|
+
# @param receive_merchant_prearbitration [Increase::Models::Simulations::CardDisputeActionParams::Visa::ReceiveMerchantPrearbitration]
|
|
163
|
+
# The parameters for receiving the prearbitration. Required if and only if
|
|
164
|
+
# `action` is `receive_merchant_prearbitration`.
|
|
157
165
|
#
|
|
158
|
-
# @param represent [Increase::Models::Simulations::CardDisputeActionParams::Visa::Represent]
|
|
166
|
+
# @param represent [Increase::Models::Simulations::CardDisputeActionParams::Visa::Represent]
|
|
167
|
+
# The parameters for re-presenting the dispute. Required if and only if `action`
|
|
168
|
+
# is `represent`.
|
|
159
169
|
#
|
|
160
|
-
# @param request_further_information [Increase::Models::Simulations::CardDisputeActionParams::Visa::RequestFurtherInformation]
|
|
170
|
+
# @param request_further_information [Increase::Models::Simulations::CardDisputeActionParams::Visa::RequestFurtherInformation]
|
|
171
|
+
# The parameters for requesting further information from the user. Required if and
|
|
172
|
+
# only if `action` is `request_further_information`.
|
|
161
173
|
#
|
|
162
|
-
# @param time_out_chargeback [Increase::Models::Simulations::CardDisputeActionParams::Visa::TimeOutChargeback]
|
|
174
|
+
# @param time_out_chargeback [Increase::Models::Simulations::CardDisputeActionParams::Visa::TimeOutChargeback]
|
|
175
|
+
# The parameters for timing out the chargeback. Required if and only if `action`
|
|
176
|
+
# is `time_out_chargeback`.
|
|
163
177
|
#
|
|
164
|
-
# @param time_out_merchant_prearbitration [Increase::Models::Simulations::CardDisputeActionParams::Visa::TimeOutMerchantPrearbitration]
|
|
178
|
+
# @param time_out_merchant_prearbitration [Increase::Models::Simulations::CardDisputeActionParams::Visa::TimeOutMerchantPrearbitration]
|
|
179
|
+
# The parameters for timing out the merchant prearbitration. Required if and only
|
|
180
|
+
# if `action` is `time_out_merchant_prearbitration`.
|
|
165
181
|
#
|
|
166
|
-
# @param time_out_representment [Increase::Models::Simulations::CardDisputeActionParams::Visa::TimeOutRepresentment]
|
|
182
|
+
# @param time_out_representment [Increase::Models::Simulations::CardDisputeActionParams::Visa::TimeOutRepresentment]
|
|
183
|
+
# The parameters for timing out the re-presentment. Required if and only if
|
|
184
|
+
# `action` is `time_out_representment`.
|
|
167
185
|
#
|
|
168
|
-
# @param time_out_user_prearbitration [Increase::Models::Simulations::CardDisputeActionParams::Visa::TimeOutUserPrearbitration]
|
|
186
|
+
# @param time_out_user_prearbitration [Increase::Models::Simulations::CardDisputeActionParams::Visa::TimeOutUserPrearbitration]
|
|
187
|
+
# The parameters for timing out the user prearbitration. Required if and only if
|
|
188
|
+
# `action` is `time_out_user_prearbitration`.
|
|
169
189
|
|
|
170
190
|
# The action to take. Details specific to the action are required under the
|
|
171
191
|
# sub-object with the same identifier as the action.
|
|
@@ -22,11 +22,9 @@ module Increase
|
|
|
22
22
|
required :card_payment_id, String
|
|
23
23
|
|
|
24
24
|
# @!method initialize(amount:, card_payment_id:, request_options: {})
|
|
25
|
-
#
|
|
26
|
-
#
|
|
27
|
-
#
|
|
28
|
-
#
|
|
29
|
-
# @param amount [Integer] The amount of the fuel_confirmation in minor units in the card authorization's c
|
|
25
|
+
# @param amount [Integer]
|
|
26
|
+
# The amount of the fuel_confirmation in minor units in the card authorization's
|
|
27
|
+
# currency.
|
|
30
28
|
#
|
|
31
29
|
# @param card_payment_id [String] The identifier of the Card Payment to create a fuel_confirmation on.
|
|
32
30
|
#
|
|
@@ -30,14 +30,15 @@ module Increase
|
|
|
30
30
|
optional :event_subscription_id, String
|
|
31
31
|
|
|
32
32
|
# @!method initialize(amount:, card_payment_id:, event_subscription_id: nil, request_options: {})
|
|
33
|
-
# Some parameter documentations has been truncated, see
|
|
34
|
-
# {Increase::Models::Simulations::CardIncrementCreateParams} for more details.
|
|
35
|
-
#
|
|
36
33
|
# @param amount [Integer] The amount of the increment in minor units in the card authorization's currency.
|
|
37
34
|
#
|
|
38
35
|
# @param card_payment_id [String] The identifier of the Card Payment to create an increment on.
|
|
39
36
|
#
|
|
40
|
-
# @param event_subscription_id [String]
|
|
37
|
+
# @param event_subscription_id [String]
|
|
38
|
+
# The identifier of the Event Subscription to use. If provided, will override the
|
|
39
|
+
# default real time event subscription. Because you can only create one real time
|
|
40
|
+
# decision event subscription, you can use this field to route events to any
|
|
41
|
+
# specified event subscription for testing purposes.
|
|
41
42
|
#
|
|
42
43
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
43
44
|
end
|