increase 1.340.0 → 1.342.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 +49 -28
- 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 +220 -105
- 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 +60 -46
- data/lib/increase/models/beneficial_owner_list_params.rb +11 -6
- data/lib/increase/models/beneficial_owner_update_params.rb +56 -40
- 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 +127 -76
- 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 +395 -290
- 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 +136 -104
- data/lib/increase/models/event.rb +14 -5
- data/lib/increase/models/event_list_params.rb +31 -17
- data/lib/increase/models/event_subscription.rb +25 -9
- data/lib/increase/models/event_subscription_create_params.rb +22 -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 +51 -22
- 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 +18 -6
- 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 +16 -13
- 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 -5
- 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 +60 -27
- data/lib/increase/models/swift_transfer_create_params.rb +40 -20
- data/lib/increase/models/swift_transfer_list_params.rb +23 -16
- data/lib/increase/models/transaction.rb +1016 -536
- data/lib/increase/models/transaction_list_params.rb +21 -16
- data/lib/increase/models/unwrap_webhook_event.rb +14 -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 +18 -15
- 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 +8 -6
- 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 +33 -17
- 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/ach_prenotification.rbi +1 -1
- data/rbi/increase/models/ach_transfer.rbi +19 -1
- data/rbi/increase/models/beneficial_owner_create_params.rbi +13 -8
- data/rbi/increase/models/beneficial_owner_update_params.rbi +13 -8
- data/rbi/increase/models/check_transfer.rbi +12 -2
- data/rbi/increase/models/check_transfer_create_params.rbi +35 -36
- data/rbi/increase/models/entity_create_params.rbi +78 -48
- data/rbi/increase/models/entity_list_params.rbi +119 -0
- data/rbi/increase/models/entity_update_params.rbi +26 -16
- data/rbi/increase/models/event.rbi +14 -0
- data/rbi/increase/models/event_list_params.rbi +14 -0
- data/rbi/increase/models/event_subscription.rbi +14 -0
- data/rbi/increase/models/event_subscription_create_params.rbi +14 -0
- data/rbi/increase/models/inbound_wire_transfer.rbi +16 -0
- data/rbi/increase/models/pending_transaction_create_params.rbi +4 -4
- data/rbi/increase/models/simulations/ach_transfer_return_params.rbi +16 -1
- data/rbi/increase/models/simulations/card_settlement_create_params.rbi +17 -12
- data/rbi/increase/models/simulations/program_create_params.rbi +0 -7
- data/rbi/increase/models/swift_transfer.rbi +10 -0
- data/rbi/increase/models/swift_transfer_create_params.rbi +13 -0
- data/rbi/increase/models/transaction.rbi +19 -1
- data/rbi/increase/models/unwrap_webhook_event.rbi +14 -0
- data/rbi/increase/resources/entities.rbi +3 -0
- data/rbi/increase/resources/pending_transactions.rbi +2 -2
- data/rbi/increase/resources/simulations/ach_transfers.rbi +5 -0
- data/rbi/increase/resources/simulations/card_settlements.rbi +6 -5
- data/rbi/increase/resources/swift_transfers.rbi +4 -0
- data/sig/increase/models/ach_prenotification.rbs +1 -1
- data/sig/increase/models/ach_transfer.rbs +6 -1
- data/sig/increase/models/beneficial_owner_create_params.rbs +7 -5
- data/sig/increase/models/beneficial_owner_update_params.rbs +7 -5
- 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_create_params.rbs +42 -30
- data/sig/increase/models/entity_list_params.rbs +48 -1
- data/sig/increase/models/entity_update_params.rbs +14 -10
- data/sig/increase/models/event.rbs +8 -0
- data/sig/increase/models/event_list_params.rbs +8 -0
- data/sig/increase/models/event_subscription.rbs +8 -0
- data/sig/increase/models/event_subscription_create_params.rbs +8 -0
- data/sig/increase/models/inbound_wire_transfer.rbs +10 -0
- data/sig/increase/models/simulations/ach_transfer_return_params.rbs +8 -1
- data/sig/increase/models/simulations/card_settlement_create_params.rbs +7 -5
- data/sig/increase/models/simulations/program_create_params.rbs +1 -8
- data/sig/increase/models/swift_transfer.rbs +5 -0
- data/sig/increase/models/swift_transfer_create_params.rbs +7 -0
- data/sig/increase/models/transaction.rbs +6 -1
- data/sig/increase/models/unwrap_webhook_event.rbs +8 -0
- data/sig/increase/resources/entities.rbs +1 -0
- data/sig/increase/resources/simulations/ach_transfers.rbs +1 -0
- data/sig/increase/resources/simulations/card_settlements.rbs +1 -1
- data/sig/increase/resources/swift_transfers.rbs +1 -0
- metadata +2 -2
|
@@ -3,22 +3,29 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class OAuthTokens
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::OAuthTokenCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create an OAuth Token
|
|
10
7
|
#
|
|
11
8
|
# @overload create(grant_type:, client_id: nil, client_secret: nil, code: nil, production_token: nil, request_options: {})
|
|
12
9
|
#
|
|
13
|
-
# @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType]
|
|
10
|
+
# @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType]
|
|
11
|
+
# The credential you request in exchange for the code. In Production, this is
|
|
12
|
+
# always `authorization_code`. In Sandbox, you can pass either enum value.
|
|
14
13
|
#
|
|
15
14
|
# @param client_id [String] The public identifier for your application.
|
|
16
15
|
#
|
|
17
|
-
# @param client_secret [String]
|
|
16
|
+
# @param client_secret [String]
|
|
17
|
+
# The secret that confirms you own the application. This is redundant given that
|
|
18
|
+
# the request is made with your API key but it's a required component of OAuth
|
|
19
|
+
# 2.0.
|
|
18
20
|
#
|
|
19
|
-
# @param code [String]
|
|
21
|
+
# @param code [String]
|
|
22
|
+
# The authorization code generated by the user and given to you as a query
|
|
23
|
+
# parameter.
|
|
20
24
|
#
|
|
21
|
-
# @param production_token [String]
|
|
25
|
+
# @param production_token [String]
|
|
26
|
+
# The production token you want to exchange for a sandbox token. This is only
|
|
27
|
+
# available in Sandbox. Set `grant_type` to `production_token` to use this
|
|
28
|
+
# parameter.
|
|
22
29
|
#
|
|
23
30
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
31
|
#
|
|
@@ -3,9 +3,6 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class PendingTransactions
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::PendingTransactionCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Creates a pending transaction on an account. This can be useful to hold funds
|
|
10
7
|
# for an external payment or known future transaction outside of Increase (only
|
|
11
8
|
# negative amounts are supported). The resulting Pending Transaction will have a
|
|
@@ -16,7 +13,10 @@ module Increase
|
|
|
16
13
|
#
|
|
17
14
|
# @param account_id [String] The Account to place the hold on.
|
|
18
15
|
#
|
|
19
|
-
# @param amount [Integer]
|
|
16
|
+
# @param amount [Integer]
|
|
17
|
+
# The amount to hold in the minor unit of the account's currency. For dollars, for
|
|
18
|
+
# example, this is cents. This should be a negative amount: To hold $1.00 from the
|
|
19
|
+
# account, pass -100 as `amount`.
|
|
20
20
|
#
|
|
21
21
|
# @param description [String] The description you choose to give the hold.
|
|
22
22
|
#
|
|
@@ -56,9 +56,6 @@ module Increase
|
|
|
56
56
|
)
|
|
57
57
|
end
|
|
58
58
|
|
|
59
|
-
# Some parameter documentations has been truncated, see
|
|
60
|
-
# {Increase::Models::PendingTransactionListParams} for more details.
|
|
61
|
-
#
|
|
62
59
|
# List Pending Transactions
|
|
63
60
|
#
|
|
64
61
|
# @overload list(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, status: nil, request_options: {})
|
|
@@ -71,7 +68,9 @@ module Increase
|
|
|
71
68
|
#
|
|
72
69
|
# @param cursor [String] Return the page of entries after this one.
|
|
73
70
|
#
|
|
74
|
-
# @param limit [Integer]
|
|
71
|
+
# @param limit [Integer]
|
|
72
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
73
|
+
# objects.
|
|
75
74
|
#
|
|
76
75
|
# @param route_id [String] Filter pending transactions to those belonging to the specified Route.
|
|
77
76
|
#
|
|
@@ -3,14 +3,12 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class PhysicalCardProfiles
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::PhysicalCardProfileCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create a Physical Card Profile
|
|
10
7
|
#
|
|
11
8
|
# @overload create(carrier_image_file_id:, contact_phone:, description:, front_image_file_id:, program_id:, front_text: nil, request_options: {})
|
|
12
9
|
#
|
|
13
|
-
# @param carrier_image_file_id [String]
|
|
10
|
+
# @param carrier_image_file_id [String]
|
|
11
|
+
# The identifier of the File containing the physical card's carrier image.
|
|
14
12
|
#
|
|
15
13
|
# @param contact_phone [String] A phone number the user can contact to receive support for their card.
|
|
16
14
|
#
|
|
@@ -20,7 +18,9 @@ module Increase
|
|
|
20
18
|
#
|
|
21
19
|
# @param program_id [String] The identifier for the Program that this Physical Card Profile falls under.
|
|
22
20
|
#
|
|
23
|
-
# @param front_text [Increase::Models::PhysicalCardProfileCreateParams::FrontText]
|
|
21
|
+
# @param front_text [Increase::Models::PhysicalCardProfileCreateParams::FrontText]
|
|
22
|
+
# Text printed on the front of the card. Reach out to
|
|
23
|
+
# [support@increase.com](mailto:support@increase.com) for more information.
|
|
24
24
|
#
|
|
25
25
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
26
26
|
#
|
|
@@ -58,18 +58,21 @@ module Increase
|
|
|
58
58
|
)
|
|
59
59
|
end
|
|
60
60
|
|
|
61
|
-
# Some parameter documentations has been truncated, see
|
|
62
|
-
# {Increase::Models::PhysicalCardProfileListParams} for more details.
|
|
63
|
-
#
|
|
64
61
|
# List Physical Card Profiles
|
|
65
62
|
#
|
|
66
63
|
# @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
67
64
|
#
|
|
68
65
|
# @param cursor [String] Return the page of entries after this one.
|
|
69
66
|
#
|
|
70
|
-
# @param idempotency_key [String]
|
|
67
|
+
# @param idempotency_key [String]
|
|
68
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
69
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
70
|
+
# request is only processed once. Learn more about
|
|
71
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
71
72
|
#
|
|
72
|
-
# @param limit [Integer]
|
|
73
|
+
# @param limit [Integer]
|
|
74
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
75
|
+
# objects.
|
|
73
76
|
#
|
|
74
77
|
# @param status [Increase::Models::PhysicalCardProfileListParams::Status]
|
|
75
78
|
#
|
|
@@ -111,16 +114,14 @@ module Increase
|
|
|
111
114
|
)
|
|
112
115
|
end
|
|
113
116
|
|
|
114
|
-
# Some parameter documentations has been truncated, see
|
|
115
|
-
# {Increase::Models::PhysicalCardProfileCloneParams} for more details.
|
|
116
|
-
#
|
|
117
117
|
# Clone a Physical Card Profile
|
|
118
118
|
#
|
|
119
119
|
# @overload clone_(physical_card_profile_id, carrier_image_file_id: nil, contact_phone: nil, description: nil, front_image_file_id: nil, front_text: nil, program_id: nil, request_options: {})
|
|
120
120
|
#
|
|
121
121
|
# @param physical_card_profile_id [String] The identifier of the Physical Card Profile to clone.
|
|
122
122
|
#
|
|
123
|
-
# @param carrier_image_file_id [String]
|
|
123
|
+
# @param carrier_image_file_id [String]
|
|
124
|
+
# The identifier of the File containing the physical card's carrier image.
|
|
124
125
|
#
|
|
125
126
|
# @param contact_phone [String] A phone number the user can contact to receive support for their card.
|
|
126
127
|
#
|
|
@@ -128,7 +129,9 @@ module Increase
|
|
|
128
129
|
#
|
|
129
130
|
# @param front_image_file_id [String] The identifier of the File containing the physical card's front image.
|
|
130
131
|
#
|
|
131
|
-
# @param front_text [Increase::Models::PhysicalCardProfileCloneParams::FrontText]
|
|
132
|
+
# @param front_text [Increase::Models::PhysicalCardProfileCloneParams::FrontText]
|
|
133
|
+
# Text printed on the front of the card. Reach out to
|
|
134
|
+
# [support@increase.com](mailto:support@increase.com) for more information.
|
|
132
135
|
#
|
|
133
136
|
# @param program_id [String] The identifier of the Program to use for the cloned Physical Card Profile.
|
|
134
137
|
#
|
|
@@ -3,20 +3,21 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class PhysicalCards
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::PhysicalCardCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create a Physical Card
|
|
10
7
|
#
|
|
11
8
|
# @overload create(card_id:, cardholder:, shipment:, physical_card_profile_id: nil, request_options: {})
|
|
12
9
|
#
|
|
13
10
|
# @param card_id [String] The underlying card representing this physical card.
|
|
14
11
|
#
|
|
15
|
-
# @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder]
|
|
12
|
+
# @param cardholder [Increase::Models::PhysicalCardCreateParams::Cardholder]
|
|
13
|
+
# Details about the cardholder, as it will appear on the physical card.
|
|
16
14
|
#
|
|
17
|
-
# @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment]
|
|
15
|
+
# @param shipment [Increase::Models::PhysicalCardCreateParams::Shipment]
|
|
16
|
+
# The details used to ship this physical card.
|
|
18
17
|
#
|
|
19
|
-
# @param physical_card_profile_id [String]
|
|
18
|
+
# @param physical_card_profile_id [String]
|
|
19
|
+
# The physical card profile to use for this physical card. The latest default
|
|
20
|
+
# physical card profile will be used if not provided.
|
|
20
21
|
#
|
|
21
22
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
22
23
|
#
|
|
@@ -60,7 +61,8 @@ module Increase
|
|
|
60
61
|
#
|
|
61
62
|
# @param physical_card_id [String] The Physical Card identifier.
|
|
62
63
|
#
|
|
63
|
-
# @param status [Symbol, Increase::Models::PhysicalCardUpdateParams::Status]
|
|
64
|
+
# @param status [Symbol, Increase::Models::PhysicalCardUpdateParams::Status]
|
|
65
|
+
# The status to update the Physical Card to.
|
|
64
66
|
#
|
|
65
67
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
66
68
|
#
|
|
@@ -78,9 +80,6 @@ module Increase
|
|
|
78
80
|
)
|
|
79
81
|
end
|
|
80
82
|
|
|
81
|
-
# Some parameter documentations has been truncated, see
|
|
82
|
-
# {Increase::Models::PhysicalCardListParams} for more details.
|
|
83
|
-
#
|
|
84
83
|
# List Physical Cards
|
|
85
84
|
#
|
|
86
85
|
# @overload list(card_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
|
|
@@ -91,9 +90,15 @@ module Increase
|
|
|
91
90
|
#
|
|
92
91
|
# @param cursor [String] Return the page of entries after this one.
|
|
93
92
|
#
|
|
94
|
-
# @param idempotency_key [String]
|
|
93
|
+
# @param idempotency_key [String]
|
|
94
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
95
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
96
|
+
# request is only processed once. Learn more about
|
|
97
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
95
98
|
#
|
|
96
|
-
# @param limit [Integer]
|
|
99
|
+
# @param limit [Integer]
|
|
100
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
101
|
+
# objects.
|
|
97
102
|
#
|
|
98
103
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
99
104
|
#
|
|
@@ -23,16 +23,15 @@ module Increase
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::ProgramListParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# List Programs
|
|
30
27
|
#
|
|
31
28
|
# @overload list(cursor: nil, limit: nil, request_options: {})
|
|
32
29
|
#
|
|
33
30
|
# @param cursor [String] Return the page of entries after this one.
|
|
34
31
|
#
|
|
35
|
-
# @param limit [Integer]
|
|
32
|
+
# @param limit [Integer]
|
|
33
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
34
|
+
# objects.
|
|
36
35
|
#
|
|
37
36
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
38
37
|
#
|
|
@@ -23,26 +23,35 @@ module Increase
|
|
|
23
23
|
)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Some parameter documentations has been truncated, see
|
|
27
|
-
# {Increase::Models::RealTimeDecisionActionParams} for more details.
|
|
28
|
-
#
|
|
29
26
|
# Action a Real-Time Decision
|
|
30
27
|
#
|
|
31
28
|
# @overload action(real_time_decision_id, card_authentication: nil, card_authentication_challenge: nil, card_authorization: nil, card_balance_inquiry: nil, digital_wallet_authentication: nil, digital_wallet_token: nil, request_options: {})
|
|
32
29
|
#
|
|
33
30
|
# @param real_time_decision_id [String] The identifier of the Real-Time Decision.
|
|
34
31
|
#
|
|
35
|
-
# @param card_authentication [Increase::Models::RealTimeDecisionActionParams::CardAuthentication]
|
|
32
|
+
# @param card_authentication [Increase::Models::RealTimeDecisionActionParams::CardAuthentication]
|
|
33
|
+
# If the Real-Time Decision relates to a 3DS card authentication attempt, this
|
|
34
|
+
# object contains your response to the authentication.
|
|
36
35
|
#
|
|
37
|
-
# @param card_authentication_challenge [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge]
|
|
36
|
+
# @param card_authentication_challenge [Increase::Models::RealTimeDecisionActionParams::CardAuthenticationChallenge]
|
|
37
|
+
# If the Real-Time Decision relates to 3DS card authentication challenge delivery,
|
|
38
|
+
# this object contains your response.
|
|
38
39
|
#
|
|
39
|
-
# @param card_authorization [Increase::Models::RealTimeDecisionActionParams::CardAuthorization]
|
|
40
|
+
# @param card_authorization [Increase::Models::RealTimeDecisionActionParams::CardAuthorization]
|
|
41
|
+
# If the Real-Time Decision relates to a card authorization attempt, this object
|
|
42
|
+
# contains your response to the authorization.
|
|
40
43
|
#
|
|
41
|
-
# @param card_balance_inquiry [Increase::Models::RealTimeDecisionActionParams::CardBalanceInquiry]
|
|
44
|
+
# @param card_balance_inquiry [Increase::Models::RealTimeDecisionActionParams::CardBalanceInquiry]
|
|
45
|
+
# If the Real-Time Decision relates to a card balance inquiry attempt, this object
|
|
46
|
+
# contains your response to the inquiry.
|
|
42
47
|
#
|
|
43
|
-
# @param digital_wallet_authentication [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication]
|
|
48
|
+
# @param digital_wallet_authentication [Increase::Models::RealTimeDecisionActionParams::DigitalWalletAuthentication]
|
|
49
|
+
# If the Real-Time Decision relates to a digital wallet authentication attempt,
|
|
50
|
+
# this object contains your response to the authentication.
|
|
44
51
|
#
|
|
45
|
-
# @param digital_wallet_token [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken]
|
|
52
|
+
# @param digital_wallet_token [Increase::Models::RealTimeDecisionActionParams::DigitalWalletToken]
|
|
53
|
+
# If the Real-Time Decision relates to a digital wallet token provisioning
|
|
54
|
+
# attempt, this object contains your response to the attempt.
|
|
46
55
|
#
|
|
47
56
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
48
57
|
#
|
|
@@ -3,34 +3,46 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class RealTimePaymentsTransfers
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::RealTimePaymentsTransferCreateParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# Create a Real-Time Payments Transfer
|
|
10
7
|
#
|
|
11
8
|
# @overload create(amount:, creditor_name:, source_account_number_id:, unstructured_remittance_information:, account_number: nil, debtor_name: nil, external_account_id: nil, require_approval: nil, routing_number: nil, ultimate_creditor_name: nil, ultimate_debtor_name: nil, request_options: {})
|
|
12
9
|
#
|
|
13
|
-
# @param amount [Integer]
|
|
10
|
+
# @param amount [Integer]
|
|
11
|
+
# The transfer amount in USD cents. For Real-Time Payments transfers, must be
|
|
12
|
+
# positive.
|
|
14
13
|
#
|
|
15
14
|
# @param creditor_name [String] The name of the transfer's recipient.
|
|
16
15
|
#
|
|
17
|
-
# @param source_account_number_id [String]
|
|
16
|
+
# @param source_account_number_id [String]
|
|
17
|
+
# The identifier of the Account Number from which to send the transfer.
|
|
18
18
|
#
|
|
19
|
-
# @param unstructured_remittance_information [String]
|
|
19
|
+
# @param unstructured_remittance_information [String]
|
|
20
|
+
# Unstructured information that will show on the recipient's bank statement.
|
|
20
21
|
#
|
|
21
22
|
# @param account_number [String] The destination account number.
|
|
22
23
|
#
|
|
23
|
-
# @param debtor_name [String]
|
|
24
|
+
# @param debtor_name [String]
|
|
25
|
+
# The name of the transfer's sender. If not provided, defaults to the name of the
|
|
26
|
+
# account's entity.
|
|
24
27
|
#
|
|
25
|
-
# @param external_account_id [String]
|
|
28
|
+
# @param external_account_id [String]
|
|
29
|
+
# The ID of an External Account to initiate a transfer to. If this parameter is
|
|
30
|
+
# provided, `account_number` and `routing_number` must be absent.
|
|
26
31
|
#
|
|
27
|
-
# @param require_approval [Boolean]
|
|
32
|
+
# @param require_approval [Boolean]
|
|
33
|
+
# Whether the transfer requires explicit approval via the dashboard or API.
|
|
28
34
|
#
|
|
29
|
-
# @param routing_number [String]
|
|
35
|
+
# @param routing_number [String]
|
|
36
|
+
# The destination American Bankers' Association (ABA) Routing Transit Number
|
|
37
|
+
# (RTN).
|
|
30
38
|
#
|
|
31
|
-
# @param ultimate_creditor_name [String]
|
|
39
|
+
# @param ultimate_creditor_name [String]
|
|
40
|
+
# The name of the ultimate recipient of the transfer. Set this if the creditor is
|
|
41
|
+
# an intermediary receiving the payment for someone else.
|
|
32
42
|
#
|
|
33
|
-
# @param ultimate_debtor_name [String]
|
|
43
|
+
# @param ultimate_debtor_name [String]
|
|
44
|
+
# The name of the ultimate sender of the transfer. Set this if the funds are being
|
|
45
|
+
# sent on behalf of someone who is not the account holder at Increase.
|
|
34
46
|
#
|
|
35
47
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
36
48
|
#
|
|
@@ -68,24 +80,30 @@ module Increase
|
|
|
68
80
|
)
|
|
69
81
|
end
|
|
70
82
|
|
|
71
|
-
# Some parameter documentations has been truncated, see
|
|
72
|
-
# {Increase::Models::RealTimePaymentsTransferListParams} for more details.
|
|
73
|
-
#
|
|
74
83
|
# List Real-Time Payments Transfers
|
|
75
84
|
#
|
|
76
85
|
# @overload list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
|
|
77
86
|
#
|
|
78
|
-
# @param account_id [String]
|
|
87
|
+
# @param account_id [String]
|
|
88
|
+
# Filter Real-Time Payments Transfers to those belonging to the specified Account.
|
|
79
89
|
#
|
|
80
90
|
# @param created_at [Increase::Models::RealTimePaymentsTransferListParams::CreatedAt]
|
|
81
91
|
#
|
|
82
92
|
# @param cursor [String] Return the page of entries after this one.
|
|
83
93
|
#
|
|
84
|
-
# @param external_account_id [String]
|
|
94
|
+
# @param external_account_id [String]
|
|
95
|
+
# Filter Real-Time Payments Transfers to those made to the specified External
|
|
96
|
+
# Account.
|
|
85
97
|
#
|
|
86
|
-
# @param idempotency_key [String]
|
|
98
|
+
# @param idempotency_key [String]
|
|
99
|
+
# Filter records to the one with the specified `idempotency_key` you chose for
|
|
100
|
+
# that object. This value is unique across Increase and is used to ensure that a
|
|
101
|
+
# request is only processed once. Learn more about
|
|
102
|
+
# [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
87
103
|
#
|
|
88
|
-
# @param limit [Integer]
|
|
104
|
+
# @param limit [Integer]
|
|
105
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
106
|
+
# objects.
|
|
89
107
|
#
|
|
90
108
|
# @param status [Increase::Models::RealTimePaymentsTransferListParams::Status]
|
|
91
109
|
#
|
|
@@ -111,7 +129,8 @@ module Increase
|
|
|
111
129
|
#
|
|
112
130
|
# @overload approve(real_time_payments_transfer_id, request_options: {})
|
|
113
131
|
#
|
|
114
|
-
# @param real_time_payments_transfer_id [String]
|
|
132
|
+
# @param real_time_payments_transfer_id [String]
|
|
133
|
+
# The identifier of the Real-Time Payments Transfer to approve.
|
|
115
134
|
#
|
|
116
135
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
117
136
|
#
|
|
@@ -131,7 +150,8 @@ module Increase
|
|
|
131
150
|
#
|
|
132
151
|
# @overload cancel(real_time_payments_transfer_id, request_options: {})
|
|
133
152
|
#
|
|
134
|
-
# @param real_time_payments_transfer_id [String]
|
|
153
|
+
# @param real_time_payments_transfer_id [String]
|
|
154
|
+
# The identifier of the pending Real-Time Payments Transfer to cancel.
|
|
135
155
|
#
|
|
136
156
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
137
157
|
#
|
|
@@ -3,9 +3,6 @@
|
|
|
3
3
|
module Increase
|
|
4
4
|
module Resources
|
|
5
5
|
class RoutingNumbers
|
|
6
|
-
# Some parameter documentations has been truncated, see
|
|
7
|
-
# {Increase::Models::RoutingNumberListParams} for more details.
|
|
8
|
-
#
|
|
9
6
|
# You can use this API to confirm if a routing number is valid, such as when a
|
|
10
7
|
# user is providing you with bank account details. Since routing numbers uniquely
|
|
11
8
|
# identify a bank, this will always return 0 or 1 entry. In Sandbox, only a few
|
|
@@ -18,7 +15,9 @@ module Increase
|
|
|
18
15
|
#
|
|
19
16
|
# @param cursor [String] Return the page of entries after this one.
|
|
20
17
|
#
|
|
21
|
-
# @param limit [Integer]
|
|
18
|
+
# @param limit [Integer]
|
|
19
|
+
# Limit the size of the list that is returned. The default (and maximum) is 100
|
|
20
|
+
# objects.
|
|
22
21
|
#
|
|
23
22
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
23
|
#
|
|
@@ -4,10 +4,6 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class AccountRevenuePayments
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::AccountRevenuePaymentCreateParams} for more
|
|
9
|
-
# details.
|
|
10
|
-
#
|
|
11
7
|
# Simulates an account revenue payment to your account. In production, this
|
|
12
8
|
# happens automatically on the first of each month.
|
|
13
9
|
#
|
|
@@ -17,11 +13,17 @@ module Increase
|
|
|
17
13
|
#
|
|
18
14
|
# @param amount [Integer] The account revenue amount in cents. Must be positive.
|
|
19
15
|
#
|
|
20
|
-
# @param accrued_on_account_id [String]
|
|
16
|
+
# @param accrued_on_account_id [String]
|
|
17
|
+
# The identifier of the Account the account revenue accrued on. Defaults to
|
|
18
|
+
# `account_id`.
|
|
21
19
|
#
|
|
22
|
-
# @param period_end [Time]
|
|
20
|
+
# @param period_end [Time]
|
|
21
|
+
# The end of the account revenue period. If not provided, defaults to the current
|
|
22
|
+
# time.
|
|
23
23
|
#
|
|
24
|
-
# @param period_start [Time]
|
|
24
|
+
# @param period_start [Time]
|
|
25
|
+
# The start of the account revenue period. If not provided, defaults to the
|
|
26
|
+
# current time.
|
|
25
27
|
#
|
|
26
28
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
27
29
|
#
|
|
@@ -29,18 +29,17 @@ module Increase
|
|
|
29
29
|
)
|
|
30
30
|
end
|
|
31
31
|
|
|
32
|
-
# Some parameter documentations has been truncated, see
|
|
33
|
-
# {Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams} for
|
|
34
|
-
# more details.
|
|
35
|
-
#
|
|
36
32
|
# Simulates receiving a Notification of Change for an
|
|
37
33
|
# [ACH Transfer](#ach-transfers).
|
|
38
34
|
#
|
|
39
35
|
# @overload create_notification_of_change(ach_transfer_id, corrected_account_funding: nil, corrected_account_number: nil, corrected_individual_id: nil, corrected_routing_number: nil, request_options: {})
|
|
40
36
|
#
|
|
41
|
-
# @param ach_transfer_id [String]
|
|
37
|
+
# @param ach_transfer_id [String]
|
|
38
|
+
# The identifier of the ACH Transfer you wish to create a notification of change
|
|
39
|
+
# for.
|
|
42
40
|
#
|
|
43
|
-
# @param corrected_account_funding [Symbol, Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::CorrectedAccountFunding]
|
|
41
|
+
# @param corrected_account_funding [Symbol, Increase::Models::Simulations::ACHTransferCreateNotificationOfChangeParams::CorrectedAccountFunding]
|
|
42
|
+
# The corrected account funding type.
|
|
44
43
|
#
|
|
45
44
|
# @param corrected_account_number [String] The corrected account number.
|
|
46
45
|
#
|
|
@@ -64,18 +63,22 @@ module Increase
|
|
|
64
63
|
)
|
|
65
64
|
end
|
|
66
65
|
|
|
67
|
-
# Some parameter documentations has been truncated, see
|
|
68
|
-
# {Increase::Models::Simulations::ACHTransferReturnParams} for more details.
|
|
69
|
-
#
|
|
70
66
|
# Simulates the return of an [ACH Transfer](#ach-transfers) by the Federal Reserve
|
|
71
67
|
# due to an error condition. This will also create a Transaction to account for
|
|
72
68
|
# the returned funds. This transfer must first have a `status` of `submitted`.
|
|
73
69
|
#
|
|
74
|
-
# @overload return_(ach_transfer_id, reason: nil, request_options: {})
|
|
70
|
+
# @overload return_(ach_transfer_id, addenda_information: nil, reason: nil, request_options: {})
|
|
75
71
|
#
|
|
76
72
|
# @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to return.
|
|
77
73
|
#
|
|
78
|
-
# @param
|
|
74
|
+
# @param addenda_information [String]
|
|
75
|
+
# Free-form information the returning bank includes in the return addenda. For a
|
|
76
|
+
# `file_record_edit_criteria` (R17) return, set this to `QUESTIONABLE` to simulate
|
|
77
|
+
# a return the bank believes was initiated under questionable circumstances.
|
|
78
|
+
#
|
|
79
|
+
# @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason]
|
|
80
|
+
# The reason why the Federal Reserve or destination bank returned this transfer.
|
|
81
|
+
# Defaults to `no_account`.
|
|
79
82
|
#
|
|
80
83
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
81
84
|
#
|
|
@@ -93,9 +96,6 @@ module Increase
|
|
|
93
96
|
)
|
|
94
97
|
end
|
|
95
98
|
|
|
96
|
-
# Some parameter documentations has been truncated, see
|
|
97
|
-
# {Increase::Models::Simulations::ACHTransferSettleParams} for more details.
|
|
98
|
-
#
|
|
99
99
|
# Simulates the settlement of an [ACH Transfer](#ach-transfers) by the Federal
|
|
100
100
|
# Reserve. This transfer must first have a `status` of `pending_submission` or
|
|
101
101
|
# `submitted`. For convenience, if the transfer is in `status`:
|
|
@@ -110,7 +110,10 @@ module Increase
|
|
|
110
110
|
#
|
|
111
111
|
# @param ach_transfer_id [String] The identifier of the ACH Transfer you wish to become settled.
|
|
112
112
|
#
|
|
113
|
-
# @param inbound_funds_hold_behavior [Symbol, Increase::Models::Simulations::ACHTransferSettleParams::InboundFundsHoldBehavior]
|
|
113
|
+
# @param inbound_funds_hold_behavior [Symbol, Increase::Models::Simulations::ACHTransferSettleParams::InboundFundsHoldBehavior]
|
|
114
|
+
# The behavior of the inbound funds hold that is created when the ACH Transfer is
|
|
115
|
+
# settled. If no behavior is specified, the inbound funds hold will be released
|
|
116
|
+
# immediately in order for the funds to be available for use.
|
|
114
117
|
#
|
|
115
118
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
116
119
|
#
|
|
@@ -4,10 +4,6 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class CardAuthentications
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::CardAuthenticationCreateParams} for more
|
|
9
|
-
# details.
|
|
10
|
-
#
|
|
11
7
|
# Simulates a Card Authentication attempt on a [Card](#cards). The attempt always
|
|
12
8
|
# results in a [Card Payment](#card_payments) being created, either with a status
|
|
13
9
|
# that allows further action or a terminal failed status.
|
|
@@ -16,13 +12,19 @@ module Increase
|
|
|
16
12
|
#
|
|
17
13
|
# @param card_id [String] The identifier of the Card to be authorized.
|
|
18
14
|
#
|
|
19
|
-
# @param category [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::Category]
|
|
15
|
+
# @param category [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::Category]
|
|
16
|
+
# The category of the card authentication attempt.
|
|
20
17
|
#
|
|
21
|
-
# @param device_channel [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::DeviceChannel]
|
|
18
|
+
# @param device_channel [Symbol, Increase::Models::Simulations::CardAuthenticationCreateParams::DeviceChannel]
|
|
19
|
+
# The device channel of the card authentication attempt.
|
|
22
20
|
#
|
|
23
|
-
# @param merchant_acceptor_id [String]
|
|
21
|
+
# @param merchant_acceptor_id [String]
|
|
22
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
23
|
+
# is transacting with.
|
|
24
24
|
#
|
|
25
|
-
# @param merchant_category_code [String]
|
|
25
|
+
# @param merchant_category_code [String]
|
|
26
|
+
# The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
27
|
+
# card is transacting with.
|
|
26
28
|
#
|
|
27
29
|
# @param merchant_country [String] The country the merchant resides in.
|
|
28
30
|
#
|
|
@@ -4,9 +4,6 @@ module Increase
|
|
|
4
4
|
module Resources
|
|
5
5
|
class Simulations
|
|
6
6
|
class CardAuthorizations
|
|
7
|
-
# Some parameter documentations has been truncated, see
|
|
8
|
-
# {Increase::Models::Simulations::CardAuthorizationCreateParams} for more details.
|
|
9
|
-
#
|
|
10
7
|
# Simulates a purchase authorization on a [Card](#cards). Depending on the balance
|
|
11
8
|
# available to the card and the `amount` submitted, the authorization activity
|
|
12
9
|
# will result in a [Pending Transaction](#pending-transactions) of type
|
|
@@ -22,19 +19,31 @@ module Increase
|
|
|
22
19
|
#
|
|
23
20
|
# @param amount [Integer] The authorization amount in cents.
|
|
24
21
|
#
|
|
25
|
-
# @param authenticated_card_payment_id [String]
|
|
22
|
+
# @param authenticated_card_payment_id [String]
|
|
23
|
+
# The identifier of a Card Payment with a `card_authentication` if you want to
|
|
24
|
+
# simulate an authenticated authorization.
|
|
26
25
|
#
|
|
27
26
|
# @param card_id [String] The identifier of the Card to be authorized.
|
|
28
27
|
#
|
|
29
|
-
# @param decline_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason]
|
|
28
|
+
# @param decline_reason [Symbol, Increase::Models::Simulations::CardAuthorizationCreateParams::DeclineReason]
|
|
29
|
+
# Forces a card decline with a specific reason. No real time decision will be
|
|
30
|
+
# sent.
|
|
30
31
|
#
|
|
31
32
|
# @param digital_wallet_token_id [String] The identifier of the Digital Wallet Token to be authorized.
|
|
32
33
|
#
|
|
33
|
-
# @param event_subscription_id [String]
|
|
34
|
+
# @param event_subscription_id [String]
|
|
35
|
+
# The identifier of the Event Subscription to use. If provided, will override the
|
|
36
|
+
# default real time event subscription. Because you can only create one real time
|
|
37
|
+
# decision event subscription, you can use this field to route events to any
|
|
38
|
+
# specified event subscription for testing purposes.
|
|
34
39
|
#
|
|
35
|
-
# @param merchant_acceptor_id [String]
|
|
40
|
+
# @param merchant_acceptor_id [String]
|
|
41
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
42
|
+
# is transacting with.
|
|
36
43
|
#
|
|
37
|
-
# @param merchant_category_code [String]
|
|
44
|
+
# @param merchant_category_code [String]
|
|
45
|
+
# The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
46
|
+
# card is transacting with.
|
|
38
47
|
#
|
|
39
48
|
# @param merchant_city [String] The city the merchant resides in.
|
|
40
49
|
#
|
|
@@ -44,15 +53,22 @@ module Increase
|
|
|
44
53
|
#
|
|
45
54
|
# @param merchant_state [String] The state the merchant resides in.
|
|
46
55
|
#
|
|
47
|
-
# @param network_details [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails]
|
|
56
|
+
# @param network_details [Increase::Models::Simulations::CardAuthorizationCreateParams::NetworkDetails]
|
|
57
|
+
# Fields specific to a given card network.
|
|
48
58
|
#
|
|
49
|
-
# @param network_risk_score [Integer]
|
|
59
|
+
# @param network_risk_score [Integer]
|
|
60
|
+
# The risk score generated by the card network. For Visa this is the Visa Advanced
|
|
61
|
+
# Authorization risk score, from 0 to 99, where 99 is the riskiest.
|
|
50
62
|
#
|
|
51
63
|
# @param physical_card_id [String] The identifier of the Physical Card to be authorized.
|
|
52
64
|
#
|
|
53
|
-
# @param processing_category [Increase::Models::Simulations::CardAuthorizationCreateParams::ProcessingCategory]
|
|
65
|
+
# @param processing_category [Increase::Models::Simulations::CardAuthorizationCreateParams::ProcessingCategory]
|
|
66
|
+
# Fields specific to a specific type of authorization, such as Automatic Fuel
|
|
67
|
+
# Dispensers, Refund Authorizations, or Cash Disbursements.
|
|
54
68
|
#
|
|
55
|
-
# @param terminal_id [String]
|
|
69
|
+
# @param terminal_id [String]
|
|
70
|
+
# The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
|
71
|
+
# is transacting with.
|
|
56
72
|
#
|
|
57
73
|
# @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
58
74
|
#
|