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
|
@@ -4,9 +4,6 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class CheckDeposits
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::CheckDepositAdjustmentParams} for more details.
|
|
9
|
-
#
|
|
10
7
|
# Simulates the creation of a
|
|
11
8
|
# [Check Deposit Adjustment](#check-deposit-adjustments) on a
|
|
12
9
|
# [Check Deposit](#check-deposits). This Check Deposit must first have a `status`
|
|
@@ -16,9 +13,15 @@ module Increase
|
|
|
16
13
|
#
|
|
17
14
|
# @param check_deposit_id [String] The identifier of the Check Deposit you wish to adjust.
|
|
18
15
|
#
|
|
19
|
-
# @param amount [Integer]
|
|
16
|
+
# @param amount [Integer]
|
|
17
|
+
# The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
|
|
18
|
+
# cents). A negative amount means that the funds are being clawed back by the
|
|
19
|
+
# other bank and is a debit to your account. Defaults to the negative of the Check
|
|
20
|
+
# Deposit amount.
|
|
20
21
|
#
|
|
21
|
-
# @param reason [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason]
|
|
22
|
+
# @param reason [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason]
|
|
23
|
+
# The reason for the adjustment. Defaults to `non_conforming_item`, which is often
|
|
24
|
+
# used for a low quality image that the recipient wasn't able to handle.
|
|
22
25
|
#
|
|
23
26
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
27
|
#
|
|
@@ -79,9 +82,6 @@ module Increase
|
|
|
79
82
|
)
|
|
80
83
|
end
|
|
81
84
|
|
|
82
|
-
# Some parameter documentations has been truncated, see
|
|
83
|
-
# {Increase::Models::Simulations::CheckDepositSubmitParams} for more details.
|
|
84
|
-
#
|
|
85
85
|
# Simulates the submission of a [Check Deposit](#check-deposits) to the Federal
|
|
86
86
|
# Reserve. This Check Deposit must first have a `status` of `pending`.
|
|
87
87
|
#
|
|
@@ -89,7 +89,9 @@ module Increase
|
|
|
89
89
|
#
|
|
90
90
|
# @param check_deposit_id [String] The identifier of the Check Deposit you wish to submit.
|
|
91
91
|
#
|
|
92
|
-
# @param scan [Increase::Models::Simulations::CheckDepositSubmitParams::Scan]
|
|
92
|
+
# @param scan [Increase::Models::Simulations::CheckDepositSubmitParams::Scan]
|
|
93
|
+
# If set, the simulation will use these values for the check's scanned MICR data.
|
|
94
|
+
# If not set, the simulation will use random values.
|
|
93
95
|
#
|
|
94
96
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
95
97
|
#
|
|
@@ -4,9 +4,6 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class Entities
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::EntityUpdateValidationParams} for more details.
|
|
9
|
-
#
|
|
10
7
|
# Simulate updates to an
|
|
11
8
|
# [Entity's validation](/documentation/api/entities#entity-object.validation). In
|
|
12
9
|
# production, Know Your Customer validations
|
|
@@ -18,7 +15,9 @@ module Increase
|
|
|
18
15
|
#
|
|
19
16
|
# @param entity_id [String] The identifier of the Entity whose validation status to update.
|
|
20
17
|
#
|
|
21
|
-
# @param issues [Array<Increase::Models::Simulations::EntityUpdateValidationParams::Issue>]
|
|
18
|
+
# @param issues [Array<Increase::Models::Simulations::EntityUpdateValidationParams::Issue>]
|
|
19
|
+
# The validation issues to attach. If no issues are provided, the validation
|
|
20
|
+
# status will be set to `valid`.
|
|
22
21
|
#
|
|
23
22
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
23
|
#
|
|
@@ -11,7 +11,8 @@ module Increase
|
|
|
11
11
|
#
|
|
12
12
|
# @overload submit(entity_onboarding_session_id, request_options: {})
|
|
13
13
|
#
|
|
14
|
-
# @param entity_onboarding_session_id [String]
|
|
14
|
+
# @param entity_onboarding_session_id [String]
|
|
15
|
+
# The identifier of the Entity Onboarding Session you wish to submit.
|
|
15
16
|
#
|
|
16
17
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
17
18
|
#
|
|
@@ -4,9 +4,6 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class Exports
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::ExportCreateParams} for more details.
|
|
9
|
-
#
|
|
10
7
|
# Many exports are created by you via POST /exports or in the Dashboard. Some
|
|
11
8
|
# exports are created automatically by Increase. For example, tax documents are
|
|
12
9
|
# published once a year. In sandbox, you can trigger the arrival of an export that
|
|
@@ -14,9 +11,12 @@ module Increase
|
|
|
14
11
|
#
|
|
15
12
|
# @overload create(category:, form_1099_int: nil, request_options: {})
|
|
16
13
|
#
|
|
17
|
-
# @param category [Symbol, Increase::Models::Simulations::ExportCreateParams::Category]
|
|
14
|
+
# @param category [Symbol, Increase::Models::Simulations::ExportCreateParams::Category]
|
|
15
|
+
# The type of Export to create.
|
|
18
16
|
#
|
|
19
|
-
# @param form_1099_int [Increase::Models::Simulations::ExportCreateParams::Form1099Int]
|
|
17
|
+
# @param form_1099_int [Increase::Models::Simulations::ExportCreateParams::Form1099Int]
|
|
18
|
+
# Options for the created export. Required if `category` is equal to
|
|
19
|
+
# `form_1099_int`.
|
|
20
20
|
#
|
|
21
21
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
22
22
|
#
|
|
@@ -4,10 +4,6 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class InboundACHTransfers
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::InboundACHTransferCreateParams} for more
|
|
9
|
-
# details.
|
|
10
|
-
#
|
|
11
7
|
# Simulates an inbound ACH transfer to your account. This imitates initiating a
|
|
12
8
|
# transfer to an Increase account from a different financial institution. The
|
|
13
9
|
# transfer may be either a credit or a debit depending on if the `amount` is
|
|
@@ -23,9 +19,13 @@ module Increase
|
|
|
23
19
|
#
|
|
24
20
|
# @param account_number_id [String] The identifier of the Account Number the inbound ACH Transfer is for.
|
|
25
21
|
#
|
|
26
|
-
# @param amount [Integer]
|
|
22
|
+
# @param amount [Integer]
|
|
23
|
+
# The transfer amount in cents. A positive amount originates a credit transfer
|
|
24
|
+
# pushing funds to the receiving account. A negative amount originates a debit
|
|
25
|
+
# transfer pulling funds from the receiving account.
|
|
27
26
|
#
|
|
28
|
-
# @param addenda [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda]
|
|
27
|
+
# @param addenda [Increase::Models::Simulations::InboundACHTransferCreateParams::Addenda]
|
|
28
|
+
# Additional information to include in the transfer.
|
|
29
29
|
#
|
|
30
30
|
# @param company_descriptive_date [String] The description of the date of the transfer.
|
|
31
31
|
#
|
|
@@ -35,15 +35,20 @@ module Increase
|
|
|
35
35
|
#
|
|
36
36
|
# @param company_id [String] The sender's company ID.
|
|
37
37
|
#
|
|
38
|
-
# @param company_name [String]
|
|
38
|
+
# @param company_name [String]
|
|
39
|
+
# The name of the sender. This corresponds to the `originator_company_name` field
|
|
40
|
+
# on the resulting Inbound ACH Transfer.
|
|
39
41
|
#
|
|
40
42
|
# @param receiver_id_number [String] The ID of the receiver of the transfer.
|
|
41
43
|
#
|
|
42
44
|
# @param receiver_name [String] The name of the receiver of the transfer.
|
|
43
45
|
#
|
|
44
|
-
# @param resolve_at [Time]
|
|
46
|
+
# @param resolve_at [Time]
|
|
47
|
+
# The time at which the transfer should be resolved. If not provided will resolve
|
|
48
|
+
# immediately.
|
|
45
49
|
#
|
|
46
|
-
# @param standard_entry_class_code [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode]
|
|
50
|
+
# @param standard_entry_class_code [Symbol, Increase::Models::Simulations::InboundACHTransferCreateParams::StandardEntryClassCode]
|
|
51
|
+
# The standard entry class code for the transfer.
|
|
47
52
|
#
|
|
48
53
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
49
54
|
#
|
|
@@ -4,10 +4,6 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class InboundCheckDeposits
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::InboundCheckDepositCreateParams} for more
|
|
9
|
-
# details.
|
|
10
|
-
#
|
|
11
7
|
# Simulates an Inbound Check Deposit against your account. This imitates someone
|
|
12
8
|
# depositing a check at their bank that was issued from your account. It may or
|
|
13
9
|
# may not be associated with a Check Transfer. Increase will evaluate the Inbound
|
|
@@ -17,13 +13,17 @@ module Increase
|
|
|
17
13
|
#
|
|
18
14
|
# @overload create(account_number_id:, amount:, check_number:, payee_name_analysis: nil, request_options: {})
|
|
19
15
|
#
|
|
20
|
-
# @param account_number_id [String]
|
|
16
|
+
# @param account_number_id [String]
|
|
17
|
+
# The identifier of the Account Number the Inbound Check Deposit will be against.
|
|
21
18
|
#
|
|
22
19
|
# @param amount [Integer] The check amount in cents.
|
|
23
20
|
#
|
|
24
21
|
# @param check_number [String] The check number on the check to be deposited.
|
|
25
22
|
#
|
|
26
|
-
# @param payee_name_analysis [Symbol, Increase::Models::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis]
|
|
23
|
+
# @param payee_name_analysis [Symbol, Increase::Models::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis]
|
|
24
|
+
# Simulate the outcome of
|
|
25
|
+
# [payee name checking](https://increase.com/documentation/positive-pay#payee-name-mismatches).
|
|
26
|
+
# Defaults to `not_evaluated`.
|
|
27
27
|
#
|
|
28
28
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
29
29
|
#
|
|
@@ -41,10 +41,6 @@ module Increase
|
|
|
41
41
|
)
|
|
42
42
|
end
|
|
43
43
|
|
|
44
|
-
# Some parameter documentations has been truncated, see
|
|
45
|
-
# {Increase::Models::Simulations::InboundCheckDepositAdjustmentParams} for more
|
|
46
|
-
# details.
|
|
47
|
-
#
|
|
48
44
|
# Simulates an adjustment on an Inbound Check Deposit. The Inbound Check Deposit
|
|
49
45
|
# must have a `status` of `accepted`.
|
|
50
46
|
#
|
|
@@ -52,9 +48,12 @@ module Increase
|
|
|
52
48
|
#
|
|
53
49
|
# @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to adjust.
|
|
54
50
|
#
|
|
55
|
-
# @param amount [Integer]
|
|
51
|
+
# @param amount [Integer]
|
|
52
|
+
# The adjustment amount in cents. Defaults to the amount of the Inbound Check
|
|
53
|
+
# Deposit.
|
|
56
54
|
#
|
|
57
|
-
# @param reason [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason]
|
|
55
|
+
# @param reason [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason]
|
|
56
|
+
# The reason for the adjustment. Defaults to `wrong_payee_credit`.
|
|
58
57
|
#
|
|
59
58
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
60
59
|
#
|
|
@@ -4,9 +4,6 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class InboundMailItems
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::InboundMailItemCreateParams} for more details.
|
|
9
|
-
#
|
|
10
7
|
# Simulates an Inbound Mail Item to one of your Lockbox Addresses or Lockbox
|
|
11
8
|
# Recipients, as if someone had mailed a physical check. Increase automatically
|
|
12
9
|
# deposits a check mailed to a Lockbox Recipient into the recipient's Account. A
|
|
@@ -17,11 +14,17 @@ module Increase
|
|
|
17
14
|
#
|
|
18
15
|
# @param amount [Integer] The amount of the check to be simulated, in cents.
|
|
19
16
|
#
|
|
20
|
-
# @param contents_file_id [String]
|
|
17
|
+
# @param contents_file_id [String]
|
|
18
|
+
# The file containing the PDF contents. If not present, a default check image file
|
|
19
|
+
# will be used.
|
|
21
20
|
#
|
|
22
|
-
# @param lockbox_address_id [String]
|
|
21
|
+
# @param lockbox_address_id [String]
|
|
22
|
+
# The identifier of the Lockbox Address to simulate inbound mail to. Exactly one
|
|
23
|
+
# lockbox identifier parameter must be provided.
|
|
23
24
|
#
|
|
24
|
-
# @param lockbox_recipient_id [String]
|
|
25
|
+
# @param lockbox_recipient_id [String]
|
|
26
|
+
# The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one
|
|
27
|
+
# lockbox identifier parameter must be provided.
|
|
25
28
|
#
|
|
26
29
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
27
30
|
#
|
|
@@ -4,17 +4,15 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class InboundRealTimePaymentsTransfers
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::InboundRealTimePaymentsTransferCreateParams} for
|
|
9
|
-
# more details.
|
|
10
|
-
#
|
|
11
7
|
# Simulates an
|
|
12
8
|
# [Inbound Real-Time Payments Transfer](#inbound-real-time-payments-transfers) to
|
|
13
9
|
# your account. Real-Time Payments are a beta feature.
|
|
14
10
|
#
|
|
15
11
|
# @overload create(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: {})
|
|
16
12
|
#
|
|
17
|
-
# @param account_number_id [String]
|
|
13
|
+
# @param account_number_id [String]
|
|
14
|
+
# The identifier of the Account Number the inbound Real-Time Payments Transfer is
|
|
15
|
+
# for.
|
|
18
16
|
#
|
|
19
17
|
# @param amount [Integer] The transfer amount in USD cents. Must be positive.
|
|
20
18
|
#
|
|
@@ -24,7 +22,8 @@ module Increase
|
|
|
24
22
|
#
|
|
25
23
|
# @param debtor_routing_number [String] The routing number of the account that sent the transfer.
|
|
26
24
|
#
|
|
27
|
-
# @param request_for_payment_id [String]
|
|
25
|
+
# @param request_for_payment_id [String]
|
|
26
|
+
# The identifier of a pending Request for Payment that this transfer will fulfill.
|
|
28
27
|
#
|
|
29
28
|
# @param unstructured_remittance_information [String] Additional information included with the transfer.
|
|
30
29
|
#
|
|
@@ -4,10 +4,6 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class InboundWireDrawdownRequests
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::InboundWireDrawdownRequestCreateParams} for more
|
|
9
|
-
# details.
|
|
10
|
-
#
|
|
11
7
|
# Simulates receiving an
|
|
12
8
|
# [Inbound Wire Drawdown Request](#inbound-wire-drawdown-requests).
|
|
13
9
|
#
|
|
@@ -19,23 +15,37 @@ module Increase
|
|
|
19
15
|
#
|
|
20
16
|
# @param creditor_routing_number [String] The creditor's routing number.
|
|
21
17
|
#
|
|
22
|
-
# @param currency [String]
|
|
18
|
+
# @param currency [String]
|
|
19
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
|
|
20
|
+
# requested. Will always be "USD".
|
|
23
21
|
#
|
|
24
|
-
# @param recipient_account_number_id [String]
|
|
22
|
+
# @param recipient_account_number_id [String]
|
|
23
|
+
# The Account Number to which the recipient of this request is being requested to
|
|
24
|
+
# send funds from.
|
|
25
25
|
#
|
|
26
|
-
# @param creditor_address_line1 [String]
|
|
26
|
+
# @param creditor_address_line1 [String]
|
|
27
|
+
# A free-form address field set by the sender representing the first line of the
|
|
28
|
+
# creditor's address.
|
|
27
29
|
#
|
|
28
|
-
# @param creditor_address_line2 [String]
|
|
30
|
+
# @param creditor_address_line2 [String]
|
|
31
|
+
# A free-form address field set by the sender representing the second line of the
|
|
32
|
+
# creditor's address.
|
|
29
33
|
#
|
|
30
|
-
# @param creditor_address_line3 [String]
|
|
34
|
+
# @param creditor_address_line3 [String]
|
|
35
|
+
# A free-form address field set by the sender representing the third line of the
|
|
36
|
+
# creditor's address.
|
|
31
37
|
#
|
|
32
38
|
# @param creditor_name [String] A free-form name field set by the sender representing the creditor's name.
|
|
33
39
|
#
|
|
34
40
|
# @param debtor_account_number [String] The debtor's account number.
|
|
35
41
|
#
|
|
36
|
-
# @param debtor_address_line1 [String]
|
|
42
|
+
# @param debtor_address_line1 [String]
|
|
43
|
+
# A free-form address field set by the sender representing the first line of the
|
|
44
|
+
# debtor's address.
|
|
37
45
|
#
|
|
38
|
-
# @param debtor_address_line2 [String]
|
|
46
|
+
# @param debtor_address_line2 [String]
|
|
47
|
+
# A free-form address field set by the sender representing the second line of the
|
|
48
|
+
# debtor's address.
|
|
39
49
|
#
|
|
40
50
|
# @param debtor_address_line3 [String] A free-form address field set by the sender.
|
|
41
51
|
#
|
|
@@ -43,11 +53,15 @@ module Increase
|
|
|
43
53
|
#
|
|
44
54
|
# @param debtor_routing_number [String] The debtor's routing number.
|
|
45
55
|
#
|
|
46
|
-
# @param end_to_end_identification [String]
|
|
56
|
+
# @param end_to_end_identification [String]
|
|
57
|
+
# A free-form reference string set by the sender, to help identify the transfer.
|
|
47
58
|
#
|
|
48
59
|
# @param instruction_identification [String] The sending bank's identifier for the wire transfer.
|
|
49
60
|
#
|
|
50
|
-
# @param unique_end_to_end_transaction_reference [String]
|
|
61
|
+
# @param unique_end_to_end_transaction_reference [String]
|
|
62
|
+
# The Unique End-to-end Transaction Reference
|
|
63
|
+
# ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
|
|
64
|
+
# of the transfer.
|
|
51
65
|
#
|
|
52
66
|
# @param unstructured_remittance_information [String] A free-form message set by the sender.
|
|
53
67
|
#
|
|
@@ -4,10 +4,6 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class InboundWireTransfers
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::InboundWireTransferCreateParams} for more
|
|
9
|
-
# details.
|
|
10
|
-
#
|
|
11
7
|
# Simulates an [Inbound Wire Transfer](#inbound-wire-transfers) to your account.
|
|
12
8
|
#
|
|
13
9
|
# @overload create(account_number_id:, amount:, creditor_address_line1: nil, creditor_address_line2: nil, creditor_address_line3: nil, creditor_name: nil, debtor_address_line1: nil, debtor_address_line2: nil, debtor_address_line3: nil, debtor_name: nil, end_to_end_identification: nil, instructing_agent_routing_number: nil, instruction_identification: nil, purpose: nil, unique_end_to_end_transaction_reference: nil, unstructured_remittance_information: nil, wire_drawdown_request_id: nil, request_options: {})
|
|
@@ -16,35 +12,65 @@ module Increase
|
|
|
16
12
|
#
|
|
17
13
|
# @param amount [Integer] The transfer amount in cents. Must be positive.
|
|
18
14
|
#
|
|
19
|
-
# @param creditor_address_line1 [String]
|
|
15
|
+
# @param creditor_address_line1 [String]
|
|
16
|
+
# The sending bank will set creditor_address_line1 in production. You can simulate
|
|
17
|
+
# any value here.
|
|
20
18
|
#
|
|
21
|
-
# @param creditor_address_line2 [String]
|
|
19
|
+
# @param creditor_address_line2 [String]
|
|
20
|
+
# The sending bank will set creditor_address_line2 in production. You can simulate
|
|
21
|
+
# any value here.
|
|
22
22
|
#
|
|
23
|
-
# @param creditor_address_line3 [String]
|
|
23
|
+
# @param creditor_address_line3 [String]
|
|
24
|
+
# The sending bank will set creditor_address_line3 in production. You can simulate
|
|
25
|
+
# any value here.
|
|
24
26
|
#
|
|
25
|
-
# @param creditor_name [String]
|
|
27
|
+
# @param creditor_name [String]
|
|
28
|
+
# The sending bank will set creditor_name in production. You can simulate any
|
|
29
|
+
# value here.
|
|
26
30
|
#
|
|
27
|
-
# @param debtor_address_line1 [String]
|
|
31
|
+
# @param debtor_address_line1 [String]
|
|
32
|
+
# The sending bank will set debtor_address_line1 in production. You can simulate
|
|
33
|
+
# any value here.
|
|
28
34
|
#
|
|
29
|
-
# @param debtor_address_line2 [String]
|
|
35
|
+
# @param debtor_address_line2 [String]
|
|
36
|
+
# The sending bank will set debtor_address_line2 in production. You can simulate
|
|
37
|
+
# any value here.
|
|
30
38
|
#
|
|
31
|
-
# @param debtor_address_line3 [String]
|
|
39
|
+
# @param debtor_address_line3 [String]
|
|
40
|
+
# The sending bank will set debtor_address_line3 in production. You can simulate
|
|
41
|
+
# any value here.
|
|
32
42
|
#
|
|
33
|
-
# @param debtor_name [String]
|
|
43
|
+
# @param debtor_name [String]
|
|
44
|
+
# The sending bank will set debtor_name in production. You can simulate any value
|
|
45
|
+
# here.
|
|
34
46
|
#
|
|
35
|
-
# @param end_to_end_identification [String]
|
|
47
|
+
# @param end_to_end_identification [String]
|
|
48
|
+
# The sending bank will set end_to_end_identification in production. You can
|
|
49
|
+
# simulate any value here.
|
|
36
50
|
#
|
|
37
|
-
# @param instructing_agent_routing_number [String]
|
|
51
|
+
# @param instructing_agent_routing_number [String]
|
|
52
|
+
# The sending bank will set instructing_agent_routing_number in production. You
|
|
53
|
+
# can simulate any value here.
|
|
38
54
|
#
|
|
39
|
-
# @param instruction_identification [String]
|
|
55
|
+
# @param instruction_identification [String]
|
|
56
|
+
# The sending bank will set instruction_identification in production. You can
|
|
57
|
+
# simulate any value here.
|
|
40
58
|
#
|
|
41
|
-
# @param purpose [String]
|
|
59
|
+
# @param purpose [String]
|
|
60
|
+
# The sending bank will set purpose in production. You can simulate any value
|
|
61
|
+
# here.
|
|
42
62
|
#
|
|
43
|
-
# @param unique_end_to_end_transaction_reference [String]
|
|
63
|
+
# @param unique_end_to_end_transaction_reference [String]
|
|
64
|
+
# The sending bank will set unique_end_to_end_transaction_reference in production.
|
|
65
|
+
# You can simulate any value here.
|
|
44
66
|
#
|
|
45
|
-
# @param unstructured_remittance_information [String]
|
|
67
|
+
# @param unstructured_remittance_information [String]
|
|
68
|
+
# The sending bank will set unstructured_remittance_information in production. You
|
|
69
|
+
# can simulate any value here.
|
|
46
70
|
#
|
|
47
|
-
# @param wire_drawdown_request_id [String]
|
|
71
|
+
# @param wire_drawdown_request_id [String]
|
|
72
|
+
# The identifier of a Wire Drawdown Request the inbound Wire Transfer is
|
|
73
|
+
# fulfilling.
|
|
48
74
|
#
|
|
49
75
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
50
76
|
#
|
|
@@ -4,9 +4,6 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class InterestPayments
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::InterestPaymentCreateParams} for more details.
|
|
9
|
-
#
|
|
10
7
|
# Simulates an interest payment to your account. In production, this happens
|
|
11
8
|
# automatically on the first of each month.
|
|
12
9
|
#
|
|
@@ -16,11 +13,13 @@ module Increase
|
|
|
16
13
|
#
|
|
17
14
|
# @param amount [Integer] The interest amount in cents. Must be positive.
|
|
18
15
|
#
|
|
19
|
-
# @param accrued_on_account_id [String]
|
|
16
|
+
# @param accrued_on_account_id [String]
|
|
17
|
+
# The identifier of the Account the Interest accrued on. Defaults to `account_id`.
|
|
20
18
|
#
|
|
21
19
|
# @param period_end [Time] The end of the interest period. If not provided, defaults to the current time.
|
|
22
20
|
#
|
|
23
|
-
# @param period_start [Time]
|
|
21
|
+
# @param period_start [Time]
|
|
22
|
+
# The start of the interest period. If not provided, defaults to the current time.
|
|
24
23
|
#
|
|
25
24
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
26
25
|
#
|
|
@@ -4,16 +4,14 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class PendingTransactions
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::PendingTransactionReleaseInboundFundsHoldParams}
|
|
9
|
-
# for more details.
|
|
10
|
-
#
|
|
11
7
|
# This endpoint simulates immediately releasing an Inbound Funds Hold, which might
|
|
12
8
|
# be created as a result of, for example, an ACH debit.
|
|
13
9
|
#
|
|
14
10
|
# @overload release_inbound_funds_hold(pending_transaction_id, request_options: {})
|
|
15
11
|
#
|
|
16
|
-
# @param pending_transaction_id [String]
|
|
12
|
+
# @param pending_transaction_id [String]
|
|
13
|
+
# The pending transaction to release. The pending transaction must have a
|
|
14
|
+
# `inbound_funds_hold` source.
|
|
17
15
|
#
|
|
18
16
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
19
17
|
#
|
|
@@ -4,9 +4,6 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class PhysicalCards
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::PhysicalCardCreateParams} for more details.
|
|
9
|
-
#
|
|
10
7
|
# This endpoint allows you to simulate receiving a tracking update for a Physical
|
|
11
8
|
# Card, to simulate the progress of a shipment.
|
|
12
9
|
#
|
|
@@ -14,9 +11,12 @@ module Increase
|
|
|
14
11
|
#
|
|
15
12
|
# @param physical_card_id [String] The Physical Card you would like to action.
|
|
16
13
|
#
|
|
17
|
-
# @param category [Symbol, Increase::Models::Simulations::PhysicalCardCreateParams::Category]
|
|
14
|
+
# @param category [Symbol, Increase::Models::Simulations::PhysicalCardCreateParams::Category]
|
|
15
|
+
# The type of tracking event.
|
|
18
16
|
#
|
|
19
|
-
# @param carrier_estimated_delivery_at [Time]
|
|
17
|
+
# @param carrier_estimated_delivery_at [Time]
|
|
18
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the
|
|
19
|
+
# carrier expects the card to be delivered.
|
|
20
20
|
#
|
|
21
21
|
# @param city [String] The city where the event took place.
|
|
22
22
|
#
|
|
@@ -48,7 +48,8 @@ module Increase
|
|
|
48
48
|
#
|
|
49
49
|
# @param physical_card_id [String] The Physical Card you would like to action.
|
|
50
50
|
#
|
|
51
|
-
# @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus]
|
|
51
|
+
# @param shipment_status [Symbol, Increase::Models::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus]
|
|
52
|
+
# The shipment status to move the Physical Card to.
|
|
52
53
|
#
|
|
53
54
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
54
55
|
#
|
|
@@ -13,9 +13,11 @@ module Increase
|
|
|
13
13
|
#
|
|
14
14
|
# @param name [String] The name of the program being added.
|
|
15
15
|
#
|
|
16
|
-
# @param bank [Symbol, Increase::Models::Simulations::ProgramCreateParams::Bank]
|
|
16
|
+
# @param bank [Symbol, Increase::Models::Simulations::ProgramCreateParams::Bank]
|
|
17
|
+
# The bank for the program's accounts, defaults to First Internet Bank.
|
|
17
18
|
#
|
|
18
|
-
# @param lending_maximum_extendable_credit [Integer]
|
|
19
|
+
# @param lending_maximum_extendable_credit [Integer]
|
|
20
|
+
# The maximum extendable credit of the program being added.
|
|
19
21
|
#
|
|
20
22
|
# @param reserve_account_id [String] The identifier of the Account the Program should be added to is for.
|
|
21
23
|
#
|
|
@@ -11,9 +11,11 @@ module Increase
|
|
|
11
11
|
#
|
|
12
12
|
# @overload complete(real_time_payments_transfer_id, rejection: nil, request_options: {})
|
|
13
13
|
#
|
|
14
|
-
# @param real_time_payments_transfer_id [String]
|
|
14
|
+
# @param real_time_payments_transfer_id [String]
|
|
15
|
+
# The identifier of the Real-Time Payments Transfer you wish to complete.
|
|
15
16
|
#
|
|
16
|
-
# @param rejection [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection]
|
|
17
|
+
# @param rejection [Increase::Models::Simulations::RealTimePaymentsTransferCompleteParams::Rejection]
|
|
18
|
+
# If set, the simulation will reject the transfer.
|
|
17
19
|
#
|
|
18
20
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
19
21
|
#
|
|
@@ -27,9 +27,6 @@ module Increase
|
|
|
27
27
|
)
|
|
28
28
|
end
|
|
29
29
|
|
|
30
|
-
# Some parameter documentations has been truncated, see
|
|
31
|
-
# {Increase::Models::SupplementalDocumentListParams} for more details.
|
|
32
|
-
#
|
|
33
30
|
# List Entity Supplemental Document Submissions
|
|
34
31
|
#
|
|
35
32
|
# @overload list(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
@@ -38,9 +35,15 @@ module Increase
|
|
|
38
35
|
#
|
|
39
36
|
# @param cursor [String] Return the page of entries after this one.
|
|
40
37
|
#
|
|
41
|
-
# @param idempotency_key [String]
|
|
38
|
+
# @param idempotency_key [String]
|
|
39
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
40
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
41
|
+
# request is only processed once. Learn more about
|
|
42
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
42
43
|
#
|
|
43
|
-
# @param limit [Integer]
|
|
44
|
+
# @param limit [Integer]
|
|
45
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
46
|
+
# objects.
|
|
44
47
|
#
|
|
45
48
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
46
49
|
#
|