--- title: "Sandbox: Settle a Card Authorization" method: POST path: "/simulations/card_settlements" --- # Sandbox: Settle a Card Authorization `POST /simulations/card_settlements` Simulates the settlement of an authorization by a card acquirer. After a card authorization is created, the merchant will eventually send a settlement. This simulates that event, which may occur many days after the purchase in production. The amount settled can be different from the amount originally authorized, for example, when adding a tip to a restaurant bill. ## Request body - SandboxSettleACardAuthorizationParameters - `amount` integer — The amount to be settled. This defaults to the amount of the Pending Transaction being settled, or a random amount if `pending_transaction_id` is not provided. - `card_id` string, required — The identifier of the Card to create a settlement on. - `pending_transaction_id` string — The identifier of the Pending Transaction for the Card Authorization you wish to settle. If not provided, the settlement will be force posted without a Card Authorization. ## Response `200` Transaction - Transaction — Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement. To learn more, see [Transactions and Transfers](/documentation/transactions-transfers). - `account_id` string, required — The identifier for the Account the Transaction belongs to. - `amount` integer, required — The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents. - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transaction occurred. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transaction's Account. - `description` string, required — An informational message describing this transaction. Use the fields in `source` to get more detailed information. This field appears as the line-item on the statement. - `id` string, required — The Transaction identifier. - `route_id` string, nullable, required — The identifier for the route this Transaction came through. Routes are things like cards and ACH details. - `route_type` 'account_number' | 'card' | 'lockbox', nullable, required — The type of the route this Transaction came through. - `source` object, required — This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future. - `account_revenue_payment` object, nullable — An Account Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `account_revenue_payment`. An Account Revenue Payment represents a payment made to an account from the bank. Account revenue is a type of non-interest income. - `accrued_on_account_id` string, required — The account on which the account revenue was accrued. - `period_end` string, date-time, required — The end of the period for which this transaction paid account revenue. - `period_start` string, date-time, required — The start of the period for which this transaction paid account revenue. - `account_transfer_intention` object, nullable — An Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`. Two Account Transfer Intentions are created from each Account Transfer. One decrements the source account, and the other increments the destination account. - `amount` integer, required — The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency. - `description` string, required — The description you chose to give the transfer. - `destination_account_id` string, required — The identifier of the Account to where the Account Transfer was sent. - `source_account_id` string, required — The identifier of the Account from where the Account Transfer was sent. - `transfer_id` string, required — The identifier of the Account Transfer that led to this Pending Transaction. - `ach_transfer_intention` object, nullable — An ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`. An ACH Transfer Intention is created from an ACH Transfer. It reflects the intention to move money into or out of an Increase account via the ACH network. - `account_number` string, required — The account number for the destination account. - `amount` integer, required — The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `routing_number` string, required — The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account. - `statement_descriptor` string, required — A description set when the ACH Transfer was created. - `transfer_id` string, required — The identifier of the ACH Transfer that led to this Transaction. - `ach_transfer_rejection` object, nullable — An ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`. An ACH Transfer Rejection is created when an ACH Transfer is rejected by Increase. It offsets the ACH Transfer Intention. These rejections are rare. - `transfer_id` string, required — The identifier of the ACH Transfer that led to this Transaction. - `ach_transfer_return` object, nullable — An ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer Return is created when an ACH Transfer is returned by the receiving bank. It offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within the first two business days after the transfer is initiated, but can occur much later. The return appears as a new posted Transaction; no Pending Transaction is created. - `addenda_information` string, nullable, required — Additional free-form information included by the receiving bank in the return's addenda record. This is raw, uninterpreted text whose presence and format are not guaranteed. For a `file_record_edit_criteria` (R17) return the receiving bank may set this to `QUESTIONABLE` (optionally followed by more text) to indicate it believes the transfer was initiated under questionable circumstances. - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created. - `raw_return_reason_code` string, required — The three character ACH return code, in the range R01 to R85. - `return_reason_code` 'insufficient_fund' | 'no_account' | 'account_closed' | 'invalid_account_number_structure' | 'account_frozen_entry_returned_per_ofac_instruction' | 'credit_entry_refused_by_receiver' | 'unauthorized_debit_to_consumer_account_using_corporate_sec_code' | 'corporate_customer_advised_not_authorized' | 'payment_stopped' | 'non_transaction_account' | 'uncollected_funds' | 'routing_number_check_digit_error' | 'customer_advised_unauthorized_improper_ineligible_or_incomplete' | 'amount_field_error' | 'authorization_revoked_by_customer' | 'invalid_ach_routing_number' | 'file_record_edit_criteria' | 'enr_invalid_individual_name' | 'returned_per_odfi_request' | 'limited_participation_dfi' | 'incorrectly_coded_outbound_international_payment' | 'account_sold_to_another_dfi' | 'addenda_error' | 'beneficiary_or_account_holder_deceased' | 'customer_advised_not_within_authorization_terms' | 'corrected_return' | 'duplicate_entry' | 'duplicate_return' | 'enr_duplicate_enrollment' | 'enr_invalid_dfi_account_number' | 'enr_invalid_individual_id_number' | 'enr_invalid_representative_payee_indicator' | 'enr_invalid_transaction_code' | 'enr_return_of_enr_entry' | 'enr_routing_number_check_digit_error' | 'entry_not_processed_by_gateway' | 'field_error' | 'foreign_receiving_dfi_unable_to_settle' | 'iat_entry_coding_error' | 'improper_effective_entry_date' | 'improper_source_document_source_document_presented' | 'invalid_company_id' | 'invalid_foreign_receiving_dfi_identification' | 'invalid_individual_id_number' | 'item_and_rck_entry_presented_for_payment' | 'item_related_to_rck_entry_is_ineligible' | 'mandatory_field_error' | 'misrouted_dishonored_return' | 'misrouted_return' | 'no_errors_found' | 'non_acceptance_of_r62_dishonored_return' | 'non_participant_in_iat_program' | 'permissible_return_entry' | 'permissible_return_entry_not_accepted' | 'rdfi_non_settlement' | 'rdfi_participant_in_check_truncation_program' | 'representative_payee_deceased_or_unable_to_continue_in_that_capacity' | 'return_not_a_duplicate' | 'return_of_erroneous_or_reversing_debit' | 'return_of_improper_credit_entry' | 'return_of_improper_debit_entry' | 'return_of_xck_entry' | 'source_document_presented_for_payment' | 'state_law_affecting_rck_acceptance' | 'stop_payment_on_item_related_to_rck_entry' | 'stop_payment_on_source_document' | 'timely_original_return' | 'trace_number_error' | 'untimely_dishonored_return' | 'untimely_return', required — Why the ACH Transfer was returned. This reason code is sent by the receiving bank back to Increase. - `trace_number` string, required — A 15 digit number that was generated by the bank that initiated the return. The trace number of the return is different than that of the original transfer. ACH trace numbers are not unique, but along with the amount and date this number can be used to identify the ACH return at the bank that initiated it. - `transaction_id` string, required — The identifier of the Transaction associated with this return. - `transfer_id` string, required — The identifier of the ACH Transfer associated with this return. This matches the original Transaction's `source.ach_transfer_intention.transfer_id`. - `blockchain_offramp_transfer_settlement` object, nullable — A Blockchain Off-Ramp Transfer Settlement object. This field will be present in the JSON response if and only if `category` is equal to `blockchain_offramp_transfer_settlement`. - `source_blockchain_address_id` string, required — The identifier of the Blockchain Address the funds were received at. - `transfer_id` string, required — The identifier of the Blockchain Off-Ramp Transfer that led to this Transaction. - `blockchain_onramp_transfer_intention` object, nullable — A Blockchain On-Ramp Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `blockchain_onramp_transfer_intention`. - `destination_blockchain_address` string, required — The blockchain address the funds were sent to. - `transfer_id` string, required — The identifier of the Blockchain On-Ramp Transfer that led to this Transaction. - `card_dispute_acceptance` object, nullable — A Legacy Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`. Contains the details of a successful Card Dispute. - `accepted_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was accepted. - `transaction_id` string, required — The identifier of the Transaction that was created to return the disputed funds to your account. - `card_dispute_financial` object, nullable — A Card Dispute Financial object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_financial`. Financial event related to a Card Dispute. - `amount` integer, required — The amount of the financial event. - `network` 'visa' | 'pulse', required — The network that the Card Dispute is associated with. - `transaction_id` string, required — The identifier of the Transaction that was created to credit or debit the disputed funds to or from your account. - `visa` CardDisputeFinancialVisa, required - `event_type` 'chargeback_submitted' | 'merchant_prearbitration_decline_submitted' | 'merchant_prearbitration_received' | 'represented' | 'user_prearbitration_decline_received' | 'user_prearbitration_submitted' | 'user_withdrawal_submitted', required — The type of card dispute financial event. - `card_dispute_loss` object, nullable — A Legacy Card Dispute Loss object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_loss`. Contains the details of a lost Card Dispute. - `explanation` string, required — Why the Card Dispute was lost. - `lost_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was lost. - `transaction_id` string, required — The identifier of the Transaction that was created to debit the disputed funds from your account. - `card_financial` CardFinancial — Card Financials are card transactions that have cleared and settled. Unlike a Card Settlement, which clears a previous authorization, a Card Financial is authorized and cleared in a single message. - `actioner` 'user' | 'increase' | 'network', required — Whether this financial was approved by Increase, the card network through stand-in processing, or the user through a real-time decision. - `additional_amounts` object, required — Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction. - `clinic` object, nullable, required — The part of this transaction amount that was for clinic-related services. - `amount` integer, required — The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). - `currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. - `dental` object, nullable, required — The part of this transaction amount that was for dental-related services. - `amount` integer, required — The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). - `currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. - `original` object, nullable, required — The original pre-authorized amount. - `amount` integer, required — The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). - `currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. - `prescription` object, nullable, required — The part of this transaction amount that was for healthcare prescriptions. - `amount` integer, required — The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). - `currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. - `surcharge` object, nullable, required — The surcharge amount charged for this transaction by the merchant. - `amount` integer, required — The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). - `currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. - `total_cumulative` object, nullable, required — The total amount of a series of incremental authorizations, optionally provided. - `amount` integer, required — The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). - `currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. - `total_healthcare` object, nullable, required — The total amount of healthcare-related additional amounts. - `amount` integer, required — The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). - `currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. - `transit` object, nullable, required — The part of this transaction amount that was for transit-related services. - `amount` integer, required — The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). - `currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. - `unknown` object, nullable, required — An unknown additional amount. - `amount` integer, required — The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). - `currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. - `vision` object, nullable, required — The part of this transaction amount that was for vision-related services. - `amount` integer, required — The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). - `currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. - `amount` integer, required — The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `card_payment_id` string, required — The ID of the Card Payment this transaction belongs to. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency. - `digital_wallet_token_id` string, nullable, required — If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used. - `direction` 'settlement' | 'refund', required — The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder. - `id` string, required — The Card Financial identifier. - `merchant_acceptor_id` string, required — The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. - `merchant_category_code` string, required — The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. - `merchant_city` string, nullable, required — The city the merchant resides in. - `merchant_country` string, required — The country the merchant resides in. - `merchant_descriptor` string, required — The merchant descriptor of the merchant the card is transacting with. - `merchant_postal_code` string, nullable, required — The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash. - `merchant_state` string, nullable, required — The state the merchant resides in. - `network_details` object, required — Fields specific to the `network`. - `category` 'visa' | 'pulse', required — The payment network used to process this card authorization. - `pulse` object, nullable, required — Fields specific to the `pulse` network. - `visa` object, nullable, required — Fields specific to the `visa` network. - `electronic_commerce_indicator` 'mail_phone_order' | 'recurring' | 'installment' | 'unknown_mail_phone_order' | 'secure_electronic_commerce' | 'non_authenticated_security_transaction_at_3ds_capable_merchant' | 'non_authenticated_security_transaction' | 'non_secure_transaction', nullable, required — For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order. - `point_of_service_entry_mode` 'unknown' | 'manual' | 'magnetic_stripe_no_cvv' | 'optical_code' | 'integrated_circuit_card' | 'contactless' | 'credential_on_file' | 'magnetic_stripe' | 'contactless_magnetic_stripe' | 'integrated_circuit_card_no_cvv', nullable, required — The method used to enter the cardholder's primary account number and card expiration date. - `stand_in_processing_reason` 'issuer_error' | 'invalid_physical_card' | 'invalid_cryptogram' | 'invalid_cardholder_authentication_verification_value' | 'internal_visa_error' | 'merchant_transaction_advisory_service_authentication_required' | 'payment_fraud_disruption_acquirer_block' | 'other', nullable, required — Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing. - `terminal_entry_capability` 'unknown' | 'terminal_not_used' | 'magnetic_stripe' | 'barcode' | 'optical_character_recognition' | 'chip_or_contactless' | 'contactless_only' | 'no_capability', nullable, required — The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable. - `network_identifiers` object, required — Network-specific identifiers for a specific request or transaction. - `authorization_identification_response` string, nullable, required — The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. - `retrieval_reference_number` string, nullable, required — A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. - `trace_number` string, nullable, required — A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. - `transaction_id` string, nullable, required — A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. - `network_risk_score` integer, nullable, required — The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest. - `physical_card_id` string, nullable, required — If the authorization was made in-person with a physical card, the Physical Card that was used. - `presentment_amount` integer, required — The pending amount in the minor unit of the transaction's presentment currency. - `presentment_currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency. - `processing_category` 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'cash_deposit' | 'balance_inquiry' | 'unknown', required — The processing category describes the intent behind the financial, such as whether it was used for bill payments or an automatic fuel dispenser. - `real_time_decision_id` string, nullable, required — The identifier of the Real-Time Decision sent to approve or decline this transaction. - `scheme_fees` object[], required — The scheme fees associated with this card financial. - `amount` string, required — The fee amount given as a string containing a decimal number. - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. - `fee_type` 'visa_international_service_assessment_single_currency' | 'visa_international_service_assessment_cross_currency' | 'visa_authorization_domestic_point_of_sale' | 'visa_authorization_international_point_of_sale' | 'visa_authorization_canada_point_of_sale' | 'visa_authorization_reversal_point_of_sale' | 'visa_authorization_reversal_international_point_of_sale' | 'visa_authorization_address_verification_service' | 'visa_advanced_authorization' | 'visa_message_transmission' | 'visa_account_verification_domestic' | 'visa_account_verification_international' | 'visa_account_verification_canada' | 'visa_corporate_acceptance_fee' | 'visa_consumer_debit_acceptance_fee' | 'visa_business_debit_acceptance_fee' | 'visa_purchasing_acceptance_fee' | 'visa_purchase_domestic' | 'visa_purchase_international' | 'visa_credit_purchase_token' | 'visa_debit_purchase_token' | 'visa_clearing_transmission' | 'visa_direct_authorization' | 'visa_direct_transaction_domestic' | 'visa_service_commercial_credit' | 'visa_advertising_service_commercial_credit' | 'visa_community_growth_acceleration_program' | 'visa_processing_guarantee_commercial_credit' | 'pulse_switch_fee', required — The type of fee being assessed. - `fixed_component` string, nullable, required — The fixed component of the fee, if applicable, given in major units of the fee amount. - `variable_rate` string, nullable, required — The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). - `terminal_id` string, nullable, required — The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with. - `transaction_id` string, required — The identifier of the Transaction associated with this Transaction. - `type` 'card_financial', required — A constant representing the object's type. For this resource it will always be `card_financial`. - `verification` object, required — Fields related to verification of cardholder-provided values. - `card_verification_code` object, required — Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. - `result` 'not_checked' | 'match' | 'no_match', required — The result of verifying the Card Verification Code. - `cardholder_address` object, required — Cardholder address provided in the authorization request and the address on file we verified it against. - `actual_line1` string, nullable, required — Line 1 of the address on file for the cardholder. - `actual_postal_code` string, nullable, required — The postal code of the address on file for the cardholder. - `provided_line1` string, nullable, required — The cardholder address line 1 provided for verification in the authorization request. - `provided_postal_code` string, nullable, required — The postal code provided for verification in the authorization request. - `result` 'not_checked' | 'postal_code_match_address_no_match' | 'postal_code_no_match_address_match' | 'match' | 'no_match' | 'postal_code_match_address_not_checked', required — The address verification result returned to the card network. - `cardholder_name` object, nullable, required — Cardholder name provided in the authorization request. - `provided_first_name` string, nullable, required — The first name provided for verification in the authorization request. - `provided_last_name` string, nullable, required — The last name provided for verification in the authorization request. - `provided_middle_name` string, nullable, required — The middle name provided for verification in the authorization request. - `card_push_transfer_acceptance` object, nullable — A Card Push Transfer Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_push_transfer_acceptance`. A Card Push Transfer Acceptance is created when an Outbound Card Push Transfer sent from Increase is accepted by the receiving bank. - `settlement_amount` integer, required — The transfer amount in USD cents. - `transfer_id` string, required — The identifier of the Card Push Transfer that led to this Transaction. - `card_refund` CardRefund — Card Refunds move money back to the cardholder. While they are usually connected to a Card Settlement, an acquirer can also refund money directly to a card without relation to a transaction. - `amount` integer, required — The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents. - `card_payment_id` string, required — The ID of the Card Payment this transaction belongs to. - `cashback` object, nullable, required — Cashback debited for this transaction, if eligible. Cashback is paid out in aggregate, monthly. - `amount` string, required — The cashback amount given as a string containing a decimal number. The amount is a positive number if it will be credited to you (e.g., settlements) and a negative number if it will be debited (e.g., refunds). - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency. - `id` string, required — The Card Refund identifier. - `interchange` object, nullable, required — Interchange assessed as a part of this transaction. - `amount` string, required — The interchange amount given as a string containing a decimal number in major units (so e.g., "3.14" for $3.14). The amount is a positive number if it is credited to Increase (e.g., settlements) and a negative number if it is debited (e.g., refunds). - `code` string, nullable, required — The card network specific interchange code. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange reimbursement. - `merchant_acceptor_id` string, required — The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. - `merchant_category_code` string, required — The 4-digit MCC describing the merchant's business. - `merchant_city` string, required — The city the merchant resides in. - `merchant_country` string, required — The country the merchant resides in. - `merchant_name` string, required — The name of the merchant. - `merchant_postal_code` string, nullable, required — The merchant's postal code. For US merchants this is always a 5-digit ZIP code. - `merchant_state` string, nullable, required — The state the merchant resides in. - `network_identifiers` object, required — Network-specific identifiers for this refund. - `acquirer_business_id` string, required — A network assigned business ID that identifies the acquirer that processed this transaction. - `acquirer_reference_number` string, required — A globally unique identifier for this settlement. - `authorization_identification_response` string, nullable, required — The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. - `transaction_id` string, nullable, required — A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. - `presentment_amount` integer, required — The amount in the minor unit of the transaction's presentment currency. - `presentment_currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency. - `purchase_details` object, nullable, required — Additional details about the card purchase, such as tax and industry-specific fields. - `car_rental` object, nullable, required — Fields specific to car rentals. - `car_class_code` string, nullable, required — Code indicating the vehicle's class. - `checkout_date` string, date, nullable, required — Date the customer picked up the car or, in the case of a no-show or pre-pay transaction, the scheduled pick up date. - `daily_rental_rate_amount` integer, nullable, required — Daily rate being charged for the vehicle. - `daily_rental_rate_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental rate. - `days_rented` integer, nullable, required — Number of days the vehicle was rented. - `extra_charges` 'no_extra_charge' | 'gas' | 'extra_mileage' | 'late_return' | 'one_way_service_fee' | 'parking_violation', nullable, required — Additional charges (gas, late fee, etc.) being billed. - `fuel_charges_amount` integer, nullable, required — Fuel charges for the vehicle. - `fuel_charges_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges assessed. - `insurance_charges_amount` integer, nullable, required — Any insurance being charged for the vehicle. - `insurance_charges_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance charges assessed. - `no_show_indicator` 'not_applicable' | 'no_show_for_specialized_vehicle', nullable, required — An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge). - `one_way_drop_off_charges_amount` integer, nullable, required — Charges for returning the vehicle at a different location than where it was picked up. - `one_way_drop_off_charges_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop-off charges assessed. - `renter_name` string, nullable, required — Name of the person renting the vehicle. - `weekly_rental_rate_amount` integer, nullable, required — Weekly rate being charged for the vehicle. - `weekly_rental_rate_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly rental rate. - `customer_reference_identifier` string, nullable, required — An identifier from the merchant for the customer or consumer. - `local_tax_amount` integer, nullable, required — The state or provincial tax amount in minor units. - `local_tax_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed. - `lodging` object, nullable, required — Fields specific to lodging. - `check_in_date` string, date, nullable, required — Date the customer checked in. - `daily_room_rate_amount` integer, nullable, required — Daily rate being charged for the room. - `daily_room_rate_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room rate. - `extra_charges` 'no_extra_charge' | 'restaurant' | 'gift_shop' | 'mini_bar' | 'telephone' | 'other' | 'laundry', nullable, required — Additional charges (phone, late check-out, etc.) being billed. - `folio_cash_advances_amount` integer, nullable, required — Folio cash advances for the room. - `folio_cash_advances_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash advances. - `food_beverage_charges_amount` integer, nullable, required — Food and beverage charges for the room. - `food_beverage_charges_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and beverage charges. - `no_show_indicator` 'not_applicable' | 'no_show', nullable, required — Indicator that the cardholder is being billed for a reserved room that was not actually used. - `prepaid_expenses_amount` integer, nullable, required — Prepaid expenses being charged for the room. - `prepaid_expenses_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expenses. - `room_nights` integer, nullable, required — Number of nights the room was rented. - `total_room_tax_amount` integer, nullable, required — Total room tax being charged. - `total_room_tax_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room tax. - `total_tax_amount` integer, nullable, required — Total tax being charged for the room. - `total_tax_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax assessed. - `national_tax_amount` integer, nullable, required — The national tax amount in minor units. - `national_tax_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed. - `purchase_identifier` string, nullable, required — An identifier from the merchant for the purchase to the issuer and cardholder. - `purchase_identifier_format` 'free_text' | 'order_number' | 'rental_agreement_number' | 'hotel_folio_number' | 'invoice_number', nullable, required — The format of the purchase identifier. - `travel` object, nullable, required — Fields specific to travel. - `ancillary` object, nullable, required — Ancillary purchases in addition to the airfare. - `connected_ticket_document_number` string, nullable, required — If this purchase has a connection or relationship to another purchase, such as a baggage fee for a passenger transport ticket, this field should contain the ticket document number for the other purchase. - `credit_reason_indicator` 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'other', nullable, required — Indicates the reason for a credit to the cardholder. - `passenger_name_or_description` string, nullable, required — Name of the passenger or description of the ancillary purchase. - `services` object[], required — Additional travel charges, such as baggage fees. - … - `ticket_document_number` string, nullable, required — Ticket document number. - `computerized_reservation_system` string, nullable, required — Indicates the computerized reservation system used to book the ticket. - `credit_reason_indicator` 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_cancellation' | 'other' | 'partial_refund_of_airline_ticket', nullable, required — Indicates the reason for a credit to the cardholder. - `departure_date` string, date, nullable, required — Date of departure. - `origination_city_airport_code` string, nullable, required — Code for the originating city or airport. - `passenger_name` string, nullable, required — Name of the passenger. - `restricted_ticket_indicator` 'no_restrictions' | 'restricted_non_refundable_ticket', nullable, required — Indicates whether this ticket is non-refundable. - `ticket_change_indicator` 'none' | 'change_to_existing_ticket' | 'new_ticket', nullable, required — Indicates why a ticket was changed. - `ticket_number` string, nullable, required — Ticket number. - `travel_agency_code` string, nullable, required — Code for the travel agency if the ticket was issued by a travel agency. - `travel_agency_name` string, nullable, required — Name of the travel agency if the ticket was issued by a travel agency. - `trip_legs` object[], nullable, required — Fields specific to each leg of the journey. - `carrier_code` string, nullable, required — Carrier code (e.g., United Airlines, Jet Blue, etc.). - `destination_city_airport_code` string, nullable, required — Code for the destination city or airport. - `fare_basis_code` string, nullable, required — Fare basis code. - `flight_number` string, nullable, required — Flight number. - `service_class` string, nullable, required — Service class (e.g., first class, business class, etc.). - `stop_over_code` 'none' | 'stop_over_allowed' | 'stop_over_not_allowed', nullable, required — Indicates whether a stopover is allowed on this ticket. - `scheme_fees` object[], required — The scheme fees associated with this card refund. - `amount` string, required — The fee amount given as a string containing a decimal number. - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. - `fee_type` 'visa_international_service_assessment_single_currency' | 'visa_international_service_assessment_cross_currency' | 'visa_authorization_domestic_point_of_sale' | 'visa_authorization_international_point_of_sale' | 'visa_authorization_canada_point_of_sale' | 'visa_authorization_reversal_point_of_sale' | 'visa_authorization_reversal_international_point_of_sale' | 'visa_authorization_address_verification_service' | 'visa_advanced_authorization' | 'visa_message_transmission' | 'visa_account_verification_domestic' | 'visa_account_verification_international' | 'visa_account_verification_canada' | 'visa_corporate_acceptance_fee' | 'visa_consumer_debit_acceptance_fee' | 'visa_business_debit_acceptance_fee' | 'visa_purchasing_acceptance_fee' | 'visa_purchase_domestic' | 'visa_purchase_international' | 'visa_credit_purchase_token' | 'visa_debit_purchase_token' | 'visa_clearing_transmission' | 'visa_direct_authorization' | 'visa_direct_transaction_domestic' | 'visa_service_commercial_credit' | 'visa_advertising_service_commercial_credit' | 'visa_community_growth_acceleration_program' | 'visa_processing_guarantee_commercial_credit' | 'pulse_switch_fee', required — The type of fee being assessed. - `fixed_component` string, nullable, required — The fixed component of the fee, if applicable, given in major units of the fee amount. - `variable_rate` string, nullable, required — The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). - `transaction_id` string, required — The identifier of the Transaction associated with this Transaction. - `type` 'card_refund', required — A constant representing the object's type. For this resource it will always be `card_refund`. - `card_revenue_payment` object, nullable — A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `card_revenue_payment`. Card Revenue Payments reflect earnings from fees on card transactions. - `amount` integer, required — The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency. - `period_end` string, date-time, required — The end of the period for which this transaction paid interest. - `period_start` string, date-time, required — The start of the period for which this transaction paid interest. - `transacted_on_account_id` string, nullable, required — The account the card belonged to. - `card_settlement` CardSettlement — Card Settlements are card transactions that have cleared and settled. While a settlement is usually preceded by an authorization, an acquirer can also directly clear a transaction without first authorizing it. - `amount` integer, required — The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents. - `card_authorization` string, nullable, required — The Card Authorization that was created prior to this Card Settlement, if one exists. - `card_payment_id` string, required — The ID of the Card Payment this transaction belongs to. - `cashback` object, nullable, required — Cashback earned on this transaction, if eligible. Cashback is paid out in aggregate, monthly. - `amount` string, required — The cashback amount given as a string containing a decimal number. The amount is a positive number if it will be credited to you (e.g., settlements) and a negative number if it will be debited (e.g., refunds). - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency. - `id` string, required — The Card Settlement identifier. - `interchange` object, nullable, required — Interchange assessed as a part of this transaction. - `amount` string, required — The interchange amount given as a string containing a decimal number in major units (so e.g., "3.14" for $3.14). The amount is a positive number if it is credited to Increase (e.g., settlements) and a negative number if it is debited (e.g., refunds). - `code` string, nullable, required — The card network specific interchange code. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange reimbursement. - `merchant_acceptor_id` string, required — The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. - `merchant_category_code` string, required — The 4-digit MCC describing the merchant's business. - `merchant_city` string, required — The city the merchant resides in. - `merchant_country` string, required — The country the merchant resides in. - `merchant_name` string, required — The name of the merchant. - `merchant_postal_code` string, nullable, required — The merchant's postal code. For US merchants this is always a 5-digit ZIP code. - `merchant_state` string, nullable, required — The state the merchant resides in. - `network` 'visa' | 'pulse', required — The card network on which this transaction was processed. - `network_identifiers` object, required — Network-specific identifiers for this refund. - `acquirer_business_id` string, required — A network assigned business ID that identifies the acquirer that processed this transaction. - `acquirer_reference_number` string, required — A globally unique identifier for this settlement. - `authorization_identification_response` string, nullable, required — The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. - `transaction_id` string, nullable, required — A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. - `pending_transaction_id` string, nullable, required — The identifier of the Pending Transaction associated with this Transaction. - `presentment_amount` integer, required — The amount in the minor unit of the transaction's presentment currency. - `presentment_currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency. - `purchase_details` object, nullable, required — Additional details about the card purchase, such as tax and industry-specific fields. - `car_rental` object, nullable, required — Fields specific to car rentals. - `car_class_code` string, nullable, required — Code indicating the vehicle's class. - `checkout_date` string, date, nullable, required — Date the customer picked up the car or, in the case of a no-show or pre-pay transaction, the scheduled pick up date. - `daily_rental_rate_amount` integer, nullable, required — Daily rate being charged for the vehicle. - `daily_rental_rate_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental rate. - `days_rented` integer, nullable, required — Number of days the vehicle was rented. - `extra_charges` 'no_extra_charge' | 'gas' | 'extra_mileage' | 'late_return' | 'one_way_service_fee' | 'parking_violation', nullable, required — Additional charges (gas, late fee, etc.) being billed. - `fuel_charges_amount` integer, nullable, required — Fuel charges for the vehicle. - `fuel_charges_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges assessed. - `insurance_charges_amount` integer, nullable, required — Any insurance being charged for the vehicle. - `insurance_charges_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance charges assessed. - `no_show_indicator` 'not_applicable' | 'no_show_for_specialized_vehicle', nullable, required — An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge). - `one_way_drop_off_charges_amount` integer, nullable, required — Charges for returning the vehicle at a different location than where it was picked up. - `one_way_drop_off_charges_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop-off charges assessed. - `renter_name` string, nullable, required — Name of the person renting the vehicle. - `weekly_rental_rate_amount` integer, nullable, required — Weekly rate being charged for the vehicle. - `weekly_rental_rate_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly rental rate. - `customer_reference_identifier` string, nullable, required — An identifier from the merchant for the customer or consumer. - `local_tax_amount` integer, nullable, required — The state or provincial tax amount in minor units. - `local_tax_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed. - `lodging` object, nullable, required — Fields specific to lodging. - `check_in_date` string, date, nullable, required — Date the customer checked in. - `daily_room_rate_amount` integer, nullable, required — Daily rate being charged for the room. - `daily_room_rate_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room rate. - `extra_charges` 'no_extra_charge' | 'restaurant' | 'gift_shop' | 'mini_bar' | 'telephone' | 'other' | 'laundry', nullable, required — Additional charges (phone, late check-out, etc.) being billed. - `folio_cash_advances_amount` integer, nullable, required — Folio cash advances for the room. - `folio_cash_advances_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash advances. - `food_beverage_charges_amount` integer, nullable, required — Food and beverage charges for the room. - `food_beverage_charges_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and beverage charges. - `no_show_indicator` 'not_applicable' | 'no_show', nullable, required — Indicator that the cardholder is being billed for a reserved room that was not actually used. - `prepaid_expenses_amount` integer, nullable, required — Prepaid expenses being charged for the room. - `prepaid_expenses_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expenses. - `room_nights` integer, nullable, required — Number of nights the room was rented. - `total_room_tax_amount` integer, nullable, required — Total room tax being charged. - `total_room_tax_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room tax. - `total_tax_amount` integer, nullable, required — Total tax being charged for the room. - `total_tax_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax assessed. - `national_tax_amount` integer, nullable, required — The national tax amount in minor units. - `national_tax_currency` string, nullable, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed. - `purchase_identifier` string, nullable, required — An identifier from the merchant for the purchase to the issuer and cardholder. - `purchase_identifier_format` 'free_text' | 'order_number' | 'rental_agreement_number' | 'hotel_folio_number' | 'invoice_number', nullable, required — The format of the purchase identifier. - `travel` object, nullable, required — Fields specific to travel. - `ancillary` object, nullable, required — Ancillary purchases in addition to the airfare. - `connected_ticket_document_number` string, nullable, required — If this purchase has a connection or relationship to another purchase, such as a baggage fee for a passenger transport ticket, this field should contain the ticket document number for the other purchase. - `credit_reason_indicator` 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'other', nullable, required — Indicates the reason for a credit to the cardholder. - `passenger_name_or_description` string, nullable, required — Name of the passenger or description of the ancillary purchase. - `services` object[], required — Additional travel charges, such as baggage fees. - … - `ticket_document_number` string, nullable, required — Ticket document number. - `computerized_reservation_system` string, nullable, required — Indicates the computerized reservation system used to book the ticket. - `credit_reason_indicator` 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_cancellation' | 'other' | 'partial_refund_of_airline_ticket', nullable, required — Indicates the reason for a credit to the cardholder. - `departure_date` string, date, nullable, required — Date of departure. - `origination_city_airport_code` string, nullable, required — Code for the originating city or airport. - `passenger_name` string, nullable, required — Name of the passenger. - `restricted_ticket_indicator` 'no_restrictions' | 'restricted_non_refundable_ticket', nullable, required — Indicates whether this ticket is non-refundable. - `ticket_change_indicator` 'none' | 'change_to_existing_ticket' | 'new_ticket', nullable, required — Indicates why a ticket was changed. - `ticket_number` string, nullable, required — Ticket number. - `travel_agency_code` string, nullable, required — Code for the travel agency if the ticket was issued by a travel agency. - `travel_agency_name` string, nullable, required — Name of the travel agency if the ticket was issued by a travel agency. - `trip_legs` object[], nullable, required — Fields specific to each leg of the journey. - `carrier_code` string, nullable, required — Carrier code (e.g., United Airlines, Jet Blue, etc.). - `destination_city_airport_code` string, nullable, required — Code for the destination city or airport. - `fare_basis_code` string, nullable, required — Fare basis code. - `flight_number` string, nullable, required — Flight number. - `service_class` string, nullable, required — Service class (e.g., first class, business class, etc.). - `stop_over_code` 'none' | 'stop_over_allowed' | 'stop_over_not_allowed', nullable, required — Indicates whether a stopover is allowed on this ticket. - `scheme_fees` object[], required — The scheme fees associated with this card settlement. - `amount` string, required — The fee amount given as a string containing a decimal number. - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. - `fee_type` 'visa_international_service_assessment_single_currency' | 'visa_international_service_assessment_cross_currency' | 'visa_authorization_domestic_point_of_sale' | 'visa_authorization_international_point_of_sale' | 'visa_authorization_canada_point_of_sale' | 'visa_authorization_reversal_point_of_sale' | 'visa_authorization_reversal_international_point_of_sale' | 'visa_authorization_address_verification_service' | 'visa_advanced_authorization' | 'visa_message_transmission' | 'visa_account_verification_domestic' | 'visa_account_verification_international' | 'visa_account_verification_canada' | 'visa_corporate_acceptance_fee' | 'visa_consumer_debit_acceptance_fee' | 'visa_business_debit_acceptance_fee' | 'visa_purchasing_acceptance_fee' | 'visa_purchase_domestic' | 'visa_purchase_international' | 'visa_credit_purchase_token' | 'visa_debit_purchase_token' | 'visa_clearing_transmission' | 'visa_direct_authorization' | 'visa_direct_transaction_domestic' | 'visa_service_commercial_credit' | 'visa_advertising_service_commercial_credit' | 'visa_community_growth_acceleration_program' | 'visa_processing_guarantee_commercial_credit' | 'pulse_switch_fee', required — The type of fee being assessed. - `fixed_component` string, nullable, required — The fixed component of the fee, if applicable, given in major units of the fee amount. - `variable_rate` string, nullable, required — The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). - `surcharge` object, nullable, required — Surcharge amount details, if applicable. The amount is positive if the surcharge is added to the overall transaction amount (surcharge), and negative if the surcharge is deducted from the overall transaction amount (discount). - `amount` integer, required — The surcharge amount in the minor unit of the transaction's settlement currency. - `presentment_amount` integer, required — The surcharge amount in the minor unit of the transaction's presentment currency. - `transaction_id` string, required — The identifier of the Transaction associated with this Transaction. - `type` 'card_settlement', required — A constant representing the object's type. For this resource it will always be `card_settlement`. - `cashback_payment` object, nullable — A Cashback Payment object. This field will be present in the JSON response if and only if `category` is equal to `cashback_payment`. A Cashback Payment represents the cashback paid to a cardholder for a given period. Cashback is usually paid monthly for the prior month's transactions. - `accrued_on_card_id` string, nullable, required — The card on which the cashback was accrued. - `amount` integer, required — The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency. - `period_end` string, date-time, required — The end of the period for which this transaction paid cashback. - `period_start` string, date-time, required — The start of the period for which this transaction paid cashback. - `category` 'account_transfer_intention' | 'ach_transfer_intention' | 'ach_transfer_rejection' | 'ach_transfer_return' | 'cashback_payment' | 'card_dispute_acceptance' | 'card_dispute_financial' | 'card_dispute_loss' | 'card_refund' | 'card_settlement' | 'card_financial' | 'card_revenue_payment' | 'check_deposit_acceptance' | 'check_deposit_return' | 'fednow_transfer_acknowledgement' | 'check_transfer_deposit' | 'fee_payment' | 'inbound_ach_transfer' | 'inbound_ach_transfer_return_intention' | 'inbound_check_deposit_return_intention' | 'inbound_check_adjustment' | 'inbound_fednow_transfer_confirmation' | 'inbound_real_time_payments_transfer_confirmation' | 'inbound_wire_reversal' | 'inbound_wire_transfer' | 'inbound_wire_transfer_reversal' | 'interest_payment' | 'internal_source' | 'real_time_payments_transfer_acknowledgement' | 'sample_funds' | 'wire_transfer_intention' | 'swift_transfer_intention' | 'swift_transfer_return' | 'card_push_transfer_acceptance' | 'account_revenue_payment' | 'blockchain_onramp_transfer_intention' | 'blockchain_offramp_transfer_settlement' | 'other', required — The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully. - `check_deposit_acceptance` object, nullable — A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`. A Check Deposit Acceptance is created when a Check Deposit is processed and its details confirmed. Check Deposits may be returned by the receiving bank, which will appear as a Check Deposit Return. - `account_number` string, required — The account number printed on the check. This is an account at the bank that issued the check. - `amount` integer, required — The amount to be deposited in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `auxiliary_on_us` string, nullable, required — An additional line of metadata printed on the check. This typically includes the check number for business checks. - `check_deposit_id` string, required — The ID of the Check Deposit that was accepted. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency. - `routing_number` string, required — The routing number printed on the check. This is a routing number for the bank that issued the check. - `serial_number` string, nullable, required — The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the `auxiliary_on_us` field. - `check_deposit_return` object, nullable — A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`. A Check Deposit Return is created when a Check Deposit is returned by the bank holding the account it was drawn against. Check Deposits may be returned for a variety of reasons, including insufficient funds or a mismatched account number. Usually, checks are returned within the first 7 days after the deposit is made. - `amount` integer, required — The returned amount in USD cents. - `check_deposit_id` string, required — The identifier of the Check Deposit that was returned. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency. - `return_reason` 'ach_conversion_not_supported' | 'closed_account' | 'duplicate_submission' | 'insufficient_funds' | 'no_account' | 'not_authorized' | 'stale_dated' | 'stop_payment' | 'unknown_reason' | 'unmatched_details' | 'unreadable_image' | 'endorsement_irregular' | 'altered_or_fictitious_item' | 'frozen_or_blocked_account' | 'post_dated' | 'endorsement_missing' | 'signature_missing' | 'stop_payment_suspect' | 'unusable_image' | 'image_fails_security_check' | 'cannot_determine_amount' | 'signature_irregular' | 'non_cash_item' | 'unable_to_process' | 'item_exceeds_dollar_limit' | 'branch_or_account_sold', required — Why this check was returned by the bank holding the account it was drawn against. - `returned_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned. - `transaction_id` string, required — The identifier of the transaction that reversed the original check deposit transaction. - `check_transfer_deposit` CheckTransferDeposit — An Inbound Check is a check drawn on an Increase account that has been deposited by an external bank account. These types of checks are not pre-registered. - `back_image_file_id` string, nullable, required — The identifier of the API File object containing an image of the back of the deposited check. - `bank_of_first_deposit_routing_number` string, nullable, required — The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank depositing this check. In some rare cases, this is not transmitted via Check21 and the value will be null. - `deposited_at` string, date-time, required — When the check was deposited. - `front_image_file_id` string, nullable, required — The identifier of the API File object containing an image of the front of the deposited check. - `inbound_check_deposit_id` string, nullable, required — The identifier of the Inbound Check Deposit object associated with this transaction. - `transaction_id` string, nullable, required — The identifier of the Transaction object created when the check was deposited. - `transfer_id` string, nullable, required — The identifier of the Check Transfer object that was deposited. - `type` 'check_transfer_deposit', required — A constant representing the object's type. For this resource it will always be `check_transfer_deposit`. - `fednow_transfer_acknowledgement` object, nullable — A FedNow Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `fednow_transfer_acknowledgement`. A FedNow Transfer Acknowledgement is created when a FedNow Transfer sent from Increase is acknowledged by the receiving bank. - `transfer_id` string, required — The identifier of the FedNow Transfer that led to this Transaction. - `fee_payment` object, nullable — A Fee Payment object. This field will be present in the JSON response if and only if `category` is equal to `fee_payment`. A Fee Payment represents a payment made to Increase. - `amount` integer, required — The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency. - `fee_period_start` string, date, required — The start of this payment's fee period, usually the first day of a month. - `program_id` string, nullable, required — The Program for which this fee was incurred. - `inbound_ach_transfer` object, nullable — An Inbound ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`. An Inbound ACH Transfer Intention is created when an ACH transfer is initiated at another bank and received by Increase. - `addenda` object, nullable, required — Additional information sent from the originator. - `category` 'freeform', required — The type of addendum. - `freeform` object, nullable, required — Unstructured `payment_related_information` passed through by the originator. - `entries` object[], required — Each entry represents an addendum received from the originator. - `payment_related_information` string, required — The payment related information passed in the addendum. - `amount` integer, required — The transfer amount in USD cents. - `originator_company_descriptive_date` string, nullable, required — The description of the date of the transfer, usually in the format `YYMMDD`. - `originator_company_discretionary_data` string, nullable, required — Data set by the originator. - `originator_company_entry_description` string, required — An informational description of the transfer. - `originator_company_id` string, required — An identifier for the originating company. This is generally, but not always, a stable identifier across multiple transfers. - `originator_company_name` string, required — A name set by the originator to identify themselves. - `receiver_id_number` string, nullable, required — The originator's identifier for the transfer recipient. - `receiver_name` string, nullable, required — The name of the transfer recipient. This value is informational and not verified by Increase. - `trace_number` string, required — A 15 digit number recorded in the Nacha file and available to both the originating and receiving bank. Along with the amount, date, and originating routing number, this can be used to identify the ACH transfer at either bank. ACH trace numbers are not unique, but are [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns). - `transfer_id` string, required — The Inbound ACH Transfer's identifier. - `inbound_ach_transfer_return_intention` InboundAchTransferReturnIntention — An Inbound ACH Transfer Return Intention is created when an ACH transfer is initiated at another bank and returned by Increase. - `inbound_ach_transfer_id` string, required — The ID of the Inbound ACH Transfer that is being returned. - `inbound_check_adjustment` InboundCheckAdjustment — An Inbound Check Adjustment is created when Increase receives an adjustment for a check or return deposited through Check21. - `adjusted_transaction_id` string, required — The ID of the transaction that was adjusted. - `amount` integer, required — The amount of the check adjustment. - `reason` 'late_return' | 'wrong_payee_credit' | 'adjusted_amount' | 'non_conforming_item' | 'paid', required — The reason for the adjustment. - `inbound_check_deposit_return_intention` InboundCheckDepositReturnIntention — An Inbound Check Deposit Return Intention is created when Increase receives an Inbound Check and the User requests that it be returned. - `inbound_check_deposit_id` string, required — The ID of the Inbound Check Deposit that is being returned. - `transfer_id` string, nullable, required — The identifier of the Check Transfer object that was deposited. - `inbound_fednow_transfer_confirmation` object, nullable — An Inbound FedNow Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_fednow_transfer_confirmation`. An Inbound FedNow Transfer Confirmation is created when a FedNow transfer is initiated at another bank and received by Increase. - `transfer_id` string, required — The identifier of the FedNow Transfer that led to this Transaction. - `inbound_real_time_payments_transfer_confirmation` object, nullable — An Inbound Real-Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time Payments Transfer Confirmation is created when a Real-Time Payments transfer is initiated at another bank and received by Increase. - `amount` integer, required — The amount in the minor unit of the transfer's currency. For dollars, for example, this is cents. - `creditor_name` string, required — The name the sender of the transfer specified as the recipient of the transfer. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real-Time Payments transfer. - `debtor_account_number` string, required — The account number of the account that sent the transfer. - `debtor_name` string, required — The name provided by the sender of the transfer. - `debtor_routing_number` string, required — The routing number of the account that sent the transfer. - `transaction_identification` string, required — The Real-Time Payments network identification of the transfer. - `transfer_id` string, required — The identifier of the Real-Time Payments Transfer that led to this Transaction. - `unstructured_remittance_information` string, nullable, required — Additional information included with the transfer. - `inbound_wire_reversal` object, nullable — An Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire Reversal represents a reversal of a wire transfer that was initiated via Increase. The other bank is sending the money back. This most often happens when the original destination account details were incorrect. - `amount` integer, required — The amount that was reversed in USD cents. - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the reversal was created. - `debtor_routing_number` string, nullable, required — The debtor's routing number. - `description` string, required — The description on the reversal message from Fedwire, set by the reversing bank. - `input_cycle_date` string, date, required — The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00 PM Eastern Time on the evening before the `cycle date`. - `input_message_accountability_data` string, required — The Fedwire transaction identifier. - `input_sequence_number` string, required — The Fedwire sequence number. - `input_source` string, required — The Fedwire input source identifier. - `instruction_identification` string, nullable, required — The sending bank's identifier for the reversal. - `return_reason_additional_information` string, nullable, required — Additional information about the reason for the reversal. - `return_reason_code` string, nullable, required — A code provided by the sending bank giving a reason for the reversal. The common return reason codes are [documented here](/documentation/wire-reversals#reversal-reason-codes). - `return_reason_code_description` string, nullable, required — An Increase-generated description of the `return_reason_code`. - `transaction_id` string, required — The ID for the Transaction associated with the transfer reversal. - `wire_transfer_id` string, required — The ID for the Wire Transfer that is being reversed. - `inbound_wire_transfer` object, nullable — An Inbound Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`. An Inbound Wire Transfer Intention is created when a wire transfer is initiated at another bank and received by Increase. - `amount` integer, required — The amount in USD cents. - `creditor_address_line1` string, nullable, required — A free-form address field set by the sender. - `creditor_address_line2` string, nullable, required — A free-form address field set by the sender. - `creditor_address_line3` string, nullable, required — A free-form address field set by the sender. - `creditor_name` string, nullable, required — A name set by the sender. - `debtor_address_line1` string, nullable, required — A free-form address field set by the sender. - `debtor_address_line2` string, nullable, required — A free-form address field set by the sender. - `debtor_address_line3` string, nullable, required — A free-form address field set by the sender. - `debtor_name` string, nullable, required — A name set by the sender. - `description` string, required — An Increase-constructed description of the transfer. - `end_to_end_identification` string, nullable, required — A free-form reference string set by the sender, to help identify the transfer. - `input_message_accountability_data` string, nullable, required — A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD. It is created when the wire is submitted to the Fedwire service and is helpful when debugging wires with the originating bank. - `instructing_agent_routing_number` string, nullable, required — The American Banking Association (ABA) routing number of the bank that sent the wire. - `instruction_identification` string, nullable, required — The sending bank's identifier for the wire transfer. - `purpose` string, nullable, required — The reason for the wire transfer, as set by the sender. - `transfer_id` string, required — The ID of the Inbound Wire Transfer object that resulted in this Transaction. - `unique_end_to_end_transaction_reference` string, nullable, required — The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer. - `unstructured_remittance_information` string, nullable, required — A free-form message set by the sender. - `inbound_wire_transfer_reversal` InboundWireTransferReversal — An Inbound Wire Transfer Reversal Intention is created when Increase has received a wire and the User requests that it be reversed. - `inbound_wire_transfer_id` string, required — The ID of the Inbound Wire Transfer that is being reversed. - `interest_payment` object, nullable — An Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`. An Interest Payment represents a payment of interest on an account. Interest is usually paid monthly. - `accrued_on_account_id` string, required — The account on which the interest was accrued. - `amount` integer, required — The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency. - `period_end` string, date-time, required — The end of the period for which this transaction paid interest. - `period_start` string, date-time, required — The start of the period for which this transaction paid interest. - `internal_source` object, nullable — An Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`. A transaction between the user and Increase. See the `reason` attribute for more information. - `amount` integer, required — The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency. - `reason` 'account_closure' | 'account_revenue_payment_distribution' | 'bank_drawn_check' | 'bank_drawn_check_credit' | 'bank_migration' | 'check_adjustment' | 'collection_payment' | 'collection_receivable' | 'dishonored_ach_return' | 'empyreal_adjustment' | 'error' | 'error_correction' | 'fees' | 'general_ledger_transfer' | 'interest' | 'negative_balance_forgiveness' | 'sample_funds' | 'sample_funds_return', required — An Internal Source is a transaction between you and Increase. This describes the reason for the transaction. - `other` object, nullable — If the category of this Transaction source is equal to `other`, this field will contain an empty object, otherwise it will contain null. - `real_time_payments_transfer_acknowledgement` object, nullable — A Real-Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer Acknowledgement is created when a Real-Time Payments Transfer sent from Increase is acknowledged by the receiving bank. - `account_number` string, required — The destination account number. - `amount` integer, required — The transfer amount in USD cents. - `routing_number` string, required — The American Bankers' Association (ABA) Routing Transit Number (RTN). - `transfer_id` string, required — The identifier of the Real-Time Payments Transfer that led to this Transaction. - `unstructured_remittance_information` string, required — Unstructured information that will show on the recipient's bank statement. - `sample_funds` object, nullable — A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`. Sample funds for testing purposes. - `originator` string, required — Where the sample funds came from. - `swift_transfer_intention` object, nullable — A Swift Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `swift_transfer_intention`. A Swift Transfer initiated via Increase. - `transfer_id` string, required — The identifier of the Swift Transfer that led to this Transaction. - `swift_transfer_return` object, nullable — A Swift Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `swift_transfer_return`. A Swift Transfer Return is created when a Swift Transfer is returned by the receiving bank. - `transfer_id` string, required — The identifier of the Swift Transfer that led to this Transaction. - `wire_transfer_intention` object, nullable — A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`. A Wire Transfer initiated via Increase and sent to a different bank. - `account_number` string, required — The destination account number. - `amount` integer, required — The transfer amount in USD cents. - `message_to_recipient` string, required — The message that will show on the recipient's bank statement. - `routing_number` string, required — The American Bankers' Association (ABA) Routing Transit Number (RTN). - `transfer_id` string, required — The identifier of the Wire Transfer that led to this Transaction. - `type` 'transaction', required — A constant representing the object's type. For this resource it will always be `transaction`. ## Other responses - `4XX` — Error - `5XX` — Error --- [API](https://skmtc.net/increase/apis/increase-api-2.md) · [All operations](https://skmtc.net/increase/apis/increase-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/increase/increase-api-2/versions/e968bcd4dcf9/schema)