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
|
@@ -76,9 +76,6 @@ module Increase
|
|
|
76
76
|
required :type, enum: -> { Increase::Transaction::Type }
|
|
77
77
|
|
|
78
78
|
# @!method initialize(id:, account_id:, amount:, created_at:, currency:, description:, route_id:, route_type:, source:, type:)
|
|
79
|
-
# Some parameter documentations has been truncated, see
|
|
80
|
-
# {Increase::Models::Transaction} for more details.
|
|
81
|
-
#
|
|
82
79
|
# Transactions are the immutable additions and removals of money from your bank
|
|
83
80
|
# account. They're the equivalent of line items on your bank statement. To learn
|
|
84
81
|
# more, see [Transactions and Transfers](/documentation/transactions-transfers).
|
|
@@ -87,21 +84,40 @@ module Increase
|
|
|
87
84
|
#
|
|
88
85
|
# @param account_id [String] The identifier for the Account the Transaction belongs to.
|
|
89
86
|
#
|
|
90
|
-
# @param amount [Integer]
|
|
87
|
+
# @param amount [Integer]
|
|
88
|
+
# The Transaction amount in the minor unit of its currency. For dollars, for
|
|
89
|
+
# example, this is cents.
|
|
91
90
|
#
|
|
92
|
-
# @param created_at [Time]
|
|
91
|
+
# @param created_at [Time]
|
|
92
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
93
|
+
# the Transaction occurred.
|
|
93
94
|
#
|
|
94
|
-
# @param currency [Symbol, Increase::Models::Transaction::Currency]
|
|
95
|
+
# @param currency [Symbol, Increase::Models::Transaction::Currency]
|
|
96
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
97
|
+
# Transaction's currency. This will match the currency on the Transaction's
|
|
98
|
+
# Account.
|
|
95
99
|
#
|
|
96
|
-
# @param description [String]
|
|
100
|
+
# @param description [String]
|
|
101
|
+
# An informational message describing this transaction. Use the fields in `source`
|
|
102
|
+
# to get more detailed information. This field appears as the line-item on the
|
|
103
|
+
# statement.
|
|
97
104
|
#
|
|
98
|
-
# @param route_id [String, nil]
|
|
105
|
+
# @param route_id [String, nil]
|
|
106
|
+
# The identifier for the route this Transaction came through. Routes are things
|
|
107
|
+
# like cards and ACH details.
|
|
99
108
|
#
|
|
100
|
-
# @param route_type [Symbol, Increase::Models::Transaction::RouteType, nil]
|
|
109
|
+
# @param route_type [Symbol, Increase::Models::Transaction::RouteType, nil]
|
|
110
|
+
# The type of the route this Transaction came through.
|
|
101
111
|
#
|
|
102
|
-
# @param source [Increase::Models::Transaction::Source]
|
|
112
|
+
# @param source [Increase::Models::Transaction::Source]
|
|
113
|
+
# This is an object giving more details on the network-level event that caused the
|
|
114
|
+
# Transaction. Note that for backwards compatibility reasons, additional
|
|
115
|
+
# undocumented keys may appear in this object. These should be treated as
|
|
116
|
+
# deprecated and will be removed in the future.
|
|
103
117
|
#
|
|
104
|
-
# @param type [Symbol, Increase::Models::Transaction::Type]
|
|
118
|
+
# @param type [Symbol, Increase::Models::Transaction::Type]
|
|
119
|
+
# A constant representing the object's type. For this resource it will always be
|
|
120
|
+
# `transaction`.
|
|
105
121
|
|
|
106
122
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
107
123
|
# Transaction's currency. This will match the currency on the Transaction's
|
|
@@ -547,91 +563,244 @@ module Increase
|
|
|
547
563
|
nil?: true
|
|
548
564
|
|
|
549
565
|
# @!method initialize(category:, account_revenue_payment: nil, account_transfer_intention: nil, ach_transfer_intention: nil, ach_transfer_rejection: nil, ach_transfer_return: nil, blockchain_offramp_transfer_settlement: nil, blockchain_onramp_transfer_intention: nil, card_dispute_acceptance: nil, card_dispute_financial: nil, card_dispute_loss: nil, card_financial: nil, card_push_transfer_acceptance: nil, card_refund: nil, card_revenue_payment: nil, card_settlement: nil, cashback_payment: nil, check_deposit_acceptance: nil, check_deposit_return: nil, check_transfer_deposit: nil, fednow_transfer_acknowledgement: nil, fee_payment: nil, inbound_ach_transfer: nil, inbound_ach_transfer_return_intention: nil, inbound_check_adjustment: nil, inbound_check_deposit_return_intention: nil, inbound_fednow_transfer_confirmation: nil, inbound_real_time_payments_transfer_confirmation: nil, inbound_wire_reversal: nil, inbound_wire_transfer: nil, inbound_wire_transfer_reversal: nil, interest_payment: nil, internal_source: nil, other: nil, real_time_payments_transfer_acknowledgement: nil, sample_funds: nil, swift_transfer_intention: nil, swift_transfer_return: nil, wire_transfer_intention: nil)
|
|
550
|
-
# Some parameter documentations has been truncated, see
|
|
551
|
-
# {Increase::Models::Transaction::Source} for more details.
|
|
552
|
-
#
|
|
553
566
|
# This is an object giving more details on the network-level event that caused the
|
|
554
567
|
# Transaction. Note that for backwards compatibility reasons, additional
|
|
555
568
|
# undocumented keys may appear in this object. These should be treated as
|
|
556
569
|
# deprecated and will be removed in the future.
|
|
557
570
|
#
|
|
558
|
-
# @param category [Symbol, Increase::Models::Transaction::Source::Category]
|
|
571
|
+
# @param category [Symbol, Increase::Models::Transaction::Source::Category]
|
|
572
|
+
# The type of the resource. We may add additional possible values for this enum
|
|
573
|
+
# over time; your application should be able to handle such additions gracefully.
|
|
559
574
|
#
|
|
560
|
-
# @param account_revenue_payment [Increase::Models::Transaction::Source::AccountRevenuePayment, nil]
|
|
575
|
+
# @param account_revenue_payment [Increase::Models::Transaction::Source::AccountRevenuePayment, nil]
|
|
576
|
+
# An Account Revenue Payment object. This field will be present in the JSON
|
|
577
|
+
# response if and only if `category` is equal to `account_revenue_payment`. An
|
|
578
|
+
# Account Revenue Payment represents a payment made to an account from the bank.
|
|
579
|
+
# Account revenue is a type of non-interest income.
|
|
561
580
|
#
|
|
562
|
-
# @param account_transfer_intention [Increase::Models::Transaction::Source::AccountTransferIntention, nil]
|
|
581
|
+
# @param account_transfer_intention [Increase::Models::Transaction::Source::AccountTransferIntention, nil]
|
|
582
|
+
# An Account Transfer Intention object. This field will be present in the JSON
|
|
583
|
+
# response if and only if `category` is equal to `account_transfer_intention`. Two
|
|
584
|
+
# Account Transfer Intentions are created from each Account Transfer. One
|
|
585
|
+
# decrements the source account, and the other increments the destination account.
|
|
563
586
|
#
|
|
564
|
-
# @param ach_transfer_intention [Increase::Models::Transaction::Source::ACHTransferIntention, nil]
|
|
587
|
+
# @param ach_transfer_intention [Increase::Models::Transaction::Source::ACHTransferIntention, nil]
|
|
588
|
+
# An ACH Transfer Intention object. This field will be present in the JSON
|
|
589
|
+
# response if and only if `category` is equal to `ach_transfer_intention`. An ACH
|
|
590
|
+
# Transfer Intention is created from an ACH Transfer. It reflects the intention to
|
|
591
|
+
# move money into or out of an Increase account via the ACH network.
|
|
565
592
|
#
|
|
566
|
-
# @param ach_transfer_rejection [Increase::Models::Transaction::Source::ACHTransferRejection, nil]
|
|
593
|
+
# @param ach_transfer_rejection [Increase::Models::Transaction::Source::ACHTransferRejection, nil]
|
|
594
|
+
# An ACH Transfer Rejection object. This field will be present in the JSON
|
|
595
|
+
# response if and only if `category` is equal to `ach_transfer_rejection`. An ACH
|
|
596
|
+
# Transfer Rejection is created when an ACH Transfer is rejected by Increase. It
|
|
597
|
+
# offsets the ACH Transfer Intention. These rejections are rare.
|
|
567
598
|
#
|
|
568
|
-
# @param ach_transfer_return [Increase::Models::Transaction::Source::ACHTransferReturn, nil]
|
|
599
|
+
# @param ach_transfer_return [Increase::Models::Transaction::Source::ACHTransferReturn, nil]
|
|
600
|
+
# An ACH Transfer Return object. This field will be present in the JSON response
|
|
601
|
+
# if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer
|
|
602
|
+
# Return is created when an ACH Transfer is returned by the receiving bank. It
|
|
603
|
+
# offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within
|
|
604
|
+
# the first two business days after the transfer is initiated, but can occur much
|
|
605
|
+
# later. The return appears as a new posted Transaction; no Pending Transaction is
|
|
606
|
+
# created.
|
|
569
607
|
#
|
|
570
|
-
# @param blockchain_offramp_transfer_settlement [Increase::Models::Transaction::Source::BlockchainOfframpTransferSettlement, nil]
|
|
608
|
+
# @param blockchain_offramp_transfer_settlement [Increase::Models::Transaction::Source::BlockchainOfframpTransferSettlement, nil]
|
|
609
|
+
# A Blockchain Off-Ramp Transfer Settlement object. This field will be present in
|
|
610
|
+
# the JSON response if and only if `category` is equal to
|
|
611
|
+
# `blockchain_offramp_transfer_settlement`.
|
|
571
612
|
#
|
|
572
|
-
# @param blockchain_onramp_transfer_intention [Increase::Models::Transaction::Source::BlockchainOnrampTransferIntention, nil]
|
|
613
|
+
# @param blockchain_onramp_transfer_intention [Increase::Models::Transaction::Source::BlockchainOnrampTransferIntention, nil]
|
|
614
|
+
# A Blockchain On-Ramp Transfer Intention object. This field will be present in
|
|
615
|
+
# the JSON response if and only if `category` is equal to
|
|
616
|
+
# `blockchain_onramp_transfer_intention`.
|
|
573
617
|
#
|
|
574
|
-
# @param card_dispute_acceptance [Increase::Models::Transaction::Source::CardDisputeAcceptance, nil]
|
|
618
|
+
# @param card_dispute_acceptance [Increase::Models::Transaction::Source::CardDisputeAcceptance, nil]
|
|
619
|
+
# A Legacy Card Dispute Acceptance object. This field will be present in the JSON
|
|
620
|
+
# response if and only if `category` is equal to `card_dispute_acceptance`.
|
|
621
|
+
# Contains the details of a successful Card Dispute.
|
|
575
622
|
#
|
|
576
|
-
# @param card_dispute_financial [Increase::Models::Transaction::Source::CardDisputeFinancial, nil]
|
|
623
|
+
# @param card_dispute_financial [Increase::Models::Transaction::Source::CardDisputeFinancial, nil]
|
|
624
|
+
# A Card Dispute Financial object. This field will be present in the JSON response
|
|
625
|
+
# if and only if `category` is equal to `card_dispute_financial`. Financial event
|
|
626
|
+
# related to a Card Dispute.
|
|
577
627
|
#
|
|
578
|
-
# @param card_dispute_loss [Increase::Models::Transaction::Source::CardDisputeLoss, nil]
|
|
628
|
+
# @param card_dispute_loss [Increase::Models::Transaction::Source::CardDisputeLoss, nil]
|
|
629
|
+
# A Legacy Card Dispute Loss object. This field will be present in the JSON
|
|
630
|
+
# response if and only if `category` is equal to `card_dispute_loss`. Contains the
|
|
631
|
+
# details of a lost Card Dispute.
|
|
579
632
|
#
|
|
580
|
-
# @param card_financial [Increase::Models::Transaction::Source::CardFinancial, nil]
|
|
633
|
+
# @param card_financial [Increase::Models::Transaction::Source::CardFinancial, nil]
|
|
634
|
+
# A Card Financial object. This field will be present in the JSON response if and
|
|
635
|
+
# only if `category` is equal to `card_financial`. Card Financials are card
|
|
636
|
+
# transactions that have cleared and settled. Unlike a Card Settlement, which
|
|
637
|
+
# clears a previous authorization, a Card Financial is authorized and cleared in a
|
|
638
|
+
# single message.
|
|
581
639
|
#
|
|
582
|
-
# @param card_push_transfer_acceptance [Increase::Models::Transaction::Source::CardPushTransferAcceptance, nil]
|
|
640
|
+
# @param card_push_transfer_acceptance [Increase::Models::Transaction::Source::CardPushTransferAcceptance, nil]
|
|
641
|
+
# A Card Push Transfer Acceptance object. This field will be present in the JSON
|
|
642
|
+
# response if and only if `category` is equal to `card_push_transfer_acceptance`.
|
|
643
|
+
# A Card Push Transfer Acceptance is created when an Outbound Card Push Transfer
|
|
644
|
+
# sent from Increase is accepted by the receiving bank.
|
|
583
645
|
#
|
|
584
|
-
# @param card_refund [Increase::Models::Transaction::Source::CardRefund, nil]
|
|
646
|
+
# @param card_refund [Increase::Models::Transaction::Source::CardRefund, nil]
|
|
647
|
+
# A Card Refund object. This field will be present in the JSON response if and
|
|
648
|
+
# only if `category` is equal to `card_refund`. Card Refunds move money back to
|
|
649
|
+
# the cardholder. While they are usually connected to a Card Settlement, an
|
|
650
|
+
# acquirer can also refund money directly to a card without relation to a
|
|
651
|
+
# transaction.
|
|
585
652
|
#
|
|
586
|
-
# @param card_revenue_payment [Increase::Models::Transaction::Source::CardRevenuePayment, nil]
|
|
653
|
+
# @param card_revenue_payment [Increase::Models::Transaction::Source::CardRevenuePayment, nil]
|
|
654
|
+
# A Card Revenue Payment object. This field will be present in the JSON response
|
|
655
|
+
# if and only if `category` is equal to `card_revenue_payment`. Card Revenue
|
|
656
|
+
# Payments reflect earnings from fees on card transactions.
|
|
587
657
|
#
|
|
588
|
-
# @param card_settlement [Increase::Models::Transaction::Source::CardSettlement, nil]
|
|
658
|
+
# @param card_settlement [Increase::Models::Transaction::Source::CardSettlement, nil]
|
|
659
|
+
# A Card Settlement object. This field will be present in the JSON response if and
|
|
660
|
+
# only if `category` is equal to `card_settlement`. Card Settlements are card
|
|
661
|
+
# transactions that have cleared and settled. While a settlement is usually
|
|
662
|
+
# preceded by an authorization, an acquirer can also directly clear a transaction
|
|
663
|
+
# without first authorizing it.
|
|
589
664
|
#
|
|
590
|
-
# @param cashback_payment [Increase::Models::Transaction::Source::CashbackPayment, nil]
|
|
665
|
+
# @param cashback_payment [Increase::Models::Transaction::Source::CashbackPayment, nil]
|
|
666
|
+
# A Cashback Payment object. This field will be present in the JSON response if
|
|
667
|
+
# and only if `category` is equal to `cashback_payment`. A Cashback Payment
|
|
668
|
+
# represents the cashback paid to a cardholder for a given period. Cashback is
|
|
669
|
+
# usually paid monthly for the prior month's transactions.
|
|
591
670
|
#
|
|
592
|
-
# @param check_deposit_acceptance [Increase::Models::Transaction::Source::CheckDepositAcceptance, nil]
|
|
671
|
+
# @param check_deposit_acceptance [Increase::Models::Transaction::Source::CheckDepositAcceptance, nil]
|
|
672
|
+
# A Check Deposit Acceptance object. This field will be present in the JSON
|
|
673
|
+
# response if and only if `category` is equal to `check_deposit_acceptance`. A
|
|
674
|
+
# Check Deposit Acceptance is created when a Check Deposit is processed and its
|
|
675
|
+
# details confirmed. Check Deposits may be returned by the receiving bank, which
|
|
676
|
+
# will appear as a Check Deposit Return.
|
|
593
677
|
#
|
|
594
|
-
# @param check_deposit_return [Increase::Models::Transaction::Source::CheckDepositReturn, nil]
|
|
678
|
+
# @param check_deposit_return [Increase::Models::Transaction::Source::CheckDepositReturn, nil]
|
|
679
|
+
# A Check Deposit Return object. This field will be present in the JSON response
|
|
680
|
+
# if and only if `category` is equal to `check_deposit_return`. A Check Deposit
|
|
681
|
+
# Return is created when a Check Deposit is returned by the bank holding the
|
|
682
|
+
# account it was drawn against. Check Deposits may be returned for a variety of
|
|
683
|
+
# reasons, including insufficient funds or a mismatched account number. Usually,
|
|
684
|
+
# checks are returned within the first 7 days after the deposit is made.
|
|
595
685
|
#
|
|
596
|
-
# @param check_transfer_deposit [Increase::Models::Transaction::Source::CheckTransferDeposit, nil]
|
|
686
|
+
# @param check_transfer_deposit [Increase::Models::Transaction::Source::CheckTransferDeposit, nil]
|
|
687
|
+
# A Check Transfer Deposit object. This field will be present in the JSON response
|
|
688
|
+
# if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check
|
|
689
|
+
# is a check drawn on an Increase account that has been deposited by an external
|
|
690
|
+
# bank account. These types of checks are not pre-registered.
|
|
597
691
|
#
|
|
598
|
-
# @param fednow_transfer_acknowledgement [Increase::Models::Transaction::Source::FednowTransferAcknowledgement, nil]
|
|
692
|
+
# @param fednow_transfer_acknowledgement [Increase::Models::Transaction::Source::FednowTransferAcknowledgement, nil]
|
|
693
|
+
# A FedNow Transfer Acknowledgement object. This field will be present in the JSON
|
|
694
|
+
# response if and only if `category` is equal to
|
|
695
|
+
# `fednow_transfer_acknowledgement`. A FedNow Transfer Acknowledgement is created
|
|
696
|
+
# when a FedNow Transfer sent from Increase is acknowledged by the receiving bank.
|
|
599
697
|
#
|
|
600
|
-
# @param fee_payment [Increase::Models::Transaction::Source::FeePayment, nil]
|
|
698
|
+
# @param fee_payment [Increase::Models::Transaction::Source::FeePayment, nil]
|
|
699
|
+
# A Fee Payment object. This field will be present in the JSON response if and
|
|
700
|
+
# only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
|
|
701
|
+
# made to Increase.
|
|
601
702
|
#
|
|
602
|
-
# @param inbound_ach_transfer [Increase::Models::Transaction::Source::InboundACHTransfer, nil]
|
|
703
|
+
# @param inbound_ach_transfer [Increase::Models::Transaction::Source::InboundACHTransfer, nil]
|
|
704
|
+
# An Inbound ACH Transfer Intention object. This field will be present in the JSON
|
|
705
|
+
# response if and only if `category` is equal to `inbound_ach_transfer`. An
|
|
706
|
+
# Inbound ACH Transfer Intention is created when an ACH transfer is initiated at
|
|
707
|
+
# another bank and received by Increase.
|
|
603
708
|
#
|
|
604
|
-
# @param inbound_ach_transfer_return_intention [Increase::Models::Transaction::Source::InboundACHTransferReturnIntention, nil]
|
|
709
|
+
# @param inbound_ach_transfer_return_intention [Increase::Models::Transaction::Source::InboundACHTransferReturnIntention, nil]
|
|
710
|
+
# An Inbound ACH Transfer Return Intention object. This field will be present in
|
|
711
|
+
# the JSON response if and only if `category` is equal to
|
|
712
|
+
# `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return
|
|
713
|
+
# Intention is created when an ACH transfer is initiated at another bank and
|
|
714
|
+
# returned by Increase.
|
|
605
715
|
#
|
|
606
|
-
# @param inbound_check_adjustment [Increase::Models::Transaction::Source::InboundCheckAdjustment, nil]
|
|
716
|
+
# @param inbound_check_adjustment [Increase::Models::Transaction::Source::InboundCheckAdjustment, nil]
|
|
717
|
+
# An Inbound Check Adjustment object. This field will be present in the JSON
|
|
718
|
+
# response if and only if `category` is equal to `inbound_check_adjustment`. An
|
|
719
|
+
# Inbound Check Adjustment is created when Increase receives an adjustment for a
|
|
720
|
+
# check or return deposited through Check21.
|
|
607
721
|
#
|
|
608
|
-
# @param inbound_check_deposit_return_intention [Increase::Models::Transaction::Source::InboundCheckDepositReturnIntention, nil]
|
|
722
|
+
# @param inbound_check_deposit_return_intention [Increase::Models::Transaction::Source::InboundCheckDepositReturnIntention, nil]
|
|
723
|
+
# An Inbound Check Deposit Return Intention object. This field will be present in
|
|
724
|
+
# the JSON response if and only if `category` is equal to
|
|
725
|
+
# `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return
|
|
726
|
+
# Intention is created when Increase receives an Inbound Check and the User
|
|
727
|
+
# requests that it be returned.
|
|
609
728
|
#
|
|
610
|
-
# @param inbound_fednow_transfer_confirmation [Increase::Models::Transaction::Source::InboundFednowTransferConfirmation, nil]
|
|
729
|
+
# @param inbound_fednow_transfer_confirmation [Increase::Models::Transaction::Source::InboundFednowTransferConfirmation, nil]
|
|
730
|
+
# An Inbound FedNow Transfer Confirmation object. This field will be present in
|
|
731
|
+
# the JSON response if and only if `category` is equal to
|
|
732
|
+
# `inbound_fednow_transfer_confirmation`. An Inbound FedNow Transfer Confirmation
|
|
733
|
+
# is created when a FedNow transfer is initiated at another bank and received by
|
|
734
|
+
# Increase.
|
|
611
735
|
#
|
|
612
|
-
# @param inbound_real_time_payments_transfer_confirmation [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation, nil]
|
|
736
|
+
# @param inbound_real_time_payments_transfer_confirmation [Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation, nil]
|
|
737
|
+
# An Inbound Real-Time Payments Transfer Confirmation object. This field will be
|
|
738
|
+
# present in the JSON response if and only if `category` is equal to
|
|
739
|
+
# `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time
|
|
740
|
+
# Payments Transfer Confirmation is created when a Real-Time Payments transfer is
|
|
741
|
+
# initiated at another bank and received by Increase.
|
|
613
742
|
#
|
|
614
|
-
# @param inbound_wire_reversal [Increase::Models::Transaction::Source::InboundWireReversal, nil]
|
|
743
|
+
# @param inbound_wire_reversal [Increase::Models::Transaction::Source::InboundWireReversal, nil]
|
|
744
|
+
# An Inbound Wire Reversal object. This field will be present in the JSON response
|
|
745
|
+
# if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire
|
|
746
|
+
# Reversal represents a reversal of a wire transfer that was initiated via
|
|
747
|
+
# Increase. The other bank is sending the money back. This most often happens when
|
|
748
|
+
# the original destination account details were incorrect.
|
|
615
749
|
#
|
|
616
|
-
# @param inbound_wire_transfer [Increase::Models::Transaction::Source::InboundWireTransfer, nil]
|
|
750
|
+
# @param inbound_wire_transfer [Increase::Models::Transaction::Source::InboundWireTransfer, nil]
|
|
751
|
+
# An Inbound Wire Transfer Intention object. This field will be present in the
|
|
752
|
+
# JSON response if and only if `category` is equal to `inbound_wire_transfer`. An
|
|
753
|
+
# Inbound Wire Transfer Intention is created when a wire transfer is initiated at
|
|
754
|
+
# another bank and received by Increase.
|
|
617
755
|
#
|
|
618
|
-
# @param inbound_wire_transfer_reversal [Increase::Models::Transaction::Source::InboundWireTransferReversal, nil]
|
|
756
|
+
# @param inbound_wire_transfer_reversal [Increase::Models::Transaction::Source::InboundWireTransferReversal, nil]
|
|
757
|
+
# An Inbound Wire Transfer Reversal Intention object. This field will be present
|
|
758
|
+
# in the JSON response if and only if `category` is equal to
|
|
759
|
+
# `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is
|
|
760
|
+
# created when Increase has received a wire and the User requests that it be
|
|
761
|
+
# reversed.
|
|
619
762
|
#
|
|
620
|
-
# @param interest_payment [Increase::Models::Transaction::Source::InterestPayment, nil]
|
|
763
|
+
# @param interest_payment [Increase::Models::Transaction::Source::InterestPayment, nil]
|
|
764
|
+
# An Interest Payment object. This field will be present in the JSON response if
|
|
765
|
+
# and only if `category` is equal to `interest_payment`. An Interest Payment
|
|
766
|
+
# represents a payment of interest on an account. Interest is usually paid
|
|
767
|
+
# monthly.
|
|
621
768
|
#
|
|
622
|
-
# @param internal_source [Increase::Models::Transaction::Source::InternalSource, nil]
|
|
769
|
+
# @param internal_source [Increase::Models::Transaction::Source::InternalSource, nil]
|
|
770
|
+
# An Internal Source object. This field will be present in the JSON response if
|
|
771
|
+
# and only if `category` is equal to `internal_source`. A transaction between the
|
|
772
|
+
# user and Increase. See the `reason` attribute for more information.
|
|
623
773
|
#
|
|
624
|
-
# @param other [Increase::Models::Transaction::Source::Other, nil]
|
|
774
|
+
# @param other [Increase::Models::Transaction::Source::Other, nil]
|
|
775
|
+
# If the category of this Transaction source is equal to `other`, this field will
|
|
776
|
+
# contain an empty object, otherwise it will contain null.
|
|
625
777
|
#
|
|
626
|
-
# @param real_time_payments_transfer_acknowledgement [Increase::Models::Transaction::Source::RealTimePaymentsTransferAcknowledgement, nil]
|
|
778
|
+
# @param real_time_payments_transfer_acknowledgement [Increase::Models::Transaction::Source::RealTimePaymentsTransferAcknowledgement, nil]
|
|
779
|
+
# A Real-Time Payments Transfer Acknowledgement object. This field will be present
|
|
780
|
+
# in the JSON response if and only if `category` is equal to
|
|
781
|
+
# `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer
|
|
782
|
+
# Acknowledgement is created when a Real-Time Payments Transfer sent from Increase
|
|
783
|
+
# is acknowledged by the receiving bank.
|
|
627
784
|
#
|
|
628
|
-
# @param sample_funds [Increase::Models::Transaction::Source::SampleFunds, nil]
|
|
785
|
+
# @param sample_funds [Increase::Models::Transaction::Source::SampleFunds, nil]
|
|
786
|
+
# A Sample Funds object. This field will be present in the JSON response if and
|
|
787
|
+
# only if `category` is equal to `sample_funds`. Sample funds for testing
|
|
788
|
+
# purposes.
|
|
629
789
|
#
|
|
630
|
-
# @param swift_transfer_intention [Increase::Models::Transaction::Source::SwiftTransferIntention, nil]
|
|
790
|
+
# @param swift_transfer_intention [Increase::Models::Transaction::Source::SwiftTransferIntention, nil]
|
|
791
|
+
# A Swift Transfer Intention object. This field will be present in the JSON
|
|
792
|
+
# response if and only if `category` is equal to `swift_transfer_intention`. A
|
|
793
|
+
# Swift Transfer initiated via Increase.
|
|
631
794
|
#
|
|
632
|
-
# @param swift_transfer_return [Increase::Models::Transaction::Source::SwiftTransferReturn, nil]
|
|
795
|
+
# @param swift_transfer_return [Increase::Models::Transaction::Source::SwiftTransferReturn, nil]
|
|
796
|
+
# A Swift Transfer Return object. This field will be present in the JSON response
|
|
797
|
+
# if and only if `category` is equal to `swift_transfer_return`. A Swift Transfer
|
|
798
|
+
# Return is created when a Swift Transfer is returned by the receiving bank.
|
|
633
799
|
#
|
|
634
|
-
# @param wire_transfer_intention [Increase::Models::Transaction::Source::WireTransferIntention, nil]
|
|
800
|
+
# @param wire_transfer_intention [Increase::Models::Transaction::Source::WireTransferIntention, nil]
|
|
801
|
+
# A Wire Transfer Intention object. This field will be present in the JSON
|
|
802
|
+
# response if and only if `category` is equal to `wire_transfer_intention`. A Wire
|
|
803
|
+
# Transfer initiated via Increase and sent to a different bank.
|
|
635
804
|
|
|
636
805
|
# The type of the resource. We may add additional possible values for this enum
|
|
637
806
|
# over time; your application should be able to handle such additions gracefully.
|
|
@@ -832,22 +1001,23 @@ module Increase
|
|
|
832
1001
|
required :transfer_id, String
|
|
833
1002
|
|
|
834
1003
|
# @!method initialize(amount:, currency:, description:, destination_account_id:, source_account_id:, transfer_id:)
|
|
835
|
-
# Some parameter documentations has been truncated, see
|
|
836
|
-
# {Increase::Models::Transaction::Source::AccountTransferIntention} for more
|
|
837
|
-
# details.
|
|
838
|
-
#
|
|
839
1004
|
# An Account Transfer Intention object. This field will be present in the JSON
|
|
840
1005
|
# response if and only if `category` is equal to `account_transfer_intention`. Two
|
|
841
1006
|
# Account Transfer Intentions are created from each Account Transfer. One
|
|
842
1007
|
# decrements the source account, and the other increments the destination account.
|
|
843
1008
|
#
|
|
844
|
-
# @param amount [Integer]
|
|
1009
|
+
# @param amount [Integer]
|
|
1010
|
+
# The pending amount in the minor unit of the transaction's currency. For dollars,
|
|
1011
|
+
# for example, this is cents.
|
|
845
1012
|
#
|
|
846
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::AccountTransferIntention::Currency]
|
|
1013
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::AccountTransferIntention::Currency]
|
|
1014
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
|
|
1015
|
+
# account currency.
|
|
847
1016
|
#
|
|
848
1017
|
# @param description [String] The description you chose to give the transfer.
|
|
849
1018
|
#
|
|
850
|
-
# @param destination_account_id [String]
|
|
1019
|
+
# @param destination_account_id [String]
|
|
1020
|
+
# The identifier of the Account to where the Account Transfer was sent.
|
|
851
1021
|
#
|
|
852
1022
|
# @param source_account_id [String] The identifier of the Account from where the Account Transfer was sent.
|
|
853
1023
|
#
|
|
@@ -903,9 +1073,6 @@ module Increase
|
|
|
903
1073
|
required :transfer_id, String
|
|
904
1074
|
|
|
905
1075
|
# @!method initialize(account_number:, amount:, routing_number:, statement_descriptor:, transfer_id:)
|
|
906
|
-
# Some parameter documentations has been truncated, see
|
|
907
|
-
# {Increase::Models::Transaction::Source::ACHTransferIntention} for more details.
|
|
908
|
-
#
|
|
909
1076
|
# An ACH Transfer Intention object. This field will be present in the JSON
|
|
910
1077
|
# response if and only if `category` is equal to `ach_transfer_intention`. An ACH
|
|
911
1078
|
# Transfer Intention is created from an ACH Transfer. It reflects the intention to
|
|
@@ -913,9 +1080,13 @@ module Increase
|
|
|
913
1080
|
#
|
|
914
1081
|
# @param account_number [String] The account number for the destination account.
|
|
915
1082
|
#
|
|
916
|
-
# @param amount [Integer]
|
|
1083
|
+
# @param amount [Integer]
|
|
1084
|
+
# The amount in the minor unit of the transaction's currency. For dollars, for
|
|
1085
|
+
# example, this is cents.
|
|
917
1086
|
#
|
|
918
|
-
# @param routing_number [String]
|
|
1087
|
+
# @param routing_number [String]
|
|
1088
|
+
# The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
|
|
1089
|
+
# destination account.
|
|
919
1090
|
#
|
|
920
1091
|
# @param statement_descriptor [String] A description set when the ACH Transfer was created.
|
|
921
1092
|
#
|
|
@@ -941,6 +1112,17 @@ module Increase
|
|
|
941
1112
|
|
|
942
1113
|
# @see Increase::Models::Transaction::Source#ach_transfer_return
|
|
943
1114
|
class ACHTransferReturn < Increase::Internal::Type::BaseModel
|
|
1115
|
+
# @!attribute addenda_information
|
|
1116
|
+
# Additional free-form information included by the receiving bank in the return's
|
|
1117
|
+
# addenda record. This is raw, uninterpreted text whose presence and format are
|
|
1118
|
+
# not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving
|
|
1119
|
+
# bank may set this to `QUESTIONABLE` (optionally followed by more text) to
|
|
1120
|
+
# indicate it believes the transfer was initiated under questionable
|
|
1121
|
+
# circumstances.
|
|
1122
|
+
#
|
|
1123
|
+
# @return [String, nil]
|
|
1124
|
+
required :addenda_information, String, nil?: true
|
|
1125
|
+
|
|
944
1126
|
# @!attribute created_at
|
|
945
1127
|
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
946
1128
|
# the transfer was created.
|
|
@@ -984,10 +1166,7 @@ module Increase
|
|
|
984
1166
|
# @return [String]
|
|
985
1167
|
required :transfer_id, String
|
|
986
1168
|
|
|
987
|
-
# @!method initialize(created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:)
|
|
988
|
-
# Some parameter documentations has been truncated, see
|
|
989
|
-
# {Increase::Models::Transaction::Source::ACHTransferReturn} for more details.
|
|
990
|
-
#
|
|
1169
|
+
# @!method initialize(addenda_information:, created_at:, raw_return_reason_code:, return_reason_code:, trace_number:, transaction_id:, transfer_id:)
|
|
991
1170
|
# An ACH Transfer Return object. This field will be present in the JSON response
|
|
992
1171
|
# if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer
|
|
993
1172
|
# Return is created when an ACH Transfer is returned by the receiving bank. It
|
|
@@ -996,17 +1175,35 @@ module Increase
|
|
|
996
1175
|
# later. The return appears as a new posted Transaction; no Pending Transaction is
|
|
997
1176
|
# created.
|
|
998
1177
|
#
|
|
999
|
-
# @param
|
|
1178
|
+
# @param addenda_information [String, nil]
|
|
1179
|
+
# Additional free-form information included by the receiving bank in the return's
|
|
1180
|
+
# addenda record. This is raw, uninterpreted text whose presence and format are
|
|
1181
|
+
# not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving
|
|
1182
|
+
# bank may set this to `QUESTIONABLE` (optionally followed by more text) to
|
|
1183
|
+
# indicate it believes the transfer was initiated under questionable
|
|
1184
|
+
# circumstances.
|
|
1185
|
+
#
|
|
1186
|
+
# @param created_at [Time]
|
|
1187
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
1188
|
+
# the transfer was created.
|
|
1000
1189
|
#
|
|
1001
1190
|
# @param raw_return_reason_code [String] The three character ACH return code, in the range R01 to R85.
|
|
1002
1191
|
#
|
|
1003
|
-
# @param return_reason_code [Symbol, Increase::Models::Transaction::Source::ACHTransferReturn::ReturnReasonCode]
|
|
1192
|
+
# @param return_reason_code [Symbol, Increase::Models::Transaction::Source::ACHTransferReturn::ReturnReasonCode]
|
|
1193
|
+
# Why the ACH Transfer was returned. This reason code is sent by the receiving
|
|
1194
|
+
# bank back to Increase.
|
|
1004
1195
|
#
|
|
1005
|
-
# @param trace_number [String]
|
|
1196
|
+
# @param trace_number [String]
|
|
1197
|
+
# A 15 digit number that was generated by the bank that initiated the return. The
|
|
1198
|
+
# trace number of the return is different than that of the original transfer. ACH
|
|
1199
|
+
# trace numbers are not unique, but along with the amount and date this number can
|
|
1200
|
+
# be used to identify the ACH return at the bank that initiated it.
|
|
1006
1201
|
#
|
|
1007
1202
|
# @param transaction_id [String] The identifier of the Transaction associated with this return.
|
|
1008
1203
|
#
|
|
1009
|
-
# @param transfer_id [String]
|
|
1204
|
+
# @param transfer_id [String]
|
|
1205
|
+
# The identifier of the ACH Transfer associated with this return. This matches the
|
|
1206
|
+
# original Transaction's `source.ach_transfer_intention.transfer_id`.
|
|
1010
1207
|
|
|
1011
1208
|
# Why the ACH Transfer was returned. This reason code is sent by the receiving
|
|
1012
1209
|
# bank back to Increase.
|
|
@@ -1065,7 +1262,7 @@ module Increase
|
|
|
1065
1262
|
# Code R13. The routing number is invalid.
|
|
1066
1263
|
INVALID_ACH_ROUTING_NUMBER = :invalid_ach_routing_number
|
|
1067
1264
|
|
|
1068
|
-
# Code R17. The receiving bank
|
|
1265
|
+
# Code R17. This return code has multiple meanings. The receiving bank was either unable to process a field in the transfer, or believes the transfer was initiated under questionable circumstances (such as fraud), or identified an improperly-initiated reversing entry.
|
|
1069
1266
|
FILE_RECORD_EDIT_CRITERIA = :file_record_edit_criteria
|
|
1070
1267
|
|
|
1071
1268
|
# Code R45. A rare return reason. The individual name field was invalid.
|
|
@@ -1248,17 +1445,15 @@ module Increase
|
|
|
1248
1445
|
required :transfer_id, String
|
|
1249
1446
|
|
|
1250
1447
|
# @!method initialize(source_blockchain_address_id:, transfer_id:)
|
|
1251
|
-
# Some parameter documentations has been truncated, see
|
|
1252
|
-
# {Increase::Models::Transaction::Source::BlockchainOfframpTransferSettlement} for
|
|
1253
|
-
# more details.
|
|
1254
|
-
#
|
|
1255
1448
|
# A Blockchain Off-Ramp Transfer Settlement object. This field will be present in
|
|
1256
1449
|
# the JSON response if and only if `category` is equal to
|
|
1257
1450
|
# `blockchain_offramp_transfer_settlement`.
|
|
1258
1451
|
#
|
|
1259
|
-
# @param source_blockchain_address_id [String]
|
|
1452
|
+
# @param source_blockchain_address_id [String]
|
|
1453
|
+
# The identifier of the Blockchain Address the funds were received at.
|
|
1260
1454
|
#
|
|
1261
|
-
# @param transfer_id [String]
|
|
1455
|
+
# @param transfer_id [String]
|
|
1456
|
+
# The identifier of the Blockchain Off-Ramp Transfer that led to this Transaction.
|
|
1262
1457
|
end
|
|
1263
1458
|
|
|
1264
1459
|
# @see Increase::Models::Transaction::Source#blockchain_onramp_transfer_intention
|
|
@@ -1282,7 +1477,8 @@ module Increase
|
|
|
1282
1477
|
#
|
|
1283
1478
|
# @param destination_blockchain_address [String] The blockchain address the funds were sent to.
|
|
1284
1479
|
#
|
|
1285
|
-
# @param transfer_id [String]
|
|
1480
|
+
# @param transfer_id [String]
|
|
1481
|
+
# The identifier of the Blockchain On-Ramp Transfer that led to this Transaction.
|
|
1286
1482
|
end
|
|
1287
1483
|
|
|
1288
1484
|
# @see Increase::Models::Transaction::Source#card_dispute_acceptance
|
|
@@ -1302,16 +1498,17 @@ module Increase
|
|
|
1302
1498
|
required :transaction_id, String
|
|
1303
1499
|
|
|
1304
1500
|
# @!method initialize(accepted_at:, transaction_id:)
|
|
1305
|
-
# Some parameter documentations has been truncated, see
|
|
1306
|
-
# {Increase::Models::Transaction::Source::CardDisputeAcceptance} for more details.
|
|
1307
|
-
#
|
|
1308
1501
|
# A Legacy Card Dispute Acceptance object. This field will be present in the JSON
|
|
1309
1502
|
# response if and only if `category` is equal to `card_dispute_acceptance`.
|
|
1310
1503
|
# Contains the details of a successful Card Dispute.
|
|
1311
1504
|
#
|
|
1312
|
-
# @param accepted_at [Time]
|
|
1505
|
+
# @param accepted_at [Time]
|
|
1506
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
1507
|
+
# the Card Dispute was accepted.
|
|
1313
1508
|
#
|
|
1314
|
-
# @param transaction_id [String]
|
|
1509
|
+
# @param transaction_id [String]
|
|
1510
|
+
# The identifier of the Transaction that was created to return the disputed funds
|
|
1511
|
+
# to your account.
|
|
1315
1512
|
end
|
|
1316
1513
|
|
|
1317
1514
|
# @see Increase::Models::Transaction::Source#card_dispute_financial
|
|
@@ -1344,20 +1541,23 @@ module Increase
|
|
|
1344
1541
|
required :visa, -> { Increase::Transaction::Source::CardDisputeFinancial::Visa }, nil?: true
|
|
1345
1542
|
|
|
1346
1543
|
# @!method initialize(amount:, network:, transaction_id:, visa:)
|
|
1347
|
-
# Some parameter documentations has been truncated, see
|
|
1348
|
-
# {Increase::Models::Transaction::Source::CardDisputeFinancial} for more details.
|
|
1349
|
-
#
|
|
1350
1544
|
# A Card Dispute Financial object. This field will be present in the JSON response
|
|
1351
1545
|
# if and only if `category` is equal to `card_dispute_financial`. Financial event
|
|
1352
1546
|
# related to a Card Dispute.
|
|
1353
1547
|
#
|
|
1354
1548
|
# @param amount [Integer] The amount of the financial event.
|
|
1355
1549
|
#
|
|
1356
|
-
# @param network [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Network]
|
|
1550
|
+
# @param network [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Network]
|
|
1551
|
+
# The network that the Card Dispute is associated with.
|
|
1357
1552
|
#
|
|
1358
|
-
# @param transaction_id [String]
|
|
1553
|
+
# @param transaction_id [String]
|
|
1554
|
+
# The identifier of the Transaction that was created to credit or debit the
|
|
1555
|
+
# disputed funds to or from your account.
|
|
1359
1556
|
#
|
|
1360
|
-
# @param visa [Increase::Models::Transaction::Source::CardDisputeFinancial::Visa, nil]
|
|
1557
|
+
# @param visa [Increase::Models::Transaction::Source::CardDisputeFinancial::Visa, nil]
|
|
1558
|
+
# Information for events related to card dispute for card payments processed over
|
|
1559
|
+
# Visa's network. This field will be present in the JSON response if and only if
|
|
1560
|
+
# `network` is equal to `visa`.
|
|
1361
1561
|
|
|
1362
1562
|
# The network that the Card Dispute is associated with.
|
|
1363
1563
|
#
|
|
@@ -1388,7 +1588,8 @@ module Increase
|
|
|
1388
1588
|
# Visa's network. This field will be present in the JSON response if and only if
|
|
1389
1589
|
# `network` is equal to `visa`.
|
|
1390
1590
|
#
|
|
1391
|
-
# @param event_type [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Visa::EventType]
|
|
1591
|
+
# @param event_type [Symbol, Increase::Models::Transaction::Source::CardDisputeFinancial::Visa::EventType]
|
|
1592
|
+
# The type of card dispute financial event.
|
|
1392
1593
|
|
|
1393
1594
|
# The type of card dispute financial event.
|
|
1394
1595
|
#
|
|
@@ -1446,18 +1647,19 @@ module Increase
|
|
|
1446
1647
|
required :transaction_id, String
|
|
1447
1648
|
|
|
1448
1649
|
# @!method initialize(explanation:, lost_at:, transaction_id:)
|
|
1449
|
-
# Some parameter documentations has been truncated, see
|
|
1450
|
-
# {Increase::Models::Transaction::Source::CardDisputeLoss} for more details.
|
|
1451
|
-
#
|
|
1452
1650
|
# A Legacy Card Dispute Loss object. This field will be present in the JSON
|
|
1453
1651
|
# response if and only if `category` is equal to `card_dispute_loss`. Contains the
|
|
1454
1652
|
# details of a lost Card Dispute.
|
|
1455
1653
|
#
|
|
1456
1654
|
# @param explanation [String] Why the Card Dispute was lost.
|
|
1457
1655
|
#
|
|
1458
|
-
# @param lost_at [Time]
|
|
1656
|
+
# @param lost_at [Time]
|
|
1657
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
1658
|
+
# the Card Dispute was lost.
|
|
1459
1659
|
#
|
|
1460
|
-
# @param transaction_id [String]
|
|
1660
|
+
# @param transaction_id [String]
|
|
1661
|
+
# The identifier of the Transaction that was created to debit the disputed funds
|
|
1662
|
+
# from your account.
|
|
1461
1663
|
end
|
|
1462
1664
|
|
|
1463
1665
|
# @see Increase::Models::Transaction::Source#card_financial
|
|
@@ -1651,9 +1853,6 @@ module Increase
|
|
|
1651
1853
|
required :verification, -> { Increase::Transaction::Source::CardFinancial::Verification }
|
|
1652
1854
|
|
|
1653
1855
|
# @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, scheme_fees:, terminal_id:, transaction_id:, type:, verification:)
|
|
1654
|
-
# Some parameter documentations has been truncated, see
|
|
1655
|
-
# {Increase::Models::Transaction::Source::CardFinancial} for more details.
|
|
1656
|
-
#
|
|
1657
1856
|
# A Card Financial object. This field will be present in the JSON response if and
|
|
1658
1857
|
# only if `category` is equal to `card_financial`. Card Financials are card
|
|
1659
1858
|
# transactions that have cleared and settled. Unlike a Card Settlement, which
|
|
@@ -1662,23 +1861,40 @@ module Increase
|
|
|
1662
1861
|
#
|
|
1663
1862
|
# @param id [String] The Card Financial identifier.
|
|
1664
1863
|
#
|
|
1665
|
-
# @param actioner [Symbol, Increase::Models::Transaction::Source::CardFinancial::Actioner]
|
|
1864
|
+
# @param actioner [Symbol, Increase::Models::Transaction::Source::CardFinancial::Actioner]
|
|
1865
|
+
# Whether this financial was approved by Increase, the card network through
|
|
1866
|
+
# stand-in processing, or the user through a real-time decision.
|
|
1666
1867
|
#
|
|
1667
|
-
# @param additional_amounts [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts]
|
|
1868
|
+
# @param additional_amounts [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts]
|
|
1869
|
+
# Additional amounts associated with the card authorization, such as ATM
|
|
1870
|
+
# surcharges fees. These are usually a subset of the `amount` field and are used
|
|
1871
|
+
# to provide more detailed information about the transaction.
|
|
1668
1872
|
#
|
|
1669
|
-
# @param amount [Integer]
|
|
1873
|
+
# @param amount [Integer]
|
|
1874
|
+
# The pending amount in the minor unit of the transaction's currency. For dollars,
|
|
1875
|
+
# for example, this is cents.
|
|
1670
1876
|
#
|
|
1671
1877
|
# @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
|
|
1672
1878
|
#
|
|
1673
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CardFinancial::Currency]
|
|
1879
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CardFinancial::Currency]
|
|
1880
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
1881
|
+
# transaction's currency.
|
|
1674
1882
|
#
|
|
1675
|
-
# @param digital_wallet_token_id [String, nil]
|
|
1883
|
+
# @param digital_wallet_token_id [String, nil]
|
|
1884
|
+
# If the authorization was made via a Digital Wallet Token (such as an Apple Pay
|
|
1885
|
+
# purchase), the identifier of the token that was used.
|
|
1676
1886
|
#
|
|
1677
|
-
# @param direction [Symbol, Increase::Models::Transaction::Source::CardFinancial::Direction]
|
|
1887
|
+
# @param direction [Symbol, Increase::Models::Transaction::Source::CardFinancial::Direction]
|
|
1888
|
+
# The direction describes the direction the funds will move, either from the
|
|
1889
|
+
# cardholder to the merchant or from the merchant to the cardholder.
|
|
1678
1890
|
#
|
|
1679
|
-
# @param merchant_acceptor_id [String]
|
|
1891
|
+
# @param merchant_acceptor_id [String]
|
|
1892
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
1893
|
+
# is transacting with.
|
|
1680
1894
|
#
|
|
1681
|
-
# @param merchant_category_code [String]
|
|
1895
|
+
# @param merchant_category_code [String]
|
|
1896
|
+
# The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
1897
|
+
# card is transacting with.
|
|
1682
1898
|
#
|
|
1683
1899
|
# @param merchant_city [String, nil] The city the merchant resides in.
|
|
1684
1900
|
#
|
|
@@ -1686,35 +1902,57 @@ module Increase
|
|
|
1686
1902
|
#
|
|
1687
1903
|
# @param merchant_descriptor [String] The merchant descriptor of the merchant the card is transacting with.
|
|
1688
1904
|
#
|
|
1689
|
-
# @param merchant_postal_code [String, nil]
|
|
1905
|
+
# @param merchant_postal_code [String, nil]
|
|
1906
|
+
# The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
|
|
1907
|
+
# ZIP code, where the first 5 and last 4 are separated by a dash.
|
|
1690
1908
|
#
|
|
1691
1909
|
# @param merchant_state [String, nil] The state the merchant resides in.
|
|
1692
1910
|
#
|
|
1693
|
-
# @param network_details [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails]
|
|
1911
|
+
# @param network_details [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails]
|
|
1912
|
+
# Fields specific to the `network`.
|
|
1694
1913
|
#
|
|
1695
|
-
# @param network_identifiers [Increase::Models::Transaction::Source::CardFinancial::NetworkIdentifiers]
|
|
1914
|
+
# @param network_identifiers [Increase::Models::Transaction::Source::CardFinancial::NetworkIdentifiers]
|
|
1915
|
+
# Network-specific identifiers for a specific request or transaction.
|
|
1696
1916
|
#
|
|
1697
|
-
# @param network_risk_score [Integer, nil]
|
|
1917
|
+
# @param network_risk_score [Integer, nil]
|
|
1918
|
+
# The risk score generated by the card network. For Visa this is the Visa Advanced
|
|
1919
|
+
# Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
|
|
1920
|
+
# score is from 0 to 999, where 999 is the riskiest.
|
|
1698
1921
|
#
|
|
1699
|
-
# @param physical_card_id [String, nil]
|
|
1922
|
+
# @param physical_card_id [String, nil]
|
|
1923
|
+
# If the authorization was made in-person with a physical card, the Physical Card
|
|
1924
|
+
# that was used.
|
|
1700
1925
|
#
|
|
1701
|
-
# @param presentment_amount [Integer]
|
|
1926
|
+
# @param presentment_amount [Integer]
|
|
1927
|
+
# The pending amount in the minor unit of the transaction's presentment currency.
|
|
1702
1928
|
#
|
|
1703
|
-
# @param presentment_currency [String]
|
|
1929
|
+
# @param presentment_currency [String]
|
|
1930
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
1931
|
+
# transaction's presentment currency.
|
|
1704
1932
|
#
|
|
1705
|
-
# @param processing_category [Symbol, Increase::Models::Transaction::Source::CardFinancial::ProcessingCategory]
|
|
1933
|
+
# @param processing_category [Symbol, Increase::Models::Transaction::Source::CardFinancial::ProcessingCategory]
|
|
1934
|
+
# The processing category describes the intent behind the financial, such as
|
|
1935
|
+
# whether it was used for bill payments or an automatic fuel dispenser.
|
|
1706
1936
|
#
|
|
1707
|
-
# @param real_time_decision_id [String, nil]
|
|
1937
|
+
# @param real_time_decision_id [String, nil]
|
|
1938
|
+
# The identifier of the Real-Time Decision sent to approve or decline this
|
|
1939
|
+
# transaction.
|
|
1708
1940
|
#
|
|
1709
|
-
# @param scheme_fees [Array<Increase::Models::Transaction::Source::CardFinancial::SchemeFee>]
|
|
1941
|
+
# @param scheme_fees [Array<Increase::Models::Transaction::Source::CardFinancial::SchemeFee>]
|
|
1942
|
+
# The scheme fees associated with this card financial.
|
|
1710
1943
|
#
|
|
1711
|
-
# @param terminal_id [String, nil]
|
|
1944
|
+
# @param terminal_id [String, nil]
|
|
1945
|
+
# The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
|
1946
|
+
# is transacting with.
|
|
1712
1947
|
#
|
|
1713
1948
|
# @param transaction_id [String] The identifier of the Transaction associated with this Transaction.
|
|
1714
1949
|
#
|
|
1715
|
-
# @param type [Symbol, Increase::Models::Transaction::Source::CardFinancial::Type]
|
|
1950
|
+
# @param type [Symbol, Increase::Models::Transaction::Source::CardFinancial::Type]
|
|
1951
|
+
# A constant representing the object's type. For this resource it will always be
|
|
1952
|
+
# `card_financial`.
|
|
1716
1953
|
#
|
|
1717
|
-
# @param verification [Increase::Models::Transaction::Source::CardFinancial::Verification]
|
|
1954
|
+
# @param verification [Increase::Models::Transaction::Source::CardFinancial::Verification]
|
|
1955
|
+
# Fields related to verification of cardholder-provided values.
|
|
1718
1956
|
|
|
1719
1957
|
# Whether this financial was approved by Increase, the card network through
|
|
1720
1958
|
# stand-in processing, or the user through a real-time decision.
|
|
@@ -1819,33 +2057,39 @@ module Increase
|
|
|
1819
2057
|
nil?: true
|
|
1820
2058
|
|
|
1821
2059
|
# @!method initialize(clinic:, dental:, original:, prescription:, surcharge:, total_cumulative:, total_healthcare:, transit:, unknown:, vision:)
|
|
1822
|
-
# Some parameter documentations has been truncated, see
|
|
1823
|
-
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts} for
|
|
1824
|
-
# more details.
|
|
1825
|
-
#
|
|
1826
2060
|
# Additional amounts associated with the card authorization, such as ATM
|
|
1827
2061
|
# surcharges fees. These are usually a subset of the `amount` field and are used
|
|
1828
2062
|
# to provide more detailed information about the transaction.
|
|
1829
2063
|
#
|
|
1830
|
-
# @param clinic [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic, nil]
|
|
2064
|
+
# @param clinic [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic, nil]
|
|
2065
|
+
# The part of this transaction amount that was for clinic-related services.
|
|
1831
2066
|
#
|
|
1832
|
-
# @param dental [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Dental, nil]
|
|
2067
|
+
# @param dental [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Dental, nil]
|
|
2068
|
+
# The part of this transaction amount that was for dental-related services.
|
|
1833
2069
|
#
|
|
1834
|
-
# @param original [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Original, nil]
|
|
2070
|
+
# @param original [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Original, nil]
|
|
2071
|
+
# The original pre-authorized amount.
|
|
1835
2072
|
#
|
|
1836
|
-
# @param prescription [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription, nil]
|
|
2073
|
+
# @param prescription [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription, nil]
|
|
2074
|
+
# The part of this transaction amount that was for healthcare prescriptions.
|
|
1837
2075
|
#
|
|
1838
|
-
# @param surcharge [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge, nil]
|
|
2076
|
+
# @param surcharge [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge, nil]
|
|
2077
|
+
# The surcharge amount charged for this transaction by the merchant.
|
|
1839
2078
|
#
|
|
1840
|
-
# @param total_cumulative [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative, nil]
|
|
2079
|
+
# @param total_cumulative [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative, nil]
|
|
2080
|
+
# The total amount of a series of incremental authorizations, optionally provided.
|
|
1841
2081
|
#
|
|
1842
|
-
# @param total_healthcare [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare, nil]
|
|
2082
|
+
# @param total_healthcare [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare, nil]
|
|
2083
|
+
# The total amount of healthcare-related additional amounts.
|
|
1843
2084
|
#
|
|
1844
|
-
# @param transit [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Transit, nil]
|
|
2085
|
+
# @param transit [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Transit, nil]
|
|
2086
|
+
# The part of this transaction amount that was for transit-related services.
|
|
1845
2087
|
#
|
|
1846
|
-
# @param unknown [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown, nil]
|
|
2088
|
+
# @param unknown [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown, nil]
|
|
2089
|
+
# An unknown additional amount.
|
|
1847
2090
|
#
|
|
1848
|
-
# @param vision [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Vision, nil]
|
|
2091
|
+
# @param vision [Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Vision, nil]
|
|
2092
|
+
# The part of this transaction amount that was for vision-related services.
|
|
1849
2093
|
|
|
1850
2094
|
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#clinic
|
|
1851
2095
|
class Clinic < Increase::Internal::Type::BaseModel
|
|
@@ -1865,15 +2109,16 @@ module Increase
|
|
|
1865
2109
|
required :currency, String
|
|
1866
2110
|
|
|
1867
2111
|
# @!method initialize(amount:, currency:)
|
|
1868
|
-
# Some parameter documentations has been truncated, see
|
|
1869
|
-
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Clinic}
|
|
1870
|
-
# for more details.
|
|
1871
|
-
#
|
|
1872
2112
|
# The part of this transaction amount that was for clinic-related services.
|
|
1873
2113
|
#
|
|
1874
|
-
# @param amount [Integer]
|
|
2114
|
+
# @param amount [Integer]
|
|
2115
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
2116
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2117
|
+
# subtracted from the amount (such as a discount).
|
|
1875
2118
|
#
|
|
1876
|
-
# @param currency [String]
|
|
2119
|
+
# @param currency [String]
|
|
2120
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2121
|
+
# amount's currency.
|
|
1877
2122
|
end
|
|
1878
2123
|
|
|
1879
2124
|
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#dental
|
|
@@ -1894,15 +2139,16 @@ module Increase
|
|
|
1894
2139
|
required :currency, String
|
|
1895
2140
|
|
|
1896
2141
|
# @!method initialize(amount:, currency:)
|
|
1897
|
-
# Some parameter documentations has been truncated, see
|
|
1898
|
-
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Dental}
|
|
1899
|
-
# for more details.
|
|
1900
|
-
#
|
|
1901
2142
|
# The part of this transaction amount that was for dental-related services.
|
|
1902
2143
|
#
|
|
1903
|
-
# @param amount [Integer]
|
|
2144
|
+
# @param amount [Integer]
|
|
2145
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
2146
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2147
|
+
# subtracted from the amount (such as a discount).
|
|
1904
2148
|
#
|
|
1905
|
-
# @param currency [String]
|
|
2149
|
+
# @param currency [String]
|
|
2150
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2151
|
+
# amount's currency.
|
|
1906
2152
|
end
|
|
1907
2153
|
|
|
1908
2154
|
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#original
|
|
@@ -1923,15 +2169,16 @@ module Increase
|
|
|
1923
2169
|
required :currency, String
|
|
1924
2170
|
|
|
1925
2171
|
# @!method initialize(amount:, currency:)
|
|
1926
|
-
# Some parameter documentations has been truncated, see
|
|
1927
|
-
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Original}
|
|
1928
|
-
# for more details.
|
|
1929
|
-
#
|
|
1930
2172
|
# The original pre-authorized amount.
|
|
1931
2173
|
#
|
|
1932
|
-
# @param amount [Integer]
|
|
2174
|
+
# @param amount [Integer]
|
|
2175
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
2176
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2177
|
+
# subtracted from the amount (such as a discount).
|
|
1933
2178
|
#
|
|
1934
|
-
# @param currency [String]
|
|
2179
|
+
# @param currency [String]
|
|
2180
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2181
|
+
# amount's currency.
|
|
1935
2182
|
end
|
|
1936
2183
|
|
|
1937
2184
|
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#prescription
|
|
@@ -1952,15 +2199,16 @@ module Increase
|
|
|
1952
2199
|
required :currency, String
|
|
1953
2200
|
|
|
1954
2201
|
# @!method initialize(amount:, currency:)
|
|
1955
|
-
# Some parameter documentations has been truncated, see
|
|
1956
|
-
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Prescription}
|
|
1957
|
-
# for more details.
|
|
1958
|
-
#
|
|
1959
2202
|
# The part of this transaction amount that was for healthcare prescriptions.
|
|
1960
2203
|
#
|
|
1961
|
-
# @param amount [Integer]
|
|
2204
|
+
# @param amount [Integer]
|
|
2205
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
2206
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2207
|
+
# subtracted from the amount (such as a discount).
|
|
1962
2208
|
#
|
|
1963
|
-
# @param currency [String]
|
|
2209
|
+
# @param currency [String]
|
|
2210
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2211
|
+
# amount's currency.
|
|
1964
2212
|
end
|
|
1965
2213
|
|
|
1966
2214
|
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#surcharge
|
|
@@ -1981,15 +2229,16 @@ module Increase
|
|
|
1981
2229
|
required :currency, String
|
|
1982
2230
|
|
|
1983
2231
|
# @!method initialize(amount:, currency:)
|
|
1984
|
-
# Some parameter documentations has been truncated, see
|
|
1985
|
-
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Surcharge}
|
|
1986
|
-
# for more details.
|
|
1987
|
-
#
|
|
1988
2232
|
# The surcharge amount charged for this transaction by the merchant.
|
|
1989
2233
|
#
|
|
1990
|
-
# @param amount [Integer]
|
|
2234
|
+
# @param amount [Integer]
|
|
2235
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
2236
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2237
|
+
# subtracted from the amount (such as a discount).
|
|
1991
2238
|
#
|
|
1992
|
-
# @param currency [String]
|
|
2239
|
+
# @param currency [String]
|
|
2240
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2241
|
+
# amount's currency.
|
|
1993
2242
|
end
|
|
1994
2243
|
|
|
1995
2244
|
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#total_cumulative
|
|
@@ -2010,15 +2259,16 @@ module Increase
|
|
|
2010
2259
|
required :currency, String
|
|
2011
2260
|
|
|
2012
2261
|
# @!method initialize(amount:, currency:)
|
|
2013
|
-
# Some parameter documentations has been truncated, see
|
|
2014
|
-
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalCumulative}
|
|
2015
|
-
# for more details.
|
|
2016
|
-
#
|
|
2017
2262
|
# The total amount of a series of incremental authorizations, optionally provided.
|
|
2018
2263
|
#
|
|
2019
|
-
# @param amount [Integer]
|
|
2264
|
+
# @param amount [Integer]
|
|
2265
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
2266
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2267
|
+
# subtracted from the amount (such as a discount).
|
|
2020
2268
|
#
|
|
2021
|
-
# @param currency [String]
|
|
2269
|
+
# @param currency [String]
|
|
2270
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2271
|
+
# amount's currency.
|
|
2022
2272
|
end
|
|
2023
2273
|
|
|
2024
2274
|
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#total_healthcare
|
|
@@ -2039,15 +2289,16 @@ module Increase
|
|
|
2039
2289
|
required :currency, String
|
|
2040
2290
|
|
|
2041
2291
|
# @!method initialize(amount:, currency:)
|
|
2042
|
-
# Some parameter documentations has been truncated, see
|
|
2043
|
-
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::TotalHealthcare}
|
|
2044
|
-
# for more details.
|
|
2045
|
-
#
|
|
2046
2292
|
# The total amount of healthcare-related additional amounts.
|
|
2047
2293
|
#
|
|
2048
|
-
# @param amount [Integer]
|
|
2294
|
+
# @param amount [Integer]
|
|
2295
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
2296
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2297
|
+
# subtracted from the amount (such as a discount).
|
|
2049
2298
|
#
|
|
2050
|
-
# @param currency [String]
|
|
2299
|
+
# @param currency [String]
|
|
2300
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2301
|
+
# amount's currency.
|
|
2051
2302
|
end
|
|
2052
2303
|
|
|
2053
2304
|
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#transit
|
|
@@ -2068,15 +2319,16 @@ module Increase
|
|
|
2068
2319
|
required :currency, String
|
|
2069
2320
|
|
|
2070
2321
|
# @!method initialize(amount:, currency:)
|
|
2071
|
-
# Some parameter documentations has been truncated, see
|
|
2072
|
-
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Transit}
|
|
2073
|
-
# for more details.
|
|
2074
|
-
#
|
|
2075
2322
|
# The part of this transaction amount that was for transit-related services.
|
|
2076
2323
|
#
|
|
2077
|
-
# @param amount [Integer]
|
|
2324
|
+
# @param amount [Integer]
|
|
2325
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
2326
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2327
|
+
# subtracted from the amount (such as a discount).
|
|
2078
2328
|
#
|
|
2079
|
-
# @param currency [String]
|
|
2329
|
+
# @param currency [String]
|
|
2330
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2331
|
+
# amount's currency.
|
|
2080
2332
|
end
|
|
2081
2333
|
|
|
2082
2334
|
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#unknown
|
|
@@ -2097,15 +2349,16 @@ module Increase
|
|
|
2097
2349
|
required :currency, String
|
|
2098
2350
|
|
|
2099
2351
|
# @!method initialize(amount:, currency:)
|
|
2100
|
-
# Some parameter documentations has been truncated, see
|
|
2101
|
-
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Unknown}
|
|
2102
|
-
# for more details.
|
|
2103
|
-
#
|
|
2104
2352
|
# An unknown additional amount.
|
|
2105
2353
|
#
|
|
2106
|
-
# @param amount [Integer]
|
|
2354
|
+
# @param amount [Integer]
|
|
2355
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
2356
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2357
|
+
# subtracted from the amount (such as a discount).
|
|
2107
2358
|
#
|
|
2108
|
-
# @param currency [String]
|
|
2359
|
+
# @param currency [String]
|
|
2360
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2361
|
+
# amount's currency.
|
|
2109
2362
|
end
|
|
2110
2363
|
|
|
2111
2364
|
# @see Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts#vision
|
|
@@ -2126,15 +2379,16 @@ module Increase
|
|
|
2126
2379
|
required :currency, String
|
|
2127
2380
|
|
|
2128
2381
|
# @!method initialize(amount:, currency:)
|
|
2129
|
-
# Some parameter documentations has been truncated, see
|
|
2130
|
-
# {Increase::Models::Transaction::Source::CardFinancial::AdditionalAmounts::Vision}
|
|
2131
|
-
# for more details.
|
|
2132
|
-
#
|
|
2133
2382
|
# The part of this transaction amount that was for vision-related services.
|
|
2134
2383
|
#
|
|
2135
|
-
# @param amount [Integer]
|
|
2384
|
+
# @param amount [Integer]
|
|
2385
|
+
# The amount in minor units of the `currency` field. The amount is positive if it
|
|
2386
|
+
# is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2387
|
+
# subtracted from the amount (such as a discount).
|
|
2136
2388
|
#
|
|
2137
|
-
# @param currency [String]
|
|
2389
|
+
# @param currency [String]
|
|
2390
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2391
|
+
# amount's currency.
|
|
2138
2392
|
end
|
|
2139
2393
|
end
|
|
2140
2394
|
|
|
@@ -2200,11 +2454,14 @@ module Increase
|
|
|
2200
2454
|
# @!method initialize(category:, pulse:, visa:)
|
|
2201
2455
|
# Fields specific to the `network`.
|
|
2202
2456
|
#
|
|
2203
|
-
# @param category [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Category]
|
|
2457
|
+
# @param category [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Category]
|
|
2458
|
+
# The payment network used to process this card authorization.
|
|
2204
2459
|
#
|
|
2205
|
-
# @param pulse [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Pulse, nil]
|
|
2460
|
+
# @param pulse [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Pulse, nil]
|
|
2461
|
+
# Fields specific to the `pulse` network.
|
|
2206
2462
|
#
|
|
2207
|
-
# @param visa [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa, nil]
|
|
2463
|
+
# @param visa [Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa, nil]
|
|
2464
|
+
# Fields specific to the `visa` network.
|
|
2208
2465
|
|
|
2209
2466
|
# The payment network used to process this card authorization.
|
|
2210
2467
|
#
|
|
@@ -2279,19 +2536,27 @@ module Increase
|
|
|
2279
2536
|
nil?: true
|
|
2280
2537
|
|
|
2281
2538
|
# @!method initialize(electronic_commerce_indicator:, point_of_service_entry_mode:, stand_in_processing_reason:, terminal_entry_capability:)
|
|
2282
|
-
# Some parameter documentations has been truncated, see
|
|
2283
|
-
# {Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa} for
|
|
2284
|
-
# more details.
|
|
2285
|
-
#
|
|
2286
2539
|
# Fields specific to the `visa` network.
|
|
2287
2540
|
#
|
|
2288
|
-
# @param electronic_commerce_indicator [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator, nil]
|
|
2541
|
+
# @param electronic_commerce_indicator [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::ElectronicCommerceIndicator, nil]
|
|
2542
|
+
# For electronic commerce transactions, this identifies the level of security used
|
|
2543
|
+
# in obtaining the customer's payment credential. For mail or telephone order
|
|
2544
|
+
# transactions, identifies the type of mail or telephone order.
|
|
2289
2545
|
#
|
|
2290
|
-
# @param point_of_service_entry_mode [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode, nil]
|
|
2546
|
+
# @param point_of_service_entry_mode [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::PointOfServiceEntryMode, nil]
|
|
2547
|
+
# The method used to enter the cardholder's primary account number and card
|
|
2548
|
+
# expiration date.
|
|
2291
2549
|
#
|
|
2292
|
-
# @param stand_in_processing_reason [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason, nil]
|
|
2550
|
+
# @param stand_in_processing_reason [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::StandInProcessingReason, nil]
|
|
2551
|
+
# Only present when `actioner: network`. Describes why a card authorization was
|
|
2552
|
+
# approved or declined by Visa through stand-in processing.
|
|
2293
2553
|
#
|
|
2294
|
-
# @param terminal_entry_capability [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::TerminalEntryCapability, nil]
|
|
2554
|
+
# @param terminal_entry_capability [Symbol, Increase::Models::Transaction::Source::CardFinancial::NetworkDetails::Visa::TerminalEntryCapability, nil]
|
|
2555
|
+
# The capability of the terminal being used to read the card. Shows whether a
|
|
2556
|
+
# terminal can e.g., accept chip cards or if it only supports magnetic stripe
|
|
2557
|
+
# reads. This reflects the highest capability of the terminal — for example, a
|
|
2558
|
+
# terminal that supports both chip and magnetic stripe will be identified as
|
|
2559
|
+
# chip-capable.
|
|
2295
2560
|
|
|
2296
2561
|
# For electronic commerce transactions, this identifies the level of security used
|
|
2297
2562
|
# in obtaining the customer's payment credential. For mail or telephone order
|
|
@@ -2480,19 +2745,24 @@ module Increase
|
|
|
2480
2745
|
required :transaction_id, String, nil?: true
|
|
2481
2746
|
|
|
2482
2747
|
# @!method initialize(authorization_identification_response:, retrieval_reference_number:, trace_number:, transaction_id:)
|
|
2483
|
-
# Some parameter documentations has been truncated, see
|
|
2484
|
-
# {Increase::Models::Transaction::Source::CardFinancial::NetworkIdentifiers} for
|
|
2485
|
-
# more details.
|
|
2486
|
-
#
|
|
2487
2748
|
# Network-specific identifiers for a specific request or transaction.
|
|
2488
2749
|
#
|
|
2489
|
-
# @param authorization_identification_response [String, nil]
|
|
2750
|
+
# @param authorization_identification_response [String, nil]
|
|
2751
|
+
# The randomly generated 6-character Authorization Identification Response code
|
|
2752
|
+
# sent back to the acquirer in an approved response.
|
|
2490
2753
|
#
|
|
2491
|
-
# @param retrieval_reference_number [String, nil]
|
|
2754
|
+
# @param retrieval_reference_number [String, nil]
|
|
2755
|
+
# A life-cycle identifier used across e.g., an authorization and a reversal.
|
|
2756
|
+
# Expected to be unique per acquirer within a window of time. For some card
|
|
2757
|
+
# networks the retrieval reference number includes the trace counter.
|
|
2492
2758
|
#
|
|
2493
|
-
# @param trace_number [String, nil]
|
|
2759
|
+
# @param trace_number [String, nil]
|
|
2760
|
+
# A counter used to verify an individual authorization. Expected to be unique per
|
|
2761
|
+
# acquirer within a window of time.
|
|
2494
2762
|
#
|
|
2495
|
-
# @param transaction_id [String, nil]
|
|
2763
|
+
# @param transaction_id [String, nil]
|
|
2764
|
+
# A globally unique transaction identifier provided by the card network, used
|
|
2765
|
+
# across multiple life-cycle requests.
|
|
2496
2766
|
end
|
|
2497
2767
|
|
|
2498
2768
|
# The processing category describes the intent behind the financial, such as
|
|
@@ -2581,21 +2851,26 @@ module Increase
|
|
|
2581
2851
|
required :variable_rate, String, nil?: true
|
|
2582
2852
|
|
|
2583
2853
|
# @!method initialize(amount:, created_at:, currency:, fee_type:, fixed_component:, variable_rate:)
|
|
2584
|
-
# Some parameter documentations has been truncated, see
|
|
2585
|
-
# {Increase::Models::Transaction::Source::CardFinancial::SchemeFee} for more
|
|
2586
|
-
# details.
|
|
2587
|
-
#
|
|
2588
2854
|
# @param amount [String] The fee amount given as a string containing a decimal number.
|
|
2589
2855
|
#
|
|
2590
|
-
# @param created_at [Time]
|
|
2856
|
+
# @param created_at [Time]
|
|
2857
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
|
|
2858
|
+
# created.
|
|
2591
2859
|
#
|
|
2592
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CardFinancial::SchemeFee::Currency]
|
|
2860
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CardFinancial::SchemeFee::Currency]
|
|
2861
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
|
|
2862
|
+
# reimbursement.
|
|
2593
2863
|
#
|
|
2594
|
-
# @param fee_type [Symbol, Increase::Models::Transaction::Source::CardFinancial::SchemeFee::FeeType]
|
|
2864
|
+
# @param fee_type [Symbol, Increase::Models::Transaction::Source::CardFinancial::SchemeFee::FeeType]
|
|
2865
|
+
# The type of fee being assessed.
|
|
2595
2866
|
#
|
|
2596
|
-
# @param fixed_component [String, nil]
|
|
2867
|
+
# @param fixed_component [String, nil]
|
|
2868
|
+
# The fixed component of the fee, if applicable, given in major units of the fee
|
|
2869
|
+
# amount.
|
|
2597
2870
|
#
|
|
2598
|
-
# @param variable_rate [String, nil]
|
|
2871
|
+
# @param variable_rate [String, nil]
|
|
2872
|
+
# The variable rate component of the fee, if applicable, given as a decimal (e.g.,
|
|
2873
|
+
# 0.015 for 1.5%).
|
|
2599
2874
|
|
|
2600
2875
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
|
|
2601
2876
|
# reimbursement.
|
|
@@ -2752,17 +3027,18 @@ module Increase
|
|
|
2752
3027
|
nil?: true
|
|
2753
3028
|
|
|
2754
3029
|
# @!method initialize(card_verification_code:, cardholder_address:, cardholder_name:)
|
|
2755
|
-
# Some parameter documentations has been truncated, see
|
|
2756
|
-
# {Increase::Models::Transaction::Source::CardFinancial::Verification} for more
|
|
2757
|
-
# details.
|
|
2758
|
-
#
|
|
2759
3030
|
# Fields related to verification of cardholder-provided values.
|
|
2760
3031
|
#
|
|
2761
|
-
# @param card_verification_code [Increase::Models::Transaction::Source::CardFinancial::Verification::CardVerificationCode]
|
|
3032
|
+
# @param card_verification_code [Increase::Models::Transaction::Source::CardFinancial::Verification::CardVerificationCode]
|
|
3033
|
+
# Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
3034
|
+
# the back of the card.
|
|
2762
3035
|
#
|
|
2763
|
-
# @param cardholder_address [Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress]
|
|
3036
|
+
# @param cardholder_address [Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress]
|
|
3037
|
+
# Cardholder address provided in the authorization request and the address on file
|
|
3038
|
+
# we verified it against.
|
|
2764
3039
|
#
|
|
2765
|
-
# @param cardholder_name [Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderName, nil]
|
|
3040
|
+
# @param cardholder_name [Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderName, nil]
|
|
3041
|
+
# Cardholder name provided in the authorization request.
|
|
2766
3042
|
|
|
2767
3043
|
# @see Increase::Models::Transaction::Source::CardFinancial::Verification#card_verification_code
|
|
2768
3044
|
class CardVerificationCode < Increase::Internal::Type::BaseModel
|
|
@@ -2777,7 +3053,8 @@ module Increase
|
|
|
2777
3053
|
# Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
2778
3054
|
# the back of the card.
|
|
2779
3055
|
#
|
|
2780
|
-
# @param result [Symbol, Increase::Models::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result]
|
|
3056
|
+
# @param result [Symbol, Increase::Models::Transaction::Source::CardFinancial::Verification::CardVerificationCode::Result]
|
|
3057
|
+
# The result of verifying the Card Verification Code.
|
|
2781
3058
|
|
|
2782
3059
|
# The result of verifying the Card Verification Code.
|
|
2783
3060
|
#
|
|
@@ -2834,10 +3111,6 @@ module Increase
|
|
|
2834
3111
|
enum: -> { Increase::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result }
|
|
2835
3112
|
|
|
2836
3113
|
# @!method initialize(actual_line1:, actual_postal_code:, provided_line1:, provided_postal_code:, result:)
|
|
2837
|
-
# Some parameter documentations has been truncated, see
|
|
2838
|
-
# {Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress}
|
|
2839
|
-
# for more details.
|
|
2840
|
-
#
|
|
2841
3114
|
# Cardholder address provided in the authorization request and the address on file
|
|
2842
3115
|
# we verified it against.
|
|
2843
3116
|
#
|
|
@@ -2845,11 +3118,15 @@ module Increase
|
|
|
2845
3118
|
#
|
|
2846
3119
|
# @param actual_postal_code [String, nil] The postal code of the address on file for the cardholder.
|
|
2847
3120
|
#
|
|
2848
|
-
# @param provided_line1 [String, nil]
|
|
3121
|
+
# @param provided_line1 [String, nil]
|
|
3122
|
+
# The cardholder address line 1 provided for verification in the authorization
|
|
3123
|
+
# request.
|
|
2849
3124
|
#
|
|
2850
|
-
# @param provided_postal_code [String, nil]
|
|
3125
|
+
# @param provided_postal_code [String, nil]
|
|
3126
|
+
# The postal code provided for verification in the authorization request.
|
|
2851
3127
|
#
|
|
2852
|
-
# @param result [Symbol, Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result]
|
|
3128
|
+
# @param result [Symbol, Increase::Models::Transaction::Source::CardFinancial::Verification::CardholderAddress::Result]
|
|
3129
|
+
# The address verification result returned to the card network.
|
|
2853
3130
|
|
|
2854
3131
|
# The address verification result returned to the card network.
|
|
2855
3132
|
#
|
|
@@ -2903,11 +3180,14 @@ module Increase
|
|
|
2903
3180
|
# @!method initialize(provided_first_name:, provided_last_name:, provided_middle_name:)
|
|
2904
3181
|
# Cardholder name provided in the authorization request.
|
|
2905
3182
|
#
|
|
2906
|
-
# @param provided_first_name [String, nil]
|
|
3183
|
+
# @param provided_first_name [String, nil]
|
|
3184
|
+
# The first name provided for verification in the authorization request.
|
|
2907
3185
|
#
|
|
2908
|
-
# @param provided_last_name [String, nil]
|
|
3186
|
+
# @param provided_last_name [String, nil]
|
|
3187
|
+
# The last name provided for verification in the authorization request.
|
|
2909
3188
|
#
|
|
2910
|
-
# @param provided_middle_name [String, nil]
|
|
3189
|
+
# @param provided_middle_name [String, nil]
|
|
3190
|
+
# The middle name provided for verification in the authorization request.
|
|
2911
3191
|
end
|
|
2912
3192
|
end
|
|
2913
3193
|
end
|
|
@@ -3072,9 +3352,6 @@ module Increase
|
|
|
3072
3352
|
required :type, enum: -> { Increase::Transaction::Source::CardRefund::Type }
|
|
3073
3353
|
|
|
3074
3354
|
# @!method initialize(id:, amount:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network_identifiers:, presentment_amount:, presentment_currency:, purchase_details:, scheme_fees:, transaction_id:, type:)
|
|
3075
|
-
# Some parameter documentations has been truncated, see
|
|
3076
|
-
# {Increase::Models::Transaction::Source::CardRefund} for more details.
|
|
3077
|
-
#
|
|
3078
3355
|
# A Card Refund object. This field will be present in the JSON response if and
|
|
3079
3356
|
# only if `category` is equal to `card_refund`. Card Refunds move money back to
|
|
3080
3357
|
# the cardholder. While they are usually connected to a Card Settlement, an
|
|
@@ -3083,17 +3360,26 @@ module Increase
|
|
|
3083
3360
|
#
|
|
3084
3361
|
# @param id [String] The Card Refund identifier.
|
|
3085
3362
|
#
|
|
3086
|
-
# @param amount [Integer]
|
|
3363
|
+
# @param amount [Integer]
|
|
3364
|
+
# The amount in the minor unit of the transaction's settlement currency. For
|
|
3365
|
+
# dollars, for example, this is cents.
|
|
3087
3366
|
#
|
|
3088
3367
|
# @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
|
|
3089
3368
|
#
|
|
3090
|
-
# @param cashback [Increase::Models::Transaction::Source::CardRefund::Cashback, nil]
|
|
3369
|
+
# @param cashback [Increase::Models::Transaction::Source::CardRefund::Cashback, nil]
|
|
3370
|
+
# Cashback debited for this transaction, if eligible. Cashback is paid out in
|
|
3371
|
+
# aggregate, monthly.
|
|
3091
3372
|
#
|
|
3092
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Currency]
|
|
3373
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Currency]
|
|
3374
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
3375
|
+
# transaction's settlement currency.
|
|
3093
3376
|
#
|
|
3094
|
-
# @param interchange [Increase::Models::Transaction::Source::CardRefund::Interchange, nil]
|
|
3377
|
+
# @param interchange [Increase::Models::Transaction::Source::CardRefund::Interchange, nil]
|
|
3378
|
+
# Interchange assessed as a part of this transaction.
|
|
3095
3379
|
#
|
|
3096
|
-
# @param merchant_acceptor_id [String]
|
|
3380
|
+
# @param merchant_acceptor_id [String]
|
|
3381
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
3382
|
+
# is transacting with.
|
|
3097
3383
|
#
|
|
3098
3384
|
# @param merchant_category_code [String] The 4-digit MCC describing the merchant's business.
|
|
3099
3385
|
#
|
|
@@ -3103,23 +3389,33 @@ module Increase
|
|
|
3103
3389
|
#
|
|
3104
3390
|
# @param merchant_name [String] The name of the merchant.
|
|
3105
3391
|
#
|
|
3106
|
-
# @param merchant_postal_code [String, nil]
|
|
3392
|
+
# @param merchant_postal_code [String, nil]
|
|
3393
|
+
# The merchant's postal code. For US merchants this is always a 5-digit ZIP code.
|
|
3107
3394
|
#
|
|
3108
3395
|
# @param merchant_state [String, nil] The state the merchant resides in.
|
|
3109
3396
|
#
|
|
3110
|
-
# @param network_identifiers [Increase::Models::Transaction::Source::CardRefund::NetworkIdentifiers]
|
|
3397
|
+
# @param network_identifiers [Increase::Models::Transaction::Source::CardRefund::NetworkIdentifiers]
|
|
3398
|
+
# Network-specific identifiers for this refund.
|
|
3111
3399
|
#
|
|
3112
|
-
# @param presentment_amount [Integer]
|
|
3400
|
+
# @param presentment_amount [Integer]
|
|
3401
|
+
# The amount in the minor unit of the transaction's presentment currency.
|
|
3113
3402
|
#
|
|
3114
|
-
# @param presentment_currency [String]
|
|
3403
|
+
# @param presentment_currency [String]
|
|
3404
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
3405
|
+
# transaction's presentment currency.
|
|
3115
3406
|
#
|
|
3116
|
-
# @param purchase_details [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails, nil]
|
|
3407
|
+
# @param purchase_details [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails, nil]
|
|
3408
|
+
# Additional details about the card purchase, such as tax and industry-specific
|
|
3409
|
+
# fields.
|
|
3117
3410
|
#
|
|
3118
|
-
# @param scheme_fees [Array<Increase::Models::Transaction::Source::CardRefund::SchemeFee>]
|
|
3411
|
+
# @param scheme_fees [Array<Increase::Models::Transaction::Source::CardRefund::SchemeFee>]
|
|
3412
|
+
# The scheme fees associated with this card refund.
|
|
3119
3413
|
#
|
|
3120
3414
|
# @param transaction_id [String] The identifier of the Transaction associated with this Transaction.
|
|
3121
3415
|
#
|
|
3122
|
-
# @param type [Symbol, Increase::Models::Transaction::Source::CardRefund::Type]
|
|
3416
|
+
# @param type [Symbol, Increase::Models::Transaction::Source::CardRefund::Type]
|
|
3417
|
+
# A constant representing the object's type. For this resource it will always be
|
|
3418
|
+
# `card_refund`.
|
|
3123
3419
|
|
|
3124
3420
|
# @see Increase::Models::Transaction::Source::CardRefund#cashback
|
|
3125
3421
|
class Cashback < Increase::Internal::Type::BaseModel
|
|
@@ -3138,15 +3434,16 @@ module Increase
|
|
|
3138
3434
|
required :currency, enum: -> { Increase::Transaction::Source::CardRefund::Cashback::Currency }
|
|
3139
3435
|
|
|
3140
3436
|
# @!method initialize(amount:, currency:)
|
|
3141
|
-
# Some parameter documentations has been truncated, see
|
|
3142
|
-
# {Increase::Models::Transaction::Source::CardRefund::Cashback} for more details.
|
|
3143
|
-
#
|
|
3144
3437
|
# Cashback debited for this transaction, if eligible. Cashback is paid out in
|
|
3145
3438
|
# aggregate, monthly.
|
|
3146
3439
|
#
|
|
3147
|
-
# @param amount [String]
|
|
3440
|
+
# @param amount [String]
|
|
3441
|
+
# The cashback amount given as a string containing a decimal number. The amount is
|
|
3442
|
+
# a positive number if it will be credited to you (e.g., settlements) and a
|
|
3443
|
+
# negative number if it will be debited (e.g., refunds).
|
|
3148
3444
|
#
|
|
3149
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Cashback::Currency]
|
|
3445
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Cashback::Currency]
|
|
3446
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
|
|
3150
3447
|
|
|
3151
3448
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
|
|
3152
3449
|
#
|
|
@@ -3201,17 +3498,19 @@ module Increase
|
|
|
3201
3498
|
required :currency, enum: -> { Increase::Transaction::Source::CardRefund::Interchange::Currency }
|
|
3202
3499
|
|
|
3203
3500
|
# @!method initialize(amount:, code:, currency:)
|
|
3204
|
-
# Some parameter documentations has been truncated, see
|
|
3205
|
-
# {Increase::Models::Transaction::Source::CardRefund::Interchange} for more
|
|
3206
|
-
# details.
|
|
3207
|
-
#
|
|
3208
3501
|
# Interchange assessed as a part of this transaction.
|
|
3209
3502
|
#
|
|
3210
|
-
# @param amount [String]
|
|
3503
|
+
# @param amount [String]
|
|
3504
|
+
# The interchange amount given as a string containing a decimal number in major
|
|
3505
|
+
# units (so e.g., "3.14" for $3.14). The amount is a positive number if it is
|
|
3506
|
+
# credited to Increase (e.g., settlements) and a negative number if it is debited
|
|
3507
|
+
# (e.g., refunds).
|
|
3211
3508
|
#
|
|
3212
3509
|
# @param code [String, nil] The card network specific interchange code.
|
|
3213
3510
|
#
|
|
3214
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Interchange::Currency]
|
|
3511
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::Interchange::Currency]
|
|
3512
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
|
|
3513
|
+
# reimbursement.
|
|
3215
3514
|
|
|
3216
3515
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
|
|
3217
3516
|
# reimbursement.
|
|
@@ -3258,19 +3557,21 @@ module Increase
|
|
|
3258
3557
|
required :transaction_id, String, nil?: true
|
|
3259
3558
|
|
|
3260
3559
|
# @!method initialize(acquirer_business_id:, acquirer_reference_number:, authorization_identification_response:, transaction_id:)
|
|
3261
|
-
# Some parameter documentations has been truncated, see
|
|
3262
|
-
# {Increase::Models::Transaction::Source::CardRefund::NetworkIdentifiers} for more
|
|
3263
|
-
# details.
|
|
3264
|
-
#
|
|
3265
3560
|
# Network-specific identifiers for this refund.
|
|
3266
3561
|
#
|
|
3267
|
-
# @param acquirer_business_id [String]
|
|
3562
|
+
# @param acquirer_business_id [String]
|
|
3563
|
+
# A network assigned business ID that identifies the acquirer that processed this
|
|
3564
|
+
# transaction.
|
|
3268
3565
|
#
|
|
3269
3566
|
# @param acquirer_reference_number [String] A globally unique identifier for this settlement.
|
|
3270
3567
|
#
|
|
3271
|
-
# @param authorization_identification_response [String, nil]
|
|
3568
|
+
# @param authorization_identification_response [String, nil]
|
|
3569
|
+
# The randomly generated 6-character Authorization Identification Response code
|
|
3570
|
+
# sent back to the acquirer in an approved response.
|
|
3272
3571
|
#
|
|
3273
|
-
# @param transaction_id [String, nil]
|
|
3572
|
+
# @param transaction_id [String, nil]
|
|
3573
|
+
# A globally unique transaction identifier provided by the card network, used
|
|
3574
|
+
# across multiple life-cycle requests.
|
|
3274
3575
|
end
|
|
3275
3576
|
|
|
3276
3577
|
# @see Increase::Models::Transaction::Source::CardRefund#purchase_details
|
|
@@ -3352,32 +3653,38 @@ module Increase
|
|
|
3352
3653
|
nil?: true
|
|
3353
3654
|
|
|
3354
3655
|
# @!method initialize(car_rental:, customer_reference_identifier:, local_tax_amount:, local_tax_currency:, lodging:, national_tax_amount:, national_tax_currency:, purchase_identifier:, purchase_identifier_format:, travel:)
|
|
3355
|
-
# Some parameter documentations has been truncated, see
|
|
3356
|
-
# {Increase::Models::Transaction::Source::CardRefund::PurchaseDetails} for more
|
|
3357
|
-
# details.
|
|
3358
|
-
#
|
|
3359
3656
|
# Additional details about the card purchase, such as tax and industry-specific
|
|
3360
3657
|
# fields.
|
|
3361
3658
|
#
|
|
3362
|
-
# @param car_rental [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental, nil]
|
|
3659
|
+
# @param car_rental [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental, nil]
|
|
3660
|
+
# Fields specific to car rentals.
|
|
3363
3661
|
#
|
|
3364
|
-
# @param customer_reference_identifier [String, nil]
|
|
3662
|
+
# @param customer_reference_identifier [String, nil]
|
|
3663
|
+
# An identifier from the merchant for the customer or consumer.
|
|
3365
3664
|
#
|
|
3366
3665
|
# @param local_tax_amount [Integer, nil] The state or provincial tax amount in minor units.
|
|
3367
3666
|
#
|
|
3368
|
-
# @param local_tax_currency [String, nil]
|
|
3667
|
+
# @param local_tax_currency [String, nil]
|
|
3668
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
|
|
3669
|
+
# assessed.
|
|
3369
3670
|
#
|
|
3370
|
-
# @param lodging [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging, nil]
|
|
3671
|
+
# @param lodging [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging, nil]
|
|
3672
|
+
# Fields specific to lodging.
|
|
3371
3673
|
#
|
|
3372
3674
|
# @param national_tax_amount [Integer, nil] The national tax amount in minor units.
|
|
3373
3675
|
#
|
|
3374
|
-
# @param national_tax_currency [String, nil]
|
|
3676
|
+
# @param national_tax_currency [String, nil]
|
|
3677
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
|
|
3678
|
+
# assessed.
|
|
3375
3679
|
#
|
|
3376
|
-
# @param purchase_identifier [String, nil]
|
|
3680
|
+
# @param purchase_identifier [String, nil]
|
|
3681
|
+
# An identifier from the merchant for the purchase to the issuer and cardholder.
|
|
3377
3682
|
#
|
|
3378
|
-
# @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::PurchaseIdentifierFormat, nil]
|
|
3683
|
+
# @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::PurchaseIdentifierFormat, nil]
|
|
3684
|
+
# The format of the purchase identifier.
|
|
3379
3685
|
#
|
|
3380
|
-
# @param travel [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel, nil]
|
|
3686
|
+
# @param travel [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel, nil]
|
|
3687
|
+
# Fields specific to travel.
|
|
3381
3688
|
|
|
3382
3689
|
# @see Increase::Models::Transaction::Source::CardRefund::PurchaseDetails#car_rental
|
|
3383
3690
|
class CarRental < Increase::Internal::Type::BaseModel
|
|
@@ -3494,43 +3801,56 @@ module Increase
|
|
|
3494
3801
|
required :weekly_rental_rate_currency, String, nil?: true
|
|
3495
3802
|
|
|
3496
3803
|
# @!method initialize(car_class_code:, checkout_date:, daily_rental_rate_amount:, daily_rental_rate_currency:, days_rented:, extra_charges:, fuel_charges_amount:, fuel_charges_currency:, insurance_charges_amount:, insurance_charges_currency:, no_show_indicator:, one_way_drop_off_charges_amount:, one_way_drop_off_charges_currency:, renter_name:, weekly_rental_rate_amount:, weekly_rental_rate_currency:)
|
|
3497
|
-
# Some parameter documentations has been truncated, see
|
|
3498
|
-
# {Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental}
|
|
3499
|
-
# for more details.
|
|
3500
|
-
#
|
|
3501
3804
|
# Fields specific to car rentals.
|
|
3502
3805
|
#
|
|
3503
3806
|
# @param car_class_code [String, nil] Code indicating the vehicle's class.
|
|
3504
3807
|
#
|
|
3505
|
-
# @param checkout_date [Date, nil]
|
|
3808
|
+
# @param checkout_date [Date, nil]
|
|
3809
|
+
# Date the customer picked up the car or, in the case of a no-show or pre-pay
|
|
3810
|
+
# transaction, the scheduled pick up date.
|
|
3506
3811
|
#
|
|
3507
3812
|
# @param daily_rental_rate_amount [Integer, nil] Daily rate being charged for the vehicle.
|
|
3508
3813
|
#
|
|
3509
|
-
# @param daily_rental_rate_currency [String, nil]
|
|
3814
|
+
# @param daily_rental_rate_currency [String, nil]
|
|
3815
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
|
|
3816
|
+
# rate.
|
|
3510
3817
|
#
|
|
3511
3818
|
# @param days_rented [Integer, nil] Number of days the vehicle was rented.
|
|
3512
3819
|
#
|
|
3513
|
-
# @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::ExtraCharges, nil]
|
|
3820
|
+
# @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::ExtraCharges, nil]
|
|
3821
|
+
# Additional charges (gas, late fee, etc.) being billed.
|
|
3514
3822
|
#
|
|
3515
3823
|
# @param fuel_charges_amount [Integer, nil] Fuel charges for the vehicle.
|
|
3516
3824
|
#
|
|
3517
|
-
# @param fuel_charges_currency [String, nil]
|
|
3825
|
+
# @param fuel_charges_currency [String, nil]
|
|
3826
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
|
|
3827
|
+
# assessed.
|
|
3518
3828
|
#
|
|
3519
3829
|
# @param insurance_charges_amount [Integer, nil] Any insurance being charged for the vehicle.
|
|
3520
3830
|
#
|
|
3521
|
-
# @param insurance_charges_currency [String, nil]
|
|
3831
|
+
# @param insurance_charges_currency [String, nil]
|
|
3832
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
|
|
3833
|
+
# charges assessed.
|
|
3522
3834
|
#
|
|
3523
|
-
# @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::NoShowIndicator, nil]
|
|
3835
|
+
# @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::CarRental::NoShowIndicator, nil]
|
|
3836
|
+
# An indicator that the cardholder is being billed for a reserved vehicle that was
|
|
3837
|
+
# not actually rented (that is, a "no-show" charge).
|
|
3524
3838
|
#
|
|
3525
|
-
# @param one_way_drop_off_charges_amount [Integer, nil]
|
|
3839
|
+
# @param one_way_drop_off_charges_amount [Integer, nil]
|
|
3840
|
+
# Charges for returning the vehicle at a different location than where it was
|
|
3841
|
+
# picked up.
|
|
3526
3842
|
#
|
|
3527
|
-
# @param one_way_drop_off_charges_currency [String, nil]
|
|
3843
|
+
# @param one_way_drop_off_charges_currency [String, nil]
|
|
3844
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
|
|
3845
|
+
# drop-off charges assessed.
|
|
3528
3846
|
#
|
|
3529
3847
|
# @param renter_name [String, nil] Name of the person renting the vehicle.
|
|
3530
3848
|
#
|
|
3531
3849
|
# @param weekly_rental_rate_amount [Integer, nil] Weekly rate being charged for the vehicle.
|
|
3532
3850
|
#
|
|
3533
|
-
# @param weekly_rental_rate_currency [String, nil]
|
|
3851
|
+
# @param weekly_rental_rate_currency [String, nil]
|
|
3852
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
|
|
3853
|
+
# rental rate.
|
|
3534
3854
|
|
|
3535
3855
|
# Additional charges (gas, late fee, etc.) being billed.
|
|
3536
3856
|
#
|
|
@@ -3692,43 +4012,54 @@ module Increase
|
|
|
3692
4012
|
required :total_tax_currency, String, nil?: true
|
|
3693
4013
|
|
|
3694
4014
|
# @!method initialize(check_in_date:, daily_room_rate_amount:, daily_room_rate_currency:, extra_charges:, folio_cash_advances_amount:, folio_cash_advances_currency:, food_beverage_charges_amount:, food_beverage_charges_currency:, no_show_indicator:, prepaid_expenses_amount:, prepaid_expenses_currency:, room_nights:, total_room_tax_amount:, total_room_tax_currency:, total_tax_amount:, total_tax_currency:)
|
|
3695
|
-
# Some parameter documentations has been truncated, see
|
|
3696
|
-
# {Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging}
|
|
3697
|
-
# for more details.
|
|
3698
|
-
#
|
|
3699
4015
|
# Fields specific to lodging.
|
|
3700
4016
|
#
|
|
3701
4017
|
# @param check_in_date [Date, nil] Date the customer checked in.
|
|
3702
4018
|
#
|
|
3703
4019
|
# @param daily_room_rate_amount [Integer, nil] Daily rate being charged for the room.
|
|
3704
4020
|
#
|
|
3705
|
-
# @param daily_room_rate_currency [String, nil]
|
|
4021
|
+
# @param daily_room_rate_currency [String, nil]
|
|
4022
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
|
|
4023
|
+
# rate.
|
|
3706
4024
|
#
|
|
3707
|
-
# @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::ExtraCharges, nil]
|
|
4025
|
+
# @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::ExtraCharges, nil]
|
|
4026
|
+
# Additional charges (phone, late check-out, etc.) being billed.
|
|
3708
4027
|
#
|
|
3709
4028
|
# @param folio_cash_advances_amount [Integer, nil] Folio cash advances for the room.
|
|
3710
4029
|
#
|
|
3711
|
-
# @param folio_cash_advances_currency [String, nil]
|
|
4030
|
+
# @param folio_cash_advances_currency [String, nil]
|
|
4031
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
|
|
4032
|
+
# advances.
|
|
3712
4033
|
#
|
|
3713
4034
|
# @param food_beverage_charges_amount [Integer, nil] Food and beverage charges for the room.
|
|
3714
4035
|
#
|
|
3715
|
-
# @param food_beverage_charges_currency [String, nil]
|
|
4036
|
+
# @param food_beverage_charges_currency [String, nil]
|
|
4037
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
|
|
4038
|
+
# beverage charges.
|
|
3716
4039
|
#
|
|
3717
|
-
# @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::NoShowIndicator, nil]
|
|
4040
|
+
# @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Lodging::NoShowIndicator, nil]
|
|
4041
|
+
# Indicator that the cardholder is being billed for a reserved room that was not
|
|
4042
|
+
# actually used.
|
|
3718
4043
|
#
|
|
3719
4044
|
# @param prepaid_expenses_amount [Integer, nil] Prepaid expenses being charged for the room.
|
|
3720
4045
|
#
|
|
3721
|
-
# @param prepaid_expenses_currency [String, nil]
|
|
4046
|
+
# @param prepaid_expenses_currency [String, nil]
|
|
4047
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
|
|
4048
|
+
# expenses.
|
|
3722
4049
|
#
|
|
3723
4050
|
# @param room_nights [Integer, nil] Number of nights the room was rented.
|
|
3724
4051
|
#
|
|
3725
4052
|
# @param total_room_tax_amount [Integer, nil] Total room tax being charged.
|
|
3726
4053
|
#
|
|
3727
|
-
# @param total_room_tax_currency [String, nil]
|
|
4054
|
+
# @param total_room_tax_currency [String, nil]
|
|
4055
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
|
|
4056
|
+
# tax.
|
|
3728
4057
|
#
|
|
3729
4058
|
# @param total_tax_amount [Integer, nil] Total tax being charged for the room.
|
|
3730
4059
|
#
|
|
3731
|
-
# @param total_tax_currency [String, nil]
|
|
4060
|
+
# @param total_tax_currency [String, nil]
|
|
4061
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
|
|
4062
|
+
# assessed.
|
|
3732
4063
|
|
|
3733
4064
|
# Additional charges (phone, late check-out, etc.) being billed.
|
|
3734
4065
|
#
|
|
@@ -3899,11 +4230,14 @@ module Increase
|
|
|
3899
4230
|
# @!method initialize(ancillary:, computerized_reservation_system:, credit_reason_indicator:, departure_date:, origination_city_airport_code:, passenger_name:, restricted_ticket_indicator:, ticket_change_indicator:, ticket_number:, travel_agency_code:, travel_agency_name:, trip_legs:)
|
|
3900
4231
|
# Fields specific to travel.
|
|
3901
4232
|
#
|
|
3902
|
-
# @param ancillary [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary, nil]
|
|
4233
|
+
# @param ancillary [Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary, nil]
|
|
4234
|
+
# Ancillary purchases in addition to the airfare.
|
|
3903
4235
|
#
|
|
3904
|
-
# @param computerized_reservation_system [String, nil]
|
|
4236
|
+
# @param computerized_reservation_system [String, nil]
|
|
4237
|
+
# Indicates the computerized reservation system used to book the ticket.
|
|
3905
4238
|
#
|
|
3906
|
-
# @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator, nil]
|
|
4239
|
+
# @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::CreditReasonIndicator, nil]
|
|
4240
|
+
# Indicates the reason for a credit to the cardholder.
|
|
3907
4241
|
#
|
|
3908
4242
|
# @param departure_date [Date, nil] Date of departure.
|
|
3909
4243
|
#
|
|
@@ -3911,17 +4245,22 @@ module Increase
|
|
|
3911
4245
|
#
|
|
3912
4246
|
# @param passenger_name [String, nil] Name of the passenger.
|
|
3913
4247
|
#
|
|
3914
|
-
# @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator, nil]
|
|
4248
|
+
# @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::RestrictedTicketIndicator, nil]
|
|
4249
|
+
# Indicates whether this ticket is non-refundable.
|
|
3915
4250
|
#
|
|
3916
|
-
# @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator, nil]
|
|
4251
|
+
# @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TicketChangeIndicator, nil]
|
|
4252
|
+
# Indicates why a ticket was changed.
|
|
3917
4253
|
#
|
|
3918
4254
|
# @param ticket_number [String, nil] Ticket number.
|
|
3919
4255
|
#
|
|
3920
|
-
# @param travel_agency_code [String, nil]
|
|
4256
|
+
# @param travel_agency_code [String, nil]
|
|
4257
|
+
# Code for the travel agency if the ticket was issued by a travel agency.
|
|
3921
4258
|
#
|
|
3922
|
-
# @param travel_agency_name [String, nil]
|
|
4259
|
+
# @param travel_agency_name [String, nil]
|
|
4260
|
+
# Name of the travel agency if the ticket was issued by a travel agency.
|
|
3923
4261
|
#
|
|
3924
|
-
# @param trip_legs [Array<Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg>, nil]
|
|
4262
|
+
# @param trip_legs [Array<Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg>, nil]
|
|
4263
|
+
# Fields specific to each leg of the journey.
|
|
3925
4264
|
|
|
3926
4265
|
# @see Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel#ancillary
|
|
3927
4266
|
class Ancillary < Increase::Internal::Type::BaseModel
|
|
@@ -3963,19 +4302,21 @@ module Increase
|
|
|
3963
4302
|
required :ticket_document_number, String, nil?: true
|
|
3964
4303
|
|
|
3965
4304
|
# @!method initialize(connected_ticket_document_number:, credit_reason_indicator:, passenger_name_or_description:, services:, ticket_document_number:)
|
|
3966
|
-
# Some parameter documentations has been truncated, see
|
|
3967
|
-
# {Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary}
|
|
3968
|
-
# for more details.
|
|
3969
|
-
#
|
|
3970
4305
|
# Ancillary purchases in addition to the airfare.
|
|
3971
4306
|
#
|
|
3972
|
-
# @param connected_ticket_document_number [String, nil]
|
|
4307
|
+
# @param connected_ticket_document_number [String, nil]
|
|
4308
|
+
# If this purchase has a connection or relationship to another purchase, such as a
|
|
4309
|
+
# baggage fee for a passenger transport ticket, this field should contain the
|
|
4310
|
+
# ticket document number for the other purchase.
|
|
3973
4311
|
#
|
|
3974
|
-
# @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil]
|
|
4312
|
+
# @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil]
|
|
4313
|
+
# Indicates the reason for a credit to the cardholder.
|
|
3975
4314
|
#
|
|
3976
|
-
# @param passenger_name_or_description [String, nil]
|
|
4315
|
+
# @param passenger_name_or_description [String, nil]
|
|
4316
|
+
# Name of the passenger or description of the ancillary purchase.
|
|
3977
4317
|
#
|
|
3978
|
-
# @param services [Array<Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service>]
|
|
4318
|
+
# @param services [Array<Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service>]
|
|
4319
|
+
# Additional travel charges, such as baggage fees.
|
|
3979
4320
|
#
|
|
3980
4321
|
# @param ticket_document_number [String, nil] Ticket document number.
|
|
3981
4322
|
|
|
@@ -4021,7 +4362,8 @@ module Increase
|
|
|
4021
4362
|
required :sub_category, String, nil?: true
|
|
4022
4363
|
|
|
4023
4364
|
# @!method initialize(category:, sub_category:)
|
|
4024
|
-
# @param category [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category, nil]
|
|
4365
|
+
# @param category [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::Ancillary::Service::Category, nil]
|
|
4366
|
+
# Category of the ancillary service.
|
|
4025
4367
|
#
|
|
4026
4368
|
# @param sub_category [String, nil] Sub-category of the ancillary service, free-form.
|
|
4027
4369
|
|
|
@@ -4226,7 +4568,8 @@ module Increase
|
|
|
4226
4568
|
#
|
|
4227
4569
|
# @param service_class [String, nil] Service class (e.g., first class, business class, etc.).
|
|
4228
4570
|
#
|
|
4229
|
-
# @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode, nil]
|
|
4571
|
+
# @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardRefund::PurchaseDetails::Travel::TripLeg::StopOverCode, nil]
|
|
4572
|
+
# Indicates whether a stopover is allowed on this ticket.
|
|
4230
4573
|
|
|
4231
4574
|
# Indicates whether a stopover is allowed on this ticket.
|
|
4232
4575
|
#
|
|
@@ -4292,20 +4635,26 @@ module Increase
|
|
|
4292
4635
|
required :variable_rate, String, nil?: true
|
|
4293
4636
|
|
|
4294
4637
|
# @!method initialize(amount:, created_at:, currency:, fee_type:, fixed_component:, variable_rate:)
|
|
4295
|
-
# Some parameter documentations has been truncated, see
|
|
4296
|
-
# {Increase::Models::Transaction::Source::CardRefund::SchemeFee} for more details.
|
|
4297
|
-
#
|
|
4298
4638
|
# @param amount [String] The fee amount given as a string containing a decimal number.
|
|
4299
4639
|
#
|
|
4300
|
-
# @param created_at [Time]
|
|
4640
|
+
# @param created_at [Time]
|
|
4641
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
|
|
4642
|
+
# created.
|
|
4301
4643
|
#
|
|
4302
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::SchemeFee::Currency]
|
|
4644
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CardRefund::SchemeFee::Currency]
|
|
4645
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
|
|
4646
|
+
# reimbursement.
|
|
4303
4647
|
#
|
|
4304
|
-
# @param fee_type [Symbol, Increase::Models::Transaction::Source::CardRefund::SchemeFee::FeeType]
|
|
4648
|
+
# @param fee_type [Symbol, Increase::Models::Transaction::Source::CardRefund::SchemeFee::FeeType]
|
|
4649
|
+
# The type of fee being assessed.
|
|
4305
4650
|
#
|
|
4306
|
-
# @param fixed_component [String, nil]
|
|
4651
|
+
# @param fixed_component [String, nil]
|
|
4652
|
+
# The fixed component of the fee, if applicable, given in major units of the fee
|
|
4653
|
+
# amount.
|
|
4307
4654
|
#
|
|
4308
|
-
# @param variable_rate [String, nil]
|
|
4655
|
+
# @param variable_rate [String, nil]
|
|
4656
|
+
# The variable rate component of the fee, if applicable, given as a decimal (e.g.,
|
|
4657
|
+
# 0.015 for 1.5%).
|
|
4309
4658
|
|
|
4310
4659
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
|
|
4311
4660
|
# reimbursement.
|
|
@@ -4471,16 +4820,17 @@ module Increase
|
|
|
4471
4820
|
required :transacted_on_account_id, String, nil?: true
|
|
4472
4821
|
|
|
4473
4822
|
# @!method initialize(amount:, currency:, period_end:, period_start:, transacted_on_account_id:)
|
|
4474
|
-
# Some parameter documentations has been truncated, see
|
|
4475
|
-
# {Increase::Models::Transaction::Source::CardRevenuePayment} for more details.
|
|
4476
|
-
#
|
|
4477
4823
|
# A Card Revenue Payment object. This field will be present in the JSON response
|
|
4478
4824
|
# if and only if `category` is equal to `card_revenue_payment`. Card Revenue
|
|
4479
4825
|
# Payments reflect earnings from fees on card transactions.
|
|
4480
4826
|
#
|
|
4481
|
-
# @param amount [Integer]
|
|
4827
|
+
# @param amount [Integer]
|
|
4828
|
+
# The amount in the minor unit of the transaction's currency. For dollars, for
|
|
4829
|
+
# example, this is cents.
|
|
4482
4830
|
#
|
|
4483
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CardRevenuePayment::Currency]
|
|
4831
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CardRevenuePayment::Currency]
|
|
4832
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
|
|
4833
|
+
# currency.
|
|
4484
4834
|
#
|
|
4485
4835
|
# @param period_end [Time] The end of the period for which this transaction paid interest.
|
|
4486
4836
|
#
|
|
@@ -4663,9 +5013,6 @@ module Increase
|
|
|
4663
5013
|
required :type, enum: -> { Increase::Transaction::Source::CardSettlement::Type }
|
|
4664
5014
|
|
|
4665
5015
|
# @!method initialize(id:, amount:, card_authorization:, card_payment_id:, cashback:, currency:, interchange:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_name:, merchant_postal_code:, merchant_state:, network:, network_identifiers:, pending_transaction_id:, presentment_amount:, presentment_currency:, purchase_details:, scheme_fees:, surcharge:, transaction_id:, type:)
|
|
4666
|
-
# Some parameter documentations has been truncated, see
|
|
4667
|
-
# {Increase::Models::Transaction::Source::CardSettlement} for more details.
|
|
4668
|
-
#
|
|
4669
5016
|
# A Card Settlement object. This field will be present in the JSON response if and
|
|
4670
5017
|
# only if `category` is equal to `card_settlement`. Card Settlements are card
|
|
4671
5018
|
# transactions that have cleared and settled. While a settlement is usually
|
|
@@ -4674,19 +5021,30 @@ module Increase
|
|
|
4674
5021
|
#
|
|
4675
5022
|
# @param id [String] The Card Settlement identifier.
|
|
4676
5023
|
#
|
|
4677
|
-
# @param amount [Integer]
|
|
5024
|
+
# @param amount [Integer]
|
|
5025
|
+
# The amount in the minor unit of the transaction's settlement currency. For
|
|
5026
|
+
# dollars, for example, this is cents.
|
|
4678
5027
|
#
|
|
4679
|
-
# @param card_authorization [String, nil]
|
|
5028
|
+
# @param card_authorization [String, nil]
|
|
5029
|
+
# The Card Authorization that was created prior to this Card Settlement, if one
|
|
5030
|
+
# exists.
|
|
4680
5031
|
#
|
|
4681
5032
|
# @param card_payment_id [String] The ID of the Card Payment this transaction belongs to.
|
|
4682
5033
|
#
|
|
4683
|
-
# @param cashback [Increase::Models::Transaction::Source::CardSettlement::Cashback, nil]
|
|
5034
|
+
# @param cashback [Increase::Models::Transaction::Source::CardSettlement::Cashback, nil]
|
|
5035
|
+
# Cashback earned on this transaction, if eligible. Cashback is paid out in
|
|
5036
|
+
# aggregate, monthly.
|
|
4684
5037
|
#
|
|
4685
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Currency]
|
|
5038
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Currency]
|
|
5039
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
5040
|
+
# transaction's settlement currency.
|
|
4686
5041
|
#
|
|
4687
|
-
# @param interchange [Increase::Models::Transaction::Source::CardSettlement::Interchange, nil]
|
|
5042
|
+
# @param interchange [Increase::Models::Transaction::Source::CardSettlement::Interchange, nil]
|
|
5043
|
+
# Interchange assessed as a part of this transaction.
|
|
4688
5044
|
#
|
|
4689
|
-
# @param merchant_acceptor_id [String]
|
|
5045
|
+
# @param merchant_acceptor_id [String]
|
|
5046
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
5047
|
+
# is transacting with.
|
|
4690
5048
|
#
|
|
4691
5049
|
# @param merchant_category_code [String] The 4-digit MCC describing the merchant's business.
|
|
4692
5050
|
#
|
|
@@ -4696,29 +5054,44 @@ module Increase
|
|
|
4696
5054
|
#
|
|
4697
5055
|
# @param merchant_name [String] The name of the merchant.
|
|
4698
5056
|
#
|
|
4699
|
-
# @param merchant_postal_code [String, nil]
|
|
5057
|
+
# @param merchant_postal_code [String, nil]
|
|
5058
|
+
# The merchant's postal code. For US merchants this is always a 5-digit ZIP code.
|
|
4700
5059
|
#
|
|
4701
5060
|
# @param merchant_state [String, nil] The state the merchant resides in.
|
|
4702
5061
|
#
|
|
4703
|
-
# @param network [Symbol, Increase::Models::Transaction::Source::CardSettlement::Network]
|
|
5062
|
+
# @param network [Symbol, Increase::Models::Transaction::Source::CardSettlement::Network]
|
|
5063
|
+
# The card network on which this transaction was processed.
|
|
4704
5064
|
#
|
|
4705
|
-
# @param network_identifiers [Increase::Models::Transaction::Source::CardSettlement::NetworkIdentifiers]
|
|
5065
|
+
# @param network_identifiers [Increase::Models::Transaction::Source::CardSettlement::NetworkIdentifiers]
|
|
5066
|
+
# Network-specific identifiers for this refund.
|
|
4706
5067
|
#
|
|
4707
|
-
# @param pending_transaction_id [String, nil]
|
|
5068
|
+
# @param pending_transaction_id [String, nil]
|
|
5069
|
+
# The identifier of the Pending Transaction associated with this Transaction.
|
|
4708
5070
|
#
|
|
4709
|
-
# @param presentment_amount [Integer]
|
|
5071
|
+
# @param presentment_amount [Integer]
|
|
5072
|
+
# The amount in the minor unit of the transaction's presentment currency.
|
|
4710
5073
|
#
|
|
4711
|
-
# @param presentment_currency [String]
|
|
5074
|
+
# @param presentment_currency [String]
|
|
5075
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
5076
|
+
# transaction's presentment currency.
|
|
4712
5077
|
#
|
|
4713
|
-
# @param purchase_details [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails, nil]
|
|
5078
|
+
# @param purchase_details [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails, nil]
|
|
5079
|
+
# Additional details about the card purchase, such as tax and industry-specific
|
|
5080
|
+
# fields.
|
|
4714
5081
|
#
|
|
4715
|
-
# @param scheme_fees [Array<Increase::Models::Transaction::Source::CardSettlement::SchemeFee>]
|
|
5082
|
+
# @param scheme_fees [Array<Increase::Models::Transaction::Source::CardSettlement::SchemeFee>]
|
|
5083
|
+
# The scheme fees associated with this card settlement.
|
|
4716
5084
|
#
|
|
4717
|
-
# @param surcharge [Increase::Models::Transaction::Source::CardSettlement::Surcharge, nil]
|
|
5085
|
+
# @param surcharge [Increase::Models::Transaction::Source::CardSettlement::Surcharge, nil]
|
|
5086
|
+
# Surcharge amount details, if applicable. The amount is positive if the surcharge
|
|
5087
|
+
# is added to the overall transaction amount (surcharge), and negative if the
|
|
5088
|
+
# surcharge is deducted from the overall transaction amount (discount).
|
|
4718
5089
|
#
|
|
4719
5090
|
# @param transaction_id [String] The identifier of the Transaction associated with this Transaction.
|
|
4720
5091
|
#
|
|
4721
|
-
# @param type [Symbol, Increase::Models::Transaction::Source::CardSettlement::Type]
|
|
5092
|
+
# @param type [Symbol, Increase::Models::Transaction::Source::CardSettlement::Type]
|
|
5093
|
+
# A constant representing the object's type. For this resource it will always be
|
|
5094
|
+
# `card_settlement`.
|
|
4722
5095
|
|
|
4723
5096
|
# @see Increase::Models::Transaction::Source::CardSettlement#cashback
|
|
4724
5097
|
class Cashback < Increase::Internal::Type::BaseModel
|
|
@@ -4737,16 +5110,16 @@ module Increase
|
|
|
4737
5110
|
required :currency, enum: -> { Increase::Transaction::Source::CardSettlement::Cashback::Currency }
|
|
4738
5111
|
|
|
4739
5112
|
# @!method initialize(amount:, currency:)
|
|
4740
|
-
# Some parameter documentations has been truncated, see
|
|
4741
|
-
# {Increase::Models::Transaction::Source::CardSettlement::Cashback} for more
|
|
4742
|
-
# details.
|
|
4743
|
-
#
|
|
4744
5113
|
# Cashback earned on this transaction, if eligible. Cashback is paid out in
|
|
4745
5114
|
# aggregate, monthly.
|
|
4746
5115
|
#
|
|
4747
|
-
# @param amount [String]
|
|
5116
|
+
# @param amount [String]
|
|
5117
|
+
# The cashback amount given as a string containing a decimal number. The amount is
|
|
5118
|
+
# a positive number if it will be credited to you (e.g., settlements) and a
|
|
5119
|
+
# negative number if it will be debited (e.g., refunds).
|
|
4748
5120
|
#
|
|
4749
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Cashback::Currency]
|
|
5121
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Cashback::Currency]
|
|
5122
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
|
|
4750
5123
|
|
|
4751
5124
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
|
|
4752
5125
|
#
|
|
@@ -4801,17 +5174,19 @@ module Increase
|
|
|
4801
5174
|
required :currency, enum: -> { Increase::Transaction::Source::CardSettlement::Interchange::Currency }
|
|
4802
5175
|
|
|
4803
5176
|
# @!method initialize(amount:, code:, currency:)
|
|
4804
|
-
# Some parameter documentations has been truncated, see
|
|
4805
|
-
# {Increase::Models::Transaction::Source::CardSettlement::Interchange} for more
|
|
4806
|
-
# details.
|
|
4807
|
-
#
|
|
4808
5177
|
# Interchange assessed as a part of this transaction.
|
|
4809
5178
|
#
|
|
4810
|
-
# @param amount [String]
|
|
5179
|
+
# @param amount [String]
|
|
5180
|
+
# The interchange amount given as a string containing a decimal number in major
|
|
5181
|
+
# units (so e.g., "3.14" for $3.14). The amount is a positive number if it is
|
|
5182
|
+
# credited to Increase (e.g., settlements) and a negative number if it is debited
|
|
5183
|
+
# (e.g., refunds).
|
|
4811
5184
|
#
|
|
4812
5185
|
# @param code [String, nil] The card network specific interchange code.
|
|
4813
5186
|
#
|
|
4814
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Interchange::Currency]
|
|
5187
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::Interchange::Currency]
|
|
5188
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
|
|
5189
|
+
# reimbursement.
|
|
4815
5190
|
|
|
4816
5191
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
|
|
4817
5192
|
# reimbursement.
|
|
@@ -4874,19 +5249,21 @@ module Increase
|
|
|
4874
5249
|
required :transaction_id, String, nil?: true
|
|
4875
5250
|
|
|
4876
5251
|
# @!method initialize(acquirer_business_id:, acquirer_reference_number:, authorization_identification_response:, transaction_id:)
|
|
4877
|
-
# Some parameter documentations has been truncated, see
|
|
4878
|
-
# {Increase::Models::Transaction::Source::CardSettlement::NetworkIdentifiers} for
|
|
4879
|
-
# more details.
|
|
4880
|
-
#
|
|
4881
5252
|
# Network-specific identifiers for this refund.
|
|
4882
5253
|
#
|
|
4883
|
-
# @param acquirer_business_id [String]
|
|
5254
|
+
# @param acquirer_business_id [String]
|
|
5255
|
+
# A network assigned business ID that identifies the acquirer that processed this
|
|
5256
|
+
# transaction.
|
|
4884
5257
|
#
|
|
4885
5258
|
# @param acquirer_reference_number [String] A globally unique identifier for this settlement.
|
|
4886
5259
|
#
|
|
4887
|
-
# @param authorization_identification_response [String, nil]
|
|
5260
|
+
# @param authorization_identification_response [String, nil]
|
|
5261
|
+
# The randomly generated 6-character Authorization Identification Response code
|
|
5262
|
+
# sent back to the acquirer in an approved response.
|
|
4888
5263
|
#
|
|
4889
|
-
# @param transaction_id [String, nil]
|
|
5264
|
+
# @param transaction_id [String, nil]
|
|
5265
|
+
# A globally unique transaction identifier provided by the card network, used
|
|
5266
|
+
# across multiple life-cycle requests.
|
|
4890
5267
|
end
|
|
4891
5268
|
|
|
4892
5269
|
# @see Increase::Models::Transaction::Source::CardSettlement#purchase_details
|
|
@@ -4964,32 +5341,38 @@ module Increase
|
|
|
4964
5341
|
nil?: true
|
|
4965
5342
|
|
|
4966
5343
|
# @!method initialize(car_rental:, customer_reference_identifier:, local_tax_amount:, local_tax_currency:, lodging:, national_tax_amount:, national_tax_currency:, purchase_identifier:, purchase_identifier_format:, travel:)
|
|
4967
|
-
# Some parameter documentations has been truncated, see
|
|
4968
|
-
# {Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails} for
|
|
4969
|
-
# more details.
|
|
4970
|
-
#
|
|
4971
5344
|
# Additional details about the card purchase, such as tax and industry-specific
|
|
4972
5345
|
# fields.
|
|
4973
5346
|
#
|
|
4974
|
-
# @param car_rental [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental, nil]
|
|
5347
|
+
# @param car_rental [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental, nil]
|
|
5348
|
+
# Fields specific to car rentals.
|
|
4975
5349
|
#
|
|
4976
|
-
# @param customer_reference_identifier [String, nil]
|
|
5350
|
+
# @param customer_reference_identifier [String, nil]
|
|
5351
|
+
# An identifier from the merchant for the customer or consumer.
|
|
4977
5352
|
#
|
|
4978
5353
|
# @param local_tax_amount [Integer, nil] The state or provincial tax amount in minor units.
|
|
4979
5354
|
#
|
|
4980
|
-
# @param local_tax_currency [String, nil]
|
|
5355
|
+
# @param local_tax_currency [String, nil]
|
|
5356
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
|
|
5357
|
+
# assessed.
|
|
4981
5358
|
#
|
|
4982
|
-
# @param lodging [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging, nil]
|
|
5359
|
+
# @param lodging [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging, nil]
|
|
5360
|
+
# Fields specific to lodging.
|
|
4983
5361
|
#
|
|
4984
5362
|
# @param national_tax_amount [Integer, nil] The national tax amount in minor units.
|
|
4985
5363
|
#
|
|
4986
|
-
# @param national_tax_currency [String, nil]
|
|
5364
|
+
# @param national_tax_currency [String, nil]
|
|
5365
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
|
|
5366
|
+
# assessed.
|
|
4987
5367
|
#
|
|
4988
|
-
# @param purchase_identifier [String, nil]
|
|
5368
|
+
# @param purchase_identifier [String, nil]
|
|
5369
|
+
# An identifier from the merchant for the purchase to the issuer and cardholder.
|
|
4989
5370
|
#
|
|
4990
|
-
# @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat, nil]
|
|
5371
|
+
# @param purchase_identifier_format [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::PurchaseIdentifierFormat, nil]
|
|
5372
|
+
# The format of the purchase identifier.
|
|
4991
5373
|
#
|
|
4992
|
-
# @param travel [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel, nil]
|
|
5374
|
+
# @param travel [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel, nil]
|
|
5375
|
+
# Fields specific to travel.
|
|
4993
5376
|
|
|
4994
5377
|
# @see Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails#car_rental
|
|
4995
5378
|
class CarRental < Increase::Internal::Type::BaseModel
|
|
@@ -5106,43 +5489,56 @@ module Increase
|
|
|
5106
5489
|
required :weekly_rental_rate_currency, String, nil?: true
|
|
5107
5490
|
|
|
5108
5491
|
# @!method initialize(car_class_code:, checkout_date:, daily_rental_rate_amount:, daily_rental_rate_currency:, days_rented:, extra_charges:, fuel_charges_amount:, fuel_charges_currency:, insurance_charges_amount:, insurance_charges_currency:, no_show_indicator:, one_way_drop_off_charges_amount:, one_way_drop_off_charges_currency:, renter_name:, weekly_rental_rate_amount:, weekly_rental_rate_currency:)
|
|
5109
|
-
# Some parameter documentations has been truncated, see
|
|
5110
|
-
# {Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental}
|
|
5111
|
-
# for more details.
|
|
5112
|
-
#
|
|
5113
5492
|
# Fields specific to car rentals.
|
|
5114
5493
|
#
|
|
5115
5494
|
# @param car_class_code [String, nil] Code indicating the vehicle's class.
|
|
5116
5495
|
#
|
|
5117
|
-
# @param checkout_date [Date, nil]
|
|
5496
|
+
# @param checkout_date [Date, nil]
|
|
5497
|
+
# Date the customer picked up the car or, in the case of a no-show or pre-pay
|
|
5498
|
+
# transaction, the scheduled pick up date.
|
|
5118
5499
|
#
|
|
5119
5500
|
# @param daily_rental_rate_amount [Integer, nil] Daily rate being charged for the vehicle.
|
|
5120
5501
|
#
|
|
5121
|
-
# @param daily_rental_rate_currency [String, nil]
|
|
5502
|
+
# @param daily_rental_rate_currency [String, nil]
|
|
5503
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
|
|
5504
|
+
# rate.
|
|
5122
5505
|
#
|
|
5123
5506
|
# @param days_rented [Integer, nil] Number of days the vehicle was rented.
|
|
5124
5507
|
#
|
|
5125
|
-
# @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::ExtraCharges, nil]
|
|
5508
|
+
# @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::ExtraCharges, nil]
|
|
5509
|
+
# Additional charges (gas, late fee, etc.) being billed.
|
|
5126
5510
|
#
|
|
5127
5511
|
# @param fuel_charges_amount [Integer, nil] Fuel charges for the vehicle.
|
|
5128
5512
|
#
|
|
5129
|
-
# @param fuel_charges_currency [String, nil]
|
|
5513
|
+
# @param fuel_charges_currency [String, nil]
|
|
5514
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
|
|
5515
|
+
# assessed.
|
|
5130
5516
|
#
|
|
5131
5517
|
# @param insurance_charges_amount [Integer, nil] Any insurance being charged for the vehicle.
|
|
5132
5518
|
#
|
|
5133
|
-
# @param insurance_charges_currency [String, nil]
|
|
5519
|
+
# @param insurance_charges_currency [String, nil]
|
|
5520
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
|
|
5521
|
+
# charges assessed.
|
|
5134
5522
|
#
|
|
5135
|
-
# @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator, nil]
|
|
5523
|
+
# @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::CarRental::NoShowIndicator, nil]
|
|
5524
|
+
# An indicator that the cardholder is being billed for a reserved vehicle that was
|
|
5525
|
+
# not actually rented (that is, a "no-show" charge).
|
|
5136
5526
|
#
|
|
5137
|
-
# @param one_way_drop_off_charges_amount [Integer, nil]
|
|
5527
|
+
# @param one_way_drop_off_charges_amount [Integer, nil]
|
|
5528
|
+
# Charges for returning the vehicle at a different location than where it was
|
|
5529
|
+
# picked up.
|
|
5138
5530
|
#
|
|
5139
|
-
# @param one_way_drop_off_charges_currency [String, nil]
|
|
5531
|
+
# @param one_way_drop_off_charges_currency [String, nil]
|
|
5532
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
|
|
5533
|
+
# drop-off charges assessed.
|
|
5140
5534
|
#
|
|
5141
5535
|
# @param renter_name [String, nil] Name of the person renting the vehicle.
|
|
5142
5536
|
#
|
|
5143
5537
|
# @param weekly_rental_rate_amount [Integer, nil] Weekly rate being charged for the vehicle.
|
|
5144
5538
|
#
|
|
5145
|
-
# @param weekly_rental_rate_currency [String, nil]
|
|
5539
|
+
# @param weekly_rental_rate_currency [String, nil]
|
|
5540
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
|
|
5541
|
+
# rental rate.
|
|
5146
5542
|
|
|
5147
5543
|
# Additional charges (gas, late fee, etc.) being billed.
|
|
5148
5544
|
#
|
|
@@ -5304,43 +5700,54 @@ module Increase
|
|
|
5304
5700
|
required :total_tax_currency, String, nil?: true
|
|
5305
5701
|
|
|
5306
5702
|
# @!method initialize(check_in_date:, daily_room_rate_amount:, daily_room_rate_currency:, extra_charges:, folio_cash_advances_amount:, folio_cash_advances_currency:, food_beverage_charges_amount:, food_beverage_charges_currency:, no_show_indicator:, prepaid_expenses_amount:, prepaid_expenses_currency:, room_nights:, total_room_tax_amount:, total_room_tax_currency:, total_tax_amount:, total_tax_currency:)
|
|
5307
|
-
# Some parameter documentations has been truncated, see
|
|
5308
|
-
# {Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging}
|
|
5309
|
-
# for more details.
|
|
5310
|
-
#
|
|
5311
5703
|
# Fields specific to lodging.
|
|
5312
5704
|
#
|
|
5313
5705
|
# @param check_in_date [Date, nil] Date the customer checked in.
|
|
5314
5706
|
#
|
|
5315
5707
|
# @param daily_room_rate_amount [Integer, nil] Daily rate being charged for the room.
|
|
5316
5708
|
#
|
|
5317
|
-
# @param daily_room_rate_currency [String, nil]
|
|
5709
|
+
# @param daily_room_rate_currency [String, nil]
|
|
5710
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
|
|
5711
|
+
# rate.
|
|
5318
5712
|
#
|
|
5319
|
-
# @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil]
|
|
5713
|
+
# @param extra_charges [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::ExtraCharges, nil]
|
|
5714
|
+
# Additional charges (phone, late check-out, etc.) being billed.
|
|
5320
5715
|
#
|
|
5321
5716
|
# @param folio_cash_advances_amount [Integer, nil] Folio cash advances for the room.
|
|
5322
5717
|
#
|
|
5323
|
-
# @param folio_cash_advances_currency [String, nil]
|
|
5718
|
+
# @param folio_cash_advances_currency [String, nil]
|
|
5719
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
|
|
5720
|
+
# advances.
|
|
5324
5721
|
#
|
|
5325
5722
|
# @param food_beverage_charges_amount [Integer, nil] Food and beverage charges for the room.
|
|
5326
5723
|
#
|
|
5327
|
-
# @param food_beverage_charges_currency [String, nil]
|
|
5724
|
+
# @param food_beverage_charges_currency [String, nil]
|
|
5725
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
|
|
5726
|
+
# beverage charges.
|
|
5328
5727
|
#
|
|
5329
|
-
# @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil]
|
|
5728
|
+
# @param no_show_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Lodging::NoShowIndicator, nil]
|
|
5729
|
+
# Indicator that the cardholder is being billed for a reserved room that was not
|
|
5730
|
+
# actually used.
|
|
5330
5731
|
#
|
|
5331
5732
|
# @param prepaid_expenses_amount [Integer, nil] Prepaid expenses being charged for the room.
|
|
5332
5733
|
#
|
|
5333
|
-
# @param prepaid_expenses_currency [String, nil]
|
|
5734
|
+
# @param prepaid_expenses_currency [String, nil]
|
|
5735
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
|
|
5736
|
+
# expenses.
|
|
5334
5737
|
#
|
|
5335
5738
|
# @param room_nights [Integer, nil] Number of nights the room was rented.
|
|
5336
5739
|
#
|
|
5337
5740
|
# @param total_room_tax_amount [Integer, nil] Total room tax being charged.
|
|
5338
5741
|
#
|
|
5339
|
-
# @param total_room_tax_currency [String, nil]
|
|
5742
|
+
# @param total_room_tax_currency [String, nil]
|
|
5743
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
|
|
5744
|
+
# tax.
|
|
5340
5745
|
#
|
|
5341
5746
|
# @param total_tax_amount [Integer, nil] Total tax being charged for the room.
|
|
5342
5747
|
#
|
|
5343
|
-
# @param total_tax_currency [String, nil]
|
|
5748
|
+
# @param total_tax_currency [String, nil]
|
|
5749
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
|
|
5750
|
+
# assessed.
|
|
5344
5751
|
|
|
5345
5752
|
# Additional charges (phone, late check-out, etc.) being billed.
|
|
5346
5753
|
#
|
|
@@ -5513,11 +5920,14 @@ module Increase
|
|
|
5513
5920
|
# @!method initialize(ancillary:, computerized_reservation_system:, credit_reason_indicator:, departure_date:, origination_city_airport_code:, passenger_name:, restricted_ticket_indicator:, ticket_change_indicator:, ticket_number:, travel_agency_code:, travel_agency_name:, trip_legs:)
|
|
5514
5921
|
# Fields specific to travel.
|
|
5515
5922
|
#
|
|
5516
|
-
# @param ancillary [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary, nil]
|
|
5923
|
+
# @param ancillary [Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary, nil]
|
|
5924
|
+
# Ancillary purchases in addition to the airfare.
|
|
5517
5925
|
#
|
|
5518
|
-
# @param computerized_reservation_system [String, nil]
|
|
5926
|
+
# @param computerized_reservation_system [String, nil]
|
|
5927
|
+
# Indicates the computerized reservation system used to book the ticket.
|
|
5519
5928
|
#
|
|
5520
|
-
# @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator, nil]
|
|
5929
|
+
# @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::CreditReasonIndicator, nil]
|
|
5930
|
+
# Indicates the reason for a credit to the cardholder.
|
|
5521
5931
|
#
|
|
5522
5932
|
# @param departure_date [Date, nil] Date of departure.
|
|
5523
5933
|
#
|
|
@@ -5525,17 +5935,22 @@ module Increase
|
|
|
5525
5935
|
#
|
|
5526
5936
|
# @param passenger_name [String, nil] Name of the passenger.
|
|
5527
5937
|
#
|
|
5528
|
-
# @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator, nil]
|
|
5938
|
+
# @param restricted_ticket_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::RestrictedTicketIndicator, nil]
|
|
5939
|
+
# Indicates whether this ticket is non-refundable.
|
|
5529
5940
|
#
|
|
5530
|
-
# @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator, nil]
|
|
5941
|
+
# @param ticket_change_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TicketChangeIndicator, nil]
|
|
5942
|
+
# Indicates why a ticket was changed.
|
|
5531
5943
|
#
|
|
5532
5944
|
# @param ticket_number [String, nil] Ticket number.
|
|
5533
5945
|
#
|
|
5534
|
-
# @param travel_agency_code [String, nil]
|
|
5946
|
+
# @param travel_agency_code [String, nil]
|
|
5947
|
+
# Code for the travel agency if the ticket was issued by a travel agency.
|
|
5535
5948
|
#
|
|
5536
|
-
# @param travel_agency_name [String, nil]
|
|
5949
|
+
# @param travel_agency_name [String, nil]
|
|
5950
|
+
# Name of the travel agency if the ticket was issued by a travel agency.
|
|
5537
5951
|
#
|
|
5538
|
-
# @param trip_legs [Array<Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg>, nil]
|
|
5952
|
+
# @param trip_legs [Array<Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg>, nil]
|
|
5953
|
+
# Fields specific to each leg of the journey.
|
|
5539
5954
|
|
|
5540
5955
|
# @see Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel#ancillary
|
|
5541
5956
|
class Ancillary < Increase::Internal::Type::BaseModel
|
|
@@ -5577,19 +5992,21 @@ module Increase
|
|
|
5577
5992
|
required :ticket_document_number, String, nil?: true
|
|
5578
5993
|
|
|
5579
5994
|
# @!method initialize(connected_ticket_document_number:, credit_reason_indicator:, passenger_name_or_description:, services:, ticket_document_number:)
|
|
5580
|
-
# Some parameter documentations has been truncated, see
|
|
5581
|
-
# {Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary}
|
|
5582
|
-
# for more details.
|
|
5583
|
-
#
|
|
5584
5995
|
# Ancillary purchases in addition to the airfare.
|
|
5585
5996
|
#
|
|
5586
|
-
# @param connected_ticket_document_number [String, nil]
|
|
5997
|
+
# @param connected_ticket_document_number [String, nil]
|
|
5998
|
+
# If this purchase has a connection or relationship to another purchase, such as a
|
|
5999
|
+
# baggage fee for a passenger transport ticket, this field should contain the
|
|
6000
|
+
# ticket document number for the other purchase.
|
|
5587
6001
|
#
|
|
5588
|
-
# @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil]
|
|
6002
|
+
# @param credit_reason_indicator [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::CreditReasonIndicator, nil]
|
|
6003
|
+
# Indicates the reason for a credit to the cardholder.
|
|
5589
6004
|
#
|
|
5590
|
-
# @param passenger_name_or_description [String, nil]
|
|
6005
|
+
# @param passenger_name_or_description [String, nil]
|
|
6006
|
+
# Name of the passenger or description of the ancillary purchase.
|
|
5591
6007
|
#
|
|
5592
|
-
# @param services [Array<Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service>]
|
|
6008
|
+
# @param services [Array<Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service>]
|
|
6009
|
+
# Additional travel charges, such as baggage fees.
|
|
5593
6010
|
#
|
|
5594
6011
|
# @param ticket_document_number [String, nil] Ticket document number.
|
|
5595
6012
|
|
|
@@ -5635,7 +6052,8 @@ module Increase
|
|
|
5635
6052
|
required :sub_category, String, nil?: true
|
|
5636
6053
|
|
|
5637
6054
|
# @!method initialize(category:, sub_category:)
|
|
5638
|
-
# @param category [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category, nil]
|
|
6055
|
+
# @param category [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::Ancillary::Service::Category, nil]
|
|
6056
|
+
# Category of the ancillary service.
|
|
5639
6057
|
#
|
|
5640
6058
|
# @param sub_category [String, nil] Sub-category of the ancillary service, free-form.
|
|
5641
6059
|
|
|
@@ -5840,7 +6258,8 @@ module Increase
|
|
|
5840
6258
|
#
|
|
5841
6259
|
# @param service_class [String, nil] Service class (e.g., first class, business class, etc.).
|
|
5842
6260
|
#
|
|
5843
|
-
# @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode, nil]
|
|
6261
|
+
# @param stop_over_code [Symbol, Increase::Models::Transaction::Source::CardSettlement::PurchaseDetails::Travel::TripLeg::StopOverCode, nil]
|
|
6262
|
+
# Indicates whether a stopover is allowed on this ticket.
|
|
5844
6263
|
|
|
5845
6264
|
# Indicates whether a stopover is allowed on this ticket.
|
|
5846
6265
|
#
|
|
@@ -5906,21 +6325,26 @@ module Increase
|
|
|
5906
6325
|
required :variable_rate, String, nil?: true
|
|
5907
6326
|
|
|
5908
6327
|
# @!method initialize(amount:, created_at:, currency:, fee_type:, fixed_component:, variable_rate:)
|
|
5909
|
-
# Some parameter documentations has been truncated, see
|
|
5910
|
-
# {Increase::Models::Transaction::Source::CardSettlement::SchemeFee} for more
|
|
5911
|
-
# details.
|
|
5912
|
-
#
|
|
5913
6328
|
# @param amount [String] The fee amount given as a string containing a decimal number.
|
|
5914
6329
|
#
|
|
5915
|
-
# @param created_at [Time]
|
|
6330
|
+
# @param created_at [Time]
|
|
6331
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was
|
|
6332
|
+
# created.
|
|
5916
6333
|
#
|
|
5917
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::SchemeFee::Currency]
|
|
6334
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CardSettlement::SchemeFee::Currency]
|
|
6335
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
|
|
6336
|
+
# reimbursement.
|
|
5918
6337
|
#
|
|
5919
|
-
# @param fee_type [Symbol, Increase::Models::Transaction::Source::CardSettlement::SchemeFee::FeeType]
|
|
6338
|
+
# @param fee_type [Symbol, Increase::Models::Transaction::Source::CardSettlement::SchemeFee::FeeType]
|
|
6339
|
+
# The type of fee being assessed.
|
|
5920
6340
|
#
|
|
5921
|
-
# @param fixed_component [String, nil]
|
|
6341
|
+
# @param fixed_component [String, nil]
|
|
6342
|
+
# The fixed component of the fee, if applicable, given in major units of the fee
|
|
6343
|
+
# amount.
|
|
5922
6344
|
#
|
|
5923
|
-
# @param variable_rate [String, nil]
|
|
6345
|
+
# @param variable_rate [String, nil]
|
|
6346
|
+
# The variable rate component of the fee, if applicable, given as a decimal (e.g.,
|
|
6347
|
+
# 0.015 for 1.5%).
|
|
5924
6348
|
|
|
5925
6349
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee
|
|
5926
6350
|
# reimbursement.
|
|
@@ -6053,17 +6477,15 @@ module Increase
|
|
|
6053
6477
|
required :presentment_amount, Integer
|
|
6054
6478
|
|
|
6055
6479
|
# @!method initialize(amount:, presentment_amount:)
|
|
6056
|
-
# Some parameter documentations has been truncated, see
|
|
6057
|
-
# {Increase::Models::Transaction::Source::CardSettlement::Surcharge} for more
|
|
6058
|
-
# details.
|
|
6059
|
-
#
|
|
6060
6480
|
# Surcharge amount details, if applicable. The amount is positive if the surcharge
|
|
6061
6481
|
# is added to the overall transaction amount (surcharge), and negative if the
|
|
6062
6482
|
# surcharge is deducted from the overall transaction amount (discount).
|
|
6063
6483
|
#
|
|
6064
6484
|
# @param amount [Integer] The surcharge amount in the minor unit of the transaction's settlement currency.
|
|
6065
6485
|
#
|
|
6066
|
-
# @param presentment_amount [Integer]
|
|
6486
|
+
# @param presentment_amount [Integer]
|
|
6487
|
+
# The surcharge amount in the minor unit of the transaction's presentment
|
|
6488
|
+
# currency.
|
|
6067
6489
|
end
|
|
6068
6490
|
|
|
6069
6491
|
# A constant representing the object's type. For this resource it will always be
|
|
@@ -6115,9 +6537,6 @@ module Increase
|
|
|
6115
6537
|
required :period_start, Time
|
|
6116
6538
|
|
|
6117
6539
|
# @!method initialize(accrued_on_card_id:, amount:, currency:, period_end:, period_start:)
|
|
6118
|
-
# Some parameter documentations has been truncated, see
|
|
6119
|
-
# {Increase::Models::Transaction::Source::CashbackPayment} for more details.
|
|
6120
|
-
#
|
|
6121
6540
|
# A Cashback Payment object. This field will be present in the JSON response if
|
|
6122
6541
|
# and only if `category` is equal to `cashback_payment`. A Cashback Payment
|
|
6123
6542
|
# represents the cashback paid to a cardholder for a given period. Cashback is
|
|
@@ -6125,9 +6544,13 @@ module Increase
|
|
|
6125
6544
|
#
|
|
6126
6545
|
# @param accrued_on_card_id [String, nil] The card on which the cashback was accrued.
|
|
6127
6546
|
#
|
|
6128
|
-
# @param amount [Integer]
|
|
6547
|
+
# @param amount [Integer]
|
|
6548
|
+
# The amount in the minor unit of the transaction's currency. For dollars, for
|
|
6549
|
+
# example, this is cents.
|
|
6129
6550
|
#
|
|
6130
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CashbackPayment::Currency]
|
|
6551
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CashbackPayment::Currency]
|
|
6552
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
|
|
6553
|
+
# currency.
|
|
6131
6554
|
#
|
|
6132
6555
|
# @param period_end [Time] The end of the period for which this transaction paid cashback.
|
|
6133
6556
|
#
|
|
@@ -6199,29 +6622,37 @@ module Increase
|
|
|
6199
6622
|
required :serial_number, String, nil?: true
|
|
6200
6623
|
|
|
6201
6624
|
# @!method initialize(account_number:, amount:, auxiliary_on_us:, check_deposit_id:, currency:, routing_number:, serial_number:)
|
|
6202
|
-
# Some parameter documentations has been truncated, see
|
|
6203
|
-
# {Increase::Models::Transaction::Source::CheckDepositAcceptance} for more
|
|
6204
|
-
# details.
|
|
6205
|
-
#
|
|
6206
6625
|
# A Check Deposit Acceptance object. This field will be present in the JSON
|
|
6207
6626
|
# response if and only if `category` is equal to `check_deposit_acceptance`. A
|
|
6208
6627
|
# Check Deposit Acceptance is created when a Check Deposit is processed and its
|
|
6209
6628
|
# details confirmed. Check Deposits may be returned by the receiving bank, which
|
|
6210
6629
|
# will appear as a Check Deposit Return.
|
|
6211
6630
|
#
|
|
6212
|
-
# @param account_number [String]
|
|
6631
|
+
# @param account_number [String]
|
|
6632
|
+
# The account number printed on the check. This is an account at the bank that
|
|
6633
|
+
# issued the check.
|
|
6213
6634
|
#
|
|
6214
|
-
# @param amount [Integer]
|
|
6635
|
+
# @param amount [Integer]
|
|
6636
|
+
# The amount to be deposited in the minor unit of the transaction's currency. For
|
|
6637
|
+
# dollars, for example, this is cents.
|
|
6215
6638
|
#
|
|
6216
|
-
# @param auxiliary_on_us [String, nil]
|
|
6639
|
+
# @param auxiliary_on_us [String, nil]
|
|
6640
|
+
# An additional line of metadata printed on the check. This typically includes the
|
|
6641
|
+
# check number for business checks.
|
|
6217
6642
|
#
|
|
6218
6643
|
# @param check_deposit_id [String] The ID of the Check Deposit that was accepted.
|
|
6219
6644
|
#
|
|
6220
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositAcceptance::Currency]
|
|
6645
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositAcceptance::Currency]
|
|
6646
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
6647
|
+
# transaction's currency.
|
|
6221
6648
|
#
|
|
6222
|
-
# @param routing_number [String]
|
|
6649
|
+
# @param routing_number [String]
|
|
6650
|
+
# The routing number printed on the check. This is a routing number for the bank
|
|
6651
|
+
# that issued the check.
|
|
6223
6652
|
#
|
|
6224
|
-
# @param serial_number [String, nil]
|
|
6653
|
+
# @param serial_number [String, nil]
|
|
6654
|
+
# The check serial number, if present, for consumer checks. For business checks,
|
|
6655
|
+
# the serial number is usually in the `auxiliary_on_us` field.
|
|
6225
6656
|
|
|
6226
6657
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
6227
6658
|
# transaction's currency.
|
|
@@ -6281,9 +6712,6 @@ module Increase
|
|
|
6281
6712
|
required :transaction_id, String
|
|
6282
6713
|
|
|
6283
6714
|
# @!method initialize(amount:, check_deposit_id:, currency:, return_reason:, returned_at:, transaction_id:)
|
|
6284
|
-
# Some parameter documentations has been truncated, see
|
|
6285
|
-
# {Increase::Models::Transaction::Source::CheckDepositReturn} for more details.
|
|
6286
|
-
#
|
|
6287
6715
|
# A Check Deposit Return object. This field will be present in the JSON response
|
|
6288
6716
|
# if and only if `category` is equal to `check_deposit_return`. A Check Deposit
|
|
6289
6717
|
# Return is created when a Check Deposit is returned by the bank holding the
|
|
@@ -6295,13 +6723,21 @@ module Increase
|
|
|
6295
6723
|
#
|
|
6296
6724
|
# @param check_deposit_id [String] The identifier of the Check Deposit that was returned.
|
|
6297
6725
|
#
|
|
6298
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::Currency]
|
|
6726
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::Currency]
|
|
6727
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
6728
|
+
# transaction's currency.
|
|
6299
6729
|
#
|
|
6300
|
-
# @param return_reason [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::ReturnReason]
|
|
6730
|
+
# @param return_reason [Symbol, Increase::Models::Transaction::Source::CheckDepositReturn::ReturnReason]
|
|
6731
|
+
# Why this check was returned by the bank holding the account it was drawn
|
|
6732
|
+
# against.
|
|
6301
6733
|
#
|
|
6302
|
-
# @param returned_at [Time]
|
|
6734
|
+
# @param returned_at [Time]
|
|
6735
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
6736
|
+
# the check deposit was returned.
|
|
6303
6737
|
#
|
|
6304
|
-
# @param transaction_id [String]
|
|
6738
|
+
# @param transaction_id [String]
|
|
6739
|
+
# The identifier of the transaction that reversed the original check deposit
|
|
6740
|
+
# transaction.
|
|
6305
6741
|
|
|
6306
6742
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
6307
6743
|
# transaction's currency.
|
|
@@ -6464,29 +6900,38 @@ module Increase
|
|
|
6464
6900
|
required :type, enum: -> { Increase::Transaction::Source::CheckTransferDeposit::Type }
|
|
6465
6901
|
|
|
6466
6902
|
# @!method initialize(back_image_file_id:, bank_of_first_deposit_routing_number:, deposited_at:, front_image_file_id:, inbound_check_deposit_id:, transaction_id:, transfer_id:, type:)
|
|
6467
|
-
# Some parameter documentations has been truncated, see
|
|
6468
|
-
# {Increase::Models::Transaction::Source::CheckTransferDeposit} for more details.
|
|
6469
|
-
#
|
|
6470
6903
|
# A Check Transfer Deposit object. This field will be present in the JSON response
|
|
6471
6904
|
# if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check
|
|
6472
6905
|
# is a check drawn on an Increase account that has been deposited by an external
|
|
6473
6906
|
# bank account. These types of checks are not pre-registered.
|
|
6474
6907
|
#
|
|
6475
|
-
# @param back_image_file_id [String, nil]
|
|
6908
|
+
# @param back_image_file_id [String, nil]
|
|
6909
|
+
# The identifier of the API File object containing an image of the back of the
|
|
6910
|
+
# deposited check.
|
|
6476
6911
|
#
|
|
6477
|
-
# @param bank_of_first_deposit_routing_number [String, nil]
|
|
6912
|
+
# @param bank_of_first_deposit_routing_number [String, nil]
|
|
6913
|
+
# The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
|
|
6914
|
+
# bank depositing this check. In some rare cases, this is not transmitted via
|
|
6915
|
+
# Check21 and the value will be null.
|
|
6478
6916
|
#
|
|
6479
6917
|
# @param deposited_at [Time] When the check was deposited.
|
|
6480
6918
|
#
|
|
6481
|
-
# @param front_image_file_id [String, nil]
|
|
6919
|
+
# @param front_image_file_id [String, nil]
|
|
6920
|
+
# The identifier of the API File object containing an image of the front of the
|
|
6921
|
+
# deposited check.
|
|
6482
6922
|
#
|
|
6483
|
-
# @param inbound_check_deposit_id [String, nil]
|
|
6923
|
+
# @param inbound_check_deposit_id [String, nil]
|
|
6924
|
+
# The identifier of the Inbound Check Deposit object associated with this
|
|
6925
|
+
# transaction.
|
|
6484
6926
|
#
|
|
6485
|
-
# @param transaction_id [String, nil]
|
|
6927
|
+
# @param transaction_id [String, nil]
|
|
6928
|
+
# The identifier of the Transaction object created when the check was deposited.
|
|
6486
6929
|
#
|
|
6487
6930
|
# @param transfer_id [String, nil] The identifier of the Check Transfer object that was deposited.
|
|
6488
6931
|
#
|
|
6489
|
-
# @param type [Symbol, Increase::Models::Transaction::Source::CheckTransferDeposit::Type]
|
|
6932
|
+
# @param type [Symbol, Increase::Models::Transaction::Source::CheckTransferDeposit::Type]
|
|
6933
|
+
# A constant representing the object's type. For this resource it will always be
|
|
6934
|
+
# `check_transfer_deposit`.
|
|
6490
6935
|
|
|
6491
6936
|
# A constant representing the object's type. For this resource it will always be
|
|
6492
6937
|
# `check_transfer_deposit`.
|
|
@@ -6548,16 +6993,17 @@ module Increase
|
|
|
6548
6993
|
required :program_id, String, nil?: true
|
|
6549
6994
|
|
|
6550
6995
|
# @!method initialize(amount:, currency:, fee_period_start:, program_id:)
|
|
6551
|
-
# Some parameter documentations has been truncated, see
|
|
6552
|
-
# {Increase::Models::Transaction::Source::FeePayment} for more details.
|
|
6553
|
-
#
|
|
6554
6996
|
# A Fee Payment object. This field will be present in the JSON response if and
|
|
6555
6997
|
# only if `category` is equal to `fee_payment`. A Fee Payment represents a payment
|
|
6556
6998
|
# made to Increase.
|
|
6557
6999
|
#
|
|
6558
|
-
# @param amount [Integer]
|
|
7000
|
+
# @param amount [Integer]
|
|
7001
|
+
# The amount in the minor unit of the transaction's currency. For dollars, for
|
|
7002
|
+
# example, this is cents.
|
|
6559
7003
|
#
|
|
6560
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::FeePayment::Currency]
|
|
7004
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::FeePayment::Currency]
|
|
7005
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
|
|
7006
|
+
# currency.
|
|
6561
7007
|
#
|
|
6562
7008
|
# @param fee_period_start [Date] The start of this payment's fee period, usually the first day of a month.
|
|
6563
7009
|
#
|
|
@@ -6653,33 +7099,41 @@ module Increase
|
|
|
6653
7099
|
required :transfer_id, String
|
|
6654
7100
|
|
|
6655
7101
|
# @!method initialize(addenda:, amount:, originator_company_descriptive_date:, originator_company_discretionary_data:, originator_company_entry_description:, originator_company_id:, originator_company_name:, receiver_id_number:, receiver_name:, trace_number:, transfer_id:)
|
|
6656
|
-
# Some parameter documentations has been truncated, see
|
|
6657
|
-
# {Increase::Models::Transaction::Source::InboundACHTransfer} for more details.
|
|
6658
|
-
#
|
|
6659
7102
|
# An Inbound ACH Transfer Intention object. This field will be present in the JSON
|
|
6660
7103
|
# response if and only if `category` is equal to `inbound_ach_transfer`. An
|
|
6661
7104
|
# Inbound ACH Transfer Intention is created when an ACH transfer is initiated at
|
|
6662
7105
|
# another bank and received by Increase.
|
|
6663
7106
|
#
|
|
6664
|
-
# @param addenda [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda, nil]
|
|
7107
|
+
# @param addenda [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda, nil]
|
|
7108
|
+
# Additional information sent from the originator.
|
|
6665
7109
|
#
|
|
6666
7110
|
# @param amount [Integer] The transfer amount in USD cents.
|
|
6667
7111
|
#
|
|
6668
|
-
# @param originator_company_descriptive_date [String, nil]
|
|
7112
|
+
# @param originator_company_descriptive_date [String, nil]
|
|
7113
|
+
# The description of the date of the transfer, usually in the format `YYMMDD`.
|
|
6669
7114
|
#
|
|
6670
7115
|
# @param originator_company_discretionary_data [String, nil] Data set by the originator.
|
|
6671
7116
|
#
|
|
6672
7117
|
# @param originator_company_entry_description [String] An informational description of the transfer.
|
|
6673
7118
|
#
|
|
6674
|
-
# @param originator_company_id [String]
|
|
7119
|
+
# @param originator_company_id [String]
|
|
7120
|
+
# An identifier for the originating company. This is generally, but not always, a
|
|
7121
|
+
# stable identifier across multiple transfers.
|
|
6675
7122
|
#
|
|
6676
7123
|
# @param originator_company_name [String] A name set by the originator to identify themselves.
|
|
6677
7124
|
#
|
|
6678
7125
|
# @param receiver_id_number [String, nil] The originator's identifier for the transfer recipient.
|
|
6679
7126
|
#
|
|
6680
|
-
# @param receiver_name [String, nil]
|
|
7127
|
+
# @param receiver_name [String, nil]
|
|
7128
|
+
# The name of the transfer recipient. This value is informational and not verified
|
|
7129
|
+
# by Increase.
|
|
6681
7130
|
#
|
|
6682
|
-
# @param trace_number [String]
|
|
7131
|
+
# @param trace_number [String]
|
|
7132
|
+
# A 15 digit number recorded in the Nacha file and available to both the
|
|
7133
|
+
# originating and receiving bank. Along with the amount, date, and originating
|
|
7134
|
+
# routing number, this can be used to identify the ACH transfer at either bank.
|
|
7135
|
+
# ACH trace numbers are not unique, but are
|
|
7136
|
+
# [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
|
|
6683
7137
|
#
|
|
6684
7138
|
# @param transfer_id [String] The Inbound ACH Transfer's identifier.
|
|
6685
7139
|
|
|
@@ -6702,9 +7156,11 @@ module Increase
|
|
|
6702
7156
|
# @!method initialize(category:, freeform:)
|
|
6703
7157
|
# Additional information sent from the originator.
|
|
6704
7158
|
#
|
|
6705
|
-
# @param category [Symbol, Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Category]
|
|
7159
|
+
# @param category [Symbol, Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Category]
|
|
7160
|
+
# The type of addendum.
|
|
6706
7161
|
#
|
|
6707
|
-
# @param freeform [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform, nil]
|
|
7162
|
+
# @param freeform [Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform, nil]
|
|
7163
|
+
# Unstructured `payment_related_information` passed through by the originator.
|
|
6708
7164
|
|
|
6709
7165
|
# The type of addendum.
|
|
6710
7166
|
#
|
|
@@ -6731,7 +7187,8 @@ module Increase
|
|
|
6731
7187
|
# @!method initialize(entries:)
|
|
6732
7188
|
# Unstructured `payment_related_information` passed through by the originator.
|
|
6733
7189
|
#
|
|
6734
|
-
# @param entries [Array<Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform::Entry>]
|
|
7190
|
+
# @param entries [Array<Increase::Models::Transaction::Source::InboundACHTransfer::Addenda::Freeform::Entry>]
|
|
7191
|
+
# Each entry represents an addendum received from the originator.
|
|
6735
7192
|
|
|
6736
7193
|
class Entry < Increase::Internal::Type::BaseModel
|
|
6737
7194
|
# @!attribute payment_related_information
|
|
@@ -6795,7 +7252,8 @@ module Increase
|
|
|
6795
7252
|
#
|
|
6796
7253
|
# @param amount [Integer] The amount of the check adjustment.
|
|
6797
7254
|
#
|
|
6798
|
-
# @param reason [Symbol, Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason]
|
|
7255
|
+
# @param reason [Symbol, Increase::Models::Transaction::Source::InboundCheckAdjustment::Reason]
|
|
7256
|
+
# The reason for the adjustment.
|
|
6799
7257
|
|
|
6800
7258
|
# The reason for the adjustment.
|
|
6801
7259
|
#
|
|
@@ -6927,21 +7385,22 @@ module Increase
|
|
|
6927
7385
|
required :unstructured_remittance_information, String, nil?: true
|
|
6928
7386
|
|
|
6929
7387
|
# @!method initialize(amount:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, transaction_identification:, transfer_id:, unstructured_remittance_information:)
|
|
6930
|
-
# Some parameter documentations has been truncated, see
|
|
6931
|
-
# {Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation}
|
|
6932
|
-
# for more details.
|
|
6933
|
-
#
|
|
6934
7388
|
# An Inbound Real-Time Payments Transfer Confirmation object. This field will be
|
|
6935
7389
|
# present in the JSON response if and only if `category` is equal to
|
|
6936
7390
|
# `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time
|
|
6937
7391
|
# Payments Transfer Confirmation is created when a Real-Time Payments transfer is
|
|
6938
7392
|
# initiated at another bank and received by Increase.
|
|
6939
7393
|
#
|
|
6940
|
-
# @param amount [Integer]
|
|
7394
|
+
# @param amount [Integer]
|
|
7395
|
+
# The amount in the minor unit of the transfer's currency. For dollars, for
|
|
7396
|
+
# example, this is cents.
|
|
6941
7397
|
#
|
|
6942
|
-
# @param creditor_name [String]
|
|
7398
|
+
# @param creditor_name [String]
|
|
7399
|
+
# The name the sender of the transfer specified as the recipient of the transfer.
|
|
6943
7400
|
#
|
|
6944
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation::Currency]
|
|
7401
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::InboundRealTimePaymentsTransferConfirmation::Currency]
|
|
7402
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
|
|
7403
|
+
# currency. This will always be "USD" for a Real-Time Payments transfer.
|
|
6945
7404
|
#
|
|
6946
7405
|
# @param debtor_account_number [String] The account number of the account that sent the transfer.
|
|
6947
7406
|
#
|
|
@@ -6951,9 +7410,11 @@ module Increase
|
|
|
6951
7410
|
#
|
|
6952
7411
|
# @param transaction_identification [String] The Real-Time Payments network identification of the transfer.
|
|
6953
7412
|
#
|
|
6954
|
-
# @param transfer_id [String]
|
|
7413
|
+
# @param transfer_id [String]
|
|
7414
|
+
# The identifier of the Real-Time Payments Transfer that led to this Transaction.
|
|
6955
7415
|
#
|
|
6956
|
-
# @param unstructured_remittance_information [String, nil]
|
|
7416
|
+
# @param unstructured_remittance_information [String, nil]
|
|
7417
|
+
# Additional information included with the transfer.
|
|
6957
7418
|
|
|
6958
7419
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
|
|
6959
7420
|
# currency. This will always be "USD" for a Real-Time Payments transfer.
|
|
@@ -7061,9 +7522,6 @@ module Increase
|
|
|
7061
7522
|
required :wire_transfer_id, String
|
|
7062
7523
|
|
|
7063
7524
|
# @!method initialize(amount:, created_at:, debtor_routing_number:, description:, input_cycle_date:, input_message_accountability_data:, input_sequence_number:, input_source:, instruction_identification:, return_reason_additional_information:, return_reason_code:, return_reason_code_description:, transaction_id:, wire_transfer_id:)
|
|
7064
|
-
# Some parameter documentations has been truncated, see
|
|
7065
|
-
# {Increase::Models::Transaction::Source::InboundWireReversal} for more details.
|
|
7066
|
-
#
|
|
7067
7525
|
# An Inbound Wire Reversal object. This field will be present in the JSON response
|
|
7068
7526
|
# if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire
|
|
7069
7527
|
# Reversal represents a reversal of a wire transfer that was initiated via
|
|
@@ -7072,13 +7530,18 @@ module Increase
|
|
|
7072
7530
|
#
|
|
7073
7531
|
# @param amount [Integer] The amount that was reversed in USD cents.
|
|
7074
7532
|
#
|
|
7075
|
-
# @param created_at [Time]
|
|
7533
|
+
# @param created_at [Time]
|
|
7534
|
+
# The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
7535
|
+
# the reversal was created.
|
|
7076
7536
|
#
|
|
7077
7537
|
# @param debtor_routing_number [String, nil] The debtor's routing number.
|
|
7078
7538
|
#
|
|
7079
|
-
# @param description [String]
|
|
7539
|
+
# @param description [String]
|
|
7540
|
+
# The description on the reversal message from Fedwire, set by the reversing bank.
|
|
7080
7541
|
#
|
|
7081
|
-
# @param input_cycle_date [Date]
|
|
7542
|
+
# @param input_cycle_date [Date]
|
|
7543
|
+
# The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00
|
|
7544
|
+
# PM Eastern Time on the evening before the `cycle date`.
|
|
7082
7545
|
#
|
|
7083
7546
|
# @param input_message_accountability_data [String] The Fedwire transaction identifier.
|
|
7084
7547
|
#
|
|
@@ -7088,11 +7551,16 @@ module Increase
|
|
|
7088
7551
|
#
|
|
7089
7552
|
# @param instruction_identification [String, nil] The sending bank's identifier for the reversal.
|
|
7090
7553
|
#
|
|
7091
|
-
# @param return_reason_additional_information [String, nil]
|
|
7554
|
+
# @param return_reason_additional_information [String, nil]
|
|
7555
|
+
# Additional information about the reason for the reversal.
|
|
7092
7556
|
#
|
|
7093
|
-
# @param return_reason_code [String, nil]
|
|
7557
|
+
# @param return_reason_code [String, nil]
|
|
7558
|
+
# A code provided by the sending bank giving a reason for the reversal. The common
|
|
7559
|
+
# return reason codes are
|
|
7560
|
+
# [documented here](/documentation/wire-reversals#reversal-reason-codes).
|
|
7094
7561
|
#
|
|
7095
|
-
# @param return_reason_code_description [String, nil]
|
|
7562
|
+
# @param return_reason_code_description [String, nil]
|
|
7563
|
+
# An Increase-generated description of the `return_reason_code`.
|
|
7096
7564
|
#
|
|
7097
7565
|
# @param transaction_id [String] The ID for the Transaction associated with the transfer reversal.
|
|
7098
7566
|
#
|
|
@@ -7215,9 +7683,6 @@ module Increase
|
|
|
7215
7683
|
required :unstructured_remittance_information, String, nil?: true
|
|
7216
7684
|
|
|
7217
7685
|
# @!method initialize(amount:, creditor_address_line1:, creditor_address_line2:, creditor_address_line3:, creditor_name:, debtor_address_line1:, debtor_address_line2:, debtor_address_line3:, debtor_name:, description:, end_to_end_identification:, input_message_accountability_data:, instructing_agent_routing_number:, instruction_identification:, purpose:, transfer_id:, unique_end_to_end_transaction_reference:, unstructured_remittance_information:)
|
|
7218
|
-
# Some parameter documentations has been truncated, see
|
|
7219
|
-
# {Increase::Models::Transaction::Source::InboundWireTransfer} for more details.
|
|
7220
|
-
#
|
|
7221
7686
|
# An Inbound Wire Transfer Intention object. This field will be present in the
|
|
7222
7687
|
# JSON response if and only if `category` is equal to `inbound_wire_transfer`. An
|
|
7223
7688
|
# Inbound Wire Transfer Intention is created when a wire transfer is initiated at
|
|
@@ -7243,11 +7708,17 @@ module Increase
|
|
|
7243
7708
|
#
|
|
7244
7709
|
# @param description [String] An Increase-constructed description of the transfer.
|
|
7245
7710
|
#
|
|
7246
|
-
# @param end_to_end_identification [String, nil]
|
|
7711
|
+
# @param end_to_end_identification [String, nil]
|
|
7712
|
+
# A free-form reference string set by the sender, to help identify the transfer.
|
|
7247
7713
|
#
|
|
7248
|
-
# @param input_message_accountability_data [String, nil]
|
|
7714
|
+
# @param input_message_accountability_data [String, nil]
|
|
7715
|
+
# A unique identifier available to the originating and receiving banks, commonly
|
|
7716
|
+
# abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
|
|
7717
|
+
# service and is helpful when debugging wires with the originating bank.
|
|
7249
7718
|
#
|
|
7250
|
-
# @param instructing_agent_routing_number [String, nil]
|
|
7719
|
+
# @param instructing_agent_routing_number [String, nil]
|
|
7720
|
+
# The American Banking Association (ABA) routing number of the bank that sent the
|
|
7721
|
+
# wire.
|
|
7251
7722
|
#
|
|
7252
7723
|
# @param instruction_identification [String, nil] The sending bank's identifier for the wire transfer.
|
|
7253
7724
|
#
|
|
@@ -7255,7 +7726,10 @@ module Increase
|
|
|
7255
7726
|
#
|
|
7256
7727
|
# @param transfer_id [String] The ID of the Inbound Wire Transfer object that resulted in this Transaction.
|
|
7257
7728
|
#
|
|
7258
|
-
# @param unique_end_to_end_transaction_reference [String, nil]
|
|
7729
|
+
# @param unique_end_to_end_transaction_reference [String, nil]
|
|
7730
|
+
# The Unique End-to-end Transaction Reference
|
|
7731
|
+
# ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr))
|
|
7732
|
+
# of the transfer.
|
|
7259
7733
|
#
|
|
7260
7734
|
# @param unstructured_remittance_information [String, nil] A free-form message set by the sender.
|
|
7261
7735
|
end
|
|
@@ -7313,9 +7787,6 @@ module Increase
|
|
|
7313
7787
|
required :period_start, Time
|
|
7314
7788
|
|
|
7315
7789
|
# @!method initialize(accrued_on_account_id:, amount:, currency:, period_end:, period_start:)
|
|
7316
|
-
# Some parameter documentations has been truncated, see
|
|
7317
|
-
# {Increase::Models::Transaction::Source::InterestPayment} for more details.
|
|
7318
|
-
#
|
|
7319
7790
|
# An Interest Payment object. This field will be present in the JSON response if
|
|
7320
7791
|
# and only if `category` is equal to `interest_payment`. An Interest Payment
|
|
7321
7792
|
# represents a payment of interest on an account. Interest is usually paid
|
|
@@ -7323,9 +7794,13 @@ module Increase
|
|
|
7323
7794
|
#
|
|
7324
7795
|
# @param accrued_on_account_id [String] The account on which the interest was accrued.
|
|
7325
7796
|
#
|
|
7326
|
-
# @param amount [Integer]
|
|
7797
|
+
# @param amount [Integer]
|
|
7798
|
+
# The amount in the minor unit of the transaction's currency. For dollars, for
|
|
7799
|
+
# example, this is cents.
|
|
7327
7800
|
#
|
|
7328
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::InterestPayment::Currency]
|
|
7801
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::InterestPayment::Currency]
|
|
7802
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
|
|
7803
|
+
# currency.
|
|
7329
7804
|
#
|
|
7330
7805
|
# @param period_end [Time] The end of the period for which this transaction paid interest.
|
|
7331
7806
|
#
|
|
@@ -7370,18 +7845,21 @@ module Increase
|
|
|
7370
7845
|
required :reason, enum: -> { Increase::Transaction::Source::InternalSource::Reason }
|
|
7371
7846
|
|
|
7372
7847
|
# @!method initialize(amount:, currency:, reason:)
|
|
7373
|
-
# Some parameter documentations has been truncated, see
|
|
7374
|
-
# {Increase::Models::Transaction::Source::InternalSource} for more details.
|
|
7375
|
-
#
|
|
7376
7848
|
# An Internal Source object. This field will be present in the JSON response if
|
|
7377
7849
|
# and only if `category` is equal to `internal_source`. A transaction between the
|
|
7378
7850
|
# user and Increase. See the `reason` attribute for more information.
|
|
7379
7851
|
#
|
|
7380
|
-
# @param amount [Integer]
|
|
7852
|
+
# @param amount [Integer]
|
|
7853
|
+
# The amount in the minor unit of the transaction's currency. For dollars, for
|
|
7854
|
+
# example, this is cents.
|
|
7381
7855
|
#
|
|
7382
|
-
# @param currency [Symbol, Increase::Models::Transaction::Source::InternalSource::Currency]
|
|
7856
|
+
# @param currency [Symbol, Increase::Models::Transaction::Source::InternalSource::Currency]
|
|
7857
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
|
|
7858
|
+
# currency.
|
|
7383
7859
|
#
|
|
7384
|
-
# @param reason [Symbol, Increase::Models::Transaction::Source::InternalSource::Reason]
|
|
7860
|
+
# @param reason [Symbol, Increase::Models::Transaction::Source::InternalSource::Reason]
|
|
7861
|
+
# An Internal Source is a transaction between you and Increase. This describes the
|
|
7862
|
+
# reason for the transaction.
|
|
7385
7863
|
|
|
7386
7864
|
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
|
|
7387
7865
|
# currency.
|
|
@@ -7515,9 +7993,11 @@ module Increase
|
|
|
7515
7993
|
#
|
|
7516
7994
|
# @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN).
|
|
7517
7995
|
#
|
|
7518
|
-
# @param transfer_id [String]
|
|
7996
|
+
# @param transfer_id [String]
|
|
7997
|
+
# The identifier of the Real-Time Payments Transfer that led to this Transaction.
|
|
7519
7998
|
#
|
|
7520
|
-
# @param unstructured_remittance_information [String]
|
|
7999
|
+
# @param unstructured_remittance_information [String]
|
|
8000
|
+
# Unstructured information that will show on the recipient's bank statement.
|
|
7521
8001
|
end
|
|
7522
8002
|
|
|
7523
8003
|
# @see Increase::Models::Transaction::Source#sample_funds
|