--- title: "Sandbox: Create a Card Authentication attempt" method: POST path: "/simulations/card_authentications" --- # Sandbox: Create a Card Authentication attempt `POST /simulations/card_authentications` Simulates a Card Authentication attempt on a [Card](#cards). The attempt always results in a [Card Payment](#card_payments) being created, either with a status that allows further action or a terminal failed status. ## Request body - SandboxCreateACardAuthenticationAttemptParameters - `card_id` string, required — The identifier of the Card to be authorized. - `category` 'payment_authentication' | 'non_payment_authentication' — The category of the card authentication attempt. - `device_channel` 'app' | 'browser' | 'three_ds_requestor_initiated' — The device channel of the card authentication attempt. - `merchant_acceptor_id` string — The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. - `merchant_category_code` string — The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. - `merchant_country` string — The country the merchant resides in. - `merchant_name` string — The name of the merchant - `purchase_amount` integer — The purchase amount in cents. ## Response `200` Card Payment - CardPayment — Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement. - `account_id` string, required — The identifier for the Account the Transaction belongs to. - `card_id` string, required — The Card identifier for this payment. - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Payment was created. - `digital_wallet_token_id` string, nullable, required — The Digital Wallet Token identifier for this payment. - `elements` object[], required — The interactions related to this card payment. - `card_authentication` CardAuthentication — Card Authentications are attempts to authenticate a transaction or a card with 3DS. - `access_control_server_transaction_identifier` string, required — A unique identifier assigned by the Access Control Server (us) for this transaction. - `billing_address_city` string, nullable, required — The city of the cardholder billing address associated with the card used for this purchase. - `billing_address_country` string, nullable, required — The country of the cardholder billing address associated with the card used for this purchase. - `billing_address_line1` string, nullable, required — The first line of the cardholder billing address associated with the card used for this purchase. - `billing_address_line2` string, nullable, required — The second line of the cardholder billing address associated with the card used for this purchase. - `billing_address_line3` string, nullable, required — The third line of the cardholder billing address associated with the card used for this purchase. - `billing_address_postal_code` string, nullable, required — The postal code of the cardholder billing address associated with the card used for this purchase. - `billing_address_state` string, nullable, required — The US state of the cardholder billing address associated with the card used for this purchase. - `card_id` string, required — The identifier of the Card. - `card_payment_id` string, required — The ID of the Card Payment this transaction belongs to. - `cardholder_email` string, nullable, required — The email address of the cardholder. - `cardholder_name` string, nullable, required — The name of the cardholder. - `challenge` object, nullable, required — Details about the challenge, if one was requested. - `attempts` object[], required — Details about the challenge verification attempts, if any happened. - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time of the Card Authentication Challenge Attempt. - `outcome` 'successful' | 'failed', required — The outcome of the Card Authentication Challenge Attempt. - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Authentication Challenge was started. - `one_time_code` string, required — The one-time code used for the Card Authentication Challenge. - `real_time_decision_id` string, nullable, required — The identifier of the Real-Time Decision used to deliver this challenge. - `verification_method` 'text_message' | 'email' | 'none_available', required — The method used to verify the Card Authentication Challenge. - `verification_value` string, nullable, required — E.g., the email address or phone number used for the Card Authentication Challenge. - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Authentication was attempted. - `deny_reason` 'group_locked' | 'card_not_active' | 'entity_not_active' | 'transaction_not_allowed' | 'webhook_denied' | 'webhook_timed_out', nullable, required — The reason why this authentication attempt was denied, if it was. - `device_channel` object, required — The device channel of the card authentication attempt. - `browser` object, nullable, required — Fields specific to the browser device channel. - `accept_header` string, nullable, required — The accept header from the cardholder's browser. - `ip_address` string, nullable, required — The IP address of the cardholder's browser. - `javascript_enabled` 'enabled' | 'disabled', nullable, required — Whether JavaScript is enabled in the cardholder's browser. - `language` string, nullable, required — The language of the cardholder's browser. - `user_agent` string, nullable, required — The user agent of the cardholder's browser. - `category` 'app' | 'browser' | 'three_ds_requestor_initiated', required — The category of the device channel. - `merchant_initiated` object, nullable, required — Fields specific to merchant initiated transactions. - `indicator` 'recurring_transaction' | 'installment_transaction' | 'add_card' | 'maintain_card_information' | 'account_verification' | 'split_delayed_shipment' | 'top_up' | 'mail_order' | 'telephone_order' | 'whitelist_status_check' | 'other_payment' | 'billing_agreement' | 'device_binding_status_check' | 'card_security_code_status_check' | 'delayed_shipment' | 'split_payment' | 'fido_credential_deletion' | 'fido_credential_registration' | 'decoupled_authentication_fallback', required — The merchant initiated indicator for the transaction. - `directory_server_transaction_identifier` string, required — A unique identifier assigned by the Directory Server (the card network) for this transaction. - `id` string, required — The Card Authentication identifier. - `merchant_acceptor_id` string, nullable, required — The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. - `merchant_category_code` string, nullable, required — The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. - `merchant_country` string, nullable, required — The country the merchant resides in. - `merchant_name` string, nullable, required — The name of the merchant. - `message_category` object, required — The message category of the card authentication attempt. - `category` 'payment_authentication' | 'non_payment_authentication', required — The category of the card authentication attempt. - `non_payment` object, nullable, required — Fields specific to non-payment authentication attempts. - `payment` object, nullable, required — Fields specific to payment authentication attempts. - `purchase_amount` integer, required — The purchase amount in minor units. - `purchase_amount_cardholder_estimated` integer, nullable, required — The purchase amount in the cardholder's currency (i.e., USD) estimated using daily conversion rates from the card network. - `purchase_currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authentication attempt's purchase currency. - `transaction_type` 'goods_service_purchase' | 'check_acceptance' | 'account_funding' | 'quasi_cash_transaction' | 'prepaid_activation_and_load', nullable, required — The type of transaction being authenticated. - `prior_authenticated_card_payment_id` string, nullable, required — The ID of a prior Card Authentication that the requestor used to authenticate this cardholder for a previous transaction. - `real_time_decision_id` string, nullable, required — The identifier of the Real-Time Decision sent to approve or decline this authentication attempt. - `requestor_authentication_indicator` 'payment_transaction' | 'recurring_transaction' | 'installment_transaction' | 'add_card' | 'maintain_card' | 'emv_token_cardholder_verification' | 'billing_agreement', nullable, required — The 3DS requestor authentication indicator describes why the authentication attempt is performed, such as for a recurring transaction. - `requestor_challenge_indicator` 'no_preference' | 'no_challenge_requested' | 'challenge_requested_3ds_requestor_preference' | 'challenge_requested_mandate' | 'no_challenge_requested_transactional_risk_analysis_already_performed' | 'no_challenge_requested_data_share_only' | 'no_challenge_requested_strong_consumer_authentication_already_performed' | 'no_challenge_requested_utilize_whitelist_exemption_if_no_challenge_required' | 'challenge_requested_whitelist_prompt_requested_if_challenge_required', nullable, required — Indicates whether a challenge is requested for this transaction. - `requestor_name` string, required — The name of the 3DS requestor. - `requestor_url` string, required — The URL of the 3DS requestor. - `shipping_address_city` string, nullable, required — The city of the shipping address associated with this purchase. - `shipping_address_country` string, nullable, required — The country of the shipping address associated with this purchase. - `shipping_address_line1` string, nullable, required — The first line of the shipping address associated with this purchase. - `shipping_address_line2` string, nullable, required — The second line of the shipping address associated with this purchase. - `shipping_address_line3` string, nullable, required — The third line of the shipping address associated with this purchase. - `shipping_address_postal_code` string, nullable, required — The postal code of the shipping address associated with this purchase. - `shipping_address_state` string, nullable, required — The US state of the shipping address associated with this purchase. - `status` 'denied' | 'authenticated_with_challenge' | 'authenticated_without_challenge' | 'awaiting_challenge' | 'validating_challenge' | 'canceled' | 'timed_out_awaiting_challenge' | 'errored' | 'exceeded_attempt_threshold', required — The status of the card authentication. - `three_d_secure_server_transaction_identifier` string, required — A unique identifier assigned by the 3DS Server initiating the authentication attempt for this transaction. - `type` 'card_authentication', required — A constant representing the object's type. For this resource it will always be `card_authentication`. - `card_authorization` CardAuthorization — Card Authorizations are temporary holds placed on a customer's funds with the intent to later clear a transaction. - `actioner` 'user' | 'increase' | 'network', required — Whether this authorization 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. - `expires_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization will expire and the pending transaction will be released. - `healthcare` object, nullable, required — The healthcare-related fields for this authorization. Only present for specific programs. - `merchant_ninety_percent_eligibility` 'eligible' | 'not_eligible', required — The merchant's eligibility under the Internal Revenue Service's 90% Rule for Flexible Spending Account (FSA) and Health Savings Account (HSA) eligible products. The eligibility is determined based on the list of merchants maintained by the Special Interest Group for IIAS Standards (SIGIS). - `id` string, required — The Card Authorization 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. - `original_card_payment_id` string, nullable, required — The ID of the Card Payment containing the original authorization or card validation this transaction references. For a merchant-initiated transaction, this is the Card Payment from when the card was first stored, which is typically where the CVV2 was verified. The reference this is derived from is supplied by the merchant or their acquirer, so it is not guaranteed to be present. - `pending_transaction_id` string, nullable, required — The identifier of the Pending Transaction associated with this Transaction. - `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 authorization, 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 authorization. - `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. - `type` 'card_authorization', required — A constant representing the object's type. For this resource it will always be `card_authorization`. - `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_authorization_expiration` CardAuthorizationExpiration — Card Authorization Expirations are cancellations of authorizations that were never settled by the acquirer. - `card_authorization_id` string, required — The identifier for the Card Authorization this reverses. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's currency. - `expired_amount` integer, required — The amount of this authorization expiration in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `id` string, required — The Card Authorization Expiration identifier. - `network` 'visa' | 'pulse', required — The card network used to process this card authorization. - `type` 'card_authorization_expiration', required — A constant representing the object's type. For this resource it will always be `card_authorization_expiration`. - `card_balance_inquiry` CardBalanceInquiry — Card Balance Inquiries are transactions that allow merchants to check the available balance on a card without placing a hold on funds, commonly used when a customer requests their balance at an ATM. - `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. - `balance` integer, required — The balance amount in the minor unit of the account'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 account'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. - `id` string, required — The Card Balance Inquiry 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. - `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 balance inquiry. - `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. - `type` 'card_balance_inquiry', required — A constant representing the object's type. For this resource it will always be `card_balance_inquiry`. - `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_decline` object, nullable — A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`. - `actioner` 'user' | 'increase' | 'network', required — Whether this authorization 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 declined amount in the minor unit of the destination account 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 destination account currency. - `declined_transaction_id` string, required — The identifier of the declined transaction created for this Card Decline. - `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 Decline identifier. - `incremented_card_authorization_id` string, nullable, required — The identifier of the card authorization this request attempted to incrementally authorize. - `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 declined 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 authorization, 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. - `real_time_decision_reason` 'insufficient_funds' | 'transaction_never_allowed' | 'exceeds_approval_limit' | 'card_temporarily_disabled' | 'suspected_fraud' | 'other', nullable, required — This is present if a specific decline reason was given in the real-time decision. - `reason` 'account_closed' | 'card_not_active' | 'card_canceled' | 'physical_card_not_active' | 'entity_not_active' | 'group_locked' | 'insufficient_funds' | 'cvv2_mismatch' | 'pin_mismatch' | 'card_expiration_mismatch' | 'transaction_not_allowed' | 'breaches_limit' | 'webhook_declined' | 'webhook_timed_out' | 'declined_by_stand_in_processing' | 'invalid_physical_card' | 'missing_original_authorization' | 'invalid_cryptogram' | 'failed_3ds_authentication' | 'suspected_card_testing' | 'suspected_fraud', required — Why the transaction was declined. - `scheme_fees` object[], required — The scheme fees associated with this card decline. - `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. - `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_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_fuel_confirmation` CardFuelConfirmation — Card Fuel Confirmations update the amount of a Card Authorization after a fuel pump transaction is completed. - `card_authorization_id` string, required — The identifier for the Card Authorization this updates. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's currency. - `id` string, required — The Card Fuel Confirmation identifier. - `network` 'visa' | 'pulse', required — The card network used to process this card authorization. - `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. - `pending_transaction_id` string, nullable, required — The identifier of the Pending Transaction associated with this Card Fuel Confirmation. - `scheme_fees` object[], required — The scheme fees associated with this card fuel confirmation. - `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%). - `type` 'card_fuel_confirmation', required — A constant representing the object's type. For this resource it will always be `card_fuel_confirmation`. - `updated_authorization_amount` integer, required — The updated authorization amount after this fuel confirmation, in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `card_increment` CardIncrement — Card Increments increase the pending amount of an authorized transaction. - `actioner` 'user' | 'increase' | 'network', required — Whether this authorization 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 amount of this increment in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `card_authorization_id` string, required — The identifier for the Card Authorization this increments. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's currency. - `id` string, required — The Card Increment identifier. - `network` 'visa' | 'pulse', required — The card network used to process this card authorization. - `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. - `pending_transaction_id` string, nullable, required — The identifier of the Pending Transaction associated with this Card Increment. - `presentment_amount` integer, required — The amount of this increment 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. - `real_time_decision_id` string, nullable, required — The identifier of the Real-Time Decision sent to approve or decline this incremental authorization. - `scheme_fees` object[], required — The scheme fees associated with this card increment. - `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%). - `type` 'card_increment', required — A constant representing the object's type. For this resource it will always be `card_increment`. - `updated_authorization_amount` integer, required — The updated authorization amount after this increment, in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `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_reversal` CardReversal — Card Reversals cancel parts of or the entirety of an existing Card Authorization. - `card_authorization_id` string, required — The identifier for the Card Authorization this reverses. - `currency` 'USD', required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's currency. - `id` string, required — The Card Reversal 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, nullable, 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` 'visa' | 'pulse', required — The card network used to process this card authorization. - `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. - `pending_transaction_id` string, nullable, required — The identifier of the Pending Transaction associated with this Card Reversal. - `presentment_currency` string, required — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's presentment currency. - `reversal_amount` integer, required — The amount of this reversal in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `reversal_presentment_amount` integer, required — The amount of this reversal in the minor unit of the transaction's presentment currency. For dollars, for example, this is cents. - `reversal_reason` 'reversed_by_customer' | 'reversed_by_network_or_acquirer' | 'reversed_by_point_of_sale' | 'partial_reversal', nullable, required — Why this reversal was initiated. - `scheme_fees` object[], required — The scheme fees associated with this card reversal. - `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. - `type` 'card_reversal', required — A constant representing the object's type. For this resource it will always be `card_reversal`. - `updated_authorization_amount` integer, required — The amount left pending on the Card Authorization in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `updated_authorization_presentment_amount` integer, required — The amount left pending on the Card Authorization in the minor unit of the transaction's presentment currency. For dollars, for example, this is cents. - `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`. - `card_validation` InboundCardValidation — Inbound Card Validations are requests from a merchant to verify that a card number and optionally its address and/or Card Verification Value are valid. - `actioner` 'user' | 'increase' | 'network', required — Whether this authorization 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. - `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. - `id` string, required — The Card Validation 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. - `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 validation. - `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. - `type` 'inbound_card_validation', required — A constant representing the object's type. For this resource it will always be `inbound_card_validation`. - `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. - `category` 'card_authorization' | 'card_authentication' | 'card_balance_inquiry' | 'card_validation' | 'card_decline' | 'card_reversal' | 'card_authorization_expiration' | 'card_increment' | 'card_settlement' | 'card_refund' | 'card_fuel_confirmation' | 'card_financial' | '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. - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the card payment element was created. - `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. - `id` string, required — The Card Payment identifier. - `physical_card_id` string, nullable, required — The Physical Card identifier for this payment. - `state` object, required — The summarized state of this card payment. - `authorized_amount` integer, required — The total authorized amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `fuel_confirmed_amount` integer, required — The total amount from fuel confirmations in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `incremented_amount` integer, required — The total incrementally updated authorized amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `refund_authorized_amount` integer, required — The total refund authorized amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `refunded_amount` integer, required — The total refunded amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `reversed_amount` integer, required — The total reversed amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `settled_amount` integer, required — The total settled amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. - `type` 'card_payment', required — A constant representing the object's type. For this resource it will always be `card_payment`. ## 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)