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
|
@@ -29,15 +29,15 @@ module Increase
|
|
|
29
29
|
-> { Increase::Internal::Type::ArrayOf[Increase::Simulations::CardPurchaseSupplementCreateParams::LineItem] }
|
|
30
30
|
|
|
31
31
|
# @!method initialize(transaction_id:, invoice: nil, line_items: nil, request_options: {})
|
|
32
|
-
#
|
|
33
|
-
#
|
|
34
|
-
#
|
|
32
|
+
# @param transaction_id [String]
|
|
33
|
+
# The identifier of the Transaction to create a Card Purchase Supplement for. The
|
|
34
|
+
# Transaction must have a source of type `card_settlement`.
|
|
35
35
|
#
|
|
36
|
-
# @param
|
|
36
|
+
# @param invoice [Increase::Models::Simulations::CardPurchaseSupplementCreateParams::Invoice]
|
|
37
|
+
# Invoice-level information about the payment.
|
|
37
38
|
#
|
|
38
|
-
# @param
|
|
39
|
-
#
|
|
40
|
-
# @param line_items [Array<Increase::Models::Simulations::CardPurchaseSupplementCreateParams::LineItem>] Line item information, such as individual products purchased.
|
|
39
|
+
# @param line_items [Array<Increase::Models::Simulations::CardPurchaseSupplementCreateParams::LineItem>]
|
|
40
|
+
# Line item information, such as individual products purchased.
|
|
41
41
|
#
|
|
42
42
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
43
43
|
|
|
@@ -31,14 +31,18 @@ module Increase
|
|
|
31
31
|
optional :transaction_id, String
|
|
32
32
|
|
|
33
33
|
# @!method initialize(amount: nil, pending_transaction_id: nil, transaction_id: nil, request_options: {})
|
|
34
|
-
#
|
|
35
|
-
#
|
|
34
|
+
# @param amount [Integer]
|
|
35
|
+
# The refund amount in cents. Pulled off the `pending_transaction` or the
|
|
36
|
+
# `transaction` if not provided.
|
|
36
37
|
#
|
|
37
|
-
# @param
|
|
38
|
+
# @param pending_transaction_id [String]
|
|
39
|
+
# The identifier of the Pending Transaction for the refund authorization. If this
|
|
40
|
+
# is provided, `transaction` must not be provided as a refund with a refund
|
|
41
|
+
# authorized can not be linked to a regular transaction.
|
|
38
42
|
#
|
|
39
|
-
# @param
|
|
40
|
-
#
|
|
41
|
-
#
|
|
43
|
+
# @param transaction_id [String]
|
|
44
|
+
# The identifier for the Transaction to refund. The Transaction's source must have
|
|
45
|
+
# a category of card_settlement.
|
|
42
46
|
#
|
|
43
47
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
44
48
|
end
|
|
@@ -22,12 +22,11 @@ module Increase
|
|
|
22
22
|
optional :amount, Integer
|
|
23
23
|
|
|
24
24
|
# @!method initialize(card_payment_id:, amount: nil, request_options: {})
|
|
25
|
-
# Some parameter documentations has been truncated, see
|
|
26
|
-
# {Increase::Models::Simulations::CardReversalCreateParams} for more details.
|
|
27
|
-
#
|
|
28
25
|
# @param card_payment_id [String] The identifier of the Card Payment to create a reversal on.
|
|
29
26
|
#
|
|
30
|
-
# @param amount [Integer]
|
|
27
|
+
# @param amount [Integer]
|
|
28
|
+
# The amount of the reversal in minor units in the card authorization's currency.
|
|
29
|
+
# This defaults to the authorization amount.
|
|
31
30
|
#
|
|
32
31
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
33
32
|
end
|
|
@@ -29,14 +29,15 @@ module Increase
|
|
|
29
29
|
optional :amount, Integer
|
|
30
30
|
|
|
31
31
|
# @!method initialize(card_id:, pending_transaction_id:, amount: nil, request_options: {})
|
|
32
|
-
# Some parameter documentations has been truncated, see
|
|
33
|
-
# {Increase::Models::Simulations::CardSettlementCreateParams} for more details.
|
|
34
|
-
#
|
|
35
32
|
# @param card_id [String] The identifier of the Card to create a settlement on.
|
|
36
33
|
#
|
|
37
|
-
# @param pending_transaction_id [String]
|
|
34
|
+
# @param pending_transaction_id [String]
|
|
35
|
+
# The identifier of the Pending Transaction for the Card Authorization you wish to
|
|
36
|
+
# settle.
|
|
38
37
|
#
|
|
39
|
-
# @param amount [Integer]
|
|
38
|
+
# @param amount [Integer]
|
|
39
|
+
# The amount to be settled. This defaults to the amount of the Pending Transaction
|
|
40
|
+
# being settled.
|
|
40
41
|
#
|
|
41
42
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
42
43
|
end
|
|
@@ -46,17 +46,20 @@ module Increase
|
|
|
46
46
|
optional :primary_account_number_length, Integer
|
|
47
47
|
|
|
48
48
|
# @!method initialize(capabilities: nil, expiration: nil, last4: nil, outcome: nil, prefix: nil, primary_account_number_length: nil, request_options: {})
|
|
49
|
-
# @param capabilities [Array<Increase::Models::Simulations::CardTokenCreateParams::Capability>]
|
|
49
|
+
# @param capabilities [Array<Increase::Models::Simulations::CardTokenCreateParams::Capability>]
|
|
50
|
+
# The capabilities of the outbound card token.
|
|
50
51
|
#
|
|
51
52
|
# @param expiration [Date] The expiration date of the card.
|
|
52
53
|
#
|
|
53
54
|
# @param last4 [String] The last 4 digits of the card number.
|
|
54
55
|
#
|
|
55
|
-
# @param outcome [Increase::Models::Simulations::CardTokenCreateParams::Outcome]
|
|
56
|
+
# @param outcome [Increase::Models::Simulations::CardTokenCreateParams::Outcome]
|
|
57
|
+
# The outcome to simulate for card push transfers using this token.
|
|
56
58
|
#
|
|
57
59
|
# @param prefix [String] The prefix of the card number, usually the first 8 digits.
|
|
58
60
|
#
|
|
59
|
-
# @param primary_account_number_length [Integer]
|
|
61
|
+
# @param primary_account_number_length [Integer]
|
|
62
|
+
# The total length of the card number, including prefix and last4.
|
|
60
63
|
#
|
|
61
64
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
62
65
|
|
|
@@ -82,11 +85,14 @@ module Increase
|
|
|
82
85
|
required :route, enum: -> { Increase::Simulations::CardTokenCreateParams::Capability::Route }
|
|
83
86
|
|
|
84
87
|
# @!method initialize(cross_border_push_transfers:, domestic_push_transfers:, route:)
|
|
85
|
-
# @param cross_border_push_transfers [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Capability::CrossBorderPushTransfers]
|
|
88
|
+
# @param cross_border_push_transfers [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Capability::CrossBorderPushTransfers]
|
|
89
|
+
# The cross-border push transfers capability.
|
|
86
90
|
#
|
|
87
|
-
# @param domestic_push_transfers [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Capability::DomesticPushTransfers]
|
|
91
|
+
# @param domestic_push_transfers [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Capability::DomesticPushTransfers]
|
|
92
|
+
# The domestic push transfers capability.
|
|
88
93
|
#
|
|
89
|
-
# @param route [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Capability::Route]
|
|
94
|
+
# @param route [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Capability::Route]
|
|
95
|
+
# The route of the capability.
|
|
90
96
|
|
|
91
97
|
# The cross-border push transfers capability.
|
|
92
98
|
#
|
|
@@ -156,9 +162,11 @@ module Increase
|
|
|
156
162
|
# @!method initialize(result:, decline: nil)
|
|
157
163
|
# The outcome to simulate for card push transfers using this token.
|
|
158
164
|
#
|
|
159
|
-
# @param result [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Outcome::Result]
|
|
165
|
+
# @param result [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Outcome::Result]
|
|
166
|
+
# Whether card push transfers or validations will be approved or declined.
|
|
160
167
|
#
|
|
161
|
-
# @param decline [Increase::Models::Simulations::CardTokenCreateParams::Outcome::Decline]
|
|
168
|
+
# @param decline [Increase::Models::Simulations::CardTokenCreateParams::Outcome::Decline]
|
|
169
|
+
# If the result is declined, the details of the decline.
|
|
162
170
|
|
|
163
171
|
# Whether card push transfers or validations will be approved or declined.
|
|
164
172
|
#
|
|
@@ -187,7 +195,8 @@ module Increase
|
|
|
187
195
|
# @!method initialize(reason: nil)
|
|
188
196
|
# If the result is declined, the details of the decline.
|
|
189
197
|
#
|
|
190
|
-
# @param reason [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Outcome::Decline::Reason]
|
|
198
|
+
# @param reason [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Outcome::Decline::Reason]
|
|
199
|
+
# The reason for the decline.
|
|
191
200
|
|
|
192
201
|
# The reason for the decline.
|
|
193
202
|
#
|
|
@@ -31,14 +31,17 @@ module Increase
|
|
|
31
31
|
optional :reason, enum: -> { Increase::Simulations::CheckDepositAdjustmentParams::Reason }
|
|
32
32
|
|
|
33
33
|
# @!method initialize(check_deposit_id:, amount: nil, reason: nil, request_options: {})
|
|
34
|
-
# Some parameter documentations has been truncated, see
|
|
35
|
-
# {Increase::Models::Simulations::CheckDepositAdjustmentParams} for more details.
|
|
36
|
-
#
|
|
37
34
|
# @param check_deposit_id [String] The identifier of the Check Deposit you wish to adjust.
|
|
38
35
|
#
|
|
39
|
-
# @param amount [Integer]
|
|
36
|
+
# @param amount [Integer]
|
|
37
|
+
# The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
|
|
38
|
+
# cents). A negative amount means that the funds are being clawed back by the
|
|
39
|
+
# other bank and is a debit to your account. Defaults to the negative of the Check
|
|
40
|
+
# Deposit amount.
|
|
40
41
|
#
|
|
41
|
-
# @param reason [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason]
|
|
42
|
+
# @param reason [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason]
|
|
43
|
+
# The reason for the adjustment. Defaults to `non_conforming_item`, which is often
|
|
44
|
+
# used for a low quality image that the recipient wasn't able to handle.
|
|
42
45
|
#
|
|
43
46
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
44
47
|
|
|
@@ -22,12 +22,11 @@ module Increase
|
|
|
22
22
|
optional :scan, -> { Increase::Simulations::CheckDepositSubmitParams::Scan }
|
|
23
23
|
|
|
24
24
|
# @!method initialize(check_deposit_id:, scan: nil, request_options: {})
|
|
25
|
-
# Some parameter documentations has been truncated, see
|
|
26
|
-
# {Increase::Models::Simulations::CheckDepositSubmitParams} for more details.
|
|
27
|
-
#
|
|
28
25
|
# @param check_deposit_id [String] The identifier of the Check Deposit you wish to submit.
|
|
29
26
|
#
|
|
30
|
-
# @param scan [Increase::Models::Simulations::CheckDepositSubmitParams::Scan]
|
|
27
|
+
# @param scan [Increase::Models::Simulations::CheckDepositSubmitParams::Scan]
|
|
28
|
+
# If set, the simulation will use these values for the check's scanned MICR data.
|
|
29
|
+
# If not set, the simulation will use random values.
|
|
31
30
|
#
|
|
32
31
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
33
32
|
|
|
@@ -59,10 +58,6 @@ module Increase
|
|
|
59
58
|
optional :serial_number, String
|
|
60
59
|
|
|
61
60
|
# @!method initialize(account_number:, routing_number:, auxiliary_on_us: nil, serial_number: nil)
|
|
62
|
-
# Some parameter documentations has been truncated, see
|
|
63
|
-
# {Increase::Models::Simulations::CheckDepositSubmitParams::Scan} for more
|
|
64
|
-
# details.
|
|
65
|
-
#
|
|
66
61
|
# If set, the simulation will use these values for the check's scanned MICR data.
|
|
67
62
|
# If not set, the simulation will use random values.
|
|
68
63
|
#
|
|
@@ -70,9 +65,13 @@ module Increase
|
|
|
70
65
|
#
|
|
71
66
|
# @param routing_number [String] The routing number to be returned in the check deposit's scan data.
|
|
72
67
|
#
|
|
73
|
-
# @param auxiliary_on_us [String]
|
|
68
|
+
# @param auxiliary_on_us [String]
|
|
69
|
+
# The auxiliary on-us data to be returned in the check deposit's scan data.
|
|
70
|
+
# Auxiliary on-us is typically the check number for business checks.
|
|
74
71
|
#
|
|
75
|
-
# @param serial_number [String]
|
|
72
|
+
# @param serial_number [String]
|
|
73
|
+
# The serial number to be returned in the check deposit's scan data. Serial number
|
|
74
|
+
# is typically the check number for consumer checks.
|
|
76
75
|
end
|
|
77
76
|
end
|
|
78
77
|
end
|
|
@@ -29,17 +29,19 @@ module Increase
|
|
|
29
29
|
required :type, enum: -> { Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::Type }
|
|
30
30
|
|
|
31
31
|
# @!method initialize(decline_reason:, digital_wallet_token_id:, type:)
|
|
32
|
-
# Some parameter documentations has been truncated, see
|
|
33
|
-
# {Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse} for
|
|
34
|
-
# more details.
|
|
35
|
-
#
|
|
36
32
|
# The results of a Digital Wallet Token simulation.
|
|
37
33
|
#
|
|
38
|
-
# @param decline_reason [Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason, nil]
|
|
34
|
+
# @param decline_reason [Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::DeclineReason, nil]
|
|
35
|
+
# If the simulated tokenization attempt was declined, this field contains details
|
|
36
|
+
# as to why.
|
|
39
37
|
#
|
|
40
|
-
# @param digital_wallet_token_id [String, nil]
|
|
38
|
+
# @param digital_wallet_token_id [String, nil]
|
|
39
|
+
# If the simulated tokenization attempt was accepted, this field contains the id
|
|
40
|
+
# of the Digital Wallet Token that was created.
|
|
41
41
|
#
|
|
42
|
-
# @param type [Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::Type]
|
|
42
|
+
# @param type [Symbol, Increase::Models::Simulations::DigitalWalletTokenRequestCreateResponse::Type]
|
|
43
|
+
# A constant representing the object's type. For this resource it will always be
|
|
44
|
+
# `inbound_digital_wallet_token_request_simulation_result`.
|
|
43
45
|
|
|
44
46
|
# If the simulated tokenization attempt was declined, this field contains details
|
|
45
47
|
# as to why.
|
|
@@ -15,7 +15,8 @@ module Increase
|
|
|
15
15
|
required :entity_onboarding_session_id, String
|
|
16
16
|
|
|
17
17
|
# @!method initialize(entity_onboarding_session_id:, request_options: {})
|
|
18
|
-
# @param entity_onboarding_session_id [String]
|
|
18
|
+
# @param entity_onboarding_session_id [String]
|
|
19
|
+
# The identifier of the Entity Onboarding Session you wish to submit.
|
|
19
20
|
#
|
|
20
21
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
21
22
|
end
|
|
@@ -23,12 +23,11 @@ module Increase
|
|
|
23
23
|
-> { Increase::Internal::Type::ArrayOf[Increase::Simulations::EntityUpdateValidationParams::Issue] }
|
|
24
24
|
|
|
25
25
|
# @!method initialize(entity_id:, issues:, request_options: {})
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::Simulations::EntityUpdateValidationParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# @param entity_id [String] The identifier of the Entity whose validation status to update.
|
|
30
27
|
#
|
|
31
|
-
# @param issues [Array<Increase::Models::Simulations::EntityUpdateValidationParams::Issue>]
|
|
28
|
+
# @param issues [Array<Increase::Models::Simulations::EntityUpdateValidationParams::Issue>]
|
|
29
|
+
# The validation issues to attach. If no issues are provided, the validation
|
|
30
|
+
# status will be set to `valid`.
|
|
32
31
|
#
|
|
33
32
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
34
33
|
|
|
@@ -40,7 +39,8 @@ module Increase
|
|
|
40
39
|
required :category, enum: -> { Increase::Simulations::EntityUpdateValidationParams::Issue::Category }
|
|
41
40
|
|
|
42
41
|
# @!method initialize(category:)
|
|
43
|
-
# @param category [Symbol, Increase::Models::Simulations::EntityUpdateValidationParams::Issue::Category]
|
|
42
|
+
# @param category [Symbol, Increase::Models::Simulations::EntityUpdateValidationParams::Issue::Category]
|
|
43
|
+
# The type of issue.
|
|
44
44
|
|
|
45
45
|
# The type of issue.
|
|
46
46
|
#
|
|
@@ -22,12 +22,12 @@ module Increase
|
|
|
22
22
|
optional :form_1099_int, -> { Increase::Simulations::ExportCreateParams::Form1099Int }
|
|
23
23
|
|
|
24
24
|
# @!method initialize(category:, form_1099_int: nil, request_options: {})
|
|
25
|
-
#
|
|
26
|
-
#
|
|
25
|
+
# @param category [Symbol, Increase::Models::Simulations::ExportCreateParams::Category]
|
|
26
|
+
# The type of Export to create.
|
|
27
27
|
#
|
|
28
|
-
# @param
|
|
29
|
-
#
|
|
30
|
-
#
|
|
28
|
+
# @param form_1099_int [Increase::Models::Simulations::ExportCreateParams::Form1099Int]
|
|
29
|
+
# Options for the created export. Required if `category` is equal to
|
|
30
|
+
# `form_1099_int`.
|
|
31
31
|
#
|
|
32
32
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
33
33
|
|
|
@@ -86,15 +86,15 @@ module Increase
|
|
|
86
86
|
enum: -> { Increase::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode }
|
|
87
87
|
|
|
88
88
|
# @!method initialize(account_number_id:, amount:, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_id: nil, company_name: nil, receiver_id_number: nil, receiver_name: nil, resolve_at: nil, standard_entry_class_code: nil, request_options: {})
|
|
89
|
-
# Some parameter documentations has been truncated, see
|
|
90
|
-
# {Increase::Models::Simulations::InboundACHTransferCreateParams} for more
|
|
91
|
-
# details.
|
|
92
|
-
#
|
|
93
89
|
# @param account_number_id [String] The identifier of the Account Number the inbound ACH Transfer is for.
|
|
94
90
|
#
|
|
95
|
-
# @param amount [Integer]
|
|
91
|
+
# @param amount [Integer]
|
|
92
|
+
# The transfer amount in cents. A positive amount originates a credit transfer
|
|
93
|
+
# pushing funds to the receiving account. A negative amount originates a debit
|
|
94
|
+
# transfer pulling funds from the receiving account.
|
|
96
95
|
#
|
|
97
|
-
# @param addenda [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda]
|
|
96
|
+
# @param addenda [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda]
|
|
97
|
+
# Additional information to include in the transfer.
|
|
98
98
|
#
|
|
99
99
|
# @param company_descriptive_date [String] The description of the date of the transfer.
|
|
100
100
|
#
|
|
@@ -104,15 +104,20 @@ module Increase
|
|
|
104
104
|
#
|
|
105
105
|
# @param company_id [String] The sender's company ID.
|
|
106
106
|
#
|
|
107
|
-
# @param company_name [String]
|
|
107
|
+
# @param company_name [String]
|
|
108
|
+
# The name of the sender. This corresponds to the `originator_company_name` field
|
|
109
|
+
# on the resulting Inbound ACH Transfer.
|
|
108
110
|
#
|
|
109
111
|
# @param receiver_id_number [String] The ID of the receiver of the transfer.
|
|
110
112
|
#
|
|
111
113
|
# @param receiver_name [String] The name of the receiver of the transfer.
|
|
112
114
|
#
|
|
113
|
-
# @param resolve_at [Time]
|
|
115
|
+
# @param resolve_at [Time]
|
|
116
|
+
# The time at which the transfer should be resolved. If not provided will resolve
|
|
117
|
+
# immediately.
|
|
114
118
|
#
|
|
115
|
-
# @param standard_entry_class_code [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode]
|
|
119
|
+
# @param standard_entry_class_code [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode]
|
|
120
|
+
# The standard entry class code for the transfer.
|
|
116
121
|
#
|
|
117
122
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
118
123
|
|
|
@@ -132,9 +137,11 @@ module Increase
|
|
|
132
137
|
# @!method initialize(category:, freeform: nil)
|
|
133
138
|
# Additional information to include in the transfer.
|
|
134
139
|
#
|
|
135
|
-
# @param category [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Category]
|
|
140
|
+
# @param category [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Category]
|
|
141
|
+
# The type of addenda to simulate being sent with the transfer.
|
|
136
142
|
#
|
|
137
|
-
# @param freeform [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform]
|
|
143
|
+
# @param freeform [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform]
|
|
144
|
+
# Unstructured `payment_related_information` passed through with the transfer.
|
|
138
145
|
|
|
139
146
|
# The type of addenda to simulate being sent with the transfer.
|
|
140
147
|
#
|
|
@@ -161,7 +168,8 @@ module Increase
|
|
|
161
168
|
# @!method initialize(entries:)
|
|
162
169
|
# Unstructured `payment_related_information` passed through with the transfer.
|
|
163
170
|
#
|
|
164
|
-
# @param entries [Array<Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform::Entry>]
|
|
171
|
+
# @param entries [Array<Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda::Freeform::Entry>]
|
|
172
|
+
# Each entry represents an addendum sent with the transfer.
|
|
165
173
|
|
|
166
174
|
class Entry < Increase::Internal::Type::BaseModel
|
|
167
175
|
# @!attribute payment_related_information
|
|
@@ -28,15 +28,14 @@ module Increase
|
|
|
28
28
|
optional :reason, enum: -> { Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason }
|
|
29
29
|
|
|
30
30
|
# @!method initialize(inbound_check_deposit_id:, amount: nil, reason: nil, request_options: {})
|
|
31
|
-
# Some parameter documentations has been truncated, see
|
|
32
|
-
# {Increase::Models::Simulations::InboundCheckDepositAdjustmentParams} for more
|
|
33
|
-
# details.
|
|
34
|
-
#
|
|
35
31
|
# @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to adjust.
|
|
36
32
|
#
|
|
37
|
-
# @param amount [Integer]
|
|
33
|
+
# @param amount [Integer]
|
|
34
|
+
# The adjustment amount in cents. Defaults to the amount of the Inbound Check
|
|
35
|
+
# Deposit.
|
|
38
36
|
#
|
|
39
|
-
# @param reason [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason]
|
|
37
|
+
# @param reason [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason]
|
|
38
|
+
# The reason for the adjustment. Defaults to `wrong_payee_credit`.
|
|
40
39
|
#
|
|
41
40
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
42
41
|
|
|
@@ -36,17 +36,17 @@ module Increase
|
|
|
36
36
|
enum: -> { Increase::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis }
|
|
37
37
|
|
|
38
38
|
# @!method initialize(account_number_id:, amount:, check_number:, payee_name_analysis: nil, request_options: {})
|
|
39
|
-
#
|
|
40
|
-
#
|
|
41
|
-
# details.
|
|
42
|
-
#
|
|
43
|
-
# @param account_number_id [String] The identifier of the Account Number the Inbound Check Deposit will be against.
|
|
39
|
+
# @param account_number_id [String]
|
|
40
|
+
# The identifier of the Account Number the Inbound Check Deposit will be against.
|
|
44
41
|
#
|
|
45
42
|
# @param amount [Integer] The check amount in cents.
|
|
46
43
|
#
|
|
47
44
|
# @param check_number [String] The check number on the check to be deposited.
|
|
48
45
|
#
|
|
49
|
-
# @param payee_name_analysis [Symbol, Increase::Models::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis]
|
|
46
|
+
# @param payee_name_analysis [Symbol, Increase::Models::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis]
|
|
47
|
+
# Simulate the outcome of
|
|
48
|
+
# [payee name checking](https://increase.com/documentation/positive-pay#payee-name-mismatches).
|
|
49
|
+
# Defaults to `not_evaluated`.
|
|
50
50
|
#
|
|
51
51
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
52
52
|
|
|
@@ -36,16 +36,19 @@ module Increase
|
|
|
36
36
|
optional :lockbox_recipient_id, String
|
|
37
37
|
|
|
38
38
|
# @!method initialize(amount:, contents_file_id: nil, lockbox_address_id: nil, lockbox_recipient_id: nil, request_options: {})
|
|
39
|
-
# Some parameter documentations has been truncated, see
|
|
40
|
-
# {Increase::Models::Simulations::InboundMailItemCreateParams} for more details.
|
|
41
|
-
#
|
|
42
39
|
# @param amount [Integer] The amount of the check to be simulated, in cents.
|
|
43
40
|
#
|
|
44
|
-
# @param contents_file_id [String]
|
|
41
|
+
# @param contents_file_id [String]
|
|
42
|
+
# The file containing the PDF contents. If not present, a default check image file
|
|
43
|
+
# will be used.
|
|
45
44
|
#
|
|
46
|
-
# @param lockbox_address_id [String]
|
|
45
|
+
# @param lockbox_address_id [String]
|
|
46
|
+
# The identifier of the Lockbox Address to simulate inbound mail to. Exactly one
|
|
47
|
+
# lockbox identifier parameter must be provided.
|
|
47
48
|
#
|
|
48
|
-
# @param lockbox_recipient_id [String]
|
|
49
|
+
# @param lockbox_recipient_id [String]
|
|
50
|
+
# The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
|
|
51
|
+
# lockbox identifier parameter must be provided.
|
|
49
52
|
#
|
|
50
53
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
51
54
|
end
|
|
@@ -52,11 +52,9 @@ module Increase
|
|
|
52
52
|
optional :unstructured_remittance_information, String
|
|
53
53
|
|
|
54
54
|
# @!method initialize(account_number_id:, amount:, debtor_account_number: nil, debtor_name: nil, debtor_routing_number: nil, request_for_payment_id: nil, unstructured_remittance_information: nil, request_options: {})
|
|
55
|
-
#
|
|
56
|
-
#
|
|
57
|
-
#
|
|
58
|
-
#
|
|
59
|
-
# @param account_number_id [String] The identifier of the Account Number the inbound Real-Time Payments Transfer is
|
|
55
|
+
# @param account_number_id [String]
|
|
56
|
+
# The identifier of the Account Number the inbound Real-Time Payments Transfer is
|
|
57
|
+
# for.
|
|
60
58
|
#
|
|
61
59
|
# @param amount [Integer] The transfer amount in USD cents. Must be positive.
|
|
62
60
|
#
|
|
@@ -66,7 +64,8 @@ module Increase
|
|
|
66
64
|
#
|
|
67
65
|
# @param debtor_routing_number [String] The routing number of the account that sent the transfer.
|
|
68
66
|
#
|
|
69
|
-
# @param request_for_payment_id [String]
|
|
67
|
+
# @param request_for_payment_id [String]
|
|
68
|
+
# The identifier of a pending Request for Payment that this transfer will fulfill.
|
|
70
69
|
#
|
|
71
70
|
# @param unstructured_remittance_information [String] Additional information included with the transfer.
|
|
72
71
|
#
|
|
@@ -132,33 +132,43 @@ module Increase
|
|
|
132
132
|
optional :unstructured_remittance_information, String
|
|
133
133
|
|
|
134
134
|
# @!method initialize(amount:, creditor_account_number:, creditor_routing_number:, currency:, recipient_account_number_id:, creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_account_number: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, debtor_routing_number: nil, end_to_end_identification: nil, instruction_identification: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: nil, request_options: {})
|
|
135
|
-
# Some parameter documentations has been truncated, see
|
|
136
|
-
# {Increase::Models::Simulations::InboundWireDrawdownRequestCreateParams} for more
|
|
137
|
-
# details.
|
|
138
|
-
#
|
|
139
135
|
# @param amount [Integer] The amount being requested in cents.
|
|
140
136
|
#
|
|
141
137
|
# @param creditor_account_number [String] The creditor's account number.
|
|
142
138
|
#
|
|
143
139
|
# @param creditor_routing_number [String] The creditor's routing number.
|
|
144
140
|
#
|
|
145
|
-
# @param currency [String]
|
|
141
|
+
# @param currency [String]
|
|
142
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
|
|
143
|
+
# requested. Will always be "USD".
|
|
146
144
|
#
|
|
147
|
-
# @param recipient_account_number_id [String]
|
|
145
|
+
# @param recipient_account_number_id [String]
|
|
146
|
+
# The Account Number to which the recipient of this request is being requested to
|
|
147
|
+
# send funds from.
|
|
148
148
|
#
|
|
149
|
-
# @param creditor_address_line1 [String]
|
|
149
|
+
# @param creditor_address_line1 [String]
|
|
150
|
+
# A free-form address field set by the sender representing the first line of the
|
|
151
|
+
# creditor's address.
|
|
150
152
|
#
|
|
151
|
-
# @param creditor_address_line2 [String]
|
|
153
|
+
# @param creditor_address_line2 [String]
|
|
154
|
+
# A free-form address field set by the sender representing the second line of the
|
|
155
|
+
# creditor's address.
|
|
152
156
|
#
|
|
153
|
-
# @param creditor_address_line3 [String]
|
|
157
|
+
# @param creditor_address_line3 [String]
|
|
158
|
+
# A free-form address field set by the sender representing the third line of the
|
|
159
|
+
# creditor's address.
|
|
154
160
|
#
|
|
155
161
|
# @param creditor_name [String] A free-form name field set by the sender representing the creditor's name.
|
|
156
162
|
#
|
|
157
163
|
# @param debtor_account_number [String] The debtor's account number.
|
|
158
164
|
#
|
|
159
|
-
# @param debtor_address_line1 [String]
|
|
165
|
+
# @param debtor_address_line1 [String]
|
|
166
|
+
# A free-form address field set by the sender representing the first line of the
|
|
167
|
+
# debtor's address.
|
|
160
168
|
#
|
|
161
|
-
# @param debtor_address_line2 [String]
|
|
169
|
+
# @param debtor_address_line2 [String]
|
|
170
|
+
# A free-form address field set by the sender representing the second line of the
|
|
171
|
+
# debtor's address.
|
|
162
172
|
#
|
|
163
173
|
# @param debtor_address_line3 [String] A free-form address field set by the sender.
|
|
164
174
|
#
|
|
@@ -166,11 +176,15 @@ module Increase
|
|
|
166
176
|
#
|
|
167
177
|
# @param debtor_routing_number [String] The debtor's routing number.
|
|
168
178
|
#
|
|
169
|
-
# @param end_to_end_identification [String]
|
|
179
|
+
# @param end_to_end_identification [String]
|
|
180
|
+
# A free-form reference string set by the sender, to help identify the transfer.
|
|
170
181
|
#
|
|
171
182
|
# @param instruction_identification [String] The sending bank's identifier for the wire transfer.
|
|
172
183
|
#
|
|
173
|
-
# @param unique_end_to_end_transaction_reference [String]
|
|
184
|
+
# @param unique_end_to_end_transaction_reference [String]
|
|
185
|
+
# The Unique End-to-end Transaction Reference
|
|
186
|
+
# ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
|
|
187
|
+
# of the transfer.
|
|
174
188
|
#
|
|
175
189
|
# @param unstructured_remittance_information [String] A free-form message set by the sender.
|
|
176
190
|
#
|