@blockchyp/blockchyp-ts 2.19.0 → 2.21.0

package/lib/src/models.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2019-2024 BlockChyp, Inc. All rights reserved. Use of this code is governed
+ * Copyright 2019-2025 BlockChyp, Inc. All rights reserved. Use of this code is governed
  * by a license that can be found in the LICENSE file.
  *
  * This file was generated automatically by the BlockChyp SDK Generator. Changes to this
@@ -1062,7 +1062,11 @@ export declare class TokenMetadataResponse {
      * The token metadata for a given query.
      */
     token: CustomerToken | null;
-    constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, token?: CustomerToken | null);
+    /**
+     * Details about a payment card derived from its BIN/IIN.
+     */
+    cardMetadata?: CardMetadata;
+    constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, token?: CustomerToken | null, cardMetadata?: CardMetadata | undefined);
 }
 /**
  * Models a customer token.
@@ -1419,7 +1423,7 @@ export declare class AuthorizationRequest {
     /**
      * Details for HSA/FSA transactions.
      */
-    healthcare?: Healthcare;
+    healthcareMetadata?: HealthcareMetadata;
     /**
      * That the transaction should be a cryptocurrency transaction. Value should be a
      * crypto currency code (ETH, BTC) or ANY to prompt the user to choose from supported
@@ -1466,9 +1470,301 @@ export declare class AuthorizationRequest {
      * gateway and is not directly calculated.
      */
     passthroughSurcharge?: string;
