@blockchyp/blockchyp-ts 2.18.8 → 2.20.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1062,7 +1062,11 @@ export declare class TokenMetadataResponse {
1062
1062
  * The token metadata for a given query.
1063
1063
  */
1064
1064
  token: CustomerToken | null;
1065
- constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, token?: CustomerToken | null);
1065
+ /**
1066
+ * Details about a payment card derived from its BIN/IIN.
1067
+ */
1068
+ cardMetadata?: CardMetadata;
1069
+ constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, token?: CustomerToken | null, cardMetadata?: CardMetadata | undefined);
1066
1070
  }
1067
1071
  /**
1068
1072
  * Models a customer token.
@@ -1419,7 +1423,7 @@ export declare class AuthorizationRequest {
1419
1423
  /**
1420
1424
  * Details for HSA/FSA transactions.
1421
1425
  */
1422
- healthcare?: Healthcare;
1426
+ healthcareMetadata?: HealthcareMetadata;
1423
1427
  /**
1424
1428
  * That the transaction should be a cryptocurrency transaction. Value should be a
1425
1429
  * crypto currency code (ETH, BTC) or ANY to prompt the user to choose from supported
@@ -1466,9 +1470,301 @@ export declare class AuthorizationRequest {
1466
1470
  * gateway and is not directly calculated.
1467
1471
  */
1468
1472
  passthroughSurcharge?: string;
