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
|
@@ -79,30 +79,40 @@ module Increase
|
|
|
79
79
|
optional :source_account_number_id, String
|
|
80
80
|
|
|
81
81
|
# @!method initialize(account_id:, amount:, creditor:, remittance:, account_number: nil, debtor: nil, external_account_id: nil, inbound_wire_drawdown_request_id: nil, require_approval: nil, routing_number: nil, source_account_number_id: nil, request_options: {})
|
|
82
|
-
# Some parameter documentations has been truncated, see
|
|
83
|
-
# {Increase::Models::WireTransferCreateParams} for more details.
|
|
84
|
-
#
|
|
85
82
|
# @param account_id [String] The identifier for the account that will send the transfer.
|
|
86
83
|
#
|
|
87
84
|
# @param amount [Integer] The transfer amount in USD cents.
|
|
88
85
|
#
|
|
89
|
-
# @param creditor [Increase::Models::WireTransferCreateParams::Creditor]
|
|
86
|
+
# @param creditor [Increase::Models::WireTransferCreateParams::Creditor]
|
|
87
|
+
# The person or business that is receiving the funds from the transfer.
|
|
90
88
|
#
|
|
91
|
-
# @param remittance [Increase::Models::WireTransferCreateParams::Remittance]
|
|
89
|
+
# @param remittance [Increase::Models::WireTransferCreateParams::Remittance]
|
|
90
|
+
# Additional remittance information related to the wire transfer.
|
|
92
91
|
#
|
|
93
92
|
# @param account_number [String] The account number for the destination account.
|
|
94
93
|
#
|
|
95
|
-
# @param debtor [Increase::Models::WireTransferCreateParams::Debtor]
|
|
94
|
+
# @param debtor [Increase::Models::WireTransferCreateParams::Debtor]
|
|
95
|
+
# The person or business whose funds are being transferred. This is only necessary
|
|
96
|
+
# if you're transferring from a commingled account. Otherwise, we'll use the
|
|
97
|
+
# associated entity's details.
|
|
96
98
|
#
|
|
97
|
-
# @param external_account_id [String]
|
|
99
|
+
# @param external_account_id [String]
|
|
100
|
+
# The ID of an External Account to initiate a transfer to. If this parameter is
|
|
101
|
+
# provided, `account_number` and `routing_number` must be absent.
|
|
98
102
|
#
|
|
99
|
-
# @param inbound_wire_drawdown_request_id [String]
|
|
103
|
+
# @param inbound_wire_drawdown_request_id [String]
|
|
104
|
+
# The ID of an Inbound Wire Drawdown Request in response to which this transfer is
|
|
105
|
+
# being sent.
|
|
100
106
|
#
|
|
101
|
-
# @param require_approval [Boolean]
|
|
107
|
+
# @param require_approval [Boolean]
|
|
108
|
+
# Whether the transfer requires explicit approval via the dashboard or API.
|
|
102
109
|
#
|
|
103
|
-
# @param routing_number [String]
|
|
110
|
+
# @param routing_number [String]
|
|
111
|
+
# The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
|
|
112
|
+
# destination account.
|
|
104
113
|
#
|
|
105
|
-
# @param source_account_number_id [String]
|
|
114
|
+
# @param source_account_number_id [String]
|
|
115
|
+
# The ID of an Account Number that will be passed to the wire's recipient
|
|
106
116
|
#
|
|
107
117
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
108
118
|
|
|
@@ -124,7 +134,8 @@ module Increase
|
|
|
124
134
|
#
|
|
125
135
|
# @param name [String] The person or business's name.
|
|
126
136
|
#
|
|
127
|
-
# @param address [Increase::Models::WireTransferCreateParams::Creditor::Address]
|
|
137
|
+
# @param address [Increase::Models::WireTransferCreateParams::Creditor::Address]
|
|
138
|
+
# The person or business's address.
|
|
128
139
|
|
|
129
140
|
# @see Increase::Models::WireTransferCreateParams::Creditor#address
|
|
130
141
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -137,7 +148,8 @@ module Increase
|
|
|
137
148
|
# @!method initialize(unstructured:)
|
|
138
149
|
# The person or business's address.
|
|
139
150
|
#
|
|
140
|
-
# @param unstructured [Increase::Models::WireTransferCreateParams::Creditor::Address::Unstructured]
|
|
151
|
+
# @param unstructured [Increase::Models::WireTransferCreateParams::Creditor::Address::Unstructured]
|
|
152
|
+
# Unstructured address lines.
|
|
141
153
|
|
|
142
154
|
# @see Increase::Models::WireTransferCreateParams::Creditor::Address#unstructured
|
|
143
155
|
class Unstructured < Increase::Internal::Type::BaseModel
|
|
@@ -193,16 +205,18 @@ module Increase
|
|
|
193
205
|
optional :unstructured, -> { Increase::WireTransferCreateParams::Remittance::Unstructured }
|
|
194
206
|
|
|
195
207
|
# @!method initialize(category:, tax: nil, unstructured: nil)
|
|
196
|
-
# Some parameter documentations has been truncated, see
|
|
197
|
-
# {Increase::Models::WireTransferCreateParams::Remittance} for more details.
|
|
198
|
-
#
|
|
199
208
|
# Additional remittance information related to the wire transfer.
|
|
200
209
|
#
|
|
201
|
-
# @param category [Symbol, Increase::Models::WireTransferCreateParams::Remittance::Category]
|
|
210
|
+
# @param category [Symbol, Increase::Models::WireTransferCreateParams::Remittance::Category]
|
|
211
|
+
# The type of remittance information being passed.
|
|
202
212
|
#
|
|
203
|
-
# @param tax [Increase::Models::WireTransferCreateParams::Remittance::Tax]
|
|
213
|
+
# @param tax [Increase::Models::WireTransferCreateParams::Remittance::Tax]
|
|
214
|
+
# Internal Revenue Service (IRS) tax repayment information. Required if `category`
|
|
215
|
+
# is equal to `tax`.
|
|
204
216
|
#
|
|
205
|
-
# @param unstructured [Increase::Models::WireTransferCreateParams::Remittance::Unstructured]
|
|
217
|
+
# @param unstructured [Increase::Models::WireTransferCreateParams::Remittance::Unstructured]
|
|
218
|
+
# Unstructured remittance information. Required if `category` is equal to
|
|
219
|
+
# `unstructured`.
|
|
206
220
|
|
|
207
221
|
# The type of remittance information being passed.
|
|
208
222
|
#
|
|
@@ -243,15 +257,16 @@ module Increase
|
|
|
243
257
|
required :type_code, String
|
|
244
258
|
|
|
245
259
|
# @!method initialize(date:, identification_number:, type_code:)
|
|
246
|
-
# Some parameter documentations has been truncated, see
|
|
247
|
-
# {Increase::Models::WireTransferCreateParams::Remittance::Tax} for more details.
|
|
248
|
-
#
|
|
249
260
|
# Internal Revenue Service (IRS) tax repayment information. Required if `category`
|
|
250
261
|
# is equal to `tax`.
|
|
251
262
|
#
|
|
252
|
-
# @param date [Date]
|
|
263
|
+
# @param date [Date]
|
|
264
|
+
# The month and year the tax payment is for, in YYYY-MM-DD format. The day is
|
|
265
|
+
# ignored.
|
|
253
266
|
#
|
|
254
|
-
# @param identification_number [String]
|
|
267
|
+
# @param identification_number [String]
|
|
268
|
+
# The 9-digit Tax Identification Number (TIN) or Employer Identification Number
|
|
269
|
+
# (EIN).
|
|
255
270
|
#
|
|
256
271
|
# @param type_code [String] The 5-character tax type code.
|
|
257
272
|
end
|
|
@@ -292,7 +307,8 @@ module Increase
|
|
|
292
307
|
#
|
|
293
308
|
# @param name [String] The person or business's name.
|
|
294
309
|
#
|
|
295
|
-
# @param address [Increase::Models::WireTransferCreateParams::Debtor::Address]
|
|
310
|
+
# @param address [Increase::Models::WireTransferCreateParams::Debtor::Address]
|
|
311
|
+
# The person or business's address.
|
|
296
312
|
|
|
297
313
|
# @see Increase::Models::WireTransferCreateParams::Debtor#address
|
|
298
314
|
class Address < Increase::Internal::Type::BaseModel
|
|
@@ -305,7 +321,8 @@ module Increase
|
|
|
305
321
|
# @!method initialize(unstructured:)
|
|
306
322
|
# The person or business's address.
|
|
307
323
|
#
|
|
308
|
-
# @param unstructured [Increase::Models::WireTransferCreateParams::Debtor::Address::Unstructured]
|
|
324
|
+
# @param unstructured [Increase::Models::WireTransferCreateParams::Debtor::Address::Unstructured]
|
|
325
|
+
# Unstructured address lines.
|
|
309
326
|
|
|
310
327
|
# @see Increase::Models::WireTransferCreateParams::Debtor::Address#unstructured
|
|
311
328
|
class Unstructured < Increase::Internal::Type::BaseModel
|
|
@@ -52,9 +52,6 @@ module Increase
|
|
|
52
52
|
optional :status, -> { Increase::WireTransferListParams::Status }
|
|
53
53
|
|
|
54
54
|
# @!method initialize(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
55
|
-
# Some parameter documentations has been truncated, see
|
|
56
|
-
# {Increase::Models::WireTransferListParams} for more details.
|
|
57
|
-
#
|
|
58
55
|
# @param account_id [String] Filter Wire Transfers to those belonging to the specified Account.
|
|
59
56
|
#
|
|
60
57
|
# @param created_at [Increase::Models::WireTransferListParams::CreatedAt]
|
|
@@ -63,9 +60,15 @@ module Increase
|
|
|
63
60
|
#
|
|
64
61
|
# @param external_account_id [String] Filter Wire Transfers to those made to the specified External Account.
|
|
65
62
|
#
|
|
66
|
-
# @param idempotency_key [String]
|
|
63
|
+
# @param idempotency_key [String]
|
|
64
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
65
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
66
|
+
# request is only processed once. Learn more about
|
|
67
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
67
68
|
#
|
|
68
|
-
# @param limit [Integer]
|
|
69
|
+
# @param limit [Integer]
|
|
70
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
71
|
+
# objects.
|
|
69
72
|
#
|
|
70
73
|
# @param status [Increase::Models::WireTransferListParams::Status]
|
|
71
74
|
#
|
|
@@ -101,16 +104,21 @@ module Increase
|
|
|
101
104
|
optional :on_or_before, Time
|
|
102
105
|
|
|
103
106
|
# @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
|
|
104
|
-
#
|
|
105
|
-
#
|
|
106
|
-
#
|
|
107
|
-
# @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
|
|
107
|
+
# @param after [Time]
|
|
108
|
+
# Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
109
|
+
# timestamp.
|
|
108
110
|
#
|
|
109
|
-
# @param before [Time]
|
|
111
|
+
# @param before [Time]
|
|
112
|
+
# Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
113
|
+
# timestamp.
|
|
110
114
|
#
|
|
111
|
-
# @param on_or_after [Time]
|
|
115
|
+
# @param on_or_after [Time]
|
|
116
|
+
# Return results on or after this
|
|
117
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
112
118
|
#
|
|
113
|
-
# @param on_or_before [Time]
|
|
119
|
+
# @param on_or_before [Time]
|
|
120
|
+
# Return results on or before this
|
|
121
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
114
122
|
end
|
|
115
123
|
|
|
116
124
|
class Status < Increase::Internal::Type::BaseModel
|
|
@@ -124,10 +132,9 @@ module Increase
|
|
|
124
132
|
api_name: :in
|
|
125
133
|
|
|
126
134
|
# @!method initialize(in_: nil)
|
|
127
|
-
#
|
|
128
|
-
#
|
|
129
|
-
#
|
|
130
|
-
# @param in_ [Array<Symbol, Increase::Models::WireTransferListParams::Status::In>] Return results whose value is in the provided list. For GET requests, this shoul
|
|
135
|
+
# @param in_ [Array<Symbol, Increase::Models::WireTransferListParams::Status::In>]
|
|
136
|
+
# Return results whose value is in the provided list. For GET requests, this
|
|
137
|
+
# should be encoded as a comma-delimited string, such as `?in=one,two,three`.
|
|
131
138
|
|
|
132
139
|
module In
|
|
133
140
|
extend Increase::Internal::Type::Enum
|
|
@@ -3,9 +3,6 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class AccountNumbers
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::AccountNumberCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create an Account Number
|
|
10
7
|
#
|
|
11
8
|
# @overload create(account_id:, name:, inbound_ach: nil, inbound_checks: nil, request_options: {})
|
|
@@ -14,9 +11,12 @@ module Increase
|
|
|
14
11
|
#
|
|
15
12
|
# @param name [String] The name you choose for the Account Number.
|
|
16
13
|
#
|
|
17
|
-
# @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH]
|
|
14
|
+
# @param inbound_ach [Increase::Models::AccountNumberCreateParams::InboundACH]
|
|
15
|
+
# Options related to how this Account Number should handle inbound ACH transfers.
|
|
18
16
|
#
|
|
19
|
-
# @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks]
|
|
17
|
+
# @param inbound_checks [Increase::Models::AccountNumberCreateParams::InboundChecks]
|
|
18
|
+
# Options related to how this Account Number should handle inbound check
|
|
19
|
+
# withdrawals.
|
|
20
20
|
#
|
|
21
21
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
22
22
|
#
|
|
@@ -54,22 +54,23 @@ module Increase
|
|
|
54
54
|
)
|
|
55
55
|
end
|
|
56
56
|
|
|
57
|
-
# Some parameter documentations has been truncated, see
|
|
58
|
-
# {Increase::Models::AccountNumberUpdateParams} for more details.
|
|
59
|
-
#
|
|
60
57
|
# Update an Account Number
|
|
61
58
|
#
|
|
62
59
|
# @overload update(account_number_id, inbound_ach: nil, inbound_checks: nil, name: nil, status: nil, request_options: {})
|
|
63
60
|
#
|
|
64
61
|
# @param account_number_id [String] The identifier of the Account Number.
|
|
65
62
|
#
|
|
66
|
-
# @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH]
|
|
63
|
+
# @param inbound_ach [Increase::Models::AccountNumberUpdateParams::InboundACH]
|
|
64
|
+
# Options related to how this Account Number handles inbound ACH transfers.
|
|
67
65
|
#
|
|
68
|
-
# @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks]
|
|
66
|
+
# @param inbound_checks [Increase::Models::AccountNumberUpdateParams::InboundChecks]
|
|
67
|
+
# Options related to how this Account Number should handle inbound check
|
|
68
|
+
# withdrawals.
|
|
69
69
|
#
|
|
70
70
|
# @param name [String] The name you choose for the Account Number.
|
|
71
71
|
#
|
|
72
|
-
# @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status]
|
|
72
|
+
# @param status [Symbol, Increase::Models::AccountNumberUpdateParams::Status]
|
|
73
|
+
# This indicates if transfers can be made to the Account Number.
|
|
73
74
|
#
|
|
74
75
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
75
76
|
#
|
|
@@ -87,9 +88,6 @@ module Increase
|
|
|
87
88
|
)
|
|
88
89
|
end
|
|
89
90
|
|
|
90
|
-
# Some parameter documentations has been truncated, see
|
|
91
|
-
# {Increase::Models::AccountNumberListParams} for more details.
|
|
92
|
-
#
|
|
93
91
|
# List Account Numbers
|
|
94
92
|
#
|
|
95
93
|
# @overload list(account_id: nil, ach_debit_status: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
@@ -102,9 +100,15 @@ module Increase
|
|
|
102
100
|
#
|
|
103
101
|
# @param cursor [String] Return the page of entries after this one.
|
|
104
102
|
#
|
|
105
|
-
# @param idempotency_key [String]
|
|
103
|
+
# @param idempotency_key [String]
|
|
104
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
105
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
106
|
+
# request is only processed once. Learn more about
|
|
107
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
106
108
|
#
|
|
107
|
-
# @param limit [Integer]
|
|
109
|
+
# @param limit [Integer]
|
|
110
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
111
|
+
# objects.
|
|
108
112
|
#
|
|
109
113
|
# @param status [Increase::Models::AccountNumberListParams::Status]
|
|
110
114
|
#
|
|
@@ -23,9 +23,6 @@ module Increase
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::AccountStatementListParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# List Account Statements
|
|
30
27
|
#
|
|
31
28
|
# @overload list(account_id: nil, cursor: nil, limit: nil, statement_period_start: nil, request_options: {})
|
|
@@ -34,7 +31,9 @@ module Increase
|
|
|
34
31
|
#
|
|
35
32
|
# @param cursor [String] Return the page of entries after this one.
|
|
36
33
|
#
|
|
37
|
-
# @param limit [Integer]
|
|
34
|
+
# @param limit [Integer]
|
|
35
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
36
|
+
# objects.
|
|
38
37
|
#
|
|
39
38
|
# @param statement_period_start [Increase::Models::AccountStatementListParams::StatementPeriodStart]
|
|
40
39
|
#
|
|
@@ -3,22 +3,27 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class AccountTransfers
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::AccountTransferCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create an Account Transfer
|
|
10
7
|
#
|
|
11
8
|
# @overload create(account_id:, amount:, description:, destination_account_id:, require_approval: nil, request_options: {})
|
|
12
9
|
#
|
|
13
10
|
# @param account_id [String] The identifier for the originating Account that will send the transfer.
|
|
14
11
|
#
|
|
15
|
-
# @param amount [Integer]
|
|
12
|
+
# @param amount [Integer]
|
|
13
|
+
# The transfer amount in the minor unit of the account currency. For dollars, for
|
|
14
|
+
# example, this is cents.
|
|
16
15
|
#
|
|
17
|
-
# @param description [String]
|
|
16
|
+
# @param description [String]
|
|
17
|
+
# An internal-facing description for the transfer for display in the API and
|
|
18
|
+
# dashboard. This will also show in the description of the created Transactions.
|
|
18
19
|
#
|
|
19
|
-
# @param destination_account_id [String]
|
|
20
|
+
# @param destination_account_id [String]
|
|
21
|
+
# The identifier for the destination Account that will receive the transfer.
|
|
20
22
|
#
|
|
21
|
-
# @param require_approval [Boolean]
|
|
23
|
+
# @param require_approval [Boolean]
|
|
24
|
+
# Whether the transfer should require explicit approval via the dashboard or API.
|
|
25
|
+
# For more information, see
|
|
26
|
+
# [Transfer Approvals](/documentation/transfer-approvals).
|
|
22
27
|
#
|
|
23
28
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
29
|
#
|
|
@@ -56,9 +61,6 @@ module Increase
|
|
|
56
61
|
)
|
|
57
62
|
end
|
|
58
63
|
|
|
59
|
-
# Some parameter documentations has been truncated, see
|
|
60
|
-
# {Increase::Models::AccountTransferListParams} for more details.
|
|
61
|
-
#
|
|
62
64
|
# List Account Transfers
|
|
63
65
|
#
|
|
64
66
|
# @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
@@ -69,9 +71,15 @@ module Increase
|
|
|
69
71
|
#
|
|
70
72
|
# @param cursor [String] Return the page of entries after this one.
|
|
71
73
|
#
|
|
72
|
-
# @param idempotency_key [String]
|
|
74
|
+
# @param idempotency_key [String]
|
|
75
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
76
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
77
|
+
# request is only processed once. Learn more about
|
|
78
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
73
79
|
#
|
|
74
|
-
# @param limit [Integer]
|
|
80
|
+
# @param limit [Integer]
|
|
81
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
82
|
+
# objects.
|
|
75
83
|
#
|
|
76
84
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
77
85
|
#
|
|
@@ -3,9 +3,6 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class Accounts
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::AccountCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create an Account
|
|
10
7
|
#
|
|
11
8
|
# @overload create(name:, entity_id: nil, funding: nil, informational_entity_id: nil, loan: nil, program_id: nil, request_options: {})
|
|
@@ -14,13 +11,19 @@ module Increase
|
|
|
14
11
|
#
|
|
15
12
|
# @param entity_id [String] The identifier for the Entity that will own the Account.
|
|
16
13
|
#
|
|
17
|
-
# @param funding [Symbol, Increase::Models::AccountCreateParams::Funding]
|
|
14
|
+
# @param funding [Symbol, Increase::Models::AccountCreateParams::Funding]
|
|
15
|
+
# Whether the Account is funded by a loan or by deposits.
|
|
18
16
|
#
|
|
19
|
-
# @param informational_entity_id [String]
|
|
17
|
+
# @param informational_entity_id [String]
|
|
18
|
+
# The identifier of an Entity that, while not owning the Account, is associated
|
|
19
|
+
# with its activity. This is generally the beneficiary of the funds.
|
|
20
20
|
#
|
|
21
21
|
# @param loan [Increase::Models::AccountCreateParams::Loan] The loan details for the account.
|
|
22
22
|
#
|
|
23
|
-
# @param program_id [String]
|
|
23
|
+
# @param program_id [String]
|
|
24
|
+
# The identifier for the Program that this Account falls under. Required if your
|
|
25
|
+
# Group operates more than one Program. List your [Programs](#programs) to find
|
|
26
|
+
# their identifiers.
|
|
24
27
|
#
|
|
25
28
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
26
29
|
#
|
|
@@ -84,9 +87,6 @@ module Increase
|
|
|
84
87
|
)
|
|
85
88
|
end
|
|
86
89
|
|
|
87
|
-
# Some parameter documentations has been truncated, see
|
|
88
|
-
# {Increase::Models::AccountListParams} for more details.
|
|
89
|
-
#
|
|
90
90
|
# List Accounts
|
|
91
91
|
#
|
|
92
92
|
# @overload list(created_at: nil, cursor: nil, entity_id: nil, idempotency_key: nil, informational_entity_id: nil, limit: nil, program_id: nil, status: nil, request_options: {})
|
|
@@ -97,11 +97,18 @@ module Increase
|
|
|
97
97
|
#
|
|
98
98
|
# @param entity_id [String] Filter Accounts for those belonging to the specified Entity.
|
|
99
99
|
#
|
|
100
|
-
# @param idempotency_key [String]
|
|
100
|
+
# @param idempotency_key [String]
|
|
101
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
102
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
103
|
+
# request is only processed once. Learn more about
|
|
104
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
101
105
|
#
|
|
102
|
-
# @param informational_entity_id [String]
|
|
106
|
+
# @param informational_entity_id [String]
|
|
107
|
+
# Filter Accounts for those belonging to the specified Entity as informational.
|
|
103
108
|
#
|
|
104
|
-
# @param limit [Integer]
|
|
109
|
+
# @param limit [Integer]
|
|
110
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
111
|
+
# objects.
|
|
105
112
|
#
|
|
106
113
|
# @param program_id [String] Filter Accounts for those in a specific Program.
|
|
107
114
|
#
|
|
@@ -3,9 +3,6 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class ACHPrenotifications
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::ACHPrenotificationCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create an ACH Prenotification
|
|
10
7
|
#
|
|
11
8
|
# @overload create(account_id:, account_number:, routing_number:, addendum: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, credit_debit_indicator: nil, effective_date: nil, individual_id: nil, individual_name: nil, standard_entry_class_code: nil, request_options: {})
|
|
@@ -14,7 +11,9 @@ module Increase
|
|
|
14
11
|
#
|
|
15
12
|
# @param account_number [String] The account number for the destination account.
|
|
16
13
|
#
|
|
17
|
-
# @param routing_number [String]
|
|
14
|
+
# @param routing_number [String]
|
|
15
|
+
# The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
|
|
16
|
+
# destination account.
|
|
18
17
|
#
|
|
19
18
|
# @param addendum [String] Additional information that will be sent to the recipient.
|
|
20
19
|
#
|
|
@@ -26,15 +25,23 @@ module Increase
|
|
|
26
25
|
#
|
|
27
26
|
# @param company_name [String] The name by which the recipient knows you.
|
|
28
27
|
#
|
|
29
|
-
# @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator]
|
|
28
|
+
# @param credit_debit_indicator [Symbol, Increase::Models::ACHPrenotificationCreateParams::CreditDebitIndicator]
|
|
29
|
+
# Whether the Prenotification is for a future debit or credit.
|
|
30
30
|
#
|
|
31
|
-
# @param effective_date [Date]
|
|
31
|
+
# @param effective_date [Date]
|
|
32
|
+
# The ACH Prenotification effective date in
|
|
33
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
|
|
32
34
|
#
|
|
33
35
|
# @param individual_id [String] Your identifier for the recipient.
|
|
34
36
|
#
|
|
35
|
-
# @param individual_name [String]
|
|
37
|
+
# @param individual_name [String]
|
|
38
|
+
# The name of therecipient. This value is informational and not verified by the
|
|
39
|
+
# recipient's bank.
|
|
36
40
|
#
|
|
37
|
-
# @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode]
|
|
41
|
+
# @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode]
|
|
42
|
+
# The
|
|
43
|
+
# [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
|
|
44
|
+
# to use for the ACH Prenotification.
|
|
38
45
|
#
|
|
39
46
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
40
47
|
#
|
|
@@ -72,9 +79,6 @@ module Increase
|
|
|
72
79
|
)
|
|
73
80
|
end
|
|
74
81
|
|
|
75
|
-
# Some parameter documentations has been truncated, see
|
|
76
|
-
# {Increase::Models::ACHPrenotificationListParams} for more details.
|
|
77
|
-
#
|
|
78
82
|
# List ACH Prenotifications
|
|
79
83
|
#
|
|
80
84
|
# @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
@@ -83,9 +87,15 @@ module Increase
|
|
|
83
87
|
#
|
|
84
88
|
# @param cursor [String] Return the page of entries after this one.
|
|
85
89
|
#
|
|
86
|
-
# @param idempotency_key [String]
|
|
90
|
+
# @param idempotency_key [String]
|
|
91
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
92
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
93
|
+
# request is only processed once. Learn more about
|
|
94
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
87
95
|
#
|
|
88
|
-
# @param limit [Integer]
|
|
96
|
+
# @param limit [Integer]
|
|
97
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
98
|
+
# objects.
|
|
89
99
|
#
|
|
90
100
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
91
101
|
#
|