+    /**
+     * Marks a transaction as HSA/FSA.
+     */
+    healthcare?: boolean;
+    /**
+     * The total amount to process as healthcare.
+     */
+    healthcareTotal?: string;
+    /**
+     * The total amount to process as ebt.
+     */
+    ebtTotal?: string;
+    /**
+     * That this transaction will include a card metadata lookup.
+     */
+    cardMetadataLookup?: boolean;
     constructor(timeout?: number | null, test?: boolean | null, transactionRef?: string | undefined, autogeneratedRef?: boolean | null, async?: boolean | null, queue?: boolean | null, waitForRemovedCard?: boolean, force?: boolean, orderRef?: string | undefined, destinationAccount?: string | undefined, testCase?: string | undefined, token?: string | undefined, track1?: string | undefined, track2?: string | undefined, pan?: string | undefined, routingNumber?: string | undefined, cardholderName?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, cvv?: string | undefined, address?: string | undefined, postalCode?: string | undefined, manualEntry?: boolean, ksn?: string | undefined, pinBlock?: string | undefined, cardType?: CardType | undefined, paymentType?: string | undefined, currencyCode?: string | null, amount?: string | null, taxExempt?: boolean | null, surcharge?: boolean | null, cashDiscount?: boolean | null, sigFile?: string | undefined, sigFormat?: SignatureFormat | undefined, sigWidth?: number, disableSignature?: boolean, tipAmount?: string | undefined, taxAmount?: string | undefined, terminalName?: string | undefined, resetConnection?: boolean | null, transactionId?: string | undefined, onlineAuthCode?: string | undefined, enroll?: boolean, bypassDupeFilter?: boolean, description?: string | undefined, promptForTip?: boolean, cashBackEnabled?: boolean, cardOnFile?: boolean, recurring?: boolean, cit?: boolean, mit?: boolean, subscription?: boolean, purchaseOrderNumber?: string | undefined, supplierReferenceNumber?: string | undefined, lineItems?: TransactionDisplayItem[] | null, altPrices?: {
         [key: string]: string;
-    } | undefined, customer?: Customer | undefined, roundingMode?: RoundingMode | undefined, healthcare?: Healthcare | undefined, cryptocurrency?: string | undefined, cryptoNetwork?: string | undefined, cryptoReceiveAddress?: string | undefined, paymentRequestLabel?: string | undefined, paymentRequestMessage?: string | undefined, simulateChipRejection?: boolean, simulateOutOfOrderReversal?: boolean, asyncReversals?: boolean, passthroughSurcharge?: string | undefined);
+    } | undefined, customer?: Customer | undefined, roundingMode?: RoundingMode | undefined, healthcareMetadata?: HealthcareMetadata | undefined, cryptocurrency?: string | undefined, cryptoNetwork?: string | undefined, cryptoReceiveAddress?: string | undefined, paymentRequestLabel?: string | undefined, paymentRequestMessage?: string | undefined, simulateChipRejection?: boolean, simulateOutOfOrderReversal?: boolean, asyncReversals?: boolean, passthroughSurcharge?: string | undefined, healthcare?: boolean, healthcareTotal?: string | undefined, ebtTotal?: string | undefined, cardMetadataLookup?: boolean);
+}
+/**
+ * Essential information about a payment card derived from its BIN/IIN.
+ */
+export declare class CardMetadata {
+    /**
+     * The brand or network of the card (e.g., Visa, Mastercard, Amex).
+     */
+    cardBrand: string | null;
+    /**
+     * The name of the financial institution that issued the card.
+     */
+    issuerName: string | null;
+    /**
+     * Whether the card supports Level 3 processing for detailed transaction data.
+     */
+    l3: boolean | null;
+    /**
+     * Whether the card supports Level 2 processing for additional transaction data.
+     */
+    l2: boolean | null;
+    /**
+     * The general category or type of the card product.
+     */
+    productType: string | null;
+    /**
+     * The specific name or designation of the card product.
+     */
+    productName: string | null;
+    /**
+     * Whether the card is an Electronic Benefit Transfer (EBT) card.
+     */
+    ebt: boolean | null;
+    /**
+     * Whether the card is a debit card.
+     */
+    debit: boolean | null;
+    /**
+     * Whether the card is a healthcare-specific payment card.
+     */
+    healthcare: boolean | null;
+    /**
+     * Whether the card is a prepaid card.
+     */
+    prepaid: boolean | null;
+    /**
+     * The geographical region associated with the card's issuer.
+     */
+    region: string | null;
+    /**
+     * The country associated with the card's issuer.
+     */
+    country: string | null;
+    constructor(cardBrand?: string | null, issuerName?: string | null, l3?: boolean | null, l2?: boolean | null, productType?: string | null, productName?: string | null, ebt?: boolean | null, debit?: boolean | null, healthcare?: boolean | null, prepaid?: boolean | null, region?: string | null, country?: string | null);
+}
+/**
+ * Retrieves card metadata.
+ */
+export declare class CardMetadataRequest {
+    /**
+     * The request timeout in seconds.
+     */
+    timeout: number | null;
+    /**
+     * Whether or not to route transaction to the test gateway.
+     */
+    test: boolean | null;
+    /**
+     * A user-assigned reference that can be used to recall or reverse transactions.
+     */
+    transactionRef?: string;
+    /**
+     * That the transaction reference was autogenerated and should be ignored for the
+     * purposes of duplicate detection.
+     */
+    autogeneratedRef: boolean | null;
+    /**
+     * Defers the response to the transaction and returns immediately. Callers should
+     * retrive the transaction result using the Transaction Status API.
+     */
+    async: boolean | null;
+    /**
+     * Adds the transaction to the queue and returns immediately. Callers should retrive
+     * the transaction result using the Transaction Status API.
+     */
+    queue: boolean | null;
+    /**
+     * Whether or not the request should block until all cards have been removed from the card
+     * reader.
+     */
+    waitForRemovedCard?: boolean;
+    /**
+     * Override any in-progress transactions.
+     */
+    force?: boolean;
+    /**
+     * An identifier from an external point of sale system.
+     */
+    orderRef?: string;
+    /**
+     * The settlement account for merchants with split settlements.
+     */
+    destinationAccount?: string;
+    /**
+     * Can include a code used to trigger simulated conditions for the purposes of testing
+     * and certification. Valid for test merchant accounts only.
+     */
+    testCase?: string;
+    /**
+     * The payment token to be used for this transaction. This should be used for recurring
+     * transactions.
+     */
+    token?: string;
+    /**
+     * Track 1 magnetic stripe data.
+     */
+    track1?: string;
+    /**
+     * Track 2 magnetic stripe data.
+     */
+    track2?: string;
+    /**
+     * The primary account number. We recommend using the terminal or e-commerce
+     * tokenization libraries instead of passing account numbers in directly, as this
+     * would put your application in PCI scope.
+     */
+    pan?: string;
+    /**
+     * The ACH routing number for ACH transactions.
+     */
+    routingNumber?: string;
+    /**
+     * The cardholder name. Only required if the request includes a primary account number
+     * or track data.
+     */
+    cardholderName?: string;
+    /**
+     * The card expiration month for use with PAN based transactions.
+     */
+    expMonth?: string;
+    /**
+     * The card expiration year for use with PAN based transactions.
+     */
+    expYear?: string;
+    /**
+     * The card CVV for use with PAN based transactions.
+     */
+    cvv?: string;
+    /**
+     * The cardholder address for use with address verification.
+     */
+    address?: string;
+    /**
+     * The cardholder postal code for use with address verification.
+     */
+    postalCode?: string;
+    /**
+     * That the payment entry method is a manual keyed transaction. If this is true, no other
+     * payment method will be accepted.
+     */
+    manualEntry?: boolean;
+    /**
+     * The key serial number used for DUKPT encryption.
+     */
+    ksn?: string;
+    /**
+     * The encrypted pin block.
+     */
+    pinBlock?: string;
+    /**
+     * Designates categories of cards: credit, debit, EBT.
+     */
+    cardType?: CardType;
+    /**
+     * Designates brands of payment methods: Visa, Discover, etc.
+     */
+    paymentType?: string;
+    /**
+     * The name of the target payment terminal.
+     */
+    terminalName?: string;
+    /**
+     * Forces the terminal cloud connection to be reset while a transactions is in flight.
+     * This is a diagnostic settings that can be used only for test transactions.
+     */
+    resetConnection: boolean | null;
+    /**
+     * Marks a transaction as HSA/FSA.
+     */
+    healthcare?: boolean;
+    constructor(timeout?: number | null, test?: boolean | null, transactionRef?: string | undefined, autogeneratedRef?: boolean | null, async?: boolean | null, queue?: boolean | null, waitForRemovedCard?: boolean, force?: boolean, orderRef?: string | undefined, destinationAccount?: string | undefined, testCase?: string | undefined, token?: string | undefined, track1?: string | undefined, track2?: string | undefined, pan?: string | undefined, routingNumber?: string | undefined, cardholderName?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, cvv?: string | undefined, address?: string | undefined, postalCode?: string | undefined, manualEntry?: boolean, ksn?: string | undefined, pinBlock?: string | undefined, cardType?: CardType | undefined, paymentType?: string | undefined, terminalName?: string | undefined, resetConnection?: boolean | null, healthcare?: boolean);
+}
+/**
+ * The response to a card metadata request.
+ */
+export declare class CardMetadataResponse {
+    /**
+     * Whether or not the request succeeded.
+     */
+    success: boolean | null;
+    /**
+     * The error, if an error occurred.
+     */
+    error: string | null;
+    /**
+     * A narrative description of the transaction result.
+     */
+    responseDescription: string | null;
+    /**
+     * The payment token, if the payment was enrolled in the vault.
+     */
+    token?: string;
+    /**
+     * The entry method for the transaction (CHIP, MSR, KEYED, etc).
+     */
+    entryMethod?: string;
+    /**
+     * The card brand (VISA, MC, AMEX, DEBIT, etc).
+     */
+    paymentType?: string;
+    /**
+     * Provides network level detail on how a transaction was routed, especially for debit
+     * transactions.
+     */
+    network?: string;
+    /**
+     * Identifies the card association based on bin number. Used primarily used to indicate
+     * the major logo on a card, even when debit transactions are routed on a different
+     * network.
+     */
+    logo?: string;
+    /**
+     * The masked primary account number.
+     */
+    maskedPan?: string;
+    /**
+     * The BlockChyp public key if the user presented a BlockChyp payment card.
+     */
+    publicKey?: string;
+    /**
+     * That the transaction did something that would put the system in PCI scope.
+     */
+    ScopeAlert?: boolean;
+    /**
+     * The cardholder name.
+     */
+    cardHolder?: string;
+    /**
+     * The card expiration month in MM format.
+     */
+    expMonth?: string;
+    /**
+     * The card expiration year in YY format.
+     */
+    expYear?: string;
+    /**
+     * Address verification results if address information was submitted.
+     */
+    avsResponse: AVSResponse | null;
+    /**
+     * Suggested receipt fields.
+     */
+    receiptSuggestions: ReceiptSuggestions | null;
+    /**
+     * Customer data, if any. Preserved for reverse compatibility.
+     */
+    customer?: Customer;
+    /**
+     * Customer data, if any.
+     */
+    customers: Customer[] | null;
+    /**
+     * Details about a payment card derived from its BIN/IIN.
+     */
+    cardMetadata?: CardMetadata;
+    constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, token?: string | undefined, entryMethod?: string | undefined, paymentType?: string | undefined, network?: string | undefined, logo?: string | undefined, maskedPan?: string | undefined, publicKey?: string | undefined, ScopeAlert?: boolean, cardHolder?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, avsResponse?: AVSResponse | null, receiptSuggestions?: ReceiptSuggestions | null, customer?: Customer | undefined, customers?: Customer[] | null, cardMetadata?: CardMetadata | undefined);
 }
 /**
  * A request for the remaining balance on a payment type.
@@ -1913,7 +2209,7 @@ export declare class RefundRequest {
     /**
      * Details for HSA/FSA transactions.
      */
-    healthcare?: Healthcare;
+    healthcareMetadata?: HealthcareMetadata;
     /**
      * Instructs the terminal to simulate a post auth chip rejection that would trigger an
      * automatic reversal.
@@ -1936,7 +2232,11 @@ export declare class RefundRequest {
      * Manually sets the MIT (Merchant Initiated Transaction) flag.
      */
     mit?: boolean;
-    constructor(timeout?: number | null, test?: boolean | null, transactionRef?: string | undefined, autogeneratedRef?: boolean | null, async?: boolean | null, queue?: boolean | null, waitForRemovedCard?: boolean, force?: boolean, orderRef?: string | undefined, destinationAccount?: string | undefined, testCase?: string | undefined, token?: string | undefined, track1?: string | undefined, track2?: string | undefined, pan?: string | undefined, routingNumber?: string | undefined, cardholderName?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, cvv?: string | undefined, address?: string | undefined, postalCode?: string | undefined, manualEntry?: boolean, ksn?: string | undefined, pinBlock?: string | undefined, cardType?: CardType | undefined, paymentType?: string | undefined, transactionId?: string | null, currencyCode?: string | null, amount?: string | null, taxExempt?: boolean | null, surcharge?: boolean | null, cashDiscount?: boolean | null, sigFile?: string | undefined, sigFormat?: SignatureFormat | undefined, sigWidth?: number, disableSignature?: boolean, tipAmount?: string | undefined, taxAmount?: string | undefined, terminalName?: string | undefined, resetConnection?: boolean | null, healthcare?: Healthcare | undefined, simulateChipRejection?: boolean, simulateOutOfOrderReversal?: boolean, asyncReversals?: boolean, cit?: boolean, mit?: boolean);
+    /**
+     * That this transaction will include a card metadata lookup.
+     */
+    cardMetadataLookup?: boolean;
+    constructor(timeout?: number | null, test?: boolean | null, transactionRef?: string | undefined, autogeneratedRef?: boolean | null, async?: boolean | null, queue?: boolean | null, waitForRemovedCard?: boolean, force?: boolean, orderRef?: string | undefined, destinationAccount?: string | undefined, testCase?: string | undefined, token?: string | undefined, track1?: string | undefined, track2?: string | undefined, pan?: string | undefined, routingNumber?: string | undefined, cardholderName?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, cvv?: string | undefined, address?: string | undefined, postalCode?: string | undefined, manualEntry?: boolean, ksn?: string | undefined, pinBlock?: string | undefined, cardType?: CardType | undefined, paymentType?: string | undefined, transactionId?: string | null, currencyCode?: string | null, amount?: string | null, taxExempt?: boolean | null, surcharge?: boolean | null, cashDiscount?: boolean | null, sigFile?: string | undefined, sigFormat?: SignatureFormat | undefined, sigWidth?: number, disableSignature?: boolean, tipAmount?: string | undefined, taxAmount?: string | undefined, terminalName?: string | undefined, resetConnection?: boolean | null, healthcareMetadata?: HealthcareMetadata | undefined, simulateChipRejection?: boolean, simulateOutOfOrderReversal?: boolean, asyncReversals?: boolean, cit?: boolean, mit?: boolean, cardMetadataLookup?: boolean);
 }
 /**
  * The information needed to capture a preauth.
@@ -2557,7 +2857,11 @@ export declare class EnrollRequest {
      * recurring transaction.
      */
     subscription?: boolean;
-    constructor(timeout?: number | null, test?: boolean | null, transactionRef?: string | undefined, autogeneratedRef?: boolean | null, async?: boolean | null, queue?: boolean | null, waitForRemovedCard?: boolean, force?: boolean, orderRef?: string | undefined, destinationAccount?: string | undefined, testCase?: string | undefined, token?: string | undefined, track1?: string | undefined, track2?: string | undefined, pan?: string | undefined, routingNumber?: string | undefined, cardholderName?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, cvv?: string | undefined, address?: string | undefined, postalCode?: string | undefined, manualEntry?: boolean, ksn?: string | undefined, pinBlock?: string | undefined, cardType?: CardType | undefined, paymentType?: string | undefined, terminalName?: string | undefined, resetConnection?: boolean | null, entryMethod?: string | undefined, customer?: Customer | undefined, recurring?: boolean, subscription?: boolean);
+    /**
+     * That this transaction will include a card metadata lookup.
+     */
+    cardMetadataLookup?: boolean;
+    constructor(timeout?: number | null, test?: boolean | null, transactionRef?: string | undefined, autogeneratedRef?: boolean | null, async?: boolean | null, queue?: boolean | null, waitForRemovedCard?: boolean, force?: boolean, orderRef?: string | undefined, destinationAccount?: string | undefined, testCase?: string | undefined, token?: string | undefined, track1?: string | undefined, track2?: string | undefined, pan?: string | undefined, routingNumber?: string | undefined, cardholderName?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, cvv?: string | undefined, address?: string | undefined, postalCode?: string | undefined, manualEntry?: boolean, ksn?: string | undefined, pinBlock?: string | undefined, cardType?: CardType | undefined, paymentType?: string | undefined, terminalName?: string | undefined, resetConnection?: boolean | null, entryMethod?: string | undefined, customer?: Customer | undefined, recurring?: boolean, subscription?: boolean, cardMetadataLookup?: boolean);
 }
 /**
  * The response to an enroll request.
@@ -2694,7 +2998,11 @@ export declare class EnrollResponse {
      * The hex encoded signature data.
      */
     sigFile?: string;
-    constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, approved?: boolean | null, authCode?: string | undefined, authResponseCode?: string | undefined, transactionId?: string | null, batchId?: string | undefined, transactionRef?: string | undefined, transactionType?: string | null, timestamp?: string | null, tickBlock?: string | null, test?: boolean | null, destinationAccount?: string | undefined, sig?: string | undefined, token?: string | undefined, entryMethod?: string | undefined, paymentType?: string | undefined, network?: string | undefined, logo?: string | undefined, maskedPan?: string | undefined, publicKey?: string | undefined, ScopeAlert?: boolean, cardHolder?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, avsResponse?: AVSResponse | null, receiptSuggestions?: ReceiptSuggestions | null, customer?: Customer | undefined, customers?: Customer[] | null, sigFile?: string | undefined);
+    /**
+     * Details about a payment card derived from its BIN/IIN.
+     */
+    cardMetadata?: CardMetadata;
+    constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, approved?: boolean | null, authCode?: string | undefined, authResponseCode?: string | undefined, transactionId?: string | null, batchId?: string | undefined, transactionRef?: string | undefined, transactionType?: string | null, timestamp?: string | null, tickBlock?: string | null, test?: boolean | null, destinationAccount?: string | undefined, sig?: string | undefined, token?: string | undefined, entryMethod?: string | undefined, paymentType?: string | undefined, network?: string | undefined, logo?: string | undefined, maskedPan?: string | undefined, publicKey?: string | undefined, ScopeAlert?: boolean, cardHolder?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, avsResponse?: AVSResponse | null, receiptSuggestions?: ReceiptSuggestions | null, customer?: Customer | undefined, customers?: Customer[] | null, sigFile?: string | undefined, cardMetadata?: CardMetadata | undefined);
 }
 /**
  * The information needed to enroll a new payment method in the token vault.
@@ -3452,7 +3760,11 @@ export declare class AuthorizationResponse {
      * The current status of a transaction.
      */
     status: string | null;
-    constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, approved?: boolean | null, authCode?: string | undefined, authResponseCode?: string | undefined, transactionId?: string | null, batchId?: string | undefined, transactionRef?: string | undefined, transactionType?: string | null, timestamp?: string | null, tickBlock?: string | null, test?: boolean | null, destinationAccount?: string | undefined, sig?: string | undefined, partialAuth?: boolean | null, altCurrency?: boolean | null, fsaAuth?: boolean | null, currencyCode?: string | null, requestedAmount?: string | null, authorizedAmount?: string | null, remainingBalance?: string | null, tipAmount?: string | null, taxAmount?: string | null, requestedCashBackAmount?: string | null, authorizedCashBackAmount?: string | null, confirmed?: boolean | null, cryptoAuthorizedAmount?: string | null, cryptoNetworkFee?: string | null, cryptocurrency?: string | null, cryptoNetwork?: string | null, cryptoReceiveAddress?: string | null, cryptoBlock?: string | null, cryptoTransactionId?: string | null, cryptoPaymentRequest?: string | null, cryptoStatus?: string | null, token?: string | undefined, entryMethod?: string | undefined, paymentType?: string | undefined, network?: string | undefined, logo?: string | undefined, maskedPan?: string | undefined, publicKey?: string | undefined, ScopeAlert?: boolean, cardHolder?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, avsResponse?: AVSResponse | null, receiptSuggestions?: ReceiptSuggestions | null, customer?: Customer | undefined, customers?: Customer[] | null, sigFile?: string | undefined, whiteListedCard?: WhiteListedCard | undefined, storeAndForward?: boolean | null, status?: string | null);
+    /**
+     * Details about a payment card derived from its BIN/IIN.
+     */
+    cardMetadata?: CardMetadata;
+    constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, approved?: boolean | null, authCode?: string | undefined, authResponseCode?: string | undefined, transactionId?: string | null, batchId?: string | undefined, transactionRef?: string | undefined, transactionType?: string | null, timestamp?: string | null, tickBlock?: string | null, test?: boolean | null, destinationAccount?: string | undefined, sig?: string | undefined, partialAuth?: boolean | null, altCurrency?: boolean | null, fsaAuth?: boolean | null, currencyCode?: string | null, requestedAmount?: string | null, authorizedAmount?: string | null, remainingBalance?: string | null, tipAmount?: string | null, taxAmount?: string | null, requestedCashBackAmount?: string | null, authorizedCashBackAmount?: string | null, confirmed?: boolean | null, cryptoAuthorizedAmount?: string | null, cryptoNetworkFee?: string | null, cryptocurrency?: string | null, cryptoNetwork?: string | null, cryptoReceiveAddress?: string | null, cryptoBlock?: string | null, cryptoTransactionId?: string | null, cryptoPaymentRequest?: string | null, cryptoStatus?: string | null, token?: string | undefined, entryMethod?: string | undefined, paymentType?: string | undefined, network?: string | undefined, logo?: string | undefined, maskedPan?: string | undefined, publicKey?: string | undefined, ScopeAlert?: boolean, cardHolder?: string | undefined, expMonth?: string | undefined, expYear?: string | undefined, avsResponse?: AVSResponse | null, receiptSuggestions?: ReceiptSuggestions | null, customer?: Customer | undefined, customers?: Customer[] | null, sigFile?: string | undefined, whiteListedCard?: WhiteListedCard | undefined, storeAndForward?: boolean | null, status?: string | null, cardMetadata?: CardMetadata | undefined);
 }
 /**
  * Models the request for updated information about a transaction.
@@ -5560,7 +5872,11 @@ export declare class MerchantProfile {
      * Bank accounts for split bank account merchants.
      */
     bankAccounts: BankAccount[] | null;
-    constructor(timeout?: number | null, test?: boolean | null, merchantId?: string | null, bankMid?: string | null, companyName?: string | null, dbaName?: string | null, invoiceName?: string | null, contactName?: string | null, contactNumber?: string | null, locationName?: string | null, storeNumber?: string | null, partnerRef?: string | null, timeZone?: string | null, batchCloseTime?: string | null, terminalUpdateTime?: string | null, autoBatchClose?: boolean | null, disableBatchEmails?: boolean | null, pinEnabled?: boolean | null, cashBackEnabled?: boolean | null, storeAndForwardEnabled?: boolean | null, partialAuthEnabled?: boolean | null, splitBankAccountsEnabled?: boolean | null, storeAndForwardFloorLimit?: string | null, publicKey?: string | null, status?: string | null, cashDiscountEnabled?: boolean | null, surveyTimeout?: number | null, cooldownTimeout?: number | null, tipEnabled?: boolean | null, promptForTip?: boolean | null, tipDefaults?: string[] | null, cashbackPresets?: string[] | null, ebtEnabled?: boolean | null, freeRangeRefundsEnabled?: boolean | null, pinBypassEnabled?: boolean | null, giftCardsDisabled?: boolean | null, tcDisabled?: boolean | null, digitalSignaturesEnabled?: boolean | null, digitalSignatureReversal?: boolean | null, billingAddress?: Address | null, shippingAddress?: Address | null, visa?: boolean | null, masterCard?: boolean | null, amex?: boolean | null, discover?: boolean | null, jcb?: boolean | null, unionPay?: boolean | null, contactlessEmv?: boolean | null, manualEntryEnabled?: boolean | null, manualEntryPromptZip?: boolean | null, manualEntryPromptStreetNumber?: boolean | null, gatewayOnly?: boolean | null, bankAccounts?: BankAccount[] | null);
+    /**
+     * That a merchant is allowed to send a surcharge amount directly to the gateway.
+     */
+    passthroughSurchargeEnabled: boolean | null;
+    constructor(timeout?: number | null, test?: boolean | null, merchantId?: string | null, bankMid?: string | null, companyName?: string | null, dbaName?: string | null, invoiceName?: string | null, contactName?: string | null, contactNumber?: string | null, locationName?: string | null, storeNumber?: string | null, partnerRef?: string | null, timeZone?: string | null, batchCloseTime?: string | null, terminalUpdateTime?: string | null, autoBatchClose?: boolean | null, disableBatchEmails?: boolean | null, pinEnabled?: boolean | null, cashBackEnabled?: boolean | null, storeAndForwardEnabled?: boolean | null, partialAuthEnabled?: boolean | null, splitBankAccountsEnabled?: boolean | null, storeAndForwardFloorLimit?: string | null, publicKey?: string | null, status?: string | null, cashDiscountEnabled?: boolean | null, surveyTimeout?: number | null, cooldownTimeout?: number | null, tipEnabled?: boolean | null, promptForTip?: boolean | null, tipDefaults?: string[] | null, cashbackPresets?: string[] | null, ebtEnabled?: boolean | null, freeRangeRefundsEnabled?: boolean | null, pinBypassEnabled?: boolean | null, giftCardsDisabled?: boolean | null, tcDisabled?: boolean | null, digitalSignaturesEnabled?: boolean | null, digitalSignatureReversal?: boolean | null, billingAddress?: Address | null, shippingAddress?: Address | null, visa?: boolean | null, masterCard?: boolean | null, amex?: boolean | null, discover?: boolean | null, jcb?: boolean | null, unionPay?: boolean | null, contactlessEmv?: boolean | null, manualEntryEnabled?: boolean | null, manualEntryPromptZip?: boolean | null, manualEntryPromptStreetNumber?: boolean | null, gatewayOnly?: boolean | null, bankAccounts?: BankAccount[] | null, passthroughSurchargeEnabled?: boolean | null);
 }
 /**
  * Models a response for a single merchant profile.
@@ -5790,7 +6106,11 @@ export declare class MerchantProfileResponse {
      * Bank accounts for split bank account merchants.
      */
     bankAccounts: BankAccount[] | null;
-    constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, test?: boolean | null, merchantId?: string | null, bankMid?: string | null, companyName?: string | null, dbaName?: string | null, invoiceName?: string | null, contactName?: string | null, contactNumber?: string | null, locationName?: string | null, storeNumber?: string | null, partnerRef?: string | null, timeZone?: string | null, batchCloseTime?: string | null, terminalUpdateTime?: string | null, autoBatchClose?: boolean | null, disableBatchEmails?: boolean | null, pinEnabled?: boolean | null, cashBackEnabled?: boolean | null, storeAndForwardEnabled?: boolean | null, partialAuthEnabled?: boolean | null, splitBankAccountsEnabled?: boolean | null, storeAndForwardFloorLimit?: string | null, publicKey?: string | null, status?: string | null, cashDiscountEnabled?: boolean | null, surveyTimeout?: number | null, cooldownTimeout?: number | null, tipEnabled?: boolean | null, promptForTip?: boolean | null, tipDefaults?: string[] | null, cashbackPresets?: string[] | null, ebtEnabled?: boolean | null, freeRangeRefundsEnabled?: boolean | null, pinBypassEnabled?: boolean | null, giftCardsDisabled?: boolean | null, tcDisabled?: boolean | null, digitalSignaturesEnabled?: boolean | null, digitalSignatureReversal?: boolean | null, billingAddress?: Address | null, shippingAddress?: Address | null, visa?: boolean | null, masterCard?: boolean | null, amex?: boolean | null, discover?: boolean | null, jcb?: boolean | null, unionPay?: boolean | null, contactlessEmv?: boolean | null, manualEntryEnabled?: boolean | null, manualEntryPromptZip?: boolean | null, manualEntryPromptStreetNumber?: boolean | null, gatewayOnly?: boolean | null, bankAccounts?: BankAccount[] | null);
+    /**
+     * That a merchant is allowed to send a surcharge amount directly to the gateway.
+     */
+    passthroughSurchargeEnabled: boolean | null;
+    constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, test?: boolean | null, merchantId?: string | null, bankMid?: string | null, companyName?: string | null, dbaName?: string | null, invoiceName?: string | null, contactName?: string | null, contactNumber?: string | null, locationName?: string | null, storeNumber?: string | null, partnerRef?: string | null, timeZone?: string | null, batchCloseTime?: string | null, terminalUpdateTime?: string | null, autoBatchClose?: boolean | null, disableBatchEmails?: boolean | null, pinEnabled?: boolean | null, cashBackEnabled?: boolean | null, storeAndForwardEnabled?: boolean | null, partialAuthEnabled?: boolean | null, splitBankAccountsEnabled?: boolean | null, storeAndForwardFloorLimit?: string | null, publicKey?: string | null, status?: string | null, cashDiscountEnabled?: boolean | null, surveyTimeout?: number | null, cooldownTimeout?: number | null, tipEnabled?: boolean | null, promptForTip?: boolean | null, tipDefaults?: string[] | null, cashbackPresets?: string[] | null, ebtEnabled?: boolean | null, freeRangeRefundsEnabled?: boolean | null, pinBypassEnabled?: boolean | null, giftCardsDisabled?: boolean | null, tcDisabled?: boolean | null, digitalSignaturesEnabled?: boolean | null, digitalSignatureReversal?: boolean | null, billingAddress?: Address | null, shippingAddress?: Address | null, visa?: boolean | null, masterCard?: boolean | null, amex?: boolean | null, discover?: boolean | null, jcb?: boolean | null, unionPay?: boolean | null, contactlessEmv?: boolean | null, manualEntryEnabled?: boolean | null, manualEntryPromptZip?: boolean | null, manualEntryPromptStreetNumber?: boolean | null, gatewayOnly?: boolean | null, bankAccounts?: BankAccount[] | null, passthroughSurchargeEnabled?: boolean | null);
 }
 /**
  * Models meta data about a merchant bank account.
@@ -6266,7 +6586,7 @@ export declare class UnlinkTokenRequest {
 /**
  * Fields for HSA/FSA transactions.
  */