1473
+ /**
1474
+ * Marks a transaction as HSA/FSA.
1475
+ */
1476
+ healthcare?: boolean;
1477
+ /**
1478
+ * The total amount to process as healthcare.
1479
+ */
1480
+ healthcareTotal?: string;
1481
+ /**
1482
+ * The total amount to process as ebt.
1483
+ */
1484
+ ebtTotal?: string;
1485
+ /**
1486
+ * That this transaction will include a card metadata lookup.
1487
+ */
1488
+ cardMetadataLookup?: boolean;
1469
1489
  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?: {
1470
1490
  [key: string]: string;
1471
- } | 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);
1491
+ } | 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);
1492
+ }
1493
+ /**
1494
+ * Essential information about a payment card derived from its BIN/IIN.
1495
+ */
1496
+ export declare class CardMetadata {
1497
+ /**
1498
+ * The brand or network of the card (e.g., Visa, Mastercard, Amex).
1499
+ */
1500
+ cardBrand: string | null;
1501
+ /**
1502
+ * The name of the financial institution that issued the card.
1503
+ */
1504
+ issuerName: string | null;
1505
+ /**
1506
+ * Whether the card supports Level 3 processing for detailed transaction data.
1507
+ */
1508
+ l3: boolean | null;
1509
+ /**
1510
+ * Whether the card supports Level 2 processing for additional transaction data.
1511
+ */
1512
+ l2: boolean | null;
1513
+ /**
1514
+ * The general category or type of the card product.
1515
+ */
1516
+ productType: string | null;
1517
+ /**
1518
+ * The specific name or designation of the card product.
1519
+ */
1520
+ productName: string | null;
1521
+ /**
1522
+ * Whether the card is an Electronic Benefit Transfer (EBT) card.
1523
+ */
1524
+ ebt: boolean | null;
1525
+ /**
1526
+ * Whether the card is a debit card.
1527
+ */
1528
+ debit: boolean | null;
1529
+ /**
1530
+ * Whether the card is a healthcare-specific payment card.
1531
+ */
1532
+ healthcare: boolean | null;
1533
+ /**
1534
+ * Whether the card is a prepaid card.
1535
+ */
1536
+ prepaid: boolean | null;
1537
+ /**
1538
+ * The geographical region associated with the card's issuer.
1539
+ */
1540
+ region: string | null;
1541
+ /**
1542
+ * The country associated with the card's issuer.
1543
+ */
1544
+ country: string | null;
1545
+ 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);
1546
+ }
1547
+ /**
1548
+ * Retrieves card metadata.
1549
+ */
1550
+ export declare class CardMetadataRequest {
1551
+ /**
1552
+ * The request timeout in seconds.
1553
+ */
1554
+ timeout: number | null;
1555
+ /**
1556
+ * Whether or not to route transaction to the test gateway.
1557
+ */
1558
+ test: boolean | null;
1559
+ /**
1560
+ * A user-assigned reference that can be used to recall or reverse transactions.
1561
+ */
1562
+ transactionRef?: string;
1563
+ /**
1564
+ * That the transaction reference was autogenerated and should be ignored for the
1565
+ * purposes of duplicate detection.
1566
+ */
1567
+ autogeneratedRef: boolean | null;
1568
+ /**
1569
+ * Defers the response to the transaction and returns immediately. Callers should
1570
+ * retrive the transaction result using the Transaction Status API.
1571
+ */
1572
+ async: boolean | null;
1573
+ /**
1574
+ * Adds the transaction to the queue and returns immediately. Callers should retrive
1575
+ * the transaction result using the Transaction Status API.
1576
+ */
1577
+ queue: boolean | null;
1578
+ /**
1579
+ * Whether or not the request should block until all cards have been removed from the card
1580
+ * reader.
1581
+ */
1582
+ waitForRemovedCard?: boolean;
1583
+ /**
1584
+ * Override any in-progress transactions.
1585
+ */
1586
+ force?: boolean;
1587
+ /**
1588
+ * An identifier from an external point of sale system.
1589
+ */
1590
+ orderRef?: string;
1591
+ /**
1592
+ * The settlement account for merchants with split settlements.
1593
+ */
1594
+ destinationAccount?: string;
1595
+ /**
1596
+ * Can include a code used to trigger simulated conditions for the purposes of testing
1597
+ * and certification. Valid for test merchant accounts only.
1598
+ */
1599
+ testCase?: string;
1600
+ /**
1601
+ * The payment token to be used for this transaction. This should be used for recurring
1602
+ * transactions.
1603
+ */
1604
+ token?: string;
1605
+ /**
1606
+ * Track 1 magnetic stripe data.
1607
+ */
1608
+ track1?: string;
1609
+ /**
1610
+ * Track 2 magnetic stripe data.
1611
+ */
1612
+ track2?: string;
1613
+ /**
1614
+ * The primary account number. We recommend using the terminal or e-commerce
1615
+ * tokenization libraries instead of passing account numbers in directly, as this
1616
+ * would put your application in PCI scope.
1617
+ */
1618
+ pan?: string;
1619
+ /**
1620
+ * The ACH routing number for ACH transactions.
1621
+ */
1622
+ routingNumber?: string;
1623
+ /**
1624
+ * The cardholder name. Only required if the request includes a primary account number
1625
+ * or track data.
1626
+ */
1627
+ cardholderName?: string;
1628
+ /**
1629
+ * The card expiration month for use with PAN based transactions.
1630
+ */
1631
+ expMonth?: string;
1632
+ /**
1633
+ * The card expiration year for use with PAN based transactions.
1634
+ */
1635
+ expYear?: string;
1636
+ /**
1637
+ * The card CVV for use with PAN based transactions.
1638
+ */
1639
+ cvv?: string;
1640
+ /**
1641
+ * The cardholder address for use with address verification.
1642
+ */
1643
+ address?: string;
1644
+ /**
1645
+ * The cardholder postal code for use with address verification.
1646
+ */
1647
+ postalCode?: string;
1648
+ /**
1649
+ * That the payment entry method is a manual keyed transaction. If this is true, no other
1650
+ * payment method will be accepted.
1651
+ */
1652
+ manualEntry?: boolean;
1653
+ /**
1654
+ * The key serial number used for DUKPT encryption.
1655
+ */
1656
+ ksn?: string;
1657
+ /**
1658
+ * The encrypted pin block.
1659
+ */
1660
+ pinBlock?: string;
1661
+ /**
1662
+ * Designates categories of cards: credit, debit, EBT.
1663
+ */
1664
+ cardType?: CardType;
1665
+ /**
1666
+ * Designates brands of payment methods: Visa, Discover, etc.
1667
+ */
1668
+ paymentType?: string;
1669
+ /**
1670
+ * The name of the target payment terminal.
1671
+ */
1672
+ terminalName?: string;
1673
+ /**
1674
+ * Forces the terminal cloud connection to be reset while a transactions is in flight.
1675
+ * This is a diagnostic settings that can be used only for test transactions.
1676
+ */
1677
+ resetConnection: boolean | null;
1678
+ /**
1679
+ * Marks a transaction as HSA/FSA.
1680
+ */
1681
+ healthcare?: boolean;
1682
+ 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);
1683
+ }
1684
+ /**
1685
+ * The response to a card metadata request.
1686
+ */
1687
+ export declare class CardMetadataResponse {
1688
+ /**
1689
+ * Whether or not the request succeeded.
1690
+ */
1691
+ success: boolean | null;
1692
+ /**
1693
+ * The error, if an error occurred.
1694
+ */
1695
+ error: string | null;
1696
+ /**
1697
+ * A narrative description of the transaction result.
1698
+ */
1699
+ responseDescription: string | null;
1700
+ /**
1701
+ * The payment token, if the payment was enrolled in the vault.
1702
+ */
1703
+ token?: string;
1704
+ /**
1705
+ * The entry method for the transaction (CHIP, MSR, KEYED, etc).
1706
+ */
1707
+ entryMethod?: string;
1708
+ /**
1709
+ * The card brand (VISA, MC, AMEX, DEBIT, etc).
1710
+ */
1711
+ paymentType?: string;
1712
+ /**
1713
+ * Provides network level detail on how a transaction was routed, especially for debit
1714
+ * transactions.
1715
+ */
1716
+ network?: string;
1717
+ /**
1718
+ * Identifies the card association based on bin number. Used primarily used to indicate
1719
+ * the major logo on a card, even when debit transactions are routed on a different
1720
+ * network.
1721
+ */
1722
+ logo?: string;
1723
+ /**
1724
+ * The masked primary account number.
1725
+ */
1726
+ maskedPan?: string;
1727
+ /**
1728
+ * The BlockChyp public key if the user presented a BlockChyp payment card.
1729
+ */
1730
+ publicKey?: string;
1731
+ /**
1732
+ * That the transaction did something that would put the system in PCI scope.
1733
+ */
1734
+ ScopeAlert?: boolean;
1735
+ /**
1736
+ * The cardholder name.
1737
+ */
1738
+ cardHolder?: string;
1739
+ /**
1740
+ * The card expiration month in MM format.
1741
+ */
1742
+ expMonth?: string;
1743
+ /**
1744
+ * The card expiration year in YY format.
1745
+ */
1746
+ expYear?: string;
1747
+ /**
1748
+ * Address verification results if address information was submitted.
1749
+ */
1750
+ avsResponse: AVSResponse | null;
1751
+ /**
1752
+ * Suggested receipt fields.
1753
+ */
1754
+ receiptSuggestions: ReceiptSuggestions | null;
1755
+ /**
1756
+ * Customer data, if any. Preserved for reverse compatibility.
1757
+ */
1758
+ customer?: Customer;
1759
+ /**
1760
+ * Customer data, if any.
1761
+ */
1762
+ customers: Customer[] | null;
1763
+ /**
1764
+ * Details about a payment card derived from its BIN/IIN.
1765
+ */
1766
+ cardMetadata?: CardMetadata;
1767
+ 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);
1472
1768
  }
