increase 0.11.2 → 0.11.4

package/resources/card-payments.d.ts

@@ -0,0 +1,1797 @@
+import * as Core from 'increase/core';
+import { APIResource } from 'increase/resource';
+import * as API from "./index.js";
+import { Page, PageParams } from 'increase/pagination';
+export declare class CardPayments extends APIResource {
+    /**
+     * Retrieve a Card Payment
+     */
+    retrieve(cardPaymentId: string, options?: Core.RequestOptions): Core.APIPromise<CardPayment>;
+    /**
+     * List Card Payments
+     */
+    list(query?: CardPaymentListParams, options?: Core.RequestOptions): Core.PagePromise<CardPaymentsPage, CardPayment>;
+    list(options?: Core.RequestOptions): Core.PagePromise<CardPaymentsPage, CardPayment>;
+}
+export declare class CardPaymentsPage extends Page<CardPayment> {
+}
+type _CardPaymentsPage = CardPaymentsPage;
+/**
+ * Card Payments group together interactions related to a single card payment, such
+ * as an authorization and its corresponding settlement.
+ */
+export interface CardPayment {
+    /**
+     * The Card Payment identifier.
+     */
+    id: string;
+    /**
+     * The identifier for the Account the Transaction belongs to.
+     */
+    account_id: string;
+    /**
+     * The Card identifier for this payment.
+     */
+    card_id: string;
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card
+     * Payment was created.
+     */
+    created_at: string;
+    /**
+     * The interactions related to this card payment.
+     */
+    elements: Array<CardPayment.Element>;
+    /**
+     * The summarized state of this card payment.
+     */
+    state: CardPayment.State;
+    /**
+     * A constant representing the object's type. For this resource it will always be
+     * `card_payment`.
+     */
+    type: 'card_payment';
+}
+export declare namespace CardPayment {
+    interface Element {
+        /**
+         * A Card Authorization object. This field will be present in the JSON response if
+         * and only if `category` is equal to `card_authorization`.
+         */
+        card_authorization: Element.CardAuthorization | null;
+        /**
+         * A Card Authorization Expiration object. This field will be present in the JSON
+         * response if and only if `category` is equal to `card_authorization_expiration`.
+         */
+        card_authorization_expiration: Element.CardAuthorizationExpiration | null;
+        /**
+         * A Card Decline object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_decline`.
+         */
+        card_decline: Element.CardDecline | null;
+        /**
+         * A Card Increment object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_increment`.
+         */
+        card_increment: Element.CardIncrement | null;
+        /**
+         * A Card Refund object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_refund`.
+         */
+        card_refund: Element.CardRefund | null;
+        /**
+         * A Card Reversal object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_reversal`.
+         */
+        card_reversal: Element.CardReversal | null;
+        /**
+         * A Card Settlement object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_settlement`.
+         */
+        card_settlement: Element.CardSettlement | null;
+        /**
+         * A Card Validation object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_validation`.
+         */
+        card_validation: Element.CardValidation | null;
+        /**
+         * 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.
+         *
+         * - `card_authorization` - Card Authorization: details will be under the
+         *   `card_authorization` object.
+         * - `card_validation` - Card Validation: details will be under the
+         *   `card_validation` object.
+         * - `card_decline` - Card Decline: details will be under the `card_decline`
+         *   object.
+         * - `card_reversal` - Card Reversal: details will be under the `card_reversal`
+         *   object.
+         * - `card_authorization_expiration` - Card Authorization Expiration: details will
+         *   be under the `card_authorization_expiration` object.
+         * - `card_increment` - Card Increment: details will be under the `card_increment`
+         *   object.
+         * - `card_settlement` - Card Settlement: details will be under the
+         *   `card_settlement` object.
+         * - `card_refund` - Card Refund: details will be under the `card_refund` object.
+         * - `other` - Unknown card payment element.
+         */
+        category: 'card_authorization' | 'card_validation' | 'card_decline' | 'card_reversal' | 'card_authorization_expiration' | 'card_increment' | 'card_settlement' | 'card_refund' | 'other';
+        /**
+         * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+         * the card payment element was created.
+         */
+        created_at: string;
+    }
+    namespace Element {
+        /**
+         * A Card Authorization object. This field will be present in the JSON response if
+         * and only if `category` is equal to `card_authorization`.
+         */
+        interface CardAuthorization {
+            /**
+             * The Card Authorization identifier.
+             */
+            id: string;
+            /**
+             * The pending amount in the minor unit of the transaction's currency. For dollars,
+             * for example, this is cents.
+             */
+            amount: number;
+            /**
+             * The ID of the Card Payment this transaction belongs to.
+             */
+            card_payment_id: string | null;
+            /**
+             * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+             * transaction's currency.
+             *
+             * - `CAD` - Canadian Dollar (CAD)
+             * - `CHF` - Swiss Franc (CHF)
+             * - `EUR` - Euro (EUR)
+             * - `GBP` - British Pound (GBP)
+             * - `JPY` - Japanese Yen (JPY)
+             * - `USD` - US Dollar (USD)
+             */
+            currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+            /**
+             * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
+             * purchase), the identifier of the token that was used.
+             */
+            digital_wallet_token_id: string | null;
+            /**
+             * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
+             * will expire and the pending transaction will be released.
+             */
+            expires_at: string;
+            /**
+             * The merchant identifier (commonly abbreviated as MID) of the merchant the card
+             * is transacting with.
+             */
+            merchant_acceptor_id: string;
+            /**
+             * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
+             * card is transacting with.
+             */
+            merchant_category_code: string | null;
+            /**
+             * The city the merchant resides in.
+             */
+            merchant_city: string | null;
+            /**
+             * The country the merchant resides in.
+             */
+            merchant_country: string | null;
+            /**
+             * The merchant descriptor of the merchant the card is transacting with.
+             */
+            merchant_descriptor: string;
+            /**
+             * Fields specific to the `network`.
+             */
+            network_details: CardAuthorization.NetworkDetails;
+            /**
+             * The identifier of the Pending Transaction associated with this Transaction.
+             */
+            pending_transaction_id: string | null;
+            /**
+             * If the authorization was made in-person with a physical card, the Physical Card
+             * that was used.
+             */
+            physical_card_id: string | null;
+            /**
+             * The identifier of the Real-Time Decision sent to approve or decline this
+             * transaction.
+             */
+            real_time_decision_id: string | null;
+            /**
+             * A constant representing the object's type. For this resource it will always be
+             * `card_authorization`.
+             */
+            type: 'card_authorization';
+        }
+        namespace CardAuthorization {
+            /**
+             * Fields specific to the `network`.
+             */
+            interface NetworkDetails {
+                /**
+                 * The payment network used to process this card authorization.
+                 *
+                 * - `visa` - Visa
+                 */
+                category: 'visa';
+                /**
+                 * Fields specific to the `visa` network.
+                 */
+                visa: NetworkDetails.Visa | null;
+            }
+            namespace NetworkDetails {
+                /**
+                 * Fields specific to the `visa` network.
+                 */
+                interface Visa {
+                    /**
+                     * 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.
+                     *
+                     * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
+                     *   that the transaction is a mail/phone order purchase, not a recurring
+                     *   transaction or installment payment. For domestic transactions in the US
+                     *   region, this value may also indicate one bill payment transaction in the
+                     *   card-present or card-absent environments.
+                     * - `recurring` - Recurring transaction: Payment indicator used to indicate a
+                     *   recurring transaction that originates from an acquirer in the US region.
+                     * - `installment` - Installment payment: Payment indicator used to indicate one
+                     *   purchase of goods or services that is billed to the account in multiple
+                     *   charges over a period of time agreed upon by the cardholder and merchant from
+                     *   transactions that originate from an acquirer in the US region.
+                     * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
+                     *   indicate that the type of mail/telephone order is unknown.
+                     * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
+                     *   indicate that the electronic commerce transaction has been authenticated using
+                     *   e.g., 3-D Secure
+                     * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
+                     *   Non-authenticated security transaction at a 3-D Secure-capable merchant, and
+                     *   merchant attempted to authenticate the cardholder using 3-D Secure: Use to
+                     *   identify an electronic commerce transaction where the merchant attempted to
+                     *   authenticate the cardholder using 3-D Secure, but was unable to complete the
+                     *   authentication because the issuer or cardholder does not participate in the
+                     *   3-D Secure program.
+                     * - `non_authenticated_security_transaction` - Non-authenticated security
+                     *   transaction: Use to identify an electronic commerce transaction that uses data
+                     *   encryption for security however , cardholder authentication is not performed
+                     *   using 3-D Secure.
+                     * - `non_secure_transaction` - Non-secure transaction: Use to identify an
+                     *   electronic commerce transaction that has no data protection.
+                     */
+                    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' | null;
+                    /**
+                     * The method used to enter the cardholder's primary account number and card
+                     * expiration date.
+                     *
+                     * - `unknown` - Unknown
+                     * - `manual` - Manual key entry
+                     * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
+                     *   value
+                     * - `optical_code` - Optical code
+                     * - `integrated_circuit_card` - Contact chip card
+                     * - `contactless` - Contactless read of chip card
+                     * - `credential_on_file` - Transaction initiated using a credential that has
+                     *   previously been stored on file
+                     * - `magnetic_stripe` - Magnetic stripe read
+                     * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
+                     * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
+                     *   verification value
+                     */
+                    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' | null;
+                }
+            }
+        }
+        /**
+         * A Card Authorization Expiration object. This field will be present in the JSON
+         * response if and only if `category` is equal to `card_authorization_expiration`.
+         */
+        interface CardAuthorizationExpiration {
+            /**
+             * The Card Authorization Expiration identifier.
+             */
+            id: string;
+            /**
+             * The identifier for the Card Authorization this reverses.
+             */
+            card_authorization_id: string;
+            /**
+             * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
+             * currency.
+             *
+             * - `CAD` - Canadian Dollar (CAD)
+             * - `CHF` - Swiss Franc (CHF)
+             * - `EUR` - Euro (EUR)
+             * - `GBP` - British Pound (GBP)
+             * - `JPY` - Japanese Yen (JPY)
+             * - `USD` - US Dollar (USD)
+             */
+            currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+            /**
+             * The amount of this authorization expiration in the minor unit of the
+             * transaction's currency. For dollars, for example, this is cents.
+             */
+            expired_amount: number;
+            /**
+             * The card network used to process this card authorization.
+             *
+             * - `visa` - Visa
+             */
+            network: 'visa';
+            /**
+             * A constant representing the object's type. For this resource it will always be
+             * `card_authorization_expiration`.
+             */
+            type: 'card_authorization_expiration';
+        }
+        /**
+         * A Card Decline object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_decline`.
+         */
+        interface CardDecline {
+            /**
+             * The Card Decline identifier.
+             */
+            id: string;
+            /**
+             * The declined amount in the minor unit of the destination account currency. For
+             * dollars, for example, this is cents.
+             */
+            amount: number;
+            /**
+             * The ID of the Card Payment this transaction belongs to.
+             */
+            card_payment_id: string | null;
+            /**
+             * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
+             * account currency.
+             *
+             * - `CAD` - Canadian Dollar (CAD)
+             * - `CHF` - Swiss Franc (CHF)
+             * - `EUR` - Euro (EUR)
+             * - `GBP` - British Pound (GBP)
+             * - `JPY` - Japanese Yen (JPY)
+             * - `USD` - US Dollar (USD)
+             */
+            currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+            /**
+             * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
+             * purchase), the identifier of the token that was used.
+             */
+            digital_wallet_token_id: string | null;
+            /**
+             * The merchant identifier (commonly abbreviated as MID) of the merchant the card
+             * is transacting with.
+             */
+            merchant_acceptor_id: string;
+            /**
+             * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
+             * card is transacting with.
+             */
+            merchant_category_code: string | null;
+            /**
+             * The city the merchant resides in.
+             */
+            merchant_city: string | null;
+            /**
+             * The country the merchant resides in.
+             */
+            merchant_country: string | null;
+            /**
+             * The merchant descriptor of the merchant the card is transacting with.
+             */
+            merchant_descriptor: string;
+            /**
+             * The state the merchant resides in.
+             */
+            merchant_state: string | null;
+            /**
+             * Fields specific to the `network`.
+             */
+            network_details: CardDecline.NetworkDetails;
+            /**
+             * If the authorization was made in-person with a physical card, the Physical Card
+             * that was used.
+             */
+            physical_card_id: string | null;
+            /**
+             * The identifier of the Real-Time Decision sent to approve or decline this
+             * transaction.
+             */
+            real_time_decision_id: string | null;
+            /**
+             * Why the transaction was declined.
+             *
+             * - `card_not_active` - The Card was not active.
+             * - `physical_card_not_active` - The Physical Card was not active.
+             * - `entity_not_active` - The account's entity was not active.
+             * - `group_locked` - The account was inactive.
+             * - `insufficient_funds` - The Card's Account did not have a sufficient available
+             *   balance.
+             * - `cvv2_mismatch` - The given CVV2 did not match the card's value.
+             * - `transaction_not_allowed` - The attempted card transaction is not allowed per
+             *   Increase's terms.
+             * - `breaches_limit` - The transaction was blocked by a Limit.
+             * - `webhook_declined` - Your application declined the transaction via webhook.
+             * - `webhook_timed_out` - Your application webhook did not respond without the
+             *   required timeout.
+             * - `declined_by_stand_in_processing` - Declined by stand-in processing.
+             * - `invalid_physical_card` - The card read had an invalid CVV, dCVV, or
+             *   authorization request cryptogram.
+             * - `missing_original_authorization` - The original card authorization for this
+             *   incremental authorization does not exist.
+             * - `suspected_fraud` - The transaction was suspected to be fraudulent. Please
+             *   reach out to support@increase.com for more information.
+             */
+            reason: 'card_not_active' | 'physical_card_not_active' | 'entity_not_active' | 'group_locked' | 'insufficient_funds' | 'cvv2_mismatch' | 'transaction_not_allowed' | 'breaches_limit' | 'webhook_declined' | 'webhook_timed_out' | 'declined_by_stand_in_processing' | 'invalid_physical_card' | 'missing_original_authorization' | 'suspected_fraud';
+        }
+        namespace CardDecline {
+            /**
+             * Fields specific to the `network`.
+             */
+            interface NetworkDetails {
+                /**
+                 * The payment network used to process this card authorization.
+                 *
+                 * - `visa` - Visa
+                 */
+                category: 'visa';
+                /**
+                 * Fields specific to the `visa` network.
+                 */
+                visa: NetworkDetails.Visa | null;
+            }
+            namespace NetworkDetails {
+                /**
+                 * Fields specific to the `visa` network.
+                 */
+                interface Visa {
+                    /**
+                     * 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.
+                     *
+                     * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
+                     *   that the transaction is a mail/phone order purchase, not a recurring
+                     *   transaction or installment payment. For domestic transactions in the US
+                     *   region, this value may also indicate one bill payment transaction in the
+                     *   card-present or card-absent environments.
+                     * - `recurring` - Recurring transaction: Payment indicator used to indicate a
+                     *   recurring transaction that originates from an acquirer in the US region.
+                     * - `installment` - Installment payment: Payment indicator used to indicate one
+                     *   purchase of goods or services that is billed to the account in multiple
+                     *   charges over a period of time agreed upon by the cardholder and merchant from
+                     *   transactions that originate from an acquirer in the US region.
+                     * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
+                     *   indicate that the type of mail/telephone order is unknown.
+                     * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
+                     *   indicate that the electronic commerce transaction has been authenticated using
+                     *   e.g., 3-D Secure
+                     * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
+                     *   Non-authenticated security transaction at a 3-D Secure-capable merchant, and
+                     *   merchant attempted to authenticate the cardholder using 3-D Secure: Use to
+                     *   identify an electronic commerce transaction where the merchant attempted to
+                     *   authenticate the cardholder using 3-D Secure, but was unable to complete the
+                     *   authentication because the issuer or cardholder does not participate in the
+                     *   3-D Secure program.
+                     * - `non_authenticated_security_transaction` - Non-authenticated security
+                     *   transaction: Use to identify an electronic commerce transaction that uses data
+                     *   encryption for security however , cardholder authentication is not performed
+                     *   using 3-D Secure.
+                     * - `non_secure_transaction` - Non-secure transaction: Use to identify an
+                     *   electronic commerce transaction that has no data protection.
+                     */
+                    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' | null;
+                    /**
+                     * The method used to enter the cardholder's primary account number and card
+                     * expiration date.
+                     *
+                     * - `unknown` - Unknown
+                     * - `manual` - Manual key entry
+                     * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
+                     *   value
+                     * - `optical_code` - Optical code
+                     * - `integrated_circuit_card` - Contact chip card
+                     * - `contactless` - Contactless read of chip card
+                     * - `credential_on_file` - Transaction initiated using a credential that has
+                     *   previously been stored on file
+                     * - `magnetic_stripe` - Magnetic stripe read
+                     * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
+                     * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
+                     *   verification value
+                     */
+                    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' | null;
+                }
+            }
+        }
+        /**
+         * A Card Increment object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_increment`.
+         */
+        interface CardIncrement {
+            /**
+             * The Card Increment identifier.
+             */
+            id: string;
+            /**
+             * The amount of this increment in the minor unit of the transaction's currency.
+             * For dollars, for example, this is cents.
+             */
+            amount: number;
+            /**
+             * The identifier for the Card Authorization this reverses.
+             */
+            card_authorization_id: string;
+            /**
+             * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's
+             * currency.
+             *
+             * - `CAD` - Canadian Dollar (CAD)
+             * - `CHF` - Swiss Franc (CHF)
+             * - `EUR` - Euro (EUR)
+             * - `GBP` - British Pound (GBP)
+             * - `JPY` - Japanese Yen (JPY)
+             * - `USD` - US Dollar (USD)
+             */
+            currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+            /**
+             * The card network used to process this card authorization.
+             *
+             * - `visa` - Visa
+             */
+            network: 'visa';
+            /**
+             * The identifier of the Real-Time Decision sent to approve or decline this
+             * incremental authorization.
+             */
+            real_time_decision_id: string | null;
+            /**
+             * A constant representing the object's type. For this resource it will always be
+             * `card_increment`.
+             */
+            type: 'card_increment';
+            /**
+             * The updated authorization amount after this increment, in the minor unit of the
+             * transaction's currency. For dollars, for example, this is cents.
+             */
+            updated_authorization_amount: number;
+        }
+        /**
+         * A Card Refund object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_refund`.
+         */
+        interface CardRefund {
+            /**
+             * The Card Refund identifier.
+             */
+            id: string;
+            /**
+             * The pending amount in the minor unit of the transaction's currency. For dollars,
+             * for example, this is cents.
+             */
+            amount: number;
+            /**
+             * The ID of the Card Payment this transaction belongs to.
+             */
+            card_payment_id: string | null;
+            /**
+             * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+             * transaction's currency.
+             *
+             * - `CAD` - Canadian Dollar (CAD)
+             * - `CHF` - Swiss Franc (CHF)
+             * - `EUR` - Euro (EUR)
+             * - `GBP` - British Pound (GBP)
+             * - `JPY` - Japanese Yen (JPY)
+             * - `USD` - US Dollar (USD)
+             */
+            currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+            /**
+             * The merchant identifier (commonly abbreviated as MID) of the merchant the card
+             * is transacting with.
+             */
+            merchant_acceptor_id: string | null;
+            /**
+             * The 4-digit MCC describing the merchant's business.
+             */
+            merchant_category_code: string;
+            /**
+             * The city the merchant resides in.
+             */
+            merchant_city: string | null;
+            /**
+             * The country the merchant resides in.
+             */
+            merchant_country: string;
+            /**
+             * The name of the merchant.
+             */
+            merchant_name: string | null;
+            /**
+             * The state the merchant resides in.
+             */
+            merchant_state: string | null;
+            /**
+             * Additional details about the card purchase, such as tax and industry-specific
+             * fields.
+             */
+            purchase_details: CardRefund.PurchaseDetails | null;
+            /**
+             * The identifier of the Transaction associated with this Transaction.
+             */
+            transaction_id: string;
+            /**
+             * A constant representing the object's type. For this resource it will always be
+             * `card_refund`.
+             */
+            type: 'card_refund';
+        }
+        namespace CardRefund {
+            /**
+             * Additional details about the card purchase, such as tax and industry-specific
+             * fields.
+             */
+            interface PurchaseDetails {
+                /**
+                 * Fields specific to car rentals.
+                 */
+                car_rental: PurchaseDetails.CarRental | null;
+                /**
+                 * An identifier from the merchant for the customer or consumer.
+                 */
+                customer_reference_identifier: string | null;
+                /**
+                 * The state or provincial tax amount in minor units.
+                 */
+                local_tax_amount: number | null;
+                /**
+                 * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
+                 * assessed.
+                 */
+                local_tax_currency: string | null;
+                /**
+                 * Fields specific to lodging.
+                 */
+                lodging: PurchaseDetails.Lodging | null;
+                /**
+                 * The national tax amount in minor units.
+                 */
+                national_tax_amount: number | null;
+                /**
+                 * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
+                 * assessed.
+                 */
+                national_tax_currency: string | null;
+                /**
+                 * An identifier from the merchant for the purchase to the issuer and cardholder.
+                 */
+                purchase_identifier: string | null;
+                /**
+                 * The format of the purchase identifier.
+                 *
+                 * - `free_text` - Free text
+                 * - `order_number` - Order number
+                 * - `rental_agreement_number` - Rental agreement number
+                 * - `hotel_folio_number` - Hotel folio number
+                 * - `invoice_number` - Invoice number
+                 */
+                purchase_identifier_format: 'free_text' | 'order_number' | 'rental_agreement_number' | 'hotel_folio_number' | 'invoice_number' | null;
+                /**
+                 * Fields specific to travel.
+                 */
+                travel: PurchaseDetails.Travel | null;
+            }
+            namespace PurchaseDetails {
+                /**
+                 * Fields specific to car rentals.
+                 */
+                interface CarRental {
+                    /**
+                     * Code indicating the vehicle's class.
+                     */
+                    car_class_code: string | null;
+                    /**
+                     * Date the customer picked up the car or, in the case of a no-show or pre-pay
+                     * transaction, the scheduled pick up date.
+                     */
+                    checkout_date: string | null;
+                    /**
+                     * Daily rate being charged for the vehicle.
+                     */
+                    daily_rental_rate_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
+                     * rate.
+                     */
+                    daily_rental_rate_currency: string | null;
+                    /**
+                     * Number of days the vehicle was rented.
+                     */
+                    days_rented: number | null;
+                    /**
+                     * Additional charges (gas, late fee, etc.) being billed.
+                     *
+                     * - `no_extra_charge` - No extra charge
+                     * - `gas` - Gas
+                     * - `extra_mileage` - Extra mileage
+                     * - `late_return` - Late return
+                     * - `one_way_service_fee` - One way service fee
+                     * - `parking_violation` - Parking violation
+                     */
+                    extra_charges: 'no_extra_charge' | 'gas' | 'extra_mileage' | 'late_return' | 'one_way_service_fee' | 'parking_violation' | null;
+                    /**
+                     * Fuel charges for the vehicle.
+                     */
+                    fuel_charges_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
+                     * assessed.
+                     */
+                    fuel_charges_currency: string | null;
+                    /**
+                     * Any insurance being charged for the vehicle.
+                     */
+                    insurance_charges_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
+                     * charges assessed.
+                     */
+                    insurance_charges_currency: string | null;
+                    /**
+                     * An indicator that the cardholder is being billed for a reserved vehicle that was
+                     * not actually rented (that is, a "no-show" charge).
+                     *
+                     * - `not_applicable` - Not applicable
+                     * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
+                     */
+                    no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
+                    /**
+                     * Charges for returning the vehicle at a different location than where it was
+                     * picked up.
+                     */
+                    one_way_drop_off_charges_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
+                     * drop-off charges assessed.
+                     */
+                    one_way_drop_off_charges_currency: string | null;
+                    /**
+                     * Name of the person renting the vehicle.
+                     */
+                    renter_name: string | null;
+                    /**
+                     * Weekly rate being charged for the vehicle.
+                     */
+                    weekly_rental_rate_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
+                     * rental rate.
+                     */
+                    weekly_rental_rate_currency: string | null;
+                }
+                /**
+                 * Fields specific to lodging.
+                 */
+                interface Lodging {
+                    /**
+                     * Date the customer checked in.
+                     */
+                    check_in_date: string | null;
+                    /**
+                     * Daily rate being charged for the room.
+                     */
+                    daily_room_rate_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
+                     * rate.
+                     */
+                    daily_room_rate_currency: string | null;
+                    /**
+                     * Additional charges (phone, late check-out, etc.) being billed.
+                     *
+                     * - `no_extra_charge` - No extra charge
+                     * - `restaurant` - Restaurant
+                     * - `gift_shop` - Gift shop
+                     * - `mini_bar` - Mini bar
+                     * - `telephone` - Telephone
+                     * - `other` - Other
+                     * - `laundry` - Laundry
+                     */
+                    extra_charges: 'no_extra_charge' | 'restaurant' | 'gift_shop' | 'mini_bar' | 'telephone' | 'other' | 'laundry' | null;
+                    /**
+                     * Folio cash advances for the room.
+                     */
+                    folio_cash_advances_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
+                     * advances.
+                     */
+                    folio_cash_advances_currency: string | null;
+                    /**
+                     * Food and beverage charges for the room.
+                     */
+                    food_beverage_charges_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
+                     * beverage charges.
+                     */
+                    food_beverage_charges_currency: string | null;
+                    /**
+                     * Indicator that the cardholder is being billed for a reserved room that was not
+                     * actually used.
+                     *
+                     * - `not_applicable` - Not applicable
+                     * - `no_show` - No show
+                     */
+                    no_show_indicator: 'not_applicable' | 'no_show' | null;
+                    /**
+                     * Prepaid expenses being charged for the room.
+                     */
+                    prepaid_expenses_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
+                     * expenses.
+                     */
+                    prepaid_expenses_currency: string | null;
+                    /**
+                     * Number of nights the room was rented.
+                     */
+                    room_nights: number | null;
+                    /**
+                     * Total room tax being charged.
+                     */
+                    total_room_tax_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
+                     * tax.
+                     */
+                    total_room_tax_currency: string | null;
+                    /**
+                     * Total tax being charged for the room.
+                     */
+                    total_tax_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
+                     * assessed.
+                     */
+                    total_tax_currency: string | null;
+                }
+                /**
+                 * Fields specific to travel.
+                 */
+                interface Travel {
+                    /**
+                     * Ancillary purchases in addition to the airfare.
+                     */
+                    ancillary: Travel.Ancillary | null;
+                    /**
+                     * Indicates the computerized reservation system used to book the ticket.
+                     */
+                    computerized_reservation_system: string | null;
+                    /**
+                     * Indicates the reason for a credit to the cardholder.
+                     *
+                     * - `no_credit` - No credit
+                     * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
+                     *   ancillary purchase cancellation
+                     * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
+                     *   Airline ticket and passenger transport ancillary purchase cancellation
+                     * - `airline_ticket_cancellation` - Airline ticket cancellation
+                     * - `other` - Other
+                     * - `partial_refund_of_airline_ticket` - Partial refund of airline 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' | null;
+                    /**
+                     * Date of departure.
+                     */
+                    departure_date: string | null;
+                    /**
+                     * Code for the originating city or airport.
+                     */
+                    origination_city_airport_code: string | null;
+                    /**
+                     * Name of the passenger.
+                     */
+                    passenger_name: string | null;
+                    /**
+                     * Indicates whether this ticket is non-refundable.
+                     *
+                     * - `no_restrictions` - No restrictions
+                     * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
+                     */
+                    restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
+                    /**
+                     * Indicates why a ticket was changed.
+                     *
+                     * - `none` - None
+                     * - `change_to_existing_ticket` - Change to existing ticket
+                     * - `new_ticket` - New ticket
+                     */
+                    ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
+                    /**
+                     * Ticket number.
+                     */
+                    ticket_number: string | null;
+                    /**
+                     * Code for the travel agency if the ticket was issued by a travel agency.
+                     */
+                    travel_agency_code: string | null;
+                    /**
+                     * Name of the travel agency if the ticket was issued by a travel agency.
+                     */
+                    travel_agency_name: string | null;
+                    /**
+                     * Fields specific to each leg of the journey.
+                     */
+                    trip_legs: Array<Travel.TripLeg> | null;
+                }
+                namespace Travel {
+                    /**
+                     * Ancillary purchases in addition to the airfare.
+                     */
+                    interface Ancillary {
+                        /**
+                         * 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.
+                         */
+                        connected_ticket_document_number: string | null;
+                        /**
+                         * Indicates the reason for a credit to the cardholder.
+                         *
+                         * - `no_credit` - No credit
+                         * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
+                         *   ancillary purchase cancellation
+                         * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
+                         *   Airline ticket and passenger transport ancillary purchase cancellation
+                         * - `other` - Other
+                         */
+                        credit_reason_indicator: 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'other' | null;
+                        /**
+                         * Name of the passenger or description of the ancillary purchase.
+                         */
+                        passenger_name_or_description: string | null;
+                        /**
+                         * Additional travel charges, such as baggage fees.
+                         */
+                        services: Array<Ancillary.Service>;
+                        /**
+                         * Ticket document number.
+                         */
+                        ticket_document_number: string | null;
+                    }
+                    namespace Ancillary {
+                        interface Service {
+                            /**
+                             * Category of the ancillary service.
+                             *
+                             * - `none` - None
+                             * - `bundled_service` - Bundled service
+                             * - `baggage_fee` - Baggage fee
+                             * - `change_fee` - Change fee
+                             * - `cargo` - Cargo
+                             * - `carbon_offset` - Carbon offset
+                             * - `frequent_flyer` - Frequent flyer
+                             * - `gift_card` - Gift card
+                             * - `ground_transport` - Ground transport
+                             * - `in_flight_entertainment` - In-flight entertainment
+                             * - `lounge` - Lounge
+                             * - `medical` - Medical
+                             * - `meal_beverage` - Meal beverage
+                             * - `other` - Other
+                             * - `passenger_assist_fee` - Passenger assist fee
+                             * - `pets` - Pets
+                             * - `seat_fees` - Seat fees
+                             * - `standby` - Standby
+                             * - `service_fee` - Service fee
+                             * - `store` - Store
+                             * - `travel_service` - Travel service
+                             * - `unaccompanied_travel` - Unaccompanied travel
+                             * - `upgrades` - Upgrades
+                             * - `wifi` - Wi-fi
+                             */
+                            category: 'none' | 'bundled_service' | 'baggage_fee' | 'change_fee' | 'cargo' | 'carbon_offset' | 'frequent_flyer' | 'gift_card' | 'ground_transport' | 'in_flight_entertainment' | 'lounge' | 'medical' | 'meal_beverage' | 'other' | 'passenger_assist_fee' | 'pets' | 'seat_fees' | 'standby' | 'service_fee' | 'store' | 'travel_service' | 'unaccompanied_travel' | 'upgrades' | 'wifi' | null;
+                            /**
+                             * Sub-category of the ancillary service, free-form.
+                             */
+                            sub_category: string | null;
+                        }
+                    }
+                    interface TripLeg {
+                        /**
+                         * Carrier code (e.g., United Airlines, Jet Blue, etc.).
+                         */
+                        carrier_code: string | null;
+                        /**
+                         * Code for the destination city or airport.
+                         */
+                        destination_city_airport_code: string | null;
+                        /**
+                         * Fare basis code.
+                         */
+                        fare_basis_code: string | null;
+                        /**
+                         * Flight number.
+                         */
+                        flight_number: string | null;
+                        /**
+                         * Service class (e.g., first class, business class, etc.).
+                         */
+                        service_class: string | null;
+                        /**
+                         * Indicates whether a stopover is allowed on this ticket.
+                         *
+                         * - `none` - None
+                         * - `stop_over_allowed` - Stop over allowed
+                         * - `stop_over_not_allowed` - Stop over not allowed
+                         */
+                        stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
+                    }
+                }
+            }
+        }
+        /**
+         * A Card Reversal object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_reversal`.
+         */
+        interface CardReversal {
+            /**
+             * The Card Reversal identifier.
+             */
+            id: string;
+            /**
+             * The identifier for the Card Authorization this reverses.
+             */
+            card_authorization_id: string;
+            /**
+             * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
+             * currency.
+             *
+             * - `CAD` - Canadian Dollar (CAD)
+             * - `CHF` - Swiss Franc (CHF)
+             * - `EUR` - Euro (EUR)
+             * - `GBP` - British Pound (GBP)
+             * - `JPY` - Japanese Yen (JPY)
+             * - `USD` - US Dollar (USD)
+             */
+            currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+            /**
+             * The card network used to process this card authorization.
+             *
+             * - `visa` - Visa
+             */
+            network: 'visa';
+            /**
+             * The amount of this reversal in the minor unit of the transaction's currency. For
+             * dollars, for example, this is cents.
+             */
+            reversal_amount: number;
+            /**
+             * A constant representing the object's type. For this resource it will always be
+             * `card_reversal`.
+             */
+            type: 'card_reversal';
+            /**
+             * 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_amount: number;
+        }
+        /**
+         * A Card Settlement object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_settlement`.
+         */
+        interface CardSettlement {
+            /**
+             * The Card Settlement identifier.
+             */
+            id: string;
+            /**
+             * The amount in the minor unit of the transaction's settlement currency. For
+             * dollars, for example, this is cents.
+             */
+            amount: number;
+            /**
+             * The Card Authorization that was created prior to this Card Settlement, if one
+             * exists.
+             */
+            card_authorization: string | null;
+            /**
+             * The ID of the Card Payment this transaction belongs to.
+             */
+            card_payment_id: string | null;
+            /**
+             * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+             * transaction's settlement currency.
+             *
+             * - `CAD` - Canadian Dollar (CAD)
+             * - `CHF` - Swiss Franc (CHF)
+             * - `EUR` - Euro (EUR)
+             * - `GBP` - British Pound (GBP)
+             * - `JPY` - Japanese Yen (JPY)
+             * - `USD` - US Dollar (USD)
+             */
+            currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+            /**
+             * The merchant identifier (commonly abbreviated as MID) of the merchant the card
+             * is transacting with.
+             */
+            merchant_acceptor_id: string | null;
+            /**
+             * The 4-digit MCC describing the merchant's business.
+             */
+            merchant_category_code: string;
+            /**
+             * The city the merchant resides in.
+             */
+            merchant_city: string | null;
+            /**
+             * The country the merchant resides in.
+             */
+            merchant_country: string;
+            /**
+             * The name of the merchant.
+             */
+            merchant_name: string | null;
+            /**
+             * The state the merchant resides in.
+             */
+            merchant_state: string | null;
+            /**
+             * The identifier of the Pending Transaction associated with this Transaction.
+             */
+            pending_transaction_id: string | null;
+            /**
+             * The amount in the minor unit of the transaction's presentment currency.
+             */
+            presentment_amount: number;
+            /**
+             * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+             * transaction's presentment currency.
+             */
+            presentment_currency: string;
+            /**
+             * Additional details about the card purchase, such as tax and industry-specific
+             * fields.
+             */
+            purchase_details: CardSettlement.PurchaseDetails | null;
+            /**
+             * The identifier of the Transaction associated with this Transaction.
+             */
+            transaction_id: string;
+            /**
+             * A constant representing the object's type. For this resource it will always be
+             * `card_settlement`.
+             */
+            type: 'card_settlement';
+        }
+        namespace CardSettlement {
+            /**
+             * Additional details about the card purchase, such as tax and industry-specific
+             * fields.
+             */
+            interface PurchaseDetails {
+                /**
+                 * Fields specific to car rentals.
+                 */
+                car_rental: PurchaseDetails.CarRental | null;
+                /**
+                 * An identifier from the merchant for the customer or consumer.
+                 */
+                customer_reference_identifier: string | null;
+                /**
+                 * The state or provincial tax amount in minor units.
+                 */
+                local_tax_amount: number | null;
+                /**
+                 * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
+                 * assessed.
+                 */
+                local_tax_currency: string | null;
+                /**
+                 * Fields specific to lodging.
+                 */
+                lodging: PurchaseDetails.Lodging | null;
+                /**
+                 * The national tax amount in minor units.
+                 */
+                national_tax_amount: number | null;
+                /**
+                 * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
+                 * assessed.
+                 */
+                national_tax_currency: string | null;
+                /**
+                 * An identifier from the merchant for the purchase to the issuer and cardholder.
+                 */
+                purchase_identifier: string | null;
+                /**
+                 * The format of the purchase identifier.
+                 *
+                 * - `free_text` - Free text
+                 * - `order_number` - Order number
+                 * - `rental_agreement_number` - Rental agreement number
+                 * - `hotel_folio_number` - Hotel folio number
+                 * - `invoice_number` - Invoice number
+                 */
+                purchase_identifier_format: 'free_text' | 'order_number' | 'rental_agreement_number' | 'hotel_folio_number' | 'invoice_number' | null;
+                /**
+                 * Fields specific to travel.
+                 */
+                travel: PurchaseDetails.Travel | null;
+            }
+            namespace PurchaseDetails {
+                /**
+                 * Fields specific to car rentals.
+                 */
+                interface CarRental {
+                    /**
+                     * Code indicating the vehicle's class.
+                     */
+                    car_class_code: string | null;
+                    /**
+                     * Date the customer picked up the car or, in the case of a no-show or pre-pay
+                     * transaction, the scheduled pick up date.
+                     */
+                    checkout_date: string | null;
+                    /**
+                     * Daily rate being charged for the vehicle.
+                     */
+                    daily_rental_rate_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
+                     * rate.
+                     */
+                    daily_rental_rate_currency: string | null;
+                    /**
+                     * Number of days the vehicle was rented.
+                     */
+                    days_rented: number | null;
+                    /**
+                     * Additional charges (gas, late fee, etc.) being billed.
+                     *
+                     * - `no_extra_charge` - No extra charge
+                     * - `gas` - Gas
+                     * - `extra_mileage` - Extra mileage
+                     * - `late_return` - Late return
+                     * - `one_way_service_fee` - One way service fee
+                     * - `parking_violation` - Parking violation
+                     */
+                    extra_charges: 'no_extra_charge' | 'gas' | 'extra_mileage' | 'late_return' | 'one_way_service_fee' | 'parking_violation' | null;
+                    /**
+                     * Fuel charges for the vehicle.
+                     */
+                    fuel_charges_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
+                     * assessed.
+                     */
+                    fuel_charges_currency: string | null;
+                    /**
+                     * Any insurance being charged for the vehicle.
+                     */
+                    insurance_charges_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
+                     * charges assessed.
+                     */
+                    insurance_charges_currency: string | null;
+                    /**
+                     * An indicator that the cardholder is being billed for a reserved vehicle that was
+                     * not actually rented (that is, a "no-show" charge).
+                     *
+                     * - `not_applicable` - Not applicable
+                     * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
+                     */
+                    no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
+                    /**
+                     * Charges for returning the vehicle at a different location than where it was
+                     * picked up.
+                     */
+                    one_way_drop_off_charges_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
+                     * drop-off charges assessed.
+                     */
+                    one_way_drop_off_charges_currency: string | null;
+                    /**
+                     * Name of the person renting the vehicle.
+                     */
+                    renter_name: string | null;
+                    /**
+                     * Weekly rate being charged for the vehicle.
+                     */
+                    weekly_rental_rate_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
+                     * rental rate.
+                     */
+                    weekly_rental_rate_currency: string | null;
+                }
+                /**
+                 * Fields specific to lodging.
+                 */
+                interface Lodging {
+                    /**
+                     * Date the customer checked in.
+                     */
+                    check_in_date: string | null;
+                    /**
+                     * Daily rate being charged for the room.
+                     */
+                    daily_room_rate_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
+                     * rate.
+                     */
+                    daily_room_rate_currency: string | null;
+                    /**
+                     * Additional charges (phone, late check-out, etc.) being billed.
+                     *
+                     * - `no_extra_charge` - No extra charge
+                     * - `restaurant` - Restaurant
+                     * - `gift_shop` - Gift shop
+                     * - `mini_bar` - Mini bar
+                     * - `telephone` - Telephone
+                     * - `other` - Other
+                     * - `laundry` - Laundry
+                     */
+                    extra_charges: 'no_extra_charge' | 'restaurant' | 'gift_shop' | 'mini_bar' | 'telephone' | 'other' | 'laundry' | null;
+                    /**
+                     * Folio cash advances for the room.
+                     */
+                    folio_cash_advances_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
+                     * advances.
+                     */
+                    folio_cash_advances_currency: string | null;
+                    /**
+                     * Food and beverage charges for the room.
+                     */
+                    food_beverage_charges_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
+                     * beverage charges.
+                     */
+                    food_beverage_charges_currency: string | null;
+                    /**
+                     * Indicator that the cardholder is being billed for a reserved room that was not
+                     * actually used.
+                     *
+                     * - `not_applicable` - Not applicable
+                     * - `no_show` - No show
+                     */
+                    no_show_indicator: 'not_applicable' | 'no_show' | null;
+                    /**
+                     * Prepaid expenses being charged for the room.
+                     */
+                    prepaid_expenses_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
+                     * expenses.
+                     */
+                    prepaid_expenses_currency: string | null;
+                    /**
+                     * Number of nights the room was rented.
+                     */
+                    room_nights: number | null;
+                    /**
+                     * Total room tax being charged.
+                     */
+                    total_room_tax_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
+                     * tax.
+                     */
+                    total_room_tax_currency: string | null;
+                    /**
+                     * Total tax being charged for the room.
+                     */
+                    total_tax_amount: number | null;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
+                     * assessed.
+                     */
+                    total_tax_currency: string | null;
+                }
+                /**
+                 * Fields specific to travel.
+                 */
+                interface Travel {
+                    /**
+                     * Ancillary purchases in addition to the airfare.
+                     */
+                    ancillary: Travel.Ancillary | null;
+                    /**
+                     * Indicates the computerized reservation system used to book the ticket.
+                     */
+                    computerized_reservation_system: string | null;
+                    /**
+                     * Indicates the reason for a credit to the cardholder.
+                     *
+                     * - `no_credit` - No credit
+                     * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
+                     *   ancillary purchase cancellation
+                     * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
+                     *   Airline ticket and passenger transport ancillary purchase cancellation
+                     * - `airline_ticket_cancellation` - Airline ticket cancellation
+                     * - `other` - Other
+                     * - `partial_refund_of_airline_ticket` - Partial refund of airline 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' | null;
+                    /**
+                     * Date of departure.
+                     */
+                    departure_date: string | null;
+                    /**
+                     * Code for the originating city or airport.
+                     */
+                    origination_city_airport_code: string | null;
+                    /**
+                     * Name of the passenger.
+                     */
+                    passenger_name: string | null;
+                    /**
+                     * Indicates whether this ticket is non-refundable.
+                     *
+                     * - `no_restrictions` - No restrictions
+                     * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
+                     */
+                    restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
+                    /**
+                     * Indicates why a ticket was changed.
+                     *
+                     * - `none` - None
+                     * - `change_to_existing_ticket` - Change to existing ticket
+                     * - `new_ticket` - New ticket
+                     */
+                    ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
+                    /**
+                     * Ticket number.
+                     */
+                    ticket_number: string | null;
+                    /**
+                     * Code for the travel agency if the ticket was issued by a travel agency.
+                     */
+                    travel_agency_code: string | null;
+                    /**
+                     * Name of the travel agency if the ticket was issued by a travel agency.
+                     */
+                    travel_agency_name: string | null;
+                    /**
+                     * Fields specific to each leg of the journey.
+                     */
+                    trip_legs: Array<Travel.TripLeg> | null;
+                }
+                namespace Travel {
+                    /**
+                     * Ancillary purchases in addition to the airfare.
+                     */
+                    interface Ancillary {
+                        /**
+                         * 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.
+                         */
+                        connected_ticket_document_number: string | null;
+                        /**
+                         * Indicates the reason for a credit to the cardholder.
+                         *
+                         * - `no_credit` - No credit
+                         * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
+                         *   ancillary purchase cancellation
+                         * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
+                         *   Airline ticket and passenger transport ancillary purchase cancellation
+                         * - `other` - Other
+                         */
+                        credit_reason_indicator: 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'other' | null;
+                        /**
+                         * Name of the passenger or description of the ancillary purchase.
+                         */
+                        passenger_name_or_description: string | null;
+                        /**
+                         * Additional travel charges, such as baggage fees.
+                         */
+                        services: Array<Ancillary.Service>;
+                        /**
+                         * Ticket document number.
+                         */
+                        ticket_document_number: string | null;
+                    }
+                    namespace Ancillary {
+                        interface Service {
+                            /**
+                             * Category of the ancillary service.
+                             *
+                             * - `none` - None
+                             * - `bundled_service` - Bundled service
+                             * - `baggage_fee` - Baggage fee
+                             * - `change_fee` - Change fee
+                             * - `cargo` - Cargo
+                             * - `carbon_offset` - Carbon offset
+                             * - `frequent_flyer` - Frequent flyer
+                             * - `gift_card` - Gift card
+                             * - `ground_transport` - Ground transport
+                             * - `in_flight_entertainment` - In-flight entertainment
+                             * - `lounge` - Lounge
+                             * - `medical` - Medical
+                             * - `meal_beverage` - Meal beverage
+                             * - `other` - Other
+                             * - `passenger_assist_fee` - Passenger assist fee
+                             * - `pets` - Pets
+                             * - `seat_fees` - Seat fees
+                             * - `standby` - Standby
+                             * - `service_fee` - Service fee
+                             * - `store` - Store
+                             * - `travel_service` - Travel service
+                             * - `unaccompanied_travel` - Unaccompanied travel
+                             * - `upgrades` - Upgrades
+                             * - `wifi` - Wi-fi
+                             */
+                            category: 'none' | 'bundled_service' | 'baggage_fee' | 'change_fee' | 'cargo' | 'carbon_offset' | 'frequent_flyer' | 'gift_card' | 'ground_transport' | 'in_flight_entertainment' | 'lounge' | 'medical' | 'meal_beverage' | 'other' | 'passenger_assist_fee' | 'pets' | 'seat_fees' | 'standby' | 'service_fee' | 'store' | 'travel_service' | 'unaccompanied_travel' | 'upgrades' | 'wifi' | null;
+                            /**
+                             * Sub-category of the ancillary service, free-form.
+                             */
+                            sub_category: string | null;
+                        }
+                    }
+                    interface TripLeg {
+                        /**
+                         * Carrier code (e.g., United Airlines, Jet Blue, etc.).
+                         */
+                        carrier_code: string | null;
+                        /**
+                         * Code for the destination city or airport.
+                         */
+                        destination_city_airport_code: string | null;
+                        /**
+                         * Fare basis code.
+                         */
+                        fare_basis_code: string | null;
+                        /**
+                         * Flight number.
+                         */
+                        flight_number: string | null;
+                        /**
+                         * Service class (e.g., first class, business class, etc.).
+                         */
+                        service_class: string | null;
+                        /**
+                         * Indicates whether a stopover is allowed on this ticket.
+                         *
+                         * - `none` - None
+                         * - `stop_over_allowed` - Stop over allowed
+                         * - `stop_over_not_allowed` - Stop over not allowed
+                         */
+                        stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
+                    }
+                }
+            }
+        }
+        /**
+         * A Card Validation object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_validation`.
+         */
+        interface CardValidation {
+            /**
+             * The Card Validation identifier.
+             */
+            id: string;
+            /**
+             * The ID of the Card Payment this transaction belongs to.
+             */
+            card_payment_id: string | null;
+            /**
+             * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
+             * transaction's currency.
+             *
+             * - `CAD` - Canadian Dollar (CAD)
+             * - `CHF` - Swiss Franc (CHF)
+             * - `EUR` - Euro (EUR)
+             * - `GBP` - British Pound (GBP)
+             * - `JPY` - Japanese Yen (JPY)
+             * - `USD` - US Dollar (USD)
+             */
+            currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
+            /**
+             * If the authorization was made via a Digital Wallet Token (such as an Apple Pay
+             * purchase), the identifier of the token that was used.
+             */
+            digital_wallet_token_id: string | null;
+            /**
+             * The merchant identifier (commonly abbreviated as MID) of the merchant the card
+             * is transacting with.
+             */
+            merchant_acceptor_id: string;
+            /**
+             * The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
+             * card is transacting with.
+             */
+            merchant_category_code: string | null;
+            /**
+             * The city the merchant resides in.
+             */
+            merchant_city: string | null;
+            /**
+             * The country the merchant resides in.
+             */
+            merchant_country: string | null;
+            /**
+             * The merchant descriptor of the merchant the card is transacting with.
+             */
+            merchant_descriptor: string;
+            /**
+             * Fields specific to the `network`.
+             */
+            network_details: CardValidation.NetworkDetails;
+            /**
+             * If the authorization was made in-person with a physical card, the Physical Card
+             * that was used.
+             */
+            physical_card_id: string | null;
+            /**
+             * The identifier of the Real-Time Decision sent to approve or decline this
+             * transaction.
+             */
+            real_time_decision_id: string | null;
+            /**
+             * A constant representing the object's type. For this resource it will always be
+             * `card_validation`.
+             */
+            type: 'card_validation';
+        }
+        namespace CardValidation {
+            /**
+             * Fields specific to the `network`.
+             */
+            interface NetworkDetails {
+                /**
+                 * The payment network used to process this card authorization.
+                 *
+                 * - `visa` - Visa
+                 */
+                category: 'visa';
+                /**
+                 * Fields specific to the `visa` network.
+                 */
+                visa: NetworkDetails.Visa | null;
+            }
+            namespace NetworkDetails {
+                /**
+                 * Fields specific to the `visa` network.
+                 */
+                interface Visa {
+                    /**
+                     * 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.
+                     *
+                     * - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
+                     *   that the transaction is a mail/phone order purchase, not a recurring
+                     *   transaction or installment payment. For domestic transactions in the US
+                     *   region, this value may also indicate one bill payment transaction in the
+                     *   card-present or card-absent environments.
+                     * - `recurring` - Recurring transaction: Payment indicator used to indicate a
+                     *   recurring transaction that originates from an acquirer in the US region.
+                     * - `installment` - Installment payment: Payment indicator used to indicate one
+                     *   purchase of goods or services that is billed to the account in multiple
+                     *   charges over a period of time agreed upon by the cardholder and merchant from
+                     *   transactions that originate from an acquirer in the US region.
+                     * - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
+                     *   indicate that the type of mail/telephone order is unknown.
+                     * - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
+                     *   indicate that the electronic commerce transaction has been authenticated using
+                     *   e.g., 3-D Secure
+                     * - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
+                     *   Non-authenticated security transaction at a 3-D Secure-capable merchant, and
+                     *   merchant attempted to authenticate the cardholder using 3-D Secure: Use to
+                     *   identify an electronic commerce transaction where the merchant attempted to
+                     *   authenticate the cardholder using 3-D Secure, but was unable to complete the
+                     *   authentication because the issuer or cardholder does not participate in the
+                     *   3-D Secure program.
+                     * - `non_authenticated_security_transaction` - Non-authenticated security
+                     *   transaction: Use to identify an electronic commerce transaction that uses data
+                     *   encryption for security however , cardholder authentication is not performed
+                     *   using 3-D Secure.
+                     * - `non_secure_transaction` - Non-secure transaction: Use to identify an
+                     *   electronic commerce transaction that has no data protection.
+                     */
+                    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' | null;
+                    /**
+                     * The method used to enter the cardholder's primary account number and card
+                     * expiration date.
+                     *
+                     * - `unknown` - Unknown
+                     * - `manual` - Manual key entry
+                     * - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
+                     *   value
+                     * - `optical_code` - Optical code
+                     * - `integrated_circuit_card` - Contact chip card
+                     * - `contactless` - Contactless read of chip card
+                     * - `credential_on_file` - Transaction initiated using a credential that has
+                     *   previously been stored on file
+                     * - `magnetic_stripe` - Magnetic stripe read
+                     * - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
+                     * - `integrated_circuit_card_no_cvv` - Contact chip card, without card
+                     *   verification value
+                     */
+                    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' | null;
+                }
+            }
+        }
+    }
+    /**
+     * The summarized state of this card payment.
+     */
+    interface State {
+        /**
+         * The total authorized amount in the minor unit of the transaction's currency. For
+         * dollars, for example, this is cents.
+         */
+        authorized_amount: number;
+        /**
+         * The total incrementally updated authorized amount in the minor unit of the
+         * transaction's currency. For dollars, for example, this is cents.
+         */
+        incremented_amount: number;
+        /**
+         * The total reversed amount in the minor unit of the transaction's currency. For
+         * dollars, for example, this is cents.
+         */
+        reversed_amount: number;
+        /**
+         * The total settled or refunded amount in the minor unit of the transaction's
+         * currency. For dollars, for example, this is cents.
+         */
+        settled_amount: number;
+    }
+}
+export interface CardPaymentListParams extends PageParams {
+    /**
+     * Filter Card Payments to ones belonging to the specified Account.
+     */
+    account_id?: string;
+    /**
+     * Filter Card Payments to ones belonging to the specified Card.
+     */
+    card_id?: string;
+    created_at?: CardPaymentListParams.CreatedAt;
+}
+export declare namespace CardPaymentListParams {
+    interface CreatedAt {
+        /**
+         * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+         * timestamp.
+         */
+        after?: string;
+        /**
+         * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+         * timestamp.
+         */
+        before?: string;
+        /**
+         * Return results on or after this
+         * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+         */
+        on_or_after?: string;
+        /**
+         * Return results on or before this
+         * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+         */
+        on_or_before?: string;
+    }
+}
+export declare namespace CardPayments {
+    export import CardPayment = API.CardPayment;
+    type CardPaymentsPage = _CardPaymentsPage;
+    export import CardPaymentListParams = API.CardPaymentListParams;
+}
+export {};
+//# sourceMappingURL=card-payments.d.ts.map