increase 0.248.0 → 0.250.0

package/resources/card-payments.d.ts

@@ -361,6 +361,12 @@ export declare namespace CardPayment {
              *   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: CardAuthorization.AdditionalAmounts;
             /**
              * The pending amount in the minor unit of the transaction's currency. For dollars,
              * for example, this is cents.
@@ -508,6 +514,177 @@ export declare namespace CardPayment {
             verification: CardAuthorization.Verification;
         }
         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.
+             */
+            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;
+            }
+            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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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`.
              */
@@ -762,6 +939,12 @@ export declare namespace CardPayment {
              *   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: CardDecline.AdditionalAmounts;
             /**
              * The declined amount in the minor unit of the destination account currency. For
              * dollars, for example, this is cents.
@@ -802,6 +985,11 @@ export declare namespace CardPayment {
              *   voucher authorization, where funds are credited to the cardholder.
              */
             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.
@@ -951,6 +1139,177 @@ export declare namespace CardPayment {
             verification: CardDecline.Verification;
         }
         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.
+             */
+            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;
+            }
+            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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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`.
              */
@@ -1238,6 +1597,12 @@ export declare namespace CardPayment {
              *   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: CardIncrement.AdditionalAmounts;
             /**
              * The amount of this increment in the minor unit of the transaction's currency.
              * For dollars, for example, this is cents.
@@ -1305,6 +1670,177 @@ export declare namespace CardPayment {
             updated_authorization_amount: number;
         }
         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.
+             */
+            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;
+            }
+            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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
              */
@@ -2645,6 +3181,12 @@ export declare namespace CardPayment {
              *   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: CardValidation.AdditionalAmounts;
             /**
              * The ID of the Card Payment this transaction belongs to.
              */
@@ -2736,6 +3278,177 @@ export declare namespace CardPayment {
             verification: CardValidation.Verification;
         }
         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.
+             */
+            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;
+            }
+            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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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.
+                     */
+                    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`.
              */