1473
1769
  /**
1474
1770
  * A request for the remaining balance on a payment type.
@@ -1913,7 +2209,7 @@ export declare class RefundRequest {
1913
2209
  /**
1914
2210
  * Details for HSA/FSA transactions.
1915
2211
  */
1916
- healthcare?: Healthcare;
2212
+ healthcareMetadata?: HealthcareMetadata;
1917
2213
  /**
1918
2214
  * Instructs the terminal to simulate a post auth chip rejection that would trigger an
1919
2215
  * automatic reversal.
@@ -1936,7 +2232,11 @@ export declare class RefundRequest {
1936
2232
  * Manually sets the MIT (Merchant Initiated Transaction) flag.
1937
2233
  */
1938
2234
  mit?: boolean;
1939
- 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);
2235
+ /**
2236
+ * That this transaction will include a card metadata lookup.
2237
+ */
2238
+ cardMetadataLookup?: boolean;
2239
+ 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);
1940
2240
  }
1941
2241
  /**
1942
2242
  * The information needed to capture a preauth.
@@ -2557,7 +2857,11 @@ export declare class EnrollRequest {
2557
2857
  * recurring transaction.
2558
2858
  */
2559
2859
  subscription?: boolean;
2560
- 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);
2860
+ /**
2861
+ * That this transaction will include a card metadata lookup.
2862
+ */
2863
+ cardMetadataLookup?: boolean;
2864
+ 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);
2561
2865
  }
2562
2866
  /**
2563
2867
  * The response to an enroll request.
@@ -2694,7 +2998,11 @@ export declare class EnrollResponse {
2694
2998
  * The hex encoded signature data.
2695
2999
  */
2696
3000
  sigFile?: string;
2697
- 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);
3001
+ /**
3002
+ * Details about a payment card derived from its BIN/IIN.
3003
+ */
3004
+ cardMetadata?: CardMetadata;
3005
+ 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);
2698
3006
  }
2699
3007
  /**
2700
3008
  * The information needed to enroll a new payment method in the token vault.
@@ -3452,7 +3760,11 @@ export declare class AuthorizationResponse {
3452
3760
  * The current status of a transaction.
3453
3761
  */
3454
3762
  status: string | null;
3455
- 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);
3763
+ /**
3764
+ * Details about a payment card derived from its BIN/IIN.
3765
+ */
3766
+ cardMetadata?: CardMetadata;
3767
+ 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);
3456
3768
  }
3457
3769
  /**
3458
3770
  * Models the request for updated information about a transaction.
@@ -5090,6 +5402,24 @@ export declare class AddTestMerchantRequest {
5090
5402
  timeout: number | null;
5091
5403
  constructor(test?: boolean | null, dbaName?: string | null, companyName?: string | null, timeout?: number | null);
5092
5404
  }
5405
+ /**
5406
+ * Models basic information needed to create a gateway merchant.
5407
+ */
5408
+ export declare class AddGatewayMerchantRequest {
5409
+ /**
5410
+ * Whether or not to route transaction to the test gateway.
5411
+ */
5412
+ test: boolean | null;
5413
+ /**
5414
+ * The merchant profile to be boarded.
5415
+ */
5416
+ profile: MerchantProfile | null;
5417
+ /**
5418
+ * The request timeout in seconds.
5419
+ */
5420
+ timeout: number | null;
5421
+ constructor(test?: boolean | null, profile?: MerchantProfile | null, timeout?: number | null);
5422
+ }
5093
5423
  /**
5094
5424
  * Models a request for information about the merchant profile.
5095
5425
  */
@@ -5338,6 +5668,10 @@ export declare class MerchantProfile {
5338
5668
  * The merchant id.
5339
5669
  */
5340
5670
  merchantId: string | null;
5671
+ /**
5672
+ * The primary bank mid.
5673
+ */
5674
+ bankMid: string | null;
5341
5675
  /**
5342
5676
  * The merchant's company name.
5343
5677
  */
@@ -5538,7 +5872,7 @@ export declare class MerchantProfile {
5538
5872
  * Bank accounts for split bank account merchants.
5539
5873
  */
5540
5874
  bankAccounts: BankAccount[] | null;
5541
- constructor(timeout?: number | null, test?: boolean | null, merchantId?: 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);
5875
+ 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);
5542
5876
  }
5543
5877
  /**
5544
5878
  * Models a response for a single merchant profile.
@@ -5564,6 +5898,10 @@ export declare class MerchantProfileResponse {
5564
5898
  * The merchant id.
5565
5899
  */
5566
5900
  merchantId: string | null;
5901
+ /**
5902
+ * The primary bank mid.
5903
+ */
5904
+ bankMid: string | null;
5567
5905
  /**
5568
5906
  * The merchant's company name.
5569
5907
  */
@@ -5764,7 +6102,7 @@ export declare class MerchantProfileResponse {
5764
6102
  * Bank accounts for split bank account merchants.
5765
6103
  */
5766
6104
  bankAccounts: BankAccount[] | null;
5767
- constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, test?: boolean | null, merchantId?: 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);
6105
+ 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);
5768
6106
  }
5769
6107
  /**
5770
6108
  * Models meta data about a merchant bank account.
@@ -6240,7 +6578,7 @@ export declare class UnlinkTokenRequest {
6240
6578
  /**
6241
6579
  * Fields for HSA/FSA transactions.
6242
6580
  */
6243
- export declare class Healthcare {
6581
+ export declare class HealthcareMetadata {
6244
6582
  /**
6245
6583
  * A list of healthcare categories in the transaction.
6246
6584
  */
@@ -6440,6 +6778,46 @@ export declare class MerchantPlatformsResponse {
6440
6778
  results: MerchantPlatform[] | null;
6441
6779
  constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, test?: boolean | null, results?: MerchantPlatform[] | null);
6442
6780
  }
6781
+ /**
6782
+ * Used to up platform configuration for gateway merchants.
6783
+ */
6784
+ export declare class UpdateMerchantPlatformRequest {
6785
+ /**
6786
+ * The request timeout in seconds.
6787
+ */
6788
+ timeout: number | null;
6789
+ /**
6790
+ * Whether or not to route transaction to the test gateway.
6791
+ */
6792
+ test: boolean | null;
6793
+ /**
6794
+ * The merchant platform configuration.
6795
+ */
6796
+ platform: MerchantPlatform | null;
6797
+ constructor(timeout?: number | null, test?: boolean | null, platform?: MerchantPlatform | null);
6798
+ }
6799
+ /**
6800
+ * Echoes back the state of the current platform configuration after a change.
6801
+ */
6802
+ export declare class UpdateMerchantPlatformResponse {
6803
+ /**
6804
+ * Whether or not the request succeeded.
6805
+ */
6806
+ success: boolean | null;
6807
+ /**
6808
+ * The error, if an error occurred.
6809
+ */
6810
+ error: string | null;
6811
+ /**
6812
+ * A narrative description of the transaction result.
6813
+ */
6814
+ responseDescription: string | null;
6815
+ /**
6816
+ * The current platform configuration.
6817
+ */
6818
+ platform: MerchantPlatform | null;
6819
+ constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, platform?: MerchantPlatform | null);
6820
+ }
6443
6821
  /**
6444
6822
  * Details about a merchant board platform configuration.
6445
6823
  */
