increase 0.342.0 → 0.344.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.344.0 (2025-10-28)
+
+Full Changelog: [v0.343.0...v0.344.0](https://github.com/Increase/increase-node/compare/v0.343.0...v0.344.0)
+
+### Features
+
+* **api:** api update ([c87b65e](https://github.com/Increase/increase-node/commit/c87b65ecd352369f5065af0a68d3e9353d0d2d96))
+
+## 0.343.0 (2025-10-27)
+
+Full Changelog: [v0.342.0...v0.343.0](https://github.com/Increase/increase-node/compare/v0.342.0...v0.343.0)
+
+### Features
+
+* **api:** api update ([961d480](https://github.com/Increase/increase-node/commit/961d48093496cde8ea09ed7d5a14ee1c4dd1dafc))
+
 ## 0.342.0 (2025-10-27)
 
 Full Changelog: [v0.341.0...v0.342.0](https://github.com/Increase/increase-node/compare/v0.341.0...v0.342.0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "increase",
-  "version": "0.342.0",
+  "version": "0.344.0",
   "description": "The official TypeScript library for the Increase API",
   "author": "Increase <dev-feedback@increase.com>",
   "types": "./index.d.ts",

package/resources/card-payments.d.ts

@@ -100,6 +100,12 @@ export declare namespace CardPayment {
          * only if `category` is equal to `card_decline`.
          */
         card_decline: Element.CardDecline | null;
+        /**
+         * A Card Financial object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_financial`. Card Financials are temporary
+         * holds placed on a customers funds with the intent to later clear a transaction.
+         */
+        card_financial: Element.CardFinancial | null;
         /**
          * A Card Fuel Confirmation object. This field will be present in the JSON response
          * if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel
@@ -165,9 +171,11 @@ export declare namespace CardPayment {
          * - `card_refund` - Card Refund: details will be under the `card_refund` object.
          * - `card_fuel_confirmation` - Card Fuel Confirmation: details will be under the
          *   `card_fuel_confirmation` object.
+         * - `card_financial` - Card Financial: details will be under the `card_financial`
+         *   object.
          * - `other` - Unknown card payment element.
          */
-        category: 'card_authorization' | 'card_authentication' | 'card_validation' | 'card_decline' | 'card_reversal' | 'card_authorization_expiration' | 'card_increment' | 'card_settlement' | 'card_refund' | 'card_fuel_confirmation' | 'other';
+        category: 'card_authorization' | 'card_authentication' | 'card_validation' | 'card_decline' | 'card_reversal' | 'card_authorization_expiration' | 'card_increment' | 'card_settlement' | 'card_refund' | 'card_fuel_confirmation' | 'card_financial' | 'other';
         /**
          * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
          * the card payment element was created.
@@ -1602,6 +1610,586 @@ export declare namespace CardPayment {
                 }
             }
         }
+        /**
+         * A Card Financial object. This field will be present in the JSON response if and
+         * only if `category` is equal to `card_financial`. Card Financials are temporary
+         * holds placed on a customers funds with the intent to later clear a transaction.
+         */
+        interface CardFinancial {
+            /**
+             * The Card Financial identifier.
+             */
+            id: string;
+            /**
+             * Whether this financial was approved by Increase, the card network through
+             * stand-in processing, or the user through a real-time decision.
+             *
+             * - `user` - This object was actioned by the user through a real-time decision.
+             * - `increase` - This object was actioned by Increase without user intervention.
+             * - `network` - This object was actioned by the network, through stand-in
+             *   processing.
+             */
+            actioner: 'user' | 'increase' | 'network';
+            /**
+             * 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.
+             */
+            additional_amounts: CardFinancial.AdditionalAmounts;
+            /**
+             * 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;
+            /**
+             * 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 direction describes the direction the funds will move, either from the
+             * cardholder to the merchant or from the merchant to the cardholder.
+             *
+             * - `settlement` - A regular card authorization where funds are debited from the
+             *   cardholder.
+             * - `refund` - A refund card authorization, sometimes referred to as a credit
+             *   voucher authorization, where funds are credited to the cardholder.
+             */
+            direction: 'settlement' | 'refund';
+            /**
+             * 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;
+            /**
+             * The city the merchant resides in.
+             */
+            merchant_city: string | null;
+            /**
+             * The country the merchant resides in.
+             */
+            merchant_country: string;
+            /**
+             * The merchant descriptor of the merchant the card is transacting with.
+             */
+            merchant_descriptor: string;
+            /**
+             * 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_postal_code: string | null;
+            /**
+             * The state the merchant resides in.
+             */
+            merchant_state: string | null;
+            /**
+             * Fields specific to the `network`.
+             */
+            network_details: CardFinancial.NetworkDetails;
+            /**
+             * Network-specific identifiers for a specific request or transaction.
+             */
+            network_identifiers: CardFinancial.NetworkIdentifiers;
+            /**
+             * 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.
+             */
+            network_risk_score: number | null;
+            /**
+             * If the authorization was made in-person with a physical card, the Physical Card
+             * that was used.
+             */
+            physical_card_id: string | null;
+            /**
+             * The pending 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;
+            /**
+             * The processing category describes the intent behind the financial, such as
+             * whether it was used for bill payments or an automatic fuel dispenser.
+             *
+             * - `account_funding` - Account funding transactions are transactions used to
+             *   e.g., fund an account or transfer funds between accounts.
+             * - `automatic_fuel_dispenser` - Automatic fuel dispenser authorizations occur
+             *   when a card is used at a gas pump, prior to the actual transaction amount
+             *   being known. They are followed by an advice message that updates the amount of
+             *   the pending transaction.
+             * - `bill_payment` - A transaction used to pay a bill.
+             * - `original_credit` - Original credit transactions are used to send money to a
+             *   cardholder.
+             * - `purchase` - A regular purchase.
+             * - `quasi_cash` - Quasi-cash transactions represent purchases of items which may
+             *   be convertible to cash.
+             * - `refund` - A refund card authorization, sometimes referred to as a credit
+             *   voucher authorization, where funds are credited to the cardholder.
+             * - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
+             *   from an ATM or a point of sale.
+             * - `unknown` - The processing category is unknown.
+             */
+            processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'unknown';
+            /**
+             * The identifier of the Real-Time Decision sent to approve or decline this
+             * transaction.
+             */
+            real_time_decision_id: string | null;
+            /**
+             * The terminal identifier (commonly abbreviated as TID) of the terminal the card
+             * is transacting with.
+             */
+            terminal_id: string | 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_financial`.
+             */
+            type: 'card_financial';
+            /**
+             * Fields related to verification of cardholder-provided values.
+             */
+            verification: CardFinancial.Verification;
+        }
+        namespace CardFinancial {
+            /**
+             * 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.
+             */
+            interface AdditionalAmounts {
+                /**
+                 * The part of this transaction amount that was for clinic-related services.
+                 */
+                clinic: AdditionalAmounts.Clinic | null;
+                /**
+                 * The part of this transaction amount that was for dental-related services.
+                 */
+                dental: AdditionalAmounts.Dental | null;
+                /**
+                 * The original pre-authorized amount.
+                 */
+                original: AdditionalAmounts.Original | null;
+                /**
+                 * The part of this transaction amount that was for healthcare prescriptions.
+                 */
+                prescription: AdditionalAmounts.Prescription | null;
+                /**
+                 * The surcharge amount charged for this transaction by the merchant.
+                 */
+                surcharge: AdditionalAmounts.Surcharge | null;
+                /**
+                 * The total amount of a series of incremental authorizations, optionally provided.
+                 */
+                total_cumulative: AdditionalAmounts.TotalCumulative | null;
+                /**
+                 * The total amount of healthcare-related additional amounts.
+                 */
+                total_healthcare: AdditionalAmounts.TotalHealthcare | null;
+                /**
+                 * The part of this transaction amount that was for transit-related services.
+                 */
+                transit: AdditionalAmounts.Transit | null;
+                /**
+                 * An unknown additional amount.
+                 */
+                unknown: AdditionalAmounts.Unknown | null;
+                /**
+                 * The part of this transaction amount that was for vision-related services.
+                 */
+                vision: AdditionalAmounts.Vision | null;
+            }
+            namespace AdditionalAmounts {
+                /**
+                 * The part of this transaction amount that was for clinic-related services.
+                 */
+                interface Clinic {
+                    /**
+                     * 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).
+                     */
+                    amount: number;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                     * amount's currency.
+                     */
+                    currency: string;
+                }
+                /**
+                 * The part of this transaction amount that was for dental-related services.
+                 */
+                interface Dental {
+                    /**
+                     * 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).
+                     */
+                    amount: number;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                     * amount's currency.
+                     */
+                    currency: string;
+                }
+                /**
+                 * The original pre-authorized amount.
+                 */
+                interface Original {
+                    /**
+                     * 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).
+                     */
+                    amount: number;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                     * amount's currency.
+                     */
+                    currency: string;
+                }
+                /**
+                 * The part of this transaction amount that was for healthcare prescriptions.
+                 */
+                interface Prescription {
+                    /**
+                     * 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).
+                     */
+                    amount: number;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                     * amount's currency.
+                     */
+                    currency: string;
+                }
+                /**
+                 * The surcharge amount charged for this transaction by the merchant.
+                 */
+                interface Surcharge {
+                    /**
+                     * 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).
+                     */
+                    amount: number;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                     * amount's currency.
+                     */
+                    currency: string;
+                }
+                /**
+                 * The total amount of a series of incremental authorizations, optionally provided.
+                 */
+                interface TotalCumulative {
+                    /**
+                     * 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).
+                     */
+                    amount: number;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                     * amount's currency.
+                     */
+                    currency: string;
+                }
+                /**
+                 * The total amount of healthcare-related additional amounts.
+                 */
+                interface TotalHealthcare {
+                    /**
+                     * 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).
+                     */
+                    amount: number;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                     * amount's currency.
+                     */
+                    currency: string;
+                }
+                /**
+                 * The part of this transaction amount that was for transit-related services.
+                 */
+                interface Transit {
+                    /**
+                     * 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).
+                     */
+                    amount: number;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                     * amount's currency.
+                     */
+                    currency: string;
+                }
+                /**
+                 * An unknown additional amount.
+                 */
+                interface Unknown {
+                    /**
+                     * 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).
+                     */
+                    amount: number;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                     * amount's currency.
+                     */
+                    currency: string;
+                }
+                /**
+                 * The part of this transaction amount that was for vision-related services.
+                 */
+                interface Vision {
+                    /**
+                     * 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).
+                     */
+                    amount: number;
+                    /**
+                     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+                     * amount's currency.
+                     */
+                    currency: string;
+                }
+            }
+            /**
+             * Fields specific to the `network`.
+             */
+            interface NetworkDetails {
+                /**
+                 * The payment network used to process this card authorization.
+                 *
+                 * - `visa` - Visa
+                 * - `pulse` - Pulse
+                 */
+                category: 'visa' | 'pulse';
+                /**
+                 * Fields specific to the `pulse` network.
+                 */
+                pulse: unknown | null;
+                /**
+                 * 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;
+                    /**
+                     * Only present when `actioner: network`. Describes why a card authorization was
+                     * approved or declined by Visa through stand-in processing.
+                     *
+                     * - `issuer_error` - Increase failed to process the authorization in a timely
+                     *   manner.
+                     * - `invalid_physical_card` - The physical card read had an invalid CVV, dCVV, or
+                     *   authorization request cryptogram.
+                     * - `invalid_cardholder_authentication_verification_value` - The 3DS cardholder
+                     *   authentication verification value was invalid.
+                     * - `internal_visa_error` - An internal Visa error occurred. Visa uses this reason
+                     *   code for certain expected occurrences as well, such as Application Transaction
+                     *   Counter (ATC) replays.
+                     * - `merchant_transaction_advisory_service_authentication_required` - The merchant
+                     *   has enabled Visa's Transaction Advisory Service and requires further
+                     *   authentication to perform the transaction. In practice this is often utilized
+                     *   at fuel pumps to tell the cardholder to see the cashier.
+                     * - `payment_fraud_disruption_acquirer_block` - The transaction was blocked by
+                     *   Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior,
+                     *   such as card testing.
+                     * - `other` - An unspecific reason for stand-in processing.
+                     */
+                    stand_in_processing_reason: 'issuer_error' | 'invalid_physical_card' | 'invalid_cardholder_authentication_verification_value' | 'internal_visa_error' | 'merchant_transaction_advisory_service_authentication_required' | 'payment_fraud_disruption_acquirer_block' | 'other' | null;
+                }
+            }
+            /**
+             * Network-specific identifiers for a specific request or transaction.
+             */
+            interface NetworkIdentifiers {
+                /**
+                 * The randomly generated 6-character Authorization Identification Response code
+                 * sent back to the acquirer in an approved response.
+                 */
+                authorization_identification_response: string | null;
+                /**
+                 * 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.
+                 */
+                retrieval_reference_number: string | null;
+                /**
+                 * A counter used to verify an individual authorization. Expected to be unique per
+                 * acquirer within a window of time.
+                 */
+                trace_number: string | null;
+                /**
+                 * A globally unique transaction identifier provided by the card network, used
+                 * across multiple life-cycle requests.
+                 */
+                transaction_id: string | null;
+            }
+            /**
+             * Fields related to verification of cardholder-provided values.
+             */
+            interface Verification {
+                /**
+                 * Fields related to verification of the Card Verification Code, a 3-digit code on
+                 * the back of the card.
+                 */
+                card_verification_code: Verification.CardVerificationCode;
+                /**
+                 * Cardholder address provided in the authorization request and the address on file
+                 * we verified it against.
+                 */
+                cardholder_address: Verification.CardholderAddress;
+            }
+            namespace Verification {
+                /**
+                 * Fields related to verification of the Card Verification Code, a 3-digit code on
+                 * the back of the card.
+                 */
+                interface CardVerificationCode {
+                    /**
+                     * The result of verifying the Card Verification Code.
+                     *
+                     * - `not_checked` - No card verification code was provided in the authorization
+                     *   request.
+                     * - `match` - The card verification code matched the one on file.
+                     * - `no_match` - The card verification code did not match the one on file.
+                     */
+                    result: 'not_checked' | 'match' | 'no_match';
+                }
+                /**
+                 * Cardholder address provided in the authorization request and the address on file
+                 * we verified it against.
+                 */
+                interface CardholderAddress {
+                    /**
+                     * Line 1 of the address on file for the cardholder.
+                     */
+                    actual_line1: string | null;
+                    /**
+                     * The postal code of the address on file for the cardholder.
+                     */
+                    actual_postal_code: string | null;
+                    /**
+                     * The cardholder address line 1 provided for verification in the authorization
+                     * request.
+                     */
+                    provided_line1: string | null;
+                    /**
+                     * The postal code provided for verification in the authorization request.
+                     */
+                    provided_postal_code: string | null;
+                    /**
+                     * The address verification result returned to the card network.
+                     *
+                     * - `not_checked` - No address information was provided in the authorization
+                     *   request.
+                     * - `postal_code_match_address_no_match` - Postal code matches, but the street
+                     *   address does not match or was not provided.
+                     * - `postal_code_no_match_address_match` - Postal code does not match, but the
+                     *   street address matches or was not provided.
+                     * - `match` - Postal code and street address match.
+                     * - `no_match` - Postal code and street address do not match.
+                     * - `postal_code_match_address_not_checked` - Postal code matches, but the street
+                     *   address was not verified. (deprecated)
+                     */
+                    result: 'not_checked' | 'postal_code_match_address_no_match' | 'postal_code_no_match_address_match' | 'match' | 'no_match' | 'postal_code_match_address_not_checked';
+                }
+            }
+        }
         /**
          * A Card Fuel Confirmation object. This field will be present in the JSON response
          * if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel