increase 0.248.0 → 0.250.0

package/src/resources/card-payments.ts

@@ -456,6 +456,13 @@ export namespace CardPayment {
        */
       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: CardAuthorization.AdditionalAmounts;
+
       /**
        * The pending amount in the minor unit of the transaction's currency. For dollars,
        * for example, this is cents.
@@ -637,6 +644,204 @@ export namespace CardPayment {
     }
 
     export namespace CardAuthorization {
+      /**
+       * 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.
+       */
+      export 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 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;
+      }
+
+      export namespace AdditionalAmounts {
+        /**
+         * The part of this transaction amount that was for clinic-related services.
+         */
+        export interface Clinic {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Dental {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Prescription {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Surcharge {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface TotalCumulative {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface TotalHealthcare {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Transit {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Unknown {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Vision {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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`.
        */
@@ -949,6 +1154,13 @@ export namespace CardPayment {
        */
       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: CardDecline.AdditionalAmounts;
+
       /**
        * The declined amount in the minor unit of the destination account currency. For
        * dollars, for example, this is cents.
@@ -995,6 +1207,12 @@ export namespace CardPayment {
        */
       direction: 'settlement' | 'refund';
 
+      /**
+       * The identifier of the card authorization this request attempted to incrementally
+       * authorize.
+       */
+      incremented_card_authorization_id: string | null;
+
       /**
        * The merchant identifier (commonly abbreviated as MID) of the merchant the card
        * is transacting with.
@@ -1199,6 +1417,204 @@ export namespace CardPayment {
     }
 
     export namespace CardDecline {
+      /**
+       * 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.
+       */
+      export 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 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;
+      }
+
+      export namespace AdditionalAmounts {
+        /**
+         * The part of this transaction amount that was for clinic-related services.
+         */
+        export interface Clinic {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Dental {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Prescription {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Surcharge {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface TotalCumulative {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface TotalHealthcare {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Transit {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Unknown {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Vision {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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`.
        */
@@ -1549,6 +1965,13 @@ export namespace CardPayment {
        */
       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: CardIncrement.AdditionalAmounts;
+
       /**
        * The amount of this increment in the minor unit of the transaction's currency.
        * For dollars, for example, this is cents.
@@ -1628,6 +2051,204 @@ export namespace CardPayment {
     }
 
     export namespace CardIncrement {
+      /**
+       * 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.
+       */
+      export 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 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;
+      }
+
+      export namespace AdditionalAmounts {
+        /**
+         * The part of this transaction amount that was for clinic-related services.
+         */
+        export interface Clinic {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Dental {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Prescription {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Surcharge {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface TotalCumulative {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface TotalHealthcare {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Transit {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Unknown {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Vision {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          amount: number;
+
+          /**
+           * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
+           * amount's currency.
+           */
+          currency: string;
+        }
+      }
+
       /**
        * Network-specific identifiers for a specific request or transaction.
        */
@@ -3308,6 +3929,13 @@ export namespace CardPayment {
        */
       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: CardValidation.AdditionalAmounts;
+
       /**
        * The ID of the Card Payment this transaction belongs to.
        */
@@ -3417,6 +4045,204 @@ export namespace CardPayment {
     }
 
     export namespace CardValidation {
+      /**
+       * 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.
+       */
+      export 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 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;
+      }
+
+      export namespace AdditionalAmounts {
+        /**
+         * The part of this transaction amount that was for clinic-related services.
+         */
+        export interface Clinic {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Dental {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Prescription {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Surcharge {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface TotalCumulative {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface TotalHealthcare {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Transit {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Unknown {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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.
+         */
+        export interface Vision {
+          /**
+           * The amount in minor units of the `currency` field.
+           */
+          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`.
        */