@@ -8817,7 +9195,11 @@ export declare class MerchantCredentialGenerationRequest {
8817
9195
  * Free form description of the purpose or intent behind the credentials.
8818
9196
  */
8819
9197
  notes: string | null;
8820
- constructor(timeout?: number | null, test?: boolean | null, merchantId?: string | null, deleteProtected?: boolean | null, roles?: string[] | null, notes?: string | null);
9198
+ /**
9199
+ * Type of credentials to generate, either API or TOKENIZING. Defaults to API.
9200
+ */
9201
+ credentialType: string | null;
9202
+ constructor(timeout?: number | null, test?: boolean | null, merchantId?: string | null, deleteProtected?: boolean | null, roles?: string[] | null, notes?: string | null, credentialType?: string | null);
8821
9203
  }
8822
9204
  /**
8823
9205
  * Merchant api credential data.
@@ -8847,7 +9229,11 @@ export declare class MerchantCredentialGenerationResponse {
8847
9229
  * The merchant signing key.
8848
9230
  */
8849
9231
  signingKey: string | null;
8850
- constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, apiKey?: string | null, bearerToken?: string | null, signingKey?: string | null);
9232
+ /**
9233
+ * The tokenizing key.
9234
+ */
9235
+ tokenizingKey: string | null;
9236
+ constructor(success?: boolean | null, error?: string | null, responseDescription?: string | null, apiKey?: string | null, bearerToken?: string | null, signingKey?: string | null, tokenizingKey?: string | null);
8851
9237
  }