-export declare class Healthcare {
+export declare class HealthcareMetadata {
     /**
      * A list of healthcare categories in the transaction.
      */
@@ -9033,6 +9353,506 @@ export declare class AggregateBillingLineItemStats {
     max: string | null;
     constructor(min?: string | null, avg?: string | null, max?: string | null);
 }
+/**
+ * Models an individual with 25% or more ownership interest in a company.
+ */
+export declare class Owner {
+    /**
+     * The first name of the owner.
+     */
+    firstName: string | null;
+    /**
+     * The last name of the owner.
+     */
+    lastName: string | null;
+    /**
+     * The job title of the owner.
+     */
+    jobTitle: string | null;
+    /**
+     * The tax identification number (SSN) of the owner.
+     */
+    taxIdNumber: string | null;
+    /**
+     * The phone number of the owner.
+     */
+    phoneNumber: string | null;
+    /**
+     * The date of birth of the owner in mm/dd/yyyy format.
+     */
+    dob: string | null;
+    /**
+     * The percentage of ownership.
+     */
+    ownership: string | null;
+    /**
+     * The address of the owner.
+     */
+    address: Address | null;
+    /**
+     * The email address of the owner.
+     */
+    email: string | null;
+    /**
+     * A single line representation of the owner's address.
+     */
+    singleLineAddress: string | null;
+    /**
+     * The type of entity this owner represents.
+     */
+    entityType: string | null;
+    /**
+     * The driver's license number of the owner.
+     */
+    dlNumber: string | null;
+    /**
+     * The state that issued the owner's driver's license.
+     */
+    dlStateOrProvince: string | null;
+    /**
+     * The expiration date of the owner's driver's license.
+     */
+    dlExpiration: string | null;
+    constructor(firstName?: string | null, lastName?: string | null, jobTitle?: string | null, taxIdNumber?: string | null, phoneNumber?: string | null, dob?: string | null, ownership?: string | null, address?: Address | null, email?: string | null, singleLineAddress?: string | null, entityType?: string | null, dlNumber?: string | null, dlStateOrProvince?: string | null, dlExpiration?: string | null);
+}
+/**
+ * Models a bank account associated with an application.
+ */
+export declare class ApplicationAccount {
+    /**
+     * The name of the bank account.
+     */
+    name: string | null;
+    /**
+     * The name of the bank.
+     */
+    bank: string | null;
+    /**
+     * The name of the account holder.
+     */
+    accountHolderName: string | null;
+    /**
+     * The routing number of the bank.
+     */
+    routingNumber: string | null;
+    /**
+     * The account number.
+     */
+    accountNumber: string | null;
+    constructor(name?: string | null, bank?: string | null, accountHolderName?: string | null, routingNumber?: string | null, accountNumber?: string | null);
+}
+/**
+ * Models a merchant application form to add a merchant account.
+ */
+export declare class MerchantApplication {
+    /**
+     * The invite code for the merchant.
+     */
+    inviteCode: string | null;
+    /**
+     * The business name your customers know you by (DBA Name).
+     */
+    dbaName: string | null;
+    /**
+     * The name of the legal entity you file your taxes under.
+     */
+    corporateName: string | null;
+    /**
+     * The business website.
+     */
+    webSite: string | null;
+    /**
+     * The business tax identification number (EIN).
+     */
+    taxIdNumber: string | null;
+    /**
+     * The type of business entity.
+     */
+    entityType: string | null;
+    /**
+     * The state where the business is incorporated.
+     */
+    stateOfIncorporation: string | null;
+    /**
+     * The primary type of business (e.g., Retail, Service, etc.).
+     */
+    merchantType: string | null;
+    /**
+     * A short description of the products and services sold.
+     */
+    businessDescription: string | null;
+    /**
+     * The number of years the business has been operating.
+     */
+    yearsInBusiness: string | null;
+    /**
+     * The business telephone number.
+     */
+    businessPhoneNumber: string | null;
+    /**
+     * The physical address of the business.
+     */
+    physicalAddress: Address | null;
+    /**
+     * The mailing address of the business.
+     */
+    mailingAddress: Address | null;
+    /**
+     * The first name of the primary contact.
+     */
+    contactFirstName: string | null;
+    /**
+     * The last name of the primary contact.
+     */
+    contactLastName: string | null;
+    /**
+     * The phone number of the primary contact.
+     */
+    contactPhoneNumber: string | null;
+    /**
+     * The email address of the primary contact.
+     */
+    contactEmail: string | null;
+    /**
+     * The job title of the primary contact.
+     */
+    contactTitle: string | null;
+    /**
+     * The tax identification number (SSN) of the primary contact.
+     */
+    contactTaxIdNumber: string | null;
+    /**
+     * The date of birth of the primary contact.
+     */
+    contactDOB: string | null;
+    /**
+     * The driver's license number of the primary contact.
+     */
+    contactDlNumber: string | null;
+    /**
+     * The state that issued the primary contact's driver's license.
+     */
+    contactDlStateOrProvince: string | null;
+    /**
+     * The expiration date of the primary contact's driver's license.
+     */
+    contactDlExpiration: string | null;
+    /**
+     * The home address of the primary contact.
+     */
+    contactHomeAddress: Address | null;
+    /**
+     * The role of the primary contact in the business.
+     */
+    contactRole: string | null;
+    /**
+     * List of individuals with 25% or more ownership in the company.
+     */
+    owners: Owner[] | null;
+    /**
+     * The bank account information for the business.
+     */
+    manualAccount: ApplicationAccount | null;
+    /**
+     * The average transaction amount.
+     */
+    averageTransaction: string | null;
+    /**
+     * The highest expected transaction amount.
+     */
+    highTransaction: string | null;
+    /**
+     * The average monthly transaction volume.
+     */
+    averageMonth: string | null;
+    /**
+     * The highest expected monthly transaction volume.
+     */
+    highMonth: string | null;
+    /**
+     * The refund policy of the business.
+     */
+    refundPolicy: string | null;
+    /**
+     * The number of days after purchase that refunds can be issued.
+     */
+    refundDays: string | null;
+    /**
+     * The time zone of the business.
+     */
+    timeZone: string | null;
+    /**
+     * The time when the daily batch should close.
+     */
+    batchCloseTime: string | null;
+    /**
+     * Indicates if the business has multiple locations.
+     */
+    multipleLocations: string | null;
+    /**
+     * The name of this specific business location.
+     */
+    locationName: string | null;
+    /**
+     * The store number for this location.
+     */
+    storeNumber: string | null;
+    /**
+     * Indicates if the business wants to accept EBT cards.
+     */
+    ebtRequested: string | null;
+    /**
+     * The FNS number issued by the USDA for EBT processing.
+     */
+    fnsNumber: string | null;
+    /**
+     * Indicates if the business plans to accept payments through a website.
+     */
+    ecommerce: string | null;
+    /**
+     * Indicates if suppliers ship products directly to customers.
+     */
+    dropShipping: boolean | null;
+    /**
+     * The percentage of transactions that will be chip or swipe.
+     */
+    cardPresentPercentage: string | null;
+    /**
+     * The percentage of transactions that will be phone orders.
+     */
+    phoneOrderPercentage: string | null;
+    /**
+     * The percentage of transactions that will be e-commerce.
+     */
+    ecomPercentage: string | null;
+    /**
+     * The number of days before shipment that customers are charged.
+     */
+    billBeforeShipmentDays: string | null;
+    /**
+     * Indicates if the business plans to process recurring payments.
+     */
+    subscriptionsSupported: string | null;
+    /**
+     * The frequency of recurring payments (if applicable).
+     */
+    subscriptionFrequency: string | null;
+    /**
+     * The full legal name of the person signing the application.
+     */
+    signerName: string | null;
+    constructor(inviteCode?: string | null, dbaName?: string | null, corporateName?: string | null, webSite?: string | null, taxIdNumber?: string | null, entityType?: string | null, stateOfIncorporation?: string | null, merchantType?: string | null, businessDescription?: string | null, yearsInBusiness?: string | null, businessPhoneNumber?: string | null, physicalAddress?: Address | null, mailingAddress?: Address | null, contactFirstName?: string | null, contactLastName?: string | null, contactPhoneNumber?: string | null, contactEmail?: string | null, contactTitle?: string | null, contactTaxIdNumber?: string | null, contactDOB?: string | null, contactDlNumber?: string | null, contactDlStateOrProvince?: string | null, contactDlExpiration?: string | null, contactHomeAddress?: Address | null, contactRole?: string | null, owners?: Owner[] | null, manualAccount?: ApplicationAccount | null, averageTransaction?: string | null, highTransaction?: string | null, averageMonth?: string | null, highMonth?: string | null, refundPolicy?: string | null, refundDays?: string | null, timeZone?: string | null, batchCloseTime?: string | null, multipleLocations?: string | null, locationName?: string | null, storeNumber?: string | null, ebtRequested?: string | null, fnsNumber?: string | null, ecommerce?: string | null, dropShipping?: boolean | null, cardPresentPercentage?: string | null, phoneOrderPercentage?: string | null, ecomPercentage?: string | null, billBeforeShipmentDays?: string | null, subscriptionsSupported?: string | null, subscriptionFrequency?: string | null, signerName?: string | null);
+}
+/**
+ * Models a merchant application submission request to add a new merchant account.
+ */
+export declare class SubmitApplicationRequest {
+    /**
+     * The request timeout in seconds.
+     */
+    timeout: number | null;
+    /**
+     * Whether or not to route transaction to the test gateway.
+     */
+    test: boolean | null;
+    /**
+     * The invite code for the merchant.
+     */
+    inviteCode: string | null;
+    /**
+     * The business name your customers know you by (DBA Name).
+     */
+    dbaName: string | null;
+    /**
+     * The name of the legal entity you file your taxes under.
+     */
+    corporateName: string | null;
+    /**
+     * The business website.
+     */
+    webSite: string | null;
+    /**
+     * The business tax identification number (EIN).
+     */
+    taxIdNumber: string | null;
+    /**
+     * The type of business entity.
+     */
+    entityType: string | null;
+    /**
+     * The state where the business is incorporated.
+     */
+    stateOfIncorporation: string | null;
+    /**
+     * The primary type of business (e.g., Retail, Service, etc.).
+     */
+    merchantType: string | null;
+    /**
+     * A short description of the products and services sold.
+     */
+    businessDescription: string | null;
+    /**
+     * The number of years the business has been operating.
+     */
+    yearsInBusiness: string | null;
+    /**
+     * The business telephone number.
+     */
+    businessPhoneNumber: string | null;
+    /**
+     * The physical address of the business.
+     */
+    physicalAddress: Address | null;
+    /**
+     * The mailing address of the business.
+     */
+    mailingAddress: Address | null;
+    /**
+     * The first name of the primary contact.
+     */
+    contactFirstName: string | null;
+    /**
+     * The last name of the primary contact.
+     */
+    contactLastName: string | null;
+    /**
+     * The phone number of the primary contact.
+     */
+    contactPhoneNumber: string | null;
+    /**
+     * The email address of the primary contact.
+     */
+    contactEmail: string | null;
+    /**
+     * The job title of the primary contact.
+     */
+    contactTitle: string | null;
+    /**
+     * The tax identification number (SSN) of the primary contact.
+     */
+    contactTaxIdNumber: string | null;
+    /**
+     * The date of birth of the primary contact.
+     */
+    contactDOB: string | null;
+    /**
+     * The driver's license number of the primary contact.
+     */
+    contactDlNumber: string | null;
+    /**
+     * The state that issued the primary contact's driver's license.
+     */
+    contactDlStateOrProvince: string | null;
+    /**
+     * The expiration date of the primary contact's driver's license.
+     */
+    contactDlExpiration: string | null;
+    /**
+     * The home address of the primary contact.
+     */
+    contactHomeAddress: Address | null;
+    /**
+     * The role of the primary contact in the business.
+     */
+    contactRole: string | null;
+    /**
+     * List of individuals with 25% or more ownership in the company.
+     */
+    owners: Owner[] | null;
+    /**
+     * The bank account information for the business.
+     */
+    manualAccount: ApplicationAccount | null;
+    /**
+     * The average transaction amount.
+     */
+    averageTransaction: string | null;
+    /**
+     * The highest expected transaction amount.
+     */
+    highTransaction: string | null;
+    /**
+     * The average monthly transaction volume.
+     */
+    averageMonth: string | null;
+    /**
+     * The highest expected monthly transaction volume.
+     */
+    highMonth: string | null;
+    /**
+     * The refund policy of the business.
+     */
+    refundPolicy: string | null;
+    /**
+     * The number of days after purchase that refunds can be issued.
+     */
+    refundDays: string | null;
+    /**
+     * The time zone of the business.
+     */
+    timeZone: string | null;
+    /**
+     * The time when the daily batch should close.
+     */
+    batchCloseTime: string | null;
+    /**
+     * Indicates if the business has multiple locations.
+     */
+    multipleLocations: string | null;
+    /**
+     * The name of this specific business location.
+     */
+    locationName: string | null;
+    /**
+     * The store number for this location.
+     */
+    storeNumber: string | null;
+    /**
+     * Indicates if the business wants to accept EBT cards.
+     */
+    ebtRequested: string | null;
+    /**
+     * The FNS number issued by the USDA for EBT processing.
+     */
+    fnsNumber: string | null;
+    /**
+     * Indicates if the business plans to accept payments through a website.
+     */
+    ecommerce: string | null;
+    /**
+     * Indicates if suppliers ship products directly to customers.
+     */
+    dropShipping: boolean | null;
+    /**
+     * The percentage of transactions that will be chip or swipe.
+     */
+    cardPresentPercentage: string | null;
+    /**
+     * The percentage of transactions that will be phone orders.
+     */
+    phoneOrderPercentage: string | null;
+    /**
+     * The percentage of transactions that will be e-commerce.
+     */
+    ecomPercentage: string | null;
+    /**
+     * The number of days before shipment that customers are charged.
+     */
+    billBeforeShipmentDays: string | null;
+    /**
+     * Indicates if the business plans to process recurring payments.
+     */
+    subscriptionsSupported: string | null;
+    /**
+     * The frequency of recurring payments (if applicable).
+     */
+    subscriptionFrequency: string | null;
+    /**
+     * The full legal name of the person signing the application.
+     */
+    signerName: string | null;
+    constructor(timeout?: number | null, test?: boolean | null, inviteCode?: string | null, dbaName?: string | null, corporateName?: string | null, webSite?: string | null, taxIdNumber?: string | null, entityType?: string | null, stateOfIncorporation?: string | null, merchantType?: string | null, businessDescription?: string | null, yearsInBusiness?: string | null, businessPhoneNumber?: string | null, physicalAddress?: Address | null, mailingAddress?: Address | null, contactFirstName?: string | null, contactLastName?: string | null, contactPhoneNumber?: string | null, contactEmail?: string | null, contactTitle?: string | null, contactTaxIdNumber?: string | null, contactDOB?: string | null, contactDlNumber?: string | null, contactDlStateOrProvince?: string | null, contactDlExpiration?: string | null, contactHomeAddress?: Address | null, contactRole?: string | null, owners?: Owner[] | null, manualAccount?: ApplicationAccount | null, averageTransaction?: string | null, highTransaction?: string | null, averageMonth?: string | null, highMonth?: string | null, refundPolicy?: string | null, refundDays?: string | null, timeZone?: string | null, batchCloseTime?: string | null, multipleLocations?: string | null, locationName?: string | null, storeNumber?: string | null, ebtRequested?: string | null, fnsNumber?: string | null, ecommerce?: string | null, dropShipping?: boolean | null, cardPresentPercentage?: string | null, phoneOrderPercentage?: string | null, ecomPercentage?: string | null, billBeforeShipmentDays?: string | null, subscriptionsSupported?: string | null, subscriptionFrequency?: string | null, signerName?: string | null);
+}
 /**
  * A request for customer signature data.
  */
@@ -9089,6 +9909,14 @@ export declare class TerminalAuthorizationRequest {
     request: AuthorizationRequest;
     constructor(APICredentials: APICredentials, request: AuthorizationRequest);
 }
+/**
+ * Retrieves card metadata.
+ */
+export declare class TerminalCardMetadataRequest {
+    APICredentials: APICredentials;
+    request: CardMetadataRequest;
+    constructor(APICredentials: APICredentials, request: CardMetadataRequest);
+}
 /**
  * A request for the remaining balance on a payment type.
  */