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
|
@@ -44,9 +44,6 @@ module Increase
|
|
|
44
44
|
optional :route_id, String
|
|
45
45
|
|
|
46
46
|
# @!method initialize(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {})
|
|
47
|
-
# Some parameter documentations has been truncated, see
|
|
48
|
-
# {Increase::Models::TransactionListParams} for more details.
|
|
49
|
-
#
|
|
50
47
|
# @param account_id [String] Filter Transactions for those belonging to the specified Account.
|
|
51
48
|
#
|
|
52
49
|
# @param category [Increase::Models::TransactionListParams::Category]
|
|
@@ -55,9 +52,13 @@ module Increase
|
|
|
55
52
|
#
|
|
56
53
|
# @param cursor [String] Return the page of entries after this one.
|
|
57
54
|
#
|
|
58
|
-
# @param limit [Integer]
|
|
55
|
+
# @param limit [Integer]
|
|
56
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
57
|
+
# objects.
|
|
59
58
|
#
|
|
60
|
-
# @param route_id [String]
|
|
59
|
+
# @param route_id [String]
|
|
60
|
+
# Filter Transactions for those belonging to the specified route. This could be a
|
|
61
|
+
# Card ID or an Account Number ID.
|
|
61
62
|
#
|
|
62
63
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
63
64
|
|
|
@@ -74,10 +75,9 @@ module Increase
|
|
|
74
75
|
api_name: :in
|
|
75
76
|
|
|
76
77
|
# @!method initialize(in_: nil)
|
|
77
|
-
#
|
|
78
|
-
#
|
|
79
|
-
#
|
|
80
|
-
# @param in_ [Array<Symbol, Increase::Models::TransactionListParams::Category::In>] Return results whose value is in the provided list. For GET requests, this shoul
|
|
78
|
+
# @param in_ [Array<Symbol, Increase::Models::TransactionListParams::Category::In>]
|
|
79
|
+
# Return results whose value is in the provided list. For GET requests, this
|
|
80
|
+
# should be encoded as a comma-delimited string, such as `?in=one,two,three`.
|
|
81
81
|
|
|
82
82
|
module In
|
|
83
83
|
extend Increase::Internal::Type::Enum
|
|
@@ -231,16 +231,21 @@ module Increase
|
|
|
231
231
|
optional :on_or_before, Time
|
|
232
232
|
|
|
233
233
|
# @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
|
|
234
|
-
#
|
|
235
|
-
#
|
|
236
|
-
#
|
|
237
|
-
# @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
|
|
234
|
+
# @param after [Time]
|
|
235
|
+
# Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
236
|
+
# timestamp.
|
|
238
237
|
#
|
|
239
|
-
# @param before [Time]
|
|
238
|
+
# @param before [Time]
|
|
239
|
+
# Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
240
|
+
# timestamp.
|
|
240
241
|
#
|
|
241
|
-
# @param on_or_after [Time]
|
|
242
|
+
# @param on_or_after [Time]
|
|
243
|
+
# Return results on or after this
|
|
244
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
242
245
|
#
|
|
243
|
-
# @param on_or_before [Time]
|
|
246
|
+
# @param on_or_before [Time]
|
|
247
|
+
# Return results on or before this
|
|
248
|
+
# [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
244
249
|
end
|
|
245
250
|
end
|
|
246
251
|
end
|
|
@@ -42,9 +42,6 @@ module Increase
|
|
|
42
42
|
required :type, enum: -> { Increase::UnwrapWebhookEvent::Type }
|
|
43
43
|
|
|
44
44
|
# @!method initialize(id:, associated_object_id:, associated_object_type:, category:, created_at:, type:)
|
|
45
|
-
# Some parameter documentations has been truncated, see
|
|
46
|
-
# {Increase::Models::UnwrapWebhookEvent} for more details.
|
|
47
|
-
#
|
|
48
45
|
# Events are records of things that happened to objects at Increase. Events are
|
|
49
46
|
# accessible via the List Events endpoint and can be delivered to your application
|
|
50
47
|
# via webhooks. For more information, see our
|
|
@@ -56,11 +53,15 @@ module Increase
|
|
|
56
53
|
#
|
|
57
54
|
# @param associated_object_type [String] The type of the object that generated this Event.
|
|
58
55
|
#
|
|
59
|
-
# @param category [Symbol, Increase::Models::UnwrapWebhookEvent::Category]
|
|
56
|
+
# @param category [Symbol, Increase::Models::UnwrapWebhookEvent::Category]
|
|
57
|
+
# The category of the Event. We may add additional possible values for this enum
|
|
58
|
+
# over time; your application should be able to handle such additions gracefully.
|
|
60
59
|
#
|
|
61
60
|
# @param created_at [Time] The time the Event was created.
|
|
62
61
|
#
|
|
63
|
-
# @param type [Symbol, Increase::Models::UnwrapWebhookEvent::Type]
|
|
62
|
+
# @param type [Symbol, Increase::Models::UnwrapWebhookEvent::Type]
|
|
63
|
+
# A constant representing the object's type. For this resource it will always be
|
|
64
|
+
# `event`.
|
|
64
65
|
|
|
65
66
|
# The category of the Event. We may add additional possible values for this enum
|
|
66
67
|
# over time; your application should be able to handle such additions gracefully.
|
|
@@ -136,9 +136,6 @@ module Increase
|
|
|
136
136
|
required :unstructured_remittance_information, String
|
|
137
137
|
|
|
138
138
|
# @!method initialize(id:, account_number_id:, amount:, created_at:, creditor_address:, creditor_name:, currency:, debtor_account_number:, debtor_address:, debtor_external_account_id:, debtor_name:, debtor_routing_number:, end_to_end_identification:, fulfillment_inbound_wire_transfer_id:, idempotency_key:, status:, submission:, type:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
|
|
139
|
-
# Some parameter documentations has been truncated, see
|
|
140
|
-
# {Increase::Models::WireDrawdownRequest} for more details.
|
|
141
|
-
#
|
|
142
139
|
# Wire drawdown requests enable you to request that someone else send you a wire.
|
|
143
140
|
# Because there is nuance to making sure your counterparty's bank processes these
|
|
144
141
|
# correctly, we ask that you reach out to
|
|
@@ -148,17 +145,23 @@ module Increase
|
|
|
148
145
|
#
|
|
149
146
|
# @param id [String] The Wire drawdown request identifier.
|
|
150
147
|
#
|
|
151
|
-
# @param account_number_id [String]
|
|
148
|
+
# @param account_number_id [String]
|
|
149
|
+
# The Account Number to which the debtor—the recipient of this request—is being
|
|
150
|
+
# requested to send funds.
|
|
152
151
|
#
|
|
153
152
|
# @param amount [Integer] The amount being requested in cents.
|
|
154
153
|
#
|
|
155
|
-
# @param created_at [Time]
|
|
154
|
+
# @param created_at [Time]
|
|
155
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
156
|
+
# the wire drawdown request was created.
|
|
156
157
|
#
|
|
157
158
|
# @param creditor_address [Increase::Models::WireDrawdownRequest::CreditorAddress] The creditor's address.
|
|
158
159
|
#
|
|
159
160
|
# @param creditor_name [String] The creditor's name.
|
|
160
161
|
#
|
|
161
|
-
# @param currency [String]
|
|
162
|
+
# @param currency [String]
|
|
163
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
|
|
164
|
+
# requested. Will always be "USD".
|
|
162
165
|
#
|
|
163
166
|
# @param debtor_account_number [String] The debtor's account number.
|
|
164
167
|
#
|
|
@@ -170,21 +173,37 @@ module Increase
|
|
|
170
173
|
#
|
|
171
174
|
# @param debtor_routing_number [String] The debtor's routing number.
|
|
172
175
|
#
|
|
173
|
-
# @param end_to_end_identification [String, nil]
|
|
176
|
+
# @param end_to_end_identification [String, nil]
|
|
177
|
+
# A free-form reference string set by the sender, to be mirrored back in the
|
|
178
|
+
# subsequent wire transfer.
|
|
174
179
|
#
|
|
175
|
-
# @param fulfillment_inbound_wire_transfer_id [String, nil]
|
|
180
|
+
# @param fulfillment_inbound_wire_transfer_id [String, nil]
|
|
181
|
+
# If the recipient fulfills the drawdown request by sending funds, then this will
|
|
182
|
+
# be the identifier of the corresponding Transaction.
|
|
176
183
|
#
|
|
177
|
-
# @param idempotency_key [String, nil]
|
|
184
|
+
# @param idempotency_key [String, nil]
|
|
185
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
186
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
187
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
178
188
|
#
|
|
179
|
-
# @param status [Symbol, Increase::Models::WireDrawdownRequest::Status]
|
|
189
|
+
# @param status [Symbol, Increase::Models::WireDrawdownRequest::Status]
|
|
190
|
+
# The lifecycle status of the drawdown request.
|
|
180
191
|
#
|
|
181
|
-
# @param submission [Increase::Models::WireDrawdownRequest::Submission, nil]
|
|
192
|
+
# @param submission [Increase::Models::WireDrawdownRequest::Submission, nil]
|
|
193
|
+
# After the drawdown request is submitted to Fedwire, this will contain
|
|
194
|
+
# supplemental details.
|
|
182
195
|
#
|
|
183
|
-
# @param type [Symbol, Increase::Models::WireDrawdownRequest::Type]
|
|
196
|
+
# @param type [Symbol, Increase::Models::WireDrawdownRequest::Type]
|
|
197
|
+
# A constant representing the object's type. For this resource it will always be
|
|
198
|
+
# `wire_drawdown_request`.
|
|
184
199
|
#
|
|
185
|
-
# @param unique_end_to_end_transaction_reference [String, nil]
|
|
200
|
+
# @param unique_end_to_end_transaction_reference [String, nil]
|
|
201
|
+
# The unique end-to-end transaction reference
|
|
202
|
+
# ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
|
|
203
|
+
# of the drawdown request.
|
|
186
204
|
#
|
|
187
|
-
# @param unstructured_remittance_information [String]
|
|
205
|
+
# @param unstructured_remittance_information [String]
|
|
206
|
+
# Remittance information the debtor will see as part of the drawdown request.
|
|
188
207
|
|
|
189
208
|
# @see Increase::Models::WireDrawdownRequest#creditor_address
|
|
190
209
|
class CreditorAddress < Increase::Internal::Type::BaseModel
|
|
@@ -227,14 +246,14 @@ module Increase
|
|
|
227
246
|
required :state, String, nil?: true
|
|
228
247
|
|
|
229
248
|
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
|
230
|
-
# Some parameter documentations has been truncated, see
|
|
231
|
-
# {Increase::Models::WireDrawdownRequest::CreditorAddress} for more details.
|
|
232
|
-
#
|
|
233
249
|
# The creditor's address.
|
|
234
250
|
#
|
|
235
251
|
# @param city [String] The city, district, town, or village of the address.
|
|
236
252
|
#
|
|
237
|
-
# @param country [String]
|
|
253
|
+
# @param country [String]
|
|
254
|
+
# The two-letter
|
|
255
|
+
# [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
|
|
256
|
+
# the country of the address.
|
|
238
257
|
#
|
|
239
258
|
# @param line1 [String] The first line of the address.
|
|
240
259
|
#
|
|
@@ -286,14 +305,14 @@ module Increase
|
|
|
286
305
|
required :state, String, nil?: true
|
|
287
306
|
|
|
288
307
|
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
|
289
|
-
# Some parameter documentations has been truncated, see
|
|
290
|
-
# {Increase::Models::WireDrawdownRequest::DebtorAddress} for more details.
|
|
291
|
-
#
|
|
292
308
|
# The debtor's address.
|
|
293
309
|
#
|
|
294
310
|
# @param city [String] The city, district, town, or village of the address.
|
|
295
311
|
#
|
|
296
|
-
# @param country [String]
|
|
312
|
+
# @param country [String]
|
|
313
|
+
# The two-letter
|
|
314
|
+
# [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
|
|
315
|
+
# the country of the address.
|
|
297
316
|
#
|
|
298
317
|
# @param line1 [String] The first line of the address.
|
|
299
318
|
#
|
|
@@ -336,13 +355,12 @@ module Increase
|
|
|
336
355
|
required :input_message_accountability_data, String
|
|
337
356
|
|
|
338
357
|
# @!method initialize(input_message_accountability_data:)
|
|
339
|
-
# Some parameter documentations has been truncated, see
|
|
340
|
-
# {Increase::Models::WireDrawdownRequest::Submission} for more details.
|
|
341
|
-
#
|
|
342
358
|
# After the drawdown request is submitted to Fedwire, this will contain
|
|
343
359
|
# supplemental details.
|
|
344
360
|
#
|
|
345
|
-
# @param input_message_accountability_data [String]
|
|
361
|
+
# @param input_message_accountability_data [String]
|
|
362
|
+
# The input message accountability data (IMAD) uniquely identifying the submission
|
|
363
|
+
# with Fedwire.
|
|
346
364
|
end
|
|
347
365
|
|
|
348
366
|
# A constant representing the object's type. For this resource it will always be
|
|
@@ -83,32 +83,38 @@ module Increase
|
|
|
83
83
|
optional :end_to_end_identification, String
|
|
84
84
|
|
|
85
85
|
# @!method initialize(account_number_id:, amount:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, unstructured_remittance_information:, charge_bearer: nil, debtor_account_number: nil, debtor_external_account_id: nil, debtor_routing_number: nil, end_to_end_identification: nil, request_options: {})
|
|
86
|
-
# Some parameter documentations has been truncated, see
|
|
87
|
-
# {Increase::Models::WireDrawdownRequestCreateParams} for more details.
|
|
88
|
-
#
|
|
89
86
|
# @param account_number_id [String] The Account Number to which the debtor should send funds.
|
|
90
87
|
#
|
|
91
88
|
# @param amount [Integer] The amount requested from the debtor, in USD cents.
|
|
92
89
|
#
|
|
93
|
-
# @param creditor_address [Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress]
|
|
90
|
+
# @param creditor_address [Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress]
|
|
91
|
+
# The creditor's address.
|
|
94
92
|
#
|
|
95
93
|
# @param creditor_name [String] The creditor's name.
|
|
96
94
|
#
|
|
97
|
-
# @param debtor_address [Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress]
|
|
95
|
+
# @param debtor_address [Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress]
|
|
96
|
+
# The debtor's address.
|
|
98
97
|
#
|
|
99
98
|
# @param debtor_name [String] The debtor's name.
|
|
100
99
|
#
|
|
101
|
-
# @param unstructured_remittance_information [String]
|
|
100
|
+
# @param unstructured_remittance_information [String]
|
|
101
|
+
# Remittance information the debtor will see as part of the request.
|
|
102
102
|
#
|
|
103
|
-
# @param charge_bearer [Symbol, Increase::Models::WireDrawdownRequestCreateParams::ChargeBearer]
|
|
103
|
+
# @param charge_bearer [Symbol, Increase::Models::WireDrawdownRequestCreateParams::ChargeBearer]
|
|
104
|
+
# Determines who bears the cost of the drawdown request. Defaults to `shared` if
|
|
105
|
+
# not specified.
|
|
104
106
|
#
|
|
105
107
|
# @param debtor_account_number [String] The debtor's account number.
|
|
106
108
|
#
|
|
107
|
-
# @param debtor_external_account_id [String]
|
|
109
|
+
# @param debtor_external_account_id [String]
|
|
110
|
+
# The ID of an External Account to initiate a transfer to. If this parameter is
|
|
111
|
+
# provided, `debtor_account_number` and `debtor_routing_number` must be absent.
|
|
108
112
|
#
|
|
109
113
|
# @param debtor_routing_number [String] The debtor's routing number.
|
|
110
114
|
#
|
|
111
|
-
# @param end_to_end_identification [String]
|
|
115
|
+
# @param end_to_end_identification [String]
|
|
116
|
+
# A free-form reference string set by the sender mirrored back in the subsequent
|
|
117
|
+
# wire transfer.
|
|
112
118
|
#
|
|
113
119
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
|
|
114
120
|
|
|
@@ -152,15 +158,14 @@ module Increase
|
|
|
152
158
|
optional :state, String
|
|
153
159
|
|
|
154
160
|
# @!method initialize(city:, country:, line1:, line2: nil, postal_code: nil, state: nil)
|
|
155
|
-
# Some parameter documentations has been truncated, see
|
|
156
|
-
# {Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress} for more
|
|
157
|
-
# details.
|
|
158
|
-
#
|
|
159
161
|
# The creditor's address.
|
|
160
162
|
#
|
|
161
163
|
# @param city [String] The city, district, town, or village of the address.
|
|
162
164
|
#
|
|
163
|
-
# @param country [String]
|
|
165
|
+
# @param country [String]
|
|
166
|
+
# The two-letter
|
|
167
|
+
# [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
|
|
168
|
+
# the country of the address.
|
|
164
169
|
#
|
|
165
170
|
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
|
166
171
|
#
|
|
@@ -211,15 +216,14 @@ module Increase
|
|
|
211
216
|
optional :state, String
|
|
212
217
|
|
|
213
218
|
# @!method initialize(city:, country:, line1:, line2: nil, postal_code: nil, state: nil)
|
|
214
|
-
# Some parameter documentations has been truncated, see
|
|
215
|
-
# {Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress} for more
|
|
216
|
-
# details.
|
|
217
|
-
#
|
|
218
219
|
# The debtor's address.
|
|
219
220
|
#
|
|
220
221
|
# @param city [String] The city, district, town, or village of the address.
|
|
221
222
|
#
|
|
222
|
-
# @param country [String]
|
|
223
|
+
# @param country [String]
|
|
224
|
+
# The two-letter
|
|
225
|
+
# [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for
|
|
226
|
+
# the country of the address.
|
|
223
227
|
#
|
|
224
228
|
# @param line1 [String] The first line of the address. This is usually the street number and street.
|
|
225
229
|
#
|
|
@@ -35,14 +35,17 @@ module Increase
|
|
|
35
35
|
optional :status, -> { Increase::WireDrawdownRequestListParams::Status }
|
|
36
36
|
|
|
37
37
|
# @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
38
|
-
# Some parameter documentations has been truncated, see
|
|
39
|
-
# {Increase::Models::WireDrawdownRequestListParams} for more details.
|
|
40
|
-
#
|
|
41
38
|
# @param cursor [String] Return the page of entries after this one.
|
|
42
39
|
#
|
|
43
|
-
# @param idempotency_key [String]
|
|
40
|
+
# @param idempotency_key [String]
|
|
41
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
42
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
43
|
+
# request is only processed once. Learn more about
|
|
44
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
44
45
|
#
|
|
45
|
-
# @param limit [Integer]
|
|
46
|
+
# @param limit [Integer]
|
|
47
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
48
|
+
# objects.
|
|
46
49
|
#
|
|
47
50
|
# @param status [Increase::Models::WireDrawdownRequestListParams::Status]
|
|
48
51
|
#
|
|
@@ -62,10 +65,10 @@ module Increase
|
|
|
62
65
|
api_name: :in
|
|
63
66
|
|
|
64
67
|
# @!method initialize(in_: nil)
|
|
65
|
-
#
|
|
66
|
-
#
|
|
67
|
-
#
|
|
68
|
-
#
|
|
68
|
+
# @param in_ [Array<Symbol, Increase::Models::WireDrawdownRequestListParams::Status::In>]
|
|
69
|
+
# Filter Wire Drawdown Requests for those with the specified status. For GET
|
|
70
|
+
# requests, this should be encoded as a comma-delimited string, such as
|
|
71
|
+
# `?in=one,two,three`.
|
|
69
72
|
|
|
70
73
|
module In
|
|
71
74
|
extend Increase::Internal::Type::Enum
|
|
@@ -169,9 +169,6 @@ module Increase
|
|
|
169
169
|
required :unique_end_to_end_transaction_reference, String, nil?: true
|
|
170
170
|
|
|
171
171
|
# @!method initialize(id:, account_id:, account_number:, amount:, approval:, cancellation:, created_at:, created_by:, creditor:, currency:, debtor:, external_account_id:, idempotency_key:, inbound_wire_drawdown_request_id:, network:, pending_transaction_id:, remittance:, reversal:, routing_number:, source_account_number_id:, status:, submission:, transaction_id:, type:, unique_end_to_end_transaction_reference:)
|
|
172
|
-
# Some parameter documentations has been truncated, see
|
|
173
|
-
# {Increase::Models::WireTransfer} for more details.
|
|
174
|
-
#
|
|
175
172
|
# Wire transfers move funds between your Increase account and any other account
|
|
176
173
|
# accessible by Fedwire.
|
|
177
174
|
#
|
|
@@ -183,33 +180,56 @@ module Increase
|
|
|
183
180
|
#
|
|
184
181
|
# @param amount [Integer] The transfer amount in USD cents.
|
|
185
182
|
#
|
|
186
|
-
# @param approval [Increase::Models::WireTransfer::Approval, nil]
|
|
183
|
+
# @param approval [Increase::Models::WireTransfer::Approval, nil]
|
|
184
|
+
# If your account requires approvals for transfers and the transfer was approved,
|
|
185
|
+
# this will contain details of the approval.
|
|
187
186
|
#
|
|
188
|
-
# @param cancellation [Increase::Models::WireTransfer::Cancellation, nil]
|
|
187
|
+
# @param cancellation [Increase::Models::WireTransfer::Cancellation, nil]
|
|
188
|
+
# If your account requires approvals for transfers and the transfer was not
|
|
189
|
+
# approved, this will contain details of the cancellation.
|
|
189
190
|
#
|
|
190
|
-
# @param created_at [Time]
|
|
191
|
+
# @param created_at [Time]
|
|
192
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
193
|
+
# the transfer was created.
|
|
191
194
|
#
|
|
192
|
-
# @param created_by [Increase::Models::WireTransfer::CreatedBy, nil]
|
|
195
|
+
# @param created_by [Increase::Models::WireTransfer::CreatedBy, nil]
|
|
196
|
+
# What object created the transfer, either via the API or the dashboard.
|
|
193
197
|
#
|
|
194
|
-
# @param creditor [Increase::Models::WireTransfer::Creditor, nil]
|
|
198
|
+
# @param creditor [Increase::Models::WireTransfer::Creditor, nil]
|
|
199
|
+
# The person or business that is receiving the funds from the transfer.
|
|
195
200
|
#
|
|
196
|
-
# @param currency [Symbol, Increase::Models::WireTransfer::Currency]
|
|
201
|
+
# @param currency [Symbol, Increase::Models::WireTransfer::Currency]
|
|
202
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
|
|
203
|
+
# currency. For wire transfers this is always equal to `usd`.
|
|
197
204
|
#
|
|
198
|
-
# @param debtor [Increase::Models::WireTransfer::Debtor, nil]
|
|
205
|
+
# @param debtor [Increase::Models::WireTransfer::Debtor, nil]
|
|
206
|
+
# The person or business whose funds are being transferred.
|
|
199
207
|
#
|
|
200
|
-
# @param external_account_id [String, nil]
|
|
208
|
+
# @param external_account_id [String, nil]
|
|
209
|
+
# The identifier of the External Account the transfer was made to, if any.
|
|
201
210
|
#
|
|
202
|
-
# @param idempotency_key [String, nil]
|
|
211
|
+
# @param idempotency_key [String, nil]
|
|
212
|
+
# The idempotency key you chose for this object. This value is unique across
|
|
213
|
+
# Increase and is used to ensure that a request is only processed once. Learn more
|
|
214
|
+
# about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
203
215
|
#
|
|
204
|
-
# @param inbound_wire_drawdown_request_id [String, nil]
|
|
216
|
+
# @param inbound_wire_drawdown_request_id [String, nil]
|
|
217
|
+
# The ID of an Inbound Wire Drawdown Request in response to which this transfer
|
|
218
|
+
# was sent.
|
|
205
219
|
#
|
|
206
220
|
# @param network [Symbol, Increase::Models::WireTransfer::Network] The transfer's network.
|
|
207
221
|
#
|
|
208
|
-
# @param pending_transaction_id [String, nil]
|
|
222
|
+
# @param pending_transaction_id [String, nil]
|
|
223
|
+
# The ID for the pending transaction representing the transfer. A pending
|
|
224
|
+
# transaction is created when the transfer
|
|
225
|
+
# [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
|
|
226
|
+
# by someone else in your organization.
|
|
209
227
|
#
|
|
210
|
-
# @param remittance [Increase::Models::WireTransfer::Remittance, nil]
|
|
228
|
+
# @param remittance [Increase::Models::WireTransfer::Remittance, nil]
|
|
229
|
+
# Remittance information sent with the wire transfer.
|
|
211
230
|
#
|
|
212
|
-
# @param reversal [Increase::Models::WireTransfer::Reversal, nil]
|
|
231
|
+
# @param reversal [Increase::Models::WireTransfer::Reversal, nil]
|
|
232
|
+
# If your transfer is reversed, this will contain details of the reversal.
|
|
213
233
|
#
|
|
214
234
|
# @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
|
|
215
235
|
#
|
|
@@ -217,13 +237,20 @@ module Increase
|
|
|
217
237
|
#
|
|
218
238
|
# @param status [Symbol, Increase::Models::WireTransfer::Status] The lifecycle status of the transfer.
|
|
219
239
|
#
|
|
220
|
-
# @param submission [Increase::Models::WireTransfer::Submission, nil]
|
|
240
|
+
# @param submission [Increase::Models::WireTransfer::Submission, nil]
|
|
241
|
+
# After the transfer is submitted to Fedwire, this will contain supplemental
|
|
242
|
+
# details.
|
|
221
243
|
#
|
|
222
244
|
# @param transaction_id [String, nil] The ID for the transaction funding the transfer.
|
|
223
245
|
#
|
|
224
|
-
# @param type [Symbol, Increase::Models::WireTransfer::Type]
|
|
246
|
+
# @param type [Symbol, Increase::Models::WireTransfer::Type]
|
|
247
|
+
# A constant representing the object's type. For this resource it will always be
|
|
248
|
+
# `wire_transfer`.
|
|
225
249
|
#
|
|
226
|
-
# @param unique_end_to_end_transaction_reference [String, nil]
|
|
250
|
+
# @param unique_end_to_end_transaction_reference [String, nil]
|
|
251
|
+
# The unique end-to-end transaction reference
|
|
252
|
+
# ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
|
|
253
|
+
# of the transfer.
|
|
227
254
|
|
|
228
255
|
# @see Increase::Models::WireTransfer#approval
|
|
229
256
|
class Approval < Increase::Internal::Type::BaseModel
|
|
@@ -242,15 +269,16 @@ module Increase
|
|
|
242
269
|
required :approved_by, String, nil?: true
|
|
243
270
|
|
|
244
271
|
# @!method initialize(approved_at:, approved_by:)
|
|
245
|
-
# Some parameter documentations has been truncated, see
|
|
246
|
-
# {Increase::Models::WireTransfer::Approval} for more details.
|
|
247
|
-
#
|
|
248
272
|
# If your account requires approvals for transfers and the transfer was approved,
|
|
249
273
|
# this will contain details of the approval.
|
|
250
274
|
#
|
|
251
|
-
# @param approved_at [Time]
|
|
275
|
+
# @param approved_at [Time]
|
|
276
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
277
|
+
# the transfer was approved.
|
|
252
278
|
#
|
|
253
|
-
# @param approved_by [String, nil]
|
|
279
|
+
# @param approved_by [String, nil]
|
|
280
|
+
# If the Transfer was approved by a user in the dashboard, the email address of
|
|
281
|
+
# that user.
|
|
254
282
|
end
|
|
255
283
|
|
|
256
284
|
# @see Increase::Models::WireTransfer#cancellation
|
|
@@ -270,15 +298,16 @@ module Increase
|
|
|
270
298
|
required :canceled_by, String, nil?: true
|
|
271
299
|
|
|
272
300
|
# @!method initialize(canceled_at:, canceled_by:)
|
|
273
|
-
# Some parameter documentations has been truncated, see
|
|
274
|
-
# {Increase::Models::WireTransfer::Cancellation} for more details.
|
|
275
|
-
#
|
|
276
301
|
# If your account requires approvals for transfers and the transfer was not
|
|
277
302
|
# approved, this will contain details of the cancellation.
|
|
278
303
|
#
|
|
279
|
-
# @param canceled_at [Time]
|
|
304
|
+
# @param canceled_at [Time]
|
|
305
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
306
|
+
# the Transfer was canceled.
|
|
280
307
|
#
|
|
281
|
-
# @param canceled_by [String, nil]
|
|
308
|
+
# @param canceled_by [String, nil]
|
|
309
|
+
# If the Transfer was canceled by a user in the dashboard, the email address of
|
|
310
|
+
# that user.
|
|
282
311
|
end
|
|
283
312
|
|
|
284
313
|
# @see Increase::Models::WireTransfer#created_by
|
|
@@ -310,13 +339,17 @@ module Increase
|
|
|
310
339
|
# @!method initialize(category:, api_key: nil, oauth_application: nil, user: nil)
|
|
311
340
|
# What object created the transfer, either via the API or the dashboard.
|
|
312
341
|
#
|
|
313
|
-
# @param category [Symbol, Increase::Models::WireTransfer::CreatedBy::Category]
|
|
342
|
+
# @param category [Symbol, Increase::Models::WireTransfer::CreatedBy::Category]
|
|
343
|
+
# The type of object that created this transfer.
|
|
314
344
|
#
|
|
315
|
-
# @param api_key [Increase::Models::WireTransfer::CreatedBy::APIKey, nil]
|
|
345
|
+
# @param api_key [Increase::Models::WireTransfer::CreatedBy::APIKey, nil]
|
|
346
|
+
# If present, details about the API key that created the transfer.
|
|
316
347
|
#
|
|
317
|
-
# @param oauth_application [Increase::Models::WireTransfer::CreatedBy::OAuthApplication, nil]
|
|
348
|
+
# @param oauth_application [Increase::Models::WireTransfer::CreatedBy::OAuthApplication, nil]
|
|
349
|
+
# If present, details about the OAuth Application that created the transfer.
|
|
318
350
|
#
|
|
319
|
-
# @param user [Increase::Models::WireTransfer::CreatedBy::User, nil]
|
|
351
|
+
# @param user [Increase::Models::WireTransfer::CreatedBy::User, nil]
|
|
352
|
+
# If present, details about the User that created the transfer.
|
|
320
353
|
|
|
321
354
|
# The type of object that created this transfer.
|
|
322
355
|
#
|
|
@@ -412,7 +445,8 @@ module Increase
|
|
|
412
445
|
# @!method initialize(unstructured:)
|
|
413
446
|
# The person or business's address.
|
|
414
447
|
#
|
|
415
|
-
# @param unstructured [Increase::Models::WireTransfer::Creditor::Address::Unstructured, nil]
|
|
448
|
+
# @param unstructured [Increase::Models::WireTransfer::Creditor::Address::Unstructured, nil]
|
|
449
|
+
# Unstructured address lines.
|
|
416
450
|
|
|
417
451
|
# @see Increase::Models::WireTransfer::Creditor::Address#unstructured
|
|
418
452
|
class Unstructured < Increase::Internal::Type::BaseModel
|
|
@@ -492,7 +526,8 @@ module Increase
|
|
|
492
526
|
# @!method initialize(unstructured:)
|
|
493
527
|
# The person or business's address.
|
|
494
528
|
#
|
|
495
|
-
# @param unstructured [Increase::Models::WireTransfer::Debtor::Address::Unstructured, nil]
|
|
529
|
+
# @param unstructured [Increase::Models::WireTransfer::Debtor::Address::Unstructured, nil]
|
|
530
|
+
# Unstructured address lines.
|
|
496
531
|
|
|
497
532
|
# @see Increase::Models::WireTransfer::Debtor::Address#unstructured
|
|
498
533
|
class Unstructured < Increase::Internal::Type::BaseModel
|
|
@@ -561,16 +596,18 @@ module Increase
|
|
|
561
596
|
optional :unstructured, -> { Increase::WireTransfer::Remittance::Unstructured }, nil?: true
|
|
562
597
|
|
|
563
598
|
# @!method initialize(category:, tax: nil, unstructured: nil)
|
|
564
|
-
# Some parameter documentations has been truncated, see
|
|
565
|
-
# {Increase::Models::WireTransfer::Remittance} for more details.
|
|
566
|
-
#
|
|
567
599
|
# Remittance information sent with the wire transfer.
|
|
568
600
|
#
|
|
569
|
-
# @param category [Symbol, Increase::Models::WireTransfer::Remittance::Category]
|
|
601
|
+
# @param category [Symbol, Increase::Models::WireTransfer::Remittance::Category]
|
|
602
|
+
# The type of remittance information being passed.
|
|
570
603
|
#
|
|
571
|
-
# @param tax [Increase::Models::WireTransfer::Remittance::Tax, nil]
|
|
604
|
+
# @param tax [Increase::Models::WireTransfer::Remittance::Tax, nil]
|
|
605
|
+
# Internal Revenue Service (IRS) tax repayment information. Required if `category`
|
|
606
|
+
# is equal to `tax`.
|
|
572
607
|
#
|
|
573
|
-
# @param unstructured [Increase::Models::WireTransfer::Remittance::Unstructured, nil]
|
|
608
|
+
# @param unstructured [Increase::Models::WireTransfer::Remittance::Unstructured, nil]
|
|
609
|
+
# Unstructured remittance information. Required if `category` is equal to
|
|
610
|
+
# `unstructured`.
|
|
574
611
|
|
|
575
612
|
# The type of remittance information being passed.
|
|
576
613
|
#
|
|
@@ -611,15 +648,16 @@ module Increase
|
|
|
611
648
|
required :type_code, String
|
|
612
649
|
|
|
613
650
|
# @!method initialize(date:, identification_number:, type_code:)
|
|
614
|
-
# Some parameter documentations has been truncated, see
|
|
615
|
-
# {Increase::Models::WireTransfer::Remittance::Tax} for more details.
|
|
616
|
-
#
|
|
617
651
|
# Internal Revenue Service (IRS) tax repayment information. Required if `category`
|
|
618
652
|
# is equal to `tax`.
|
|
619
653
|
#
|
|
620
|
-
# @param date [Date]
|
|
654
|
+
# @param date [Date]
|
|
655
|
+
# The month and year the tax payment is for, in YYYY-MM-DD format. The day is
|
|
656
|
+
# ignored.
|
|
621
657
|
#
|
|
622
|
-
# @param identification_number [String]
|
|
658
|
+
# @param identification_number [String]
|
|
659
|
+
# The 9-digit Tax Identification Number (TIN) or Employer Identification Number
|
|
660
|
+
# (EIN).
|
|
623
661
|
#
|
|
624
662
|
# @param type_code [String] The 5-character tax type code.
|
|
625
663
|
end
|
|
@@ -731,20 +769,22 @@ module Increase
|
|
|
731
769
|
required :wire_transfer_id, String
|
|
732
770
|
|
|
733
771
|
# @!method initialize(amount:, created_at:, debtor_routing_number:, description:, input_cycle_date:, input_message_accountability_data:, input_sequence_number:, input_source:, instruction_identification:, return_reason_additional_information:, return_reason_code:, return_reason_code_description:, transaction_id:, wire_transfer_id:)
|
|
734
|
-
# Some parameter documentations has been truncated, see
|
|
735
|
-
# {Increase::Models::WireTransfer::Reversal} for more details.
|
|
736
|
-
#
|
|
737
772
|
# If your transfer is reversed, this will contain details of the reversal.
|
|
738
773
|
#
|
|
739
774
|
# @param amount [Integer] The amount that was reversed in USD cents.
|
|
740
775
|
#
|
|
741
|
-
# @param created_at [Time]
|
|
776
|
+
# @param created_at [Time]
|
|
777
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
778
|
+
# the reversal was created.
|
|
742
779
|
#
|
|
743
780
|
# @param debtor_routing_number [String, nil] The debtor's routing number.
|
|
744
781
|
#
|
|
745
|
-
# @param description [String]
|
|
782
|
+
# @param description [String]
|
|
783
|
+
# The description on the reversal message from Fedwire, set by the reversing bank.
|
|
746
784
|
#
|
|
747
|
-
# @param input_cycle_date [Date]
|
|
785
|
+
# @param input_cycle_date [Date]
|
|
786
|
+
# The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00
|
|
787
|
+
# PM Eastern Time on the evening before the `cycle date`.
|
|
748
788
|
#
|
|
749
789
|
# @param input_message_accountability_data [String] The Fedwire transaction identifier.
|
|
750
790
|
#
|
|
@@ -754,11 +794,16 @@ module Increase
|
|
|
754
794
|
#
|
|
755
795
|
# @param instruction_identification [String, nil] The sending bank's identifier for the reversal.
|
|
756
796
|
#
|
|
757
|
-
# @param return_reason_additional_information [String, nil]
|
|
797
|
+
# @param return_reason_additional_information [String, nil]
|
|
798
|
+
# Additional information about the reason for the reversal.
|
|
758
799
|
#
|
|
759
|
-
# @param return_reason_code [String, nil]
|
|
800
|
+
# @param return_reason_code [String, nil]
|
|
801
|
+
# A code provided by the sending bank giving a reason for the reversal. The common
|
|
802
|
+
# return reason codes are
|
|
803
|
+
# [documented here](/documentation/wire-reversals#reversal-reason-codes).
|
|
760
804
|
#
|
|
761
|
-
# @param return_reason_code_description [String, nil]
|
|
805
|
+
# @param return_reason_code_description [String, nil]
|
|
806
|
+
# An Increase-generated description of the `return_reason_code`.
|
|
762
807
|
#
|
|
763
808
|
# @param transaction_id [String] The ID for the Transaction associated with the transfer reversal.
|
|
764
809
|
#
|