8852
9238
  /**
8853
9239
  * Models a single buy rate calculation line item.
@@ -8959,6 +9345,506 @@ export declare class AggregateBillingLineItemStats {
8959
9345
  max: string | null;
8960
9346
  constructor(min?: string | null, avg?: string | null, max?: string | null);
8961
9347
  }
9348
+ /**
9349
+ * Models an individual with 25% or more ownership interest in a company.
9350
+ */
9351
+ export declare class Owner {
9352
+ /**
9353
+ * The first name of the owner.
9354
+ */
9355
+ firstName: string | null;
9356
+ /**
9357
+ * The last name of the owner.
9358
+ */
9359
+ lastName: string | null;
9360
+ /**
9361
+ * The job title of the owner.
9362
+ */
9363
+ jobTitle: string | null;
9364
+ /**
9365
+ * The tax identification number (SSN) of the owner.
9366
+ */
9367
+ taxIdNumber: string | null;
9368
+ /**
9369
+ * The phone number of the owner.
9370
+ */
9371
+ phoneNumber: string | null;
9372
+ /**
9373
+ * The date of birth of the owner in mm/dd/yyyy format.
9374
+ */
9375
+ dob: string | null;
9376
+ /**
9377
+ * The percentage of ownership.
9378
+ */
9379
+ ownership: string | null;
9380
+ /**
9381
+ * The address of the owner.
9382
+ */
9383
+ address: Address | null;
9384
+ /**
9385
+ * The email address of the owner.
9386
+ */
9387
+ email: string | null;
9388
+ /**
9389
+ * A single line representation of the owner's address.
9390
+ */
9391
+ singleLineAddress: string | null;
9392
+ /**
9393
+ * The type of entity this owner represents.
9394
+ */
9395
+ entityType: string | null;
9396
+ /**
9397
+ * The driver's license number of the owner.
9398
+ */
9399
+ dlNumber: string | null;
9400
+ /**
9401
+ * The state that issued the owner's driver's license.
9402
+ */
9403
+ dlStateOrProvince: string | null;
9404
+ /**
9405
+ * The expiration date of the owner's driver's license.
9406
+ */
9407
+ dlExpiration: string | null;
9408
+ 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);
9409
+ }
9410
+ /**
9411
+ * Models a bank account associated with an application.
9412
+ */
9413
+ export declare class ApplicationAccount {
9414
+ /**
9415
+ * The name of the bank account.
9416
+ */
9417
+ name: string | null;
9418
+ /**
9419
+ * The name of the bank.
9420
+ */
9421
+ bank: string | null;
9422
+ /**
9423
+ * The name of the account holder.
9424
+ */
9425
+ accountHolderName: string | null;
9426
+ /**
9427
+ * The routing number of the bank.
9428
+ */
9429
+ routingNumber: string | null;
9430
+ /**
9431
+ * The account number.
9432
+ */
9433
+ accountNumber: string | null;
9434
+ constructor(name?: string | null, bank?: string | null, accountHolderName?: string | null, routingNumber?: string | null, accountNumber?: string | null);
9435
+ }
9436
+ /**
9437
+ * Models a merchant application form to add a merchant account.
9438
+ */
9439
+ export declare class MerchantApplication {
9440
+ /**
9441
+ * The invite code for the merchant.
9442
+ */
9443
+ inviteCode: string | null;
9444
+ /**
9445
+ * The business name your customers know you by (DBA Name).
9446
+ */
9447
+ dbaName: string | null;
9448
+ /**
9449
+ * The name of the legal entity you file your taxes under.
9450
+ */
9451
+ corporateName: string | null;
9452
+ /**
9453
+ * The business website.
9454
+ */
9455
+ webSite: string | null;
9456
+ /**
9457
+ * The business tax identification number (EIN).
9458
+ */
9459
+ taxIdNumber: string | null;
9460
+ /**
9461
+ * The type of business entity.
9462
+ */
9463
+ entityType: string | null;
9464
+ /**
9465
+ * The state where the business is incorporated.
9466
+ */
9467
+ stateOfIncorporation: string | null;
9468
+ /**
9469
+ * The primary type of business (e.g., Retail, Service, etc.).
9470
+ */
9471
+ merchantType: string | null;
9472
+ /**
9473
+ * A short description of the products and services sold.
9474
+ */
9475
+ businessDescription: string | null;
9476
+ /**
9477
+ * The number of years the business has been operating.
9478
+ */
9479
+ yearsInBusiness: string | null;
9480
+ /**
9481
+ * The business telephone number.
9482
+ */
9483
+ businessPhoneNumber: string | null;
9484
+ /**
9485
+ * The physical address of the business.
9486
+ */
9487
+ physicalAddress: Address | null;
9488
+ /**
9489
+ * The mailing address of the business.
9490
+ */
9491
+ mailingAddress: Address | null;
9492
+ /**
9493
+ * The first name of the primary contact.
9494
+ */
9495
+ contactFirstName: string | null;
9496
+ /**
9497
+ * The last name of the primary contact.
9498
+ */
9499
+ contactLastName: string | null;
9500
+ /**
9501
+ * The phone number of the primary contact.
9502
+ */
9503
+ contactPhoneNumber: string | null;
9504
+ /**
9505
+ * The email address of the primary contact.
9506
+ */
9507
+ contactEmail: string | null;
9508
+ /**
9509
+ * The job title of the primary contact.
9510
+ */
9511
+ contactTitle: string | null;
9512
+ /**
9513
+ * The tax identification number (SSN) of the primary contact.
9514
+ */
9515
+ contactTaxIdNumber: string | null;
9516
+ /**
9517
+ * The date of birth of the primary contact.
9518
+ */
9519
+ contactDOB: string | null;
9520
+ /**
9521
+ * The driver's license number of the primary contact.
9522
+ */
9523
+ contactDlNumber: string | null;
9524
+ /**
9525
+ * The state that issued the primary contact's driver's license.
9526
+ */
9527
+ contactDlStateOrProvince: string | null;
9528
+ /**
9529
+ * The expiration date of the primary contact's driver's license.
9530
+ */
9531
+ contactDlExpiration: string | null;
9532
+ /**
9533
+ * The home address of the primary contact.
9534
+ */
9535
+ contactHomeAddress: Address | null;
9536
+ /**
9537
+ * The role of the primary contact in the business.
9538
+ */
9539
+ contactRole: string | null;
9540
+ /**
9541
+ * List of individuals with 25% or more ownership in the company.
9542
+ */
9543
+ owners: Owner[] | null;
9544
+ /**
9545
+ * The bank account information for the business.
9546
+ */
9547
+ manualAccount: ApplicationAccount | null;
9548
+ /**
9549
+ * The average transaction amount.
9550
+ */
9551
+ averageTransaction: string | null;
9552
+ /**
9553
+ * The highest expected transaction amount.
9554
+ */
9555
+ highTransaction: string | null;
9556
+ /**
9557
+ * The average monthly transaction volume.
9558
+ */
9559
+ averageMonth: string | null;
9560
+ /**
9561
+ * The highest expected monthly transaction volume.
9562
+ */
9563
+ highMonth: string | null;
9564
+ /**
9565
+ * The refund policy of the business.
9566
+ */
9567
+ refundPolicy: string | null;
9568
+ /**
9569
+ * The number of days after purchase that refunds can be issued.
9570
+ */
9571
+ refundDays: string | null;
9572
+ /**
9573
+ * The time zone of the business.
9574
+ */
9575
+ timeZone: string | null;
9576
+ /**
9577
+ * The time when the daily batch should close.
9578
+ */
9579
+ batchCloseTime: string | null;
9580
+ /**
9581
+ * Indicates if the business has multiple locations.
9582
+ */
9583
+ multipleLocations: string | null;
9584
+ /**
9585
+ * The name of this specific business location.
9586
+ */
9587
+ locationName: string | null;
9588
+ /**
9589
+ * The store number for this location.
9590
+ */
9591
+ storeNumber: string | null;
9592
+ /**
9593
+ * Indicates if the business wants to accept EBT cards.
9594
+ */
9595
+ ebtRequested: string | null;
9596
+ /**
9597
+ * The FNS number issued by the USDA for EBT processing.
9598
+ */
9599
+ fnsNumber: string | null;
9600
+ /**
9601
+ * Indicates if the business plans to accept payments through a website.
9602
+ */
9603
+ ecommerce: string | null;
9604
+ /**
9605
+ * Indicates if suppliers ship products directly to customers.
9606
+ */
9607
+ dropShipping: boolean | null;
9608
+ /**
9609
+ * The percentage of transactions that will be chip or swipe.
9610
+ */
9611
+ cardPresentPercentage: string | null;
9612
+ /**
9613
+ * The percentage of transactions that will be phone orders.
9614
+ */
9615
+ phoneOrderPercentage: string | null;
9616
+ /**
9617
+ * The percentage of transactions that will be e-commerce.
9618
+ */
9619
+ ecomPercentage: string | null;
9620
+ /**
9621
+ * The number of days before shipment that customers are charged.
9622
+ */
9623
+ billBeforeShipmentDays: string | null;
9624
+ /**
9625
+ * Indicates if the business plans to process recurring payments.
9626
+ */
9627
+ subscriptionsSupported: string | null;
9628
+ /**
9629
+ * The frequency of recurring payments (if applicable).
9630
+ */
9631
+ subscriptionFrequency: string | null;
9632
+ /**
9633
+ * The full legal name of the person signing the application.
9634
+ */
9635
+ signerName: string | null;
9636
+ 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);
9637
+ }
9638
+ /**
9639
+ * Models a merchant application submission request to add a new merchant account.
9640
+ */
9641
+ export declare class SubmitApplicationRequest {
9642
+ /**
9643
+ * The request timeout in seconds.
9644
+ */
9645
+ timeout: number | null;
9646
+ /**
9647
+ * Whether or not to route transaction to the test gateway.
9648
+ */
9649
+ test: boolean | null;
9650
+ /**
9651
+ * The invite code for the merchant.
9652
+ */
9653
+ inviteCode: string | null;
9654
+ /**
9655
+ * The business name your customers know you by (DBA Name).
9656
+ */
9657
+ dbaName: string | null;
9658
+ /**
9659
+ * The name of the legal entity you file your taxes under.
9660
+ */
9661
+ corporateName: string | null;
9662
+ /**
9663
+ * The business website.
9664
+ */
9665
+ webSite: string | null;
9666
+ /**
9667
+ * The business tax identification number (EIN).
9668
+ */
9669
+ taxIdNumber: string | null;
9670
+ /**
9671
+ * The type of business entity.
9672
+ */
9673
+ entityType: string | null;
9674
+ /**
9675
+ * The state where the business is incorporated.
9676
+ */
9677
+ stateOfIncorporation: string | null;
9678
+ /**
9679
+ * The primary type of business (e.g., Retail, Service, etc.).
9680
+ */
9681
+ merchantType: string | null;
9682
+ /**
9683
+ * A short description of the products and services sold.
9684
+ */
9685
+ businessDescription: string | null;
9686
+ /**
9687
+ * The number of years the business has been operating.
9688
+ */
9689
+ yearsInBusiness: string | null;
9690
+ /**
9691
+ * The business telephone number.
9692
+ */
9693
+ businessPhoneNumber: string | null;
9694
+ /**
9695
+ * The physical address of the business.
9696
+ */
9697
+ physicalAddress: Address | null;
9698
+ /**
9699
+ * The mailing address of the business.
9700
+ */
9701
+ mailingAddress: Address | null;
9702
+ /**
9703
+ * The first name of the primary contact.
9704
+ */
9705
+ contactFirstName: string | null;
9706
+ /**
9707
+ * The last name of the primary contact.
9708
+ */
9709
+ contactLastName: string | null;
9710
+ /**
9711
+ * The phone number of the primary contact.
9712
+ */
9713
+ contactPhoneNumber: string | null;
9714
+ /**
9715
+ * The email address of the primary contact.
9716
+ */
9717
+ contactEmail: string | null;
9718
+ /**
9719
+ * The job title of the primary contact.
9720
+ */
9721
+ contactTitle: string | null;
9722
+ /**
9723
+ * The tax identification number (SSN) of the primary contact.
9724
+ */
9725
+ contactTaxIdNumber: string | null;
9726
+ /**
9727
+ * The date of birth of the primary contact.
9728
+ */
9729
+ contactDOB: string | null;
9730
+ /**
9731
+ * The driver's license number of the primary contact.
9732
+ */
9733
+ contactDlNumber: string | null;
9734
+ /**
9735
+ * The state that issued the primary contact's driver's license.
9736
+ */
9737
+ contactDlStateOrProvince: string | null;
9738
+ /**
9739
+ * The expiration date of the primary contact's driver's license.
9740
+ */
9741
+ contactDlExpiration: string | null;
9742
+ /**
9743
+ * The home address of the primary contact.
9744
+ */
9745
+ contactHomeAddress: Address | null;
9746
+ /**
9747
+ * The role of the primary contact in the business.
9748
+ */
9749
+ contactRole: string | null;
9750
+ /**
9751
+ * List of individuals with 25% or more ownership in the company.
9752
+ */
9753
+ owners: Owner[] | null;
9754
+ /**
9755
+ * The bank account information for the business.
9756
+ */
9757
+ manualAccount: ApplicationAccount | null;
9758
+ /**
9759
+ * The average transaction amount.
9760
+ */
9761
+ averageTransaction: string | null;
9762
+ /**
9763
+ * The highest expected transaction amount.
9764
+ */
9765
+ highTransaction: string | null;
9766
+ /**
9767
+ * The average monthly transaction volume.
9768
+ */
9769
+ averageMonth: string | null;
9770
+ /**
9771
+ * The highest expected monthly transaction volume.
9772
+ */
9773
+ highMonth: string | null;
9774
+ /**
9775
+ * The refund policy of the business.
9776
+ */
9777
+ refundPolicy: string | null;
9778
+ /**
9779
+ * The number of days after purchase that refunds can be issued.
9780
+ */
9781
+ refundDays: string | null;
9782
+ /**
9783
+ * The time zone of the business.
9784
+ */
9785
+ timeZone: string | null;
9786
+ /**
9787
+ * The time when the daily batch should close.
9788
+ */
9789
+ batchCloseTime: string | null;
9790
+ /**
9791
+ * Indicates if the business has multiple locations.
9792
+ */
9793
+ multipleLocations: string | null;
9794
+ /**
9795
+ * The name of this specific business location.
9796
+ */
9797
+ locationName: string | null;
9798
+ /**
9799
+ * The store number for this location.
9800
+ */
9801
+ storeNumber: string | null;
9802
+ /**
9803
+ * Indicates if the business wants to accept EBT cards.
9804
+ */
9805
+ ebtRequested: string | null;
9806
+ /**
9807
+ * The FNS number issued by the USDA for EBT processing.
9808
+ */
9809
+ fnsNumber: string | null;
9810
+ /**
9811
+ * Indicates if the business plans to accept payments through a website.
9812
+ */
9813
+ ecommerce: string | null;
9814
+ /**
9815
+ * Indicates if suppliers ship products directly to customers.
9816
+ */
9817
+ dropShipping: boolean | null;
9818
+ /**
9819
+ * The percentage of transactions that will be chip or swipe.
9820
+ */
9821
+ cardPresentPercentage: string | null;
9822
+ /**
9823
+ * The percentage of transactions that will be phone orders.
9824
+ */
9825
+ phoneOrderPercentage: string | null;
9826
+ /**
9827
+ * The percentage of transactions that will be e-commerce.
9828
+ */
9829
+ ecomPercentage: string | null;
9830
+ /**
9831
+ * The number of days before shipment that customers are charged.
9832
+ */
9833
+ billBeforeShipmentDays: string | null;
9834
+ /**
9835
+ * Indicates if the business plans to process recurring payments.
9836
+ */
9837
+ subscriptionsSupported: string | null;
9838
+ /**
9839
+ * The frequency of recurring payments (if applicable).
9840
+ */
9841
+ subscriptionFrequency: string | null;
9842
+ /**
9843
+ * The full legal name of the person signing the application.
9844
+ */
9845
+ signerName: string | null;
9846
+ 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);
9847
+ }
8962
9848
  /**
8963
9849
  * A request for customer signature data.
8964
9850
  */
@@ -9015,6 +9901,14 @@ export declare class TerminalAuthorizationRequest {
9015
9901
  request: AuthorizationRequest;
9016
9902
  constructor(APICredentials: APICredentials, request: AuthorizationRequest);
9017
9903
  }
9904
+ /**
9905
+ * Retrieves card metadata.
9906
+ */
9907
+ export declare class TerminalCardMetadataRequest {
9908
+ APICredentials: APICredentials;
9909
+ request: CardMetadataRequest;
9910
+ constructor(APICredentials: APICredentials, request: CardMetadataRequest);
9911
+ }
9018
9912
  /**
9019
9913
  * A request for the remaining balance on a payment type.
9020
9914
  */