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
|
@@ -3,50 +3,97 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class ACHTransfers
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::ACHTransferCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create an ACH Transfer
|
|
10
7
|
#
|
|
11
8
|
# @overload create(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, transaction_timing: nil, request_options: {})
|
|
12
9
|
#
|
|
13
10
|
# @param account_id [String] The Increase identifier for the account that will send the transfer.
|
|
14
11
|
#
|
|
15
|
-
# @param amount [Integer]
|
|
16
|
-
#
|
|
17
|
-
#
|
|
18
|
-
#
|
|
19
|
-
#
|
|
20
|
-
#
|
|
21
|
-
#
|
|
22
|
-
#
|
|
23
|
-
#
|
|
24
|
-
#
|
|
25
|
-
#
|
|
26
|
-
#
|
|
27
|
-
#
|
|
28
|
-
#
|
|
29
|
-
#
|
|
30
|
-
#
|
|
31
|
-
#
|
|
32
|
-
#
|
|
33
|
-
# @param
|
|
34
|
-
#
|
|
35
|
-
#
|
|
36
|
-
#
|
|
37
|
-
#
|
|
38
|
-
#
|
|
39
|
-
# @param
|
|
40
|
-
#
|
|
41
|
-
#
|
|
42
|
-
#
|
|
43
|
-
#
|
|
44
|
-
#
|
|
45
|
-
#
|
|
46
|
-
#
|
|
47
|
-
#
|
|
48
|
-
#
|
|
49
|
-
# @param
|
|
12
|
+
# @param amount [Integer]
|
|
13
|
+
# The transfer amount in USD cents. A positive amount originates a credit transfer
|
|
14
|
+
# pushing funds to the receiving account. A negative amount originates a debit
|
|
15
|
+
# transfer pulling funds from the receiving account.
|
|
16
|
+
#
|
|
17
|
+
# @param statement_descriptor [String]
|
|
18
|
+
# A description you choose to give the transfer. This will be saved with the
|
|
19
|
+
# transfer details, displayed in the dashboard, and returned by the API. If
|
|
20
|
+
# `individual_name` and `company_name` are not explicitly set by this API, the
|
|
21
|
+
# `statement_descriptor` will be sent in those fields to the receiving bank to
|
|
22
|
+
# help the customer recognize the transfer. You are highly encouraged to pass
|
|
23
|
+
# `individual_name` and `company_name` instead of relying on this fallback.
|
|
24
|
+
#
|
|
25
|
+
# @param account_number [String]
|
|
26
|
+
# The receiver's account number. For credit transfers (positive `amount`) this is
|
|
27
|
+
# the account that funds will be sent to. For debit transfers (negative `amount`)
|
|
28
|
+
# this is the account that funds will be pulled from.
|
|
29
|
+
#
|
|
30
|
+
# @param addenda [Increase::Models::ACHTransferCreateParams::Addenda]
|
|
31
|
+
# Additional information passed through to the receiving bank with the transfer.
|
|
32
|
+
# Most ACH transfers do not need this. Only set this if your recipient has asked
|
|
33
|
+
# for addendum data, typically unstructured remittance information. Corporate
|
|
34
|
+
# Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.
|
|
35
|
+
#
|
|
36
|
+
# @param company_descriptive_date [String]
|
|
37
|
+
# A description of the transfer date (typically `YYMMDD`), sent in the company
|
|
38
|
+
# batch header. This value is informational and does not affect funds movement,
|
|
39
|
+
# settlement timing, or returns. Only set this if your recipient has asked for it.
|
|
40
|
+
#
|
|
41
|
+
# @param company_discretionary_data [String]
|
|
42
|
+
# Custom data sent in the company batch header. This value is informational and
|
|
43
|
+
# does not affect funds movement, settlement timing, or returns. Most ACH
|
|
44
|
+
# transfers do not need this. Only set this if your recipient has asked for it.
|
|
45
|
+
#
|
|
46
|
+
# @param company_entry_description [String]
|
|
47
|
+
# A short description sent in the company batch header. Most receivers do not
|
|
48
|
+
# surface this. Only set this if your recipient has asked for a specific value or
|
|
49
|
+
# if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
|
|
50
|
+
# example, Prearranged Payment and Deposit (PPD) payroll credits must use
|
|
51
|
+
# `PAYROLL`, and reversals must use `REVERSAL`.
|
|
52
|
+
#
|
|
53
|
+
# @param company_name [String]
|
|
54
|
+
# The name by which the recipient knows you, sent in the company batch header. We
|
|
55
|
+
# recommend setting this on every transfer; if you do not, we fall back to the ACH
|
|
56
|
+
# company name configured on your account.
|
|
57
|
+
#
|
|
58
|
+
# @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder]
|
|
59
|
+
# The type of entity that owns the receiver's account.
|
|
60
|
+
#
|
|
61
|
+
# @param external_account_id [String]
|
|
62
|
+
# The ID of an External Account to initiate a transfer to. If this parameter is
|
|
63
|
+
# provided, `account_number`, `routing_number`, and `funding` must be absent.
|
|
64
|
+
#
|
|
65
|
+
# @param funding [Symbol, Increase::Models::ACHTransferCreateParams::Funding]
|
|
66
|
+
# The type of the receiver's bank account.
|
|
67
|
+
#
|
|
68
|
+
# @param individual_id [String]
|
|
69
|
+
# Your internal identifier for the transfer recipient. This value is informational
|
|
70
|
+
# and not verified by the recipient's bank. Most callers can leave this unset.
|
|
71
|
+
#
|
|
72
|
+
# @param individual_name [String]
|
|
73
|
+
# The name of the transfer recipient. This value is informational and not verified
|
|
74
|
+
# by the recipient's bank.
|
|
75
|
+
#
|
|
76
|
+
# @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate]
|
|
77
|
+
# Configuration for how the effective date of the transfer will be set. This
|
|
78
|
+
# determines same-day vs future-dated settlement timing. If not set, defaults to a
|
|
79
|
+
# `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
|
|
80
|
+
# must be set.
|
|
81
|
+
#
|
|
82
|
+
# @param require_approval [Boolean]
|
|
83
|
+
# Whether the transfer requires explicit approval via the dashboard or API.
|
|
84
|
+
#
|
|
85
|
+
# @param routing_number [String]
|
|
86
|
+
# The American Bankers' Association (ABA) Routing Transit Number (RTN) of the
|
|
87
|
+
# receiver's bank.
|
|
88
|
+
#
|
|
89
|
+
# @param standard_entry_class_code [Symbol, Increase::Models::ACHTransferCreateParams::StandardEntryClassCode]
|
|
90
|
+
# The
|
|
91
|
+
# [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
|
|
92
|
+
# to use for the transfer. If not provided, the default is
|
|
93
|
+
# `corporate_credit_or_debit`.
|
|
94
|
+
#
|
|
95
|
+
# @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming]
|
|
96
|
+
# The timing of the transaction.
|
|
50
97
|
#
|
|
51
98
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
52
99
|
#
|
|
@@ -84,9 +131,6 @@ module Increase
|
|
|
84
131
|
)
|
|
85
132
|
end
|
|
86
133
|
|
|
87
|
-
# Some parameter documentations has been truncated, see
|
|
88
|
-
# {Increase::Models::ACHTransferListParams} for more details.
|
|
89
|
-
#
|
|
90
134
|
# List ACH Transfers
|
|
91
135
|
#
|
|
92
136
|
# @overload list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
@@ -99,9 +143,15 @@ module Increase
|
|
|
99
143
|
#
|
|
100
144
|
# @param external_account_id [String] Filter ACH Transfers to those made to the specified External Account.
|
|
101
145
|
#
|
|
102
|
-
# @param idempotency_key [String]
|
|
146
|
+
# @param idempotency_key [String]
|
|
147
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
148
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
149
|
+
# request is only processed once. Learn more about
|
|
150
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
103
151
|
#
|
|
104
|
-
# @param limit [Integer]
|
|
152
|
+
# @param limit [Integer]
|
|
153
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
154
|
+
# objects.
|
|
105
155
|
#
|
|
106
156
|
# @param status [Increase::Models::ACHTransferListParams::Status]
|
|
107
157
|
#
|
|
@@ -3,18 +3,21 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class BeneficialOwners
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::BeneficialOwnerCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create a Beneficial Owner
|
|
10
7
|
#
|
|
11
8
|
# @overload create(entity_id:, individual:, prongs:, company_title: nil, request_options: {})
|
|
12
9
|
#
|
|
13
|
-
# @param entity_id [String]
|
|
10
|
+
# @param entity_id [String]
|
|
11
|
+
# The identifier of the Entity to associate with the new Beneficial Owner. Only
|
|
12
|
+
# `corporation` entities have beneficial owners.
|
|
14
13
|
#
|
|
15
|
-
# @param individual [Increase::Models::BeneficialOwnerCreateParams::Individual]
|
|
14
|
+
# @param individual [Increase::Models::BeneficialOwnerCreateParams::Individual]
|
|
15
|
+
# Personal details for the beneficial owner.
|
|
16
16
|
#
|
|
17
|
-
# @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerCreateParams::Prong>]
|
|
17
|
+
# @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerCreateParams::Prong>]
|
|
18
|
+
# Why this person is considered a beneficial owner of the entity. At least one
|
|
19
|
+
# option is required, if a person is both a control person and owner, submit an
|
|
20
|
+
# array containing both.
|
|
18
21
|
#
|
|
19
22
|
# @param company_title [String] This person's role or title within the entity.
|
|
20
23
|
#
|
|
@@ -54,24 +57,32 @@ module Increase
|
|
|
54
57
|
)
|
|
55
58
|
end
|
|
56
59
|
|
|
57
|
-
# Some parameter documentations has been truncated, see
|
|
58
|
-
# {Increase::Models::BeneficialOwnerUpdateParams} for more details.
|
|
59
|
-
#
|
|
60
60
|
# Update a Beneficial Owner
|
|
61
61
|
#
|
|
62
62
|
# @overload update(entity_beneficial_owner_id, address: nil, confirmed_no_us_tax_id: nil, identification: nil, name: nil, prongs: nil, request_options: {})
|
|
63
63
|
#
|
|
64
64
|
# @param entity_beneficial_owner_id [String] The identifier of the Beneficial Owner to update.
|
|
65
65
|
#
|
|
66
|
-
# @param address [Increase::Models::BeneficialOwnerUpdateParams::Address]
|
|
66
|
+
# @param address [Increase::Models::BeneficialOwnerUpdateParams::Address]
|
|
67
|
+
# The individual's physical address. Mail receiving locations like PO Boxes and
|
|
68
|
+
# PMB's are disallowed.
|
|
67
69
|
#
|
|
68
|
-
# @param confirmed_no_us_tax_id [Boolean]
|
|
70
|
+
# @param confirmed_no_us_tax_id [Boolean]
|
|
71
|
+
# The identification method for an individual can only be a passport, driver's
|
|
72
|
+
# license, or other document if you've confirmed the individual does not have a US
|
|
73
|
+
# tax id (either a Social Security Number or Individual Taxpayer Identification
|
|
74
|
+
# Number).
|
|
69
75
|
#
|
|
70
|
-
# @param identification [Increase::Models::BeneficialOwnerUpdateParams::Identification]
|
|
76
|
+
# @param identification [Increase::Models::BeneficialOwnerUpdateParams::Identification]
|
|
77
|
+
# A means of verifying the person's identity.
|
|
71
78
|
#
|
|
72
79
|
# @param name [String] The individual's legal name.
|
|
73
80
|
#
|
|
74
|
-
# @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerUpdateParams::Prong>]
|
|
81
|
+
# @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerUpdateParams::Prong>]
|
|
82
|
+
# Why this person is considered a beneficial owner of the entity. At least one
|
|
83
|
+
# option is required, if a person is both a control person and owner, submit an
|
|
84
|
+
# array containing both. Providing this replaces the beneficial owner's current
|
|
85
|
+
# prongs.
|
|
75
86
|
#
|
|
76
87
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
77
88
|
#
|
|
@@ -89,20 +100,25 @@ module Increase
|
|
|
89
100
|
)
|
|
90
101
|
end
|
|
91
102
|
|
|
92
|
-
# Some parameter documentations has been truncated, see
|
|
93
|
-
# {Increase::Models::BeneficialOwnerListParams} for more details.
|
|
94
|
-
#
|
|
95
103
|
# List Beneficial Owners
|
|
96
104
|
#
|
|
97
105
|
# @overload list(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
98
106
|
#
|
|
99
|
-
# @param entity_id [String]
|
|
107
|
+
# @param entity_id [String]
|
|
108
|
+
# The identifier of the Entity to list beneficial owners for. Only `corporation`
|
|
109
|
+
# entities have beneficial owners.
|
|
100
110
|
#
|
|
101
111
|
# @param cursor [String] Return the page of entries after this one.
|
|
102
112
|
#
|
|
103
|
-
# @param idempotency_key [String]
|
|
113
|
+
# @param idempotency_key [String]
|
|
114
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
115
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
116
|
+
# request is only processed once. Learn more about
|
|
117
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
104
118
|
#
|
|
105
|
-
# @param limit [Integer]
|
|
119
|
+
# @param limit [Integer]
|
|
120
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
121
|
+
# objects.
|
|
106
122
|
#
|
|
107
123
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
108
124
|
#
|
|
@@ -3,24 +3,34 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class CardDisputes
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::CardDisputeCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create a Card Dispute
|
|
10
7
|
#
|
|
11
8
|
# @overload create(disputed_transaction_id:, network:, amount: nil, attachment_files: nil, explanation: nil, visa: nil, request_options: {})
|
|
12
9
|
#
|
|
13
|
-
# @param disputed_transaction_id [String]
|
|
10
|
+
# @param disputed_transaction_id [String]
|
|
11
|
+
# The Transaction you wish to dispute. This Transaction must have a `source_type`
|
|
12
|
+
# of `card_settlement`.
|
|
14
13
|
#
|
|
15
|
-
# @param network [Symbol, Increase::Models::CardDisputeCreateParams::Network]
|
|
14
|
+
# @param network [Symbol, Increase::Models::CardDisputeCreateParams::Network]
|
|
15
|
+
# The network of the disputed transaction. Details specific to the network are
|
|
16
|
+
# required under the sub-object with the same identifier as the network.
|
|
16
17
|
#
|
|
17
|
-
# @param amount [Integer]
|
|
18
|
+
# @param amount [Integer]
|
|
19
|
+
# The monetary amount of the part of the transaction that is being disputed. This
|
|
20
|
+
# is optional and will default to the full amount of the transaction if not
|
|
21
|
+
# provided. If provided, the amount must be less than or equal to the amount of
|
|
22
|
+
# the transaction.
|
|
18
23
|
#
|
|
19
|
-
# @param attachment_files [Array<Increase::Models::CardDisputeCreateParams::AttachmentFile>]
|
|
24
|
+
# @param attachment_files [Array<Increase::Models::CardDisputeCreateParams::AttachmentFile>]
|
|
25
|
+
# The files to be attached to the initial dispute submission.
|
|
20
26
|
#
|
|
21
|
-
# @param explanation [String]
|
|
27
|
+
# @param explanation [String]
|
|
28
|
+
# The free-form explanation provided to Increase to provide more context for the
|
|
29
|
+
# user submission. This field is not sent directly to the card networks.
|
|
22
30
|
#
|
|
23
|
-
# @param visa [Increase::Models::CardDisputeCreateParams::Visa]
|
|
31
|
+
# @param visa [Increase::Models::CardDisputeCreateParams::Visa]
|
|
32
|
+
# The Visa-specific parameters for the dispute. Required if and only if `network`
|
|
33
|
+
# is `visa`.
|
|
24
34
|
#
|
|
25
35
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
26
36
|
#
|
|
@@ -58,9 +68,6 @@ module Increase
|
|
|
58
68
|
)
|
|
59
69
|
end
|
|
60
70
|
|
|
61
|
-
# Some parameter documentations has been truncated, see
|
|
62
|
-
# {Increase::Models::CardDisputeListParams} for more details.
|
|
63
|
-
#
|
|
64
71
|
# List Card Disputes
|
|
65
72
|
#
|
|
66
73
|
# @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
@@ -69,9 +76,15 @@ module Increase
|
|
|
69
76
|
#
|
|
70
77
|
# @param cursor [String] Return the page of entries after this one.
|
|
71
78
|
#
|
|
72
|
-
# @param idempotency_key [String]
|
|
79
|
+
# @param idempotency_key [String]
|
|
80
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
81
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
82
|
+
# request is only processed once. Learn more about
|
|
83
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
73
84
|
#
|
|
74
|
-
# @param limit [Integer]
|
|
85
|
+
# @param limit [Integer]
|
|
86
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
87
|
+
# objects.
|
|
75
88
|
#
|
|
76
89
|
# @param status [Increase::Models::CardDisputeListParams::Status]
|
|
77
90
|
#
|
|
@@ -93,24 +106,32 @@ module Increase
|
|
|
93
106
|
)
|
|
94
107
|
end
|
|
95
108
|
|
|
96
|
-
# Some parameter documentations has been truncated, see
|
|
97
|
-
# {Increase::Models::CardDisputeSubmitUserSubmissionParams} for more details.
|
|
98
|
-
#
|
|
99
109
|
# Submit a User Submission for a Card Dispute
|
|
100
110
|
#
|
|
101
111
|
# @overload submit_user_submission(card_dispute_id, network:, amount: nil, attachment_files: nil, explanation: nil, visa: nil, request_options: {})
|
|
102
112
|
#
|
|
103
113
|
# @param card_dispute_id [String] The identifier of the Card Dispute to submit a user submission for.
|
|
104
114
|
#
|
|
105
|
-
# @param network [Symbol, Increase::Models::CardDisputeSubmitUserSubmissionParams::Network]
|
|
115
|
+
# @param network [Symbol, Increase::Models::CardDisputeSubmitUserSubmissionParams::Network]
|
|
116
|
+
# The network of the Card Dispute. Details specific to the network are required
|
|
117
|
+
# under the sub-object with the same identifier as the network.
|
|
106
118
|
#
|
|
107
|
-
# @param amount [Integer]
|
|
119
|
+
# @param amount [Integer]
|
|
120
|
+
# The adjusted monetary amount of the part of the transaction that is being
|
|
121
|
+
# disputed. This is optional and will default to the most recent amount provided.
|
|
122
|
+
# If provided, the amount must be less than or equal to the amount of the
|
|
123
|
+
# transaction.
|
|
108
124
|
#
|
|
109
|
-
# @param attachment_files [Array<Increase::Models::CardDisputeSubmitUserSubmissionParams::AttachmentFile>]
|
|
125
|
+
# @param attachment_files [Array<Increase::Models::CardDisputeSubmitUserSubmissionParams::AttachmentFile>]
|
|
126
|
+
# The files to be attached to the user submission.
|
|
110
127
|
#
|
|
111
|
-
# @param explanation [String]
|
|
128
|
+
# @param explanation [String]
|
|
129
|
+
# The free-form explanation provided to Increase to provide more context for the
|
|
130
|
+
# user submission. This field is not sent directly to the card networks.
|
|
112
131
|
#
|
|
113
|
-
# @param visa [Increase::Models::CardDisputeSubmitUserSubmissionParams::Visa]
|
|
132
|
+
# @param visa [Increase::Models::CardDisputeSubmitUserSubmissionParams::Visa]
|
|
133
|
+
# The Visa-specific parameters for the dispute. Required if and only if `network`
|
|
134
|
+
# is `visa`.
|
|
114
135
|
#
|
|
115
136
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
116
137
|
#
|
|
@@ -23,9 +23,6 @@ module Increase
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::CardPaymentListParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# List Card Payments
|
|
30
27
|
#
|
|
31
28
|
# @overload list(account_id: nil, card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
|
|
@@ -38,7 +35,9 @@ module Increase
|
|
|
38
35
|
#
|
|
39
36
|
# @param cursor [String] Return the page of entries after this one.
|
|
40
37
|
#
|
|
41
|
-
# @param limit [Integer]
|
|
38
|
+
# @param limit [Integer]
|
|
39
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
40
|
+
# objects.
|
|
42
41
|
#
|
|
43
42
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
44
43
|
#
|
|
@@ -23,20 +23,21 @@ module Increase
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::CardPurchaseSupplementListParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# List Card Purchase Supplements
|
|
30
27
|
#
|
|
31
28
|
# @overload list(card_payment_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
|
|
32
29
|
#
|
|
33
|
-
# @param card_payment_id [String]
|
|
30
|
+
# @param card_payment_id [String]
|
|
31
|
+
# Filter Card Purchase Supplements to ones belonging to the specified Card
|
|
32
|
+
# Payment.
|
|
34
33
|
#
|
|
35
34
|
# @param created_at [Increase::Models::CardPurchaseSupplementListParams::CreatedAt]
|
|
36
35
|
#
|
|
37
36
|
# @param cursor [String] Return the page of entries after this one.
|
|
38
37
|
#
|
|
39
|
-
# @param limit [Integer]
|
|
38
|
+
# @param limit [Integer]
|
|
39
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
40
|
+
# objects.
|
|
40
41
|
#
|
|
41
42
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
42
43
|
#
|
|
@@ -3,30 +3,46 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class CardPushTransfers
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::CardPushTransferCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create a Card Push Transfer
|
|
10
7
|
#
|
|
11
8
|
# @overload create(business_application_identifier:, card_token_id:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_name_prefix:, merchant_postal_code:, merchant_state:, presentment_amount:, recipient_name:, sender_address_city:, sender_address_line1:, sender_address_postal_code:, sender_address_state:, sender_name:, source_account_number_id:, merchant_legal_business_name: nil, merchant_street_address: nil, recipient_address_city: nil, recipient_address_line1: nil, recipient_address_postal_code: nil, recipient_address_state: nil, require_approval: nil, request_options: {})
|
|
12
9
|
#
|
|
13
|
-
# @param business_application_identifier [Symbol, Increase::Models::CardPushTransferCreateParams::BusinessApplicationIdentifier]
|
|
10
|
+
# @param business_application_identifier [Symbol, Increase::Models::CardPushTransferCreateParams::BusinessApplicationIdentifier]
|
|
11
|
+
# The Business Application Identifier describes the type of transaction being
|
|
12
|
+
# performed. Your program must be approved for the specified Business Application
|
|
13
|
+
# Identifier in order to use it.
|
|
14
14
|
#
|
|
15
|
-
# @param card_token_id [String]
|
|
15
|
+
# @param card_token_id [String]
|
|
16
|
+
# The Increase identifier for the Card Token that represents the card number
|
|
17
|
+
# you're pushing funds to.
|
|
16
18
|
#
|
|
17
|
-
# @param merchant_category_code [String]
|
|
19
|
+
# @param merchant_category_code [String]
|
|
20
|
+
# The merchant category code (MCC) of the merchant (generally your business)
|
|
21
|
+
# sending the transfer. This is a four-digit code that describes the type of
|
|
22
|
+
# business or service provided by the merchant. Your program must be approved for
|
|
23
|
+
# the specified MCC in order to use it.
|
|
18
24
|
#
|
|
19
|
-
# @param merchant_city_name [String]
|
|
25
|
+
# @param merchant_city_name [String]
|
|
26
|
+
# The city name of the merchant (generally your business) sending the transfer.
|
|
20
27
|
#
|
|
21
|
-
# @param merchant_name [String]
|
|
28
|
+
# @param merchant_name [String]
|
|
29
|
+
# The merchant name shows up as the statement descriptor for the transfer. This is
|
|
30
|
+
# typically the name of your business or organization.
|
|
22
31
|
#
|
|
23
|
-
# @param merchant_name_prefix [String]
|
|
32
|
+
# @param merchant_name_prefix [String]
|
|
33
|
+
# For certain Business Application Identifiers, the statement descriptor is
|
|
34
|
+
# `merchant_name_prefix*sender_name`, where the `merchant_name_prefix` is a one to
|
|
35
|
+
# four character prefix that identifies the merchant.
|
|
24
36
|
#
|
|
25
|
-
# @param merchant_postal_code [String]
|
|
37
|
+
# @param merchant_postal_code [String]
|
|
38
|
+
# The postal code of the merchant (generally your business) sending the transfer.
|
|
26
39
|
#
|
|
27
40
|
# @param merchant_state [String] The state of the merchant (generally your business) sending the transfer.
|
|
28
41
|
#
|
|
29
|
-
# @param presentment_amount [Increase::Models::CardPushTransferCreateParams::PresentmentAmount]
|
|
42
|
+
# @param presentment_amount [Increase::Models::CardPushTransferCreateParams::PresentmentAmount]
|
|
43
|
+
# The amount to transfer. The receiving bank will convert this to the cardholder's
|
|
44
|
+
# currency. The amount that is applied to your Increase account matches the
|
|
45
|
+
# currency of your account.
|
|
30
46
|
#
|
|
31
47
|
# @param recipient_name [String] The name of the funds recipient.
|
|
32
48
|
#
|
|
@@ -40,21 +56,33 @@ module Increase
|
|
|
40
56
|
#
|
|
41
57
|
# @param sender_name [String] The name of the funds originator.
|
|
42
58
|
#
|
|
43
|
-
# @param source_account_number_id [String]
|
|
59
|
+
# @param source_account_number_id [String]
|
|
60
|
+
# The identifier of the Account Number from which to send the transfer.
|
|
44
61
|
#
|
|
45
|
-
# @param merchant_legal_business_name [String]
|
|
62
|
+
# @param merchant_legal_business_name [String]
|
|
63
|
+
# The legal business name of the merchant (generally your business) sending the
|
|
64
|
+
# transfer. Required if the card is issued in Canada.
|
|
46
65
|
#
|
|
47
|
-
# @param merchant_street_address [String]
|
|
66
|
+
# @param merchant_street_address [String]
|
|
67
|
+
# The street address of the merchant (generally your business) sending the
|
|
68
|
+
# transfer. Required if the card is issued in Canada.
|
|
48
69
|
#
|
|
49
|
-
# @param recipient_address_city [String]
|
|
70
|
+
# @param recipient_address_city [String]
|
|
71
|
+
# The city of the recipient. Required if the card is issued in Canada.
|
|
50
72
|
#
|
|
51
|
-
# @param recipient_address_line1 [String]
|
|
73
|
+
# @param recipient_address_line1 [String]
|
|
74
|
+
# The first line of the recipient's address. Required if the card is issued in
|
|
75
|
+
# Canada.
|
|
52
76
|
#
|
|
53
|
-
# @param recipient_address_postal_code [String]
|
|
77
|
+
# @param recipient_address_postal_code [String]
|
|
78
|
+
# The postal code of the recipient. Required if the card is issued in Canada.
|
|
54
79
|
#
|
|
55
|
-
# @param recipient_address_state [String]
|
|
80
|
+
# @param recipient_address_state [String]
|
|
81
|
+
# The state or province of the recipient. Required if the card is issued in
|
|
82
|
+
# Canada.
|
|
56
83
|
#
|
|
57
|
-
# @param require_approval [Boolean]
|
|
84
|
+
# @param require_approval [Boolean]
|
|
85
|
+
# Whether the transfer requires explicit approval via the dashboard or API.
|
|
58
86
|
#
|
|
59
87
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
60
88
|
#
|
|
@@ -92,9 +120,6 @@ module Increase
|
|
|
92
120
|
)
|
|
93
121
|
end
|
|
94
122
|
|
|
95
|
-
# Some parameter documentations has been truncated, see
|
|
96
|
-
# {Increase::Models::CardPushTransferListParams} for more details.
|
|
97
|
-
#
|
|
98
123
|
# List Card Push Transfers
|
|
99
124
|
#
|
|
100
125
|
# @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
@@ -105,9 +130,15 @@ module Increase
|
|
|
105
130
|
#
|
|
106
131
|
# @param cursor [String] Return the page of entries after this one.
|
|
107
132
|
#
|
|
108
|
-
# @param idempotency_key [String]
|
|
133
|
+
# @param idempotency_key [String]
|
|
134
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
135
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
136
|
+
# request is only processed once. Learn more about
|
|
137
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
109
138
|
#
|
|
110
|
-
# @param limit [Integer]
|
|
139
|
+
# @param limit [Integer]
|
|
140
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
141
|
+
# objects.
|
|
111
142
|
#
|
|
112
143
|
# @param status [Increase::Models::CardPushTransferListParams::Status]
|
|
113
144
|
#
|
|
@@ -23,9 +23,6 @@ module Increase
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::CardTokenListParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# List Card Tokens
|
|
30
27
|
#
|
|
31
28
|
# @overload list(created_at: nil, cursor: nil, limit: 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 request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
40
39
|
#
|
|
@@ -3,24 +3,28 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class CardValidations
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::CardValidationCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create a Card Validation
|
|
10
7
|
#
|
|
11
8
|
# @overload create(account_id:, card_token_id:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_postal_code:, merchant_state:, cardholder_first_name: nil, cardholder_last_name: nil, cardholder_middle_name: nil, cardholder_postal_code: nil, cardholder_street_address: nil, request_options: {})
|
|
12
9
|
#
|
|
13
10
|
# @param account_id [String] The identifier of the Account from which to send the validation.
|
|
14
11
|
#
|
|
15
|
-
# @param card_token_id [String]
|
|
12
|
+
# @param card_token_id [String]
|
|
13
|
+
# The Increase identifier for the Card Token that represents the card number
|
|
14
|
+
# you're validating.
|
|
16
15
|
#
|
|
17
|
-
# @param merchant_category_code [String]
|
|
16
|
+
# @param merchant_category_code [String]
|
|
17
|
+
# A four-digit code (MCC) identifying the type of business or service provided by
|
|
18
|
+
# the merchant.
|
|
18
19
|
#
|
|
19
20
|
# @param merchant_city_name [String] The city where the merchant (typically your business) is located.
|
|
20
21
|
#
|
|
21
|
-
# @param merchant_name [String]
|
|
22
|
+
# @param merchant_name [String]
|
|
23
|
+
# The merchant name that will appear in the cardholder’s statement descriptor.
|
|
24
|
+
# Typically your business name.
|
|
22
25
|
#
|
|
23
|
-
# @param merchant_postal_code [String]
|
|
26
|
+
# @param merchant_postal_code [String]
|
|
27
|
+
# The postal code for the merchant’s (typically your business’s) location.
|
|
24
28
|
#
|
|
25
29
|
# @param merchant_state [String] The U.S. state where the merchant (typically your business) is located.
|
|
26
30
|
#
|
|
@@ -70,9 +74,6 @@ module Increase
|
|
|
70
74
|
)
|
|
71
75
|
end
|
|
72
76
|
|
|
73
|
-
# Some parameter documentations has been truncated, see
|
|
74
|
-
# {Increase::Models::CardValidationListParams} for more details.
|
|
75
|
-
#
|
|
76
77
|
# List Card Validations
|
|
77
78
|
#
|
|
78
79
|
# @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
@@ -83,9 +84,15 @@ module Increase
|
|
|
83
84
|
#
|
|
84
85
|
# @param cursor [String] Return the page of entries after this one.
|
|
85
86
|
#
|
|
86
|
-
# @param idempotency_key [String]
|
|
87
|
+
# @param idempotency_key [String]
|
|
88
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
89
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
90
|
+
# request is only processed once. Learn more about
|
|
91
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
87
92
|
#
|
|
88
|
-
# @param limit [Integer]
|
|
93
|
+
# @param limit [Integer]
|
|
94
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
95
|
+
# objects.
|
|
89
96
|
#
|
|
90
97
|
# @param status [Increase::Models::CardValidationListParams::Status]
|
|
91
98
|
#
|