@blockchyp/blockchyp-ts 2.19.0 → 2.21.0

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.
package/lib/src/models.js CHANGED
@@ -1,16 +1,16 @@
1
1
  "use strict";
2
2
  /**
3
- * Copyright 2019-2024 BlockChyp, Inc. All rights reserved. Use of this code is governed
3
+ * Copyright 2019-2025 BlockChyp, Inc. All rights reserved. Use of this code is governed
4
4
  * by a license that can be found in the LICENSE file.
5
5
  *
6
6
  * This file was generated automatically by the BlockChyp SDK Generator. Changes to this
7
7
  * file will be lost every time the code is regenerated.
8
8
  */
9
9
  Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.HeartbeatResponse = exports.TransactionDisplayRequest = exports.TransactionDisplayTransaction = exports.TransactionDisplayItem = exports.TransactionDisplayDiscount = exports.TransactionStatus = exports.PaymentLinkStatusResponse = exports.PaymentLinkStatusRequest = exports.TransactionStatusRequest = exports.AuthorizationResponse = exports.TermsAndConditionsResponse = exports.TermsAndConditionsRequest = exports.CloseBatchResponse = exports.CloseBatchRequest = exports.GiftActivateResponse = exports.GiftActivateRequest = exports.ClearTerminalRequest = exports.EnrollResponse = exports.EnrollRequest = exports.VoidResponse = exports.VoidRequest = exports.CaptureResponse = exports.CaptureRequest = exports.RefundRequest = exports.BalanceResponse = exports.BalanceRequest = exports.AuthorizationRequest = exports.WhiteListedCard = exports.BooleanPromptResponse = exports.TextPromptResponse = exports.CustomerToken = exports.TokenMetadataResponse = exports.TokenMetadataRequest = exports.Customer = exports.CustomerSearchResponse = exports.UpdateCustomerRequest = exports.CustomerSearchRequest = exports.CustomerResponse = exports.CustomerRequest = exports.TextPromptRequest = exports.BooleanPromptRequest = exports.MessageRequest = exports.LocateResponse = exports.LocateRequest = exports.PingResponse = exports.PingRequest = exports.CaptureSignatureResponse = exports.CaptureSignatureRequest = exports.Acknowledgement = exports.ReceiptSuggestions = void 0;
11
- exports.TerminalDeactivationRequest = exports.TerminalProfileResponse = exports.TerminalProfileRequest = exports.MerchantPlatform = exports.UpdateMerchantPlatformResponse = exports.UpdateMerchantPlatformRequest = exports.MerchantPlatformsResponse = exports.MerchantUser = exports.MerchantUsersResponse = exports.GetMerchantsResponse = exports.GetMerchantsRequest = exports.HealthcareGroup = exports.Healthcare = exports.UnlinkTokenRequest = exports.LinkTokenRequest = exports.DeleteTokenResponse = exports.DeleteTokenRequest = exports.DeleteCustomerResponse = exports.DeleteCustomerRequest = exports.DeleteQueuedTransactionResponse = exports.DeleteQueuedTransactionRequest = exports.ListQueuedTransactionsResponse = exports.ListQueuedTransactionsRequest = exports.BankAccount = exports.MerchantProfileResponse = exports.MerchantProfile = exports.Address = exports.InviteMerchantUserRequest = exports.MerchantPlatformRequest = exports.MerchantProfileRequest = exports.AddGatewayMerchantRequest = exports.AddTestMerchantRequest = exports.TerminalVolume = exports.BatchDetailsResponse = exports.BatchDetailsRequest = exports.BatchSummary = exports.BatchHistoryResponse = exports.BatchHistoryRequest = exports.TransactionHistoryResponse = exports.TransactionHistoryRequest = exports.CashDiscountResponse = exports.CashDiscountRequest = exports.ResendPaymentLinkResponse = exports.ResendPaymentLinkRequest = exports.CancelPaymentLinkResponse = exports.CancelPaymentLinkRequest = exports.PaymentLinkResponse = exports.PaymentLinkRequest = exports.TerminalStatusResponse = exports.TerminalStatusRequest = void 0;
12
- exports.BuyRateLineItem = exports.MerchantCredentialGenerationResponse = exports.MerchantCredentialGenerationRequest = exports.PartnerCommissionBreakdownResponse = exports.PartnerCommissionBreakdownRequest = exports.StatementDeposit = exports.InvoicePayment = exports.InvoiceLineItem = exports.MerchantInvoiceDetailResponse = exports.MerchantInvoiceDetailRequest = exports.MerchantInvoiceSummary = exports.MerchantInvoiceListResponse = exports.MerchantInvoiceListRequest = exports.PartnerStatementAdjustment = exports.PartnerStatementDisbursement = exports.PartnerStatementLineItem = exports.PartnerStatementDetailResponse = exports.PartnerStatementDetailRequest = exports.PartnerStatementListResponse = exports.PartnerStatementSummary = exports.PartnerStatementListRequest = exports.PricingPolicyResponse = exports.PricePoint = exports.PricingPolicyRequest = exports.BrandingAssetResponse = exports.BrandingAsset = exports.BrandingAssetRequest = exports.SlideShowRequest = exports.SlideShowResponse = exports.SlideShow = exports.Slide = exports.MediaLibraryResponse = exports.MediaRequest = exports.UploadStatusRequest = exports.UploadStatus = exports.UploadMetadata = exports.MediaMetadata = exports.SurveyResultsRequest = exports.SurveyDataPoint = exports.SurveyQuestionResponse = exports.SurveyQuestionRequest = exports.SurveyQuestion = exports.TermsAndConditionsLogEntry = exports.TermsAndConditionsLogResponse = exports.TermsAndConditionsLogRequest = exports.TermsAndConditionsTemplateResponse = exports.TermsAndConditionsTemplateRequest = exports.TermsAndConditionsTemplate = exports.TerminalProfile = exports.TerminalActivationRequest = void 0;
13
- exports.CoreResponse = exports.PreviousTransaction = exports.Subtotals = exports.RequestAmount = exports.PaymentMethod = exports.PaymentAmounts = exports.CryptocurrencyResponse = exports.PaymentMethodResponse = exports.CoreRequest = exports.TimeoutRequest = exports.ApprovalResponse = exports.SignatureRequest = exports.SignatureResponse = exports.TerminalReference = exports.AbstractAcknowledgement = exports.TerminalDeleteQueuedTransactionRequest = exports.TerminalListQueuedTransactionsRequest = exports.TerminalTerminalStatusRequest = exports.TerminalTransactionDisplayRequest = exports.TerminalTermsAndConditionsResponse = exports.TerminalTermsAndConditionsRequest = exports.TerminalGiftActivateRequest = exports.TerminalClearTerminalRequest = exports.TerminalEnrollRequest = exports.TerminalRefundRequest = exports.TerminalBalanceRequest = exports.TerminalAuthorizationRequest = exports.TerminalTextPromptRequest = exports.TerminalBooleanPromptRequest = exports.TerminalMessageRequest = exports.TerminalLocateRequest = exports.TerminalPingRequest = exports.TerminalCaptureSignatureRequest = exports.AggregateBillingLineItemStats = exports.AggregateBillingLineItem = void 0;
10
+ exports.TransactionDisplayItem = exports.TransactionDisplayDiscount = exports.TransactionStatus = exports.PaymentLinkStatusResponse = exports.PaymentLinkStatusRequest = exports.TransactionStatusRequest = exports.AuthorizationResponse = exports.TermsAndConditionsResponse = exports.TermsAndConditionsRequest = exports.CloseBatchResponse = exports.CloseBatchRequest = exports.GiftActivateResponse = exports.GiftActivateRequest = exports.ClearTerminalRequest = exports.EnrollResponse = exports.EnrollRequest = exports.VoidResponse = exports.VoidRequest = exports.CaptureResponse = exports.CaptureRequest = exports.RefundRequest = exports.BalanceResponse = exports.BalanceRequest = exports.CardMetadataResponse = exports.CardMetadataRequest = exports.CardMetadata = exports.AuthorizationRequest = exports.WhiteListedCard = exports.BooleanPromptResponse = exports.TextPromptResponse = exports.CustomerToken = exports.TokenMetadataResponse = exports.TokenMetadataRequest = exports.Customer = exports.CustomerSearchResponse = exports.UpdateCustomerRequest = exports.CustomerSearchRequest = exports.CustomerResponse = exports.CustomerRequest = exports.TextPromptRequest = exports.BooleanPromptRequest = exports.MessageRequest = exports.LocateResponse = exports.LocateRequest = exports.PingResponse = exports.PingRequest = exports.CaptureSignatureResponse = exports.CaptureSignatureRequest = exports.Acknowledgement = exports.ReceiptSuggestions = void 0;
11
+ exports.MerchantPlatform = exports.UpdateMerchantPlatformResponse = exports.UpdateMerchantPlatformRequest = exports.MerchantPlatformsResponse = exports.MerchantUser = exports.MerchantUsersResponse = exports.GetMerchantsResponse = exports.GetMerchantsRequest = exports.HealthcareGroup = exports.HealthcareMetadata = exports.UnlinkTokenRequest = exports.LinkTokenRequest = exports.DeleteTokenResponse = exports.DeleteTokenRequest = exports.DeleteCustomerResponse = exports.DeleteCustomerRequest = exports.DeleteQueuedTransactionResponse = exports.DeleteQueuedTransactionRequest = exports.ListQueuedTransactionsResponse = exports.ListQueuedTransactionsRequest = exports.BankAccount = exports.MerchantProfileResponse = exports.MerchantProfile = exports.Address = exports.InviteMerchantUserRequest = exports.MerchantPlatformRequest = exports.MerchantProfileRequest = exports.AddGatewayMerchantRequest = exports.AddTestMerchantRequest = exports.TerminalVolume = exports.BatchDetailsResponse = exports.BatchDetailsRequest = exports.BatchSummary = exports.BatchHistoryResponse = exports.BatchHistoryRequest = exports.TransactionHistoryResponse = exports.TransactionHistoryRequest = exports.CashDiscountResponse = exports.CashDiscountRequest = exports.ResendPaymentLinkResponse = exports.ResendPaymentLinkRequest = exports.CancelPaymentLinkResponse = exports.CancelPaymentLinkRequest = exports.PaymentLinkResponse = exports.PaymentLinkRequest = exports.TerminalStatusResponse = exports.TerminalStatusRequest = exports.HeartbeatResponse = exports.TransactionDisplayRequest = exports.TransactionDisplayTransaction = void 0;
12
+ exports.PartnerCommissionBreakdownResponse = exports.PartnerCommissionBreakdownRequest = exports.StatementDeposit = exports.InvoicePayment = exports.InvoiceLineItem = exports.MerchantInvoiceDetailResponse = exports.MerchantInvoiceDetailRequest = exports.MerchantInvoiceSummary = exports.MerchantInvoiceListResponse = exports.MerchantInvoiceListRequest = exports.PartnerStatementAdjustment = exports.PartnerStatementDisbursement = exports.PartnerStatementLineItem = exports.PartnerStatementDetailResponse = exports.PartnerStatementDetailRequest = exports.PartnerStatementListResponse = exports.PartnerStatementSummary = exports.PartnerStatementListRequest = exports.PricingPolicyResponse = exports.PricePoint = exports.PricingPolicyRequest = exports.BrandingAssetResponse = exports.BrandingAsset = exports.BrandingAssetRequest = exports.SlideShowRequest = exports.SlideShowResponse = exports.SlideShow = exports.Slide = exports.MediaLibraryResponse = exports.MediaRequest = exports.UploadStatusRequest = exports.UploadStatus = exports.UploadMetadata = exports.MediaMetadata = exports.SurveyResultsRequest = exports.SurveyDataPoint = exports.SurveyQuestionResponse = exports.SurveyQuestionRequest = exports.SurveyQuestion = exports.TermsAndConditionsLogEntry = exports.TermsAndConditionsLogResponse = exports.TermsAndConditionsLogRequest = exports.TermsAndConditionsTemplateResponse = exports.TermsAndConditionsTemplateRequest = exports.TermsAndConditionsTemplate = exports.TerminalProfile = exports.TerminalActivationRequest = exports.TerminalDeactivationRequest = exports.TerminalProfileResponse = exports.TerminalProfileRequest = void 0;
13
+ exports.CoreResponse = exports.PreviousTransaction = exports.Subtotals = exports.RequestAmount = exports.PaymentMethod = exports.PaymentAmounts = exports.CryptocurrencyResponse = exports.PaymentMethodResponse = exports.CoreRequest = exports.TimeoutRequest = exports.ApprovalResponse = exports.SignatureRequest = exports.SignatureResponse = exports.TerminalReference = exports.AbstractAcknowledgement = exports.TerminalDeleteQueuedTransactionRequest = exports.TerminalListQueuedTransactionsRequest = exports.TerminalTerminalStatusRequest = exports.TerminalTransactionDisplayRequest = exports.TerminalTermsAndConditionsResponse = exports.TerminalTermsAndConditionsRequest = exports.TerminalGiftActivateRequest = exports.TerminalClearTerminalRequest = exports.TerminalEnrollRequest = exports.TerminalRefundRequest = exports.TerminalBalanceRequest = exports.TerminalCardMetadataRequest = exports.TerminalAuthorizationRequest = exports.TerminalTextPromptRequest = exports.TerminalBooleanPromptRequest = exports.TerminalMessageRequest = exports.TerminalLocateRequest = exports.TerminalPingRequest = exports.TerminalCaptureSignatureRequest = exports.SubmitApplicationRequest = exports.MerchantApplication = exports.ApplicationAccount = exports.Owner = exports.AggregateBillingLineItemStats = exports.AggregateBillingLineItem = exports.BuyRateLineItem = exports.MerchantCredentialGenerationResponse = exports.MerchantCredentialGenerationRequest = void 0;
14
14
  // CardType is used to differentiate credit, debit, and EBT.
15
15
  var CardType;
16
16
  (function (CardType) {
@@ -875,7 +875,7 @@ exports.TokenMetadataRequest = TokenMetadataRequest;
875
875
  */
876
876
  class TokenMetadataResponse {
877
877
  // Constructor with default values for optional fields
878
- constructor(success = null, error = null, responseDescription = null, token = null) {
878
+ constructor(success = null, error = null, responseDescription = null, token = null, cardMetadata = undefined) {
879
879
  /**
880
880
  * Whether or not the request succeeded.
881
881
  */
@@ -896,6 +896,7 @@ class TokenMetadataResponse {
896
896
  this.error = error;
897
897
  this.responseDescription = responseDescription;
898
898
  this.token = token;
899
+ this.cardMetadata = cardMetadata;
899
900
  }
900
901
  }
901
902
  exports.TokenMetadataResponse = TokenMetadataResponse;
@@ -1030,7 +1031,7 @@ exports.WhiteListedCard = WhiteListedCard;
1030
1031
  */
1031
1032
  class AuthorizationRequest {
1032
1033
  // Constructor with default values for optional fields
1033
- constructor(timeout = null, test = null, transactionRef = undefined, autogeneratedRef = null, async = null, queue = null, waitForRemovedCard = false, force = false, orderRef = undefined, destinationAccount = undefined, testCase = undefined, token = undefined, track1 = undefined, track2 = undefined, pan = undefined, routingNumber = undefined, cardholderName = undefined, expMonth = undefined, expYear = undefined, cvv = undefined, address = undefined, postalCode = undefined, manualEntry = false, ksn = undefined, pinBlock = undefined, cardType = undefined, paymentType = undefined, currencyCode = null, amount = null, taxExempt = null, surcharge = null, cashDiscount = null, sigFile = undefined, sigFormat = undefined, sigWidth = 0, disableSignature = false, tipAmount = undefined, taxAmount = undefined, terminalName = undefined, resetConnection = null, transactionId = undefined, onlineAuthCode = undefined, enroll = false, bypassDupeFilter = false, description = undefined, promptForTip = false, cashBackEnabled = false, cardOnFile = false, recurring = false, cit = false, mit = false, subscription = false, purchaseOrderNumber = undefined, supplierReferenceNumber = undefined, lineItems = null, altPrices = undefined, customer = undefined, roundingMode = undefined, healthcare = undefined, cryptocurrency = undefined, cryptoNetwork = undefined, cryptoReceiveAddress = undefined, paymentRequestLabel = undefined, paymentRequestMessage = undefined, simulateChipRejection = false, simulateOutOfOrderReversal = false, asyncReversals = false, passthroughSurcharge = undefined) {
1034
+ constructor(timeout = null, test = null, transactionRef = undefined, autogeneratedRef = null, async = null, queue = null, waitForRemovedCard = false, force = false, orderRef = undefined, destinationAccount = undefined, testCase = undefined, token = undefined, track1 = undefined, track2 = undefined, pan = undefined, routingNumber = undefined, cardholderName = undefined, expMonth = undefined, expYear = undefined, cvv = undefined, address = undefined, postalCode = undefined, manualEntry = false, ksn = undefined, pinBlock = undefined, cardType = undefined, paymentType = undefined, currencyCode = null, amount = null, taxExempt = null, surcharge = null, cashDiscount = null, sigFile = undefined, sigFormat = undefined, sigWidth = 0, disableSignature = false, tipAmount = undefined, taxAmount = undefined, terminalName = undefined, resetConnection = null, transactionId = undefined, onlineAuthCode = undefined, enroll = false, bypassDupeFilter = false, description = undefined, promptForTip = false, cashBackEnabled = false, cardOnFile = false, recurring = false, cit = false, mit = false, subscription = false, purchaseOrderNumber = undefined, supplierReferenceNumber = undefined, lineItems = null, altPrices = undefined, customer = undefined, roundingMode = undefined, healthcareMetadata = undefined, cryptocurrency = undefined, cryptoNetwork = undefined, cryptoReceiveAddress = undefined, paymentRequestLabel = undefined, paymentRequestMessage = undefined, simulateChipRejection = false, simulateOutOfOrderReversal = false, asyncReversals = false, passthroughSurcharge = undefined, healthcare = false, healthcareTotal = undefined, ebtTotal = undefined, cardMetadataLookup = false) {
1034
1035
  /**
1035
1036
  * The request timeout in seconds.
1036
1037
  */
@@ -1142,7 +1143,7 @@ class AuthorizationRequest {
1142
1143
  this.altPrices = altPrices;
1143
1144
  this.customer = customer;
1144
1145
  this.roundingMode = roundingMode;
1145
- this.healthcare = healthcare;
1146
+ this.healthcareMetadata = healthcareMetadata;
1146
1147
  this.cryptocurrency = cryptocurrency;
1147
1148
  this.cryptoNetwork = cryptoNetwork;
1148
1149
  this.cryptoReceiveAddress = cryptoReceiveAddress;
@@ -1152,9 +1153,201 @@ class AuthorizationRequest {
1152
1153
  this.simulateOutOfOrderReversal = simulateOutOfOrderReversal;
1153
1154
  this.asyncReversals = asyncReversals;
1154
1155
  this.passthroughSurcharge = passthroughSurcharge;
1156
+ this.healthcare = healthcare;
1157
+ this.healthcareTotal = healthcareTotal;
1158
+ this.ebtTotal = ebtTotal;
1159
+ this.cardMetadataLookup = cardMetadataLookup;
1155
1160
  }
1156
1161
  }
1157
1162
  exports.AuthorizationRequest = AuthorizationRequest;
1163
+ /**
1164
+ * Essential information about a payment card derived from its BIN/IIN.
1165
+ */
1166
+ class CardMetadata {
1167
+ // Constructor with default values for optional fields
1168
+ constructor(cardBrand = null, issuerName = null, l3 = null, l2 = null, productType = null, productName = null, ebt = null, debit = null, healthcare = null, prepaid = null, region = null, country = null) {
1169
+ /**
1170
+ * The brand or network of the card (e.g., Visa, Mastercard, Amex).
1171
+ */
1172
+ this.cardBrand = null;
1173
+ /**
1174
+ * The name of the financial institution that issued the card.
1175
+ */
1176
+ this.issuerName = null;
1177
+ /**
1178
+ * Whether the card supports Level 3 processing for detailed transaction data.
1179
+ */
1180
+ this.l3 = null;
1181
+ /**
1182
+ * Whether the card supports Level 2 processing for additional transaction data.
1183
+ */
1184
+ this.l2 = null;
1185
+ /**
1186
+ * The general category or type of the card product.
1187
+ */
1188
+ this.productType = null;
1189
+ /**
1190
+ * The specific name or designation of the card product.
1191
+ */
1192
+ this.productName = null;
1193
+ /**
1194
+ * Whether the card is an Electronic Benefit Transfer (EBT) card.
1195
+ */
1196
+ this.ebt = null;
1197
+ /**
1198
+ * Whether the card is a debit card.
1199
+ */
1200
+ this.debit = null;
1201
+ /**
1202
+ * Whether the card is a healthcare-specific payment card.
1203
+ */
1204
+ this.healthcare = null;
1205
+ /**
1206
+ * Whether the card is a prepaid card.
1207
+ */
1208
+ this.prepaid = null;
1209
+ /**
1210
+ * The geographical region associated with the card's issuer.
1211
+ */
1212
+ this.region = null;
1213
+ /**
1214
+ * The country associated with the card's issuer.
1215
+ */
1216
+ this.country = null;
1217
+ this.cardBrand = cardBrand;
1218
+ this.issuerName = issuerName;
1219
+ this.l3 = l3;
1220
+ this.l2 = l2;
1221
+ this.productType = productType;
1222
+ this.productName = productName;
1223
+ this.ebt = ebt;
1224
+ this.debit = debit;
1225
+ this.healthcare = healthcare;
1226
+ this.prepaid = prepaid;
1227
+ this.region = region;
1228
+ this.country = country;
1229
+ }
1230
+ }
1231
+ exports.CardMetadata = CardMetadata;
1232
+ /**
1233
+ * Retrieves card metadata.
1234
+ */
1235
+ class CardMetadataRequest {
1236
+ // Constructor with default values for optional fields
1237
+ constructor(timeout = null, test = null, transactionRef = undefined, autogeneratedRef = null, async = null, queue = null, waitForRemovedCard = false, force = false, orderRef = undefined, destinationAccount = undefined, testCase = undefined, token = undefined, track1 = undefined, track2 = undefined, pan = undefined, routingNumber = undefined, cardholderName = undefined, expMonth = undefined, expYear = undefined, cvv = undefined, address = undefined, postalCode = undefined, manualEntry = false, ksn = undefined, pinBlock = undefined, cardType = undefined, paymentType = undefined, terminalName = undefined, resetConnection = null, healthcare = false) {
1238
+ /**
1239
+ * The request timeout in seconds.
1240
+ */
1241
+ this.timeout = null;
1242
+ /**
1243
+ * Whether or not to route transaction to the test gateway.
1244
+ */
1245
+ this.test = null;
1246
+ /**
1247
+ * That the transaction reference was autogenerated and should be ignored for the
1248
+ * purposes of duplicate detection.
1249
+ */
1250
+ this.autogeneratedRef = null;
1251
+ /**
1252
+ * Defers the response to the transaction and returns immediately. Callers should
1253
+ * retrive the transaction result using the Transaction Status API.
1254
+ */
1255
+ this.async = null;
1256
+ /**
1257
+ * Adds the transaction to the queue and returns immediately. Callers should retrive
1258
+ * the transaction result using the Transaction Status API.
1259
+ */
1260
+ this.queue = null;
1261
+ /**
1262
+ * Forces the terminal cloud connection to be reset while a transactions is in flight.
1263
+ * This is a diagnostic settings that can be used only for test transactions.
1264
+ */
1265
+ this.resetConnection = null;
1266
+ this.timeout = timeout;
1267
+ this.test = test;
1268
+ this.transactionRef = transactionRef;
1269
+ this.autogeneratedRef = autogeneratedRef;
1270
+ this.async = async;
1271
+ this.queue = queue;
1272
+ this.waitForRemovedCard = waitForRemovedCard;
1273
+ this.force = force;
1274
+ this.orderRef = orderRef;
1275
+ this.destinationAccount = destinationAccount;
1276
+ this.testCase = testCase;
1277
+ this.token = token;
1278
+ this.track1 = track1;
1279
+ this.track2 = track2;
1280
+ this.pan = pan;
1281
+ this.routingNumber = routingNumber;
1282
+ this.cardholderName = cardholderName;
1283
+ this.expMonth = expMonth;
1284
+ this.expYear = expYear;
1285
+ this.cvv = cvv;
1286
+ this.address = address;
1287
+ this.postalCode = postalCode;
1288
+ this.manualEntry = manualEntry;
1289
+ this.ksn = ksn;
1290
+ this.pinBlock = pinBlock;
1291
+ this.cardType = cardType;
1292
+ this.paymentType = paymentType;
1293
+ this.terminalName = terminalName;
1294
+ this.resetConnection = resetConnection;
1295
+ this.healthcare = healthcare;
1296
+ }
1297
+ }
1298
+ exports.CardMetadataRequest = CardMetadataRequest;
1299
+ /**
1300
+ * The response to a card metadata request.
1301
+ */
1302
+ class CardMetadataResponse {
1303
+ // Constructor with default values for optional fields
1304
+ constructor(success = null, error = null, responseDescription = null, token = undefined, entryMethod = undefined, paymentType = undefined, network = undefined, logo = undefined, maskedPan = undefined, publicKey = undefined, ScopeAlert = false, cardHolder = undefined, expMonth = undefined, expYear = undefined, avsResponse = null, receiptSuggestions = null, customer = undefined, customers = null, cardMetadata = undefined) {
1305
+ /**
1306
+ * Whether or not the request succeeded.
1307
+ */
1308
+ this.success = null;
1309
+ /**
1310
+ * The error, if an error occurred.
1311
+ */
1312
+ this.error = null;
1313
+ /**
1314
+ * A narrative description of the transaction result.
1315
+ */
1316
+ this.responseDescription = null;
1317
+ /**
1318
+ * Address verification results if address information was submitted.
1319
+ */
1320
+ this.avsResponse = null;
1321
+ /**
1322
+ * Suggested receipt fields.
1323
+ */
1324
+ this.receiptSuggestions = null;
1325
+ /**
1326
+ * Customer data, if any.
1327
+ */
1328
+ this.customers = null;
1329
+ this.success = success;
1330
+ this.error = error;
1331
+ this.responseDescription = responseDescription;
1332
+ this.token = token;
1333
+ this.entryMethod = entryMethod;
1334
+ this.paymentType = paymentType;
1335
+ this.network = network;
1336
+ this.logo = logo;
1337
+ this.maskedPan = maskedPan;
1338
+ this.publicKey = publicKey;
1339
+ this.ScopeAlert = ScopeAlert;
1340
+ this.cardHolder = cardHolder;
1341
+ this.expMonth = expMonth;
1342
+ this.expYear = expYear;
1343
+ this.avsResponse = avsResponse;
1344
+ this.receiptSuggestions = receiptSuggestions;
1345
+ this.customer = customer;
1346
+ this.customers = customers;
1347
+ this.cardMetadata = cardMetadata;
1348
+ }
1349
+ }
1350
+ exports.CardMetadataResponse = CardMetadataResponse;
1158
1351
  /**
1159
1352
  * A request for the remaining balance on a payment type.
1160
1353
  */
@@ -1307,7 +1500,7 @@ exports.BalanceResponse = BalanceResponse;
1307
1500
  */
1308
1501
  class RefundRequest {
1309
1502
  // Constructor with default values for optional fields
1310
- constructor(timeout = null, test = null, transactionRef = undefined, autogeneratedRef = null, async = null, queue = null, waitForRemovedCard = false, force = false, orderRef = undefined, destinationAccount = undefined, testCase = undefined, token = undefined, track1 = undefined, track2 = undefined, pan = undefined, routingNumber = undefined, cardholderName = undefined, expMonth = undefined, expYear = undefined, cvv = undefined, address = undefined, postalCode = undefined, manualEntry = false, ksn = undefined, pinBlock = undefined, cardType = undefined, paymentType = undefined, transactionId = null, currencyCode = null, amount = null, taxExempt = null, surcharge = null, cashDiscount = null, sigFile = undefined, sigFormat = undefined, sigWidth = 0, disableSignature = false, tipAmount = undefined, taxAmount = undefined, terminalName = undefined, resetConnection = null, healthcare = undefined, simulateChipRejection = false, simulateOutOfOrderReversal = false, asyncReversals = false, cit = false, mit = false) {
1503
+ constructor(timeout = null, test = null, transactionRef = undefined, autogeneratedRef = null, async = null, queue = null, waitForRemovedCard = false, force = false, orderRef = undefined, destinationAccount = undefined, testCase = undefined, token = undefined, track1 = undefined, track2 = undefined, pan = undefined, routingNumber = undefined, cardholderName = undefined, expMonth = undefined, expYear = undefined, cvv = undefined, address = undefined, postalCode = undefined, manualEntry = false, ksn = undefined, pinBlock = undefined, cardType = undefined, paymentType = undefined, transactionId = null, currencyCode = null, amount = null, taxExempt = null, surcharge = null, cashDiscount = null, sigFile = undefined, sigFormat = undefined, sigWidth = 0, disableSignature = false, tipAmount = undefined, taxAmount = undefined, terminalName = undefined, resetConnection = null, healthcareMetadata = undefined, simulateChipRejection = false, simulateOutOfOrderReversal = false, asyncReversals = false, cit = false, mit = false, cardMetadataLookup = false) {
1311
1504
  /**
1312
1505
  * The request timeout in seconds.
1313
1506
  */
@@ -1402,12 +1595,13 @@ class RefundRequest {
1402
1595
  this.taxAmount = taxAmount;
1403
1596
  this.terminalName = terminalName;
1404
1597
  this.resetConnection = resetConnection;
1405
- this.healthcare = healthcare;
1598
+ this.healthcareMetadata = healthcareMetadata;
1406
1599
  this.simulateChipRejection = simulateChipRejection;
1407
1600
  this.simulateOutOfOrderReversal = simulateOutOfOrderReversal;
1408
1601
  this.asyncReversals = asyncReversals;
1409
1602
  this.cit = cit;
1410
1603
  this.mit = mit;
1604
+ this.cardMetadataLookup = cardMetadataLookup;
1411
1605
  }
1412
1606
  }
1413
1607
  exports.RefundRequest = RefundRequest;
@@ -1782,7 +1976,7 @@ exports.VoidResponse = VoidResponse;
1782
1976
  */
1783
1977
  class EnrollRequest {
1784
1978
  // Constructor with default values for optional fields
1785
- constructor(timeout = null, test = null, transactionRef = undefined, autogeneratedRef = null, async = null, queue = null, waitForRemovedCard = false, force = false, orderRef = undefined, destinationAccount = undefined, testCase = undefined, token = undefined, track1 = undefined, track2 = undefined, pan = undefined, routingNumber = undefined, cardholderName = undefined, expMonth = undefined, expYear = undefined, cvv = undefined, address = undefined, postalCode = undefined, manualEntry = false, ksn = undefined, pinBlock = undefined, cardType = undefined, paymentType = undefined, terminalName = undefined, resetConnection = null, entryMethod = undefined, customer = undefined, recurring = false, subscription = false) {
1979
+ constructor(timeout = null, test = null, transactionRef = undefined, autogeneratedRef = null, async = null, queue = null, waitForRemovedCard = false, force = false, orderRef = undefined, destinationAccount = undefined, testCase = undefined, token = undefined, track1 = undefined, track2 = undefined, pan = undefined, routingNumber = undefined, cardholderName = undefined, expMonth = undefined, expYear = undefined, cvv = undefined, address = undefined, postalCode = undefined, manualEntry = false, ksn = undefined, pinBlock = undefined, cardType = undefined, paymentType = undefined, terminalName = undefined, resetConnection = null, entryMethod = undefined, customer = undefined, recurring = false, subscription = false, cardMetadataLookup = false) {
1786
1980
  /**
1787
1981
  * The request timeout in seconds.
1788
1982
  */
@@ -1844,6 +2038,7 @@ class EnrollRequest {
1844
2038
  this.customer = customer;
1845
2039
  this.recurring = recurring;
1846
2040
  this.subscription = subscription;
2041
+ this.cardMetadataLookup = cardMetadataLookup;
1847
2042
  }
1848
2043
  }
1849
2044
  exports.EnrollRequest = EnrollRequest;
@@ -1852,7 +2047,7 @@ exports.EnrollRequest = EnrollRequest;
1852
2047
  */
1853
2048
  class EnrollResponse {
1854
2049
  // Constructor with default values for optional fields
1855
- constructor(success = null, error = null, responseDescription = null, approved = null, authCode = undefined, authResponseCode = undefined, transactionId = null, batchId = undefined, transactionRef = undefined, transactionType = null, timestamp = null, tickBlock = null, test = null, destinationAccount = undefined, sig = undefined, token = undefined, entryMethod = undefined, paymentType = undefined, network = undefined, logo = undefined, maskedPan = undefined, publicKey = undefined, ScopeAlert = false, cardHolder = undefined, expMonth = undefined, expYear = undefined, avsResponse = null, receiptSuggestions = null, customer = undefined, customers = null, sigFile = undefined) {
2050
+ constructor(success = null, error = null, responseDescription = null, approved = null, authCode = undefined, authResponseCode = undefined, transactionId = null, batchId = undefined, transactionRef = undefined, transactionType = null, timestamp = null, tickBlock = null, test = null, destinationAccount = undefined, sig = undefined, token = undefined, entryMethod = undefined, paymentType = undefined, network = undefined, logo = undefined, maskedPan = undefined, publicKey = undefined, ScopeAlert = false, cardHolder = undefined, expMonth = undefined, expYear = undefined, avsResponse = null, receiptSuggestions = null, customer = undefined, customers = null, sigFile = undefined, cardMetadata = undefined) {
1856
2051
  /**
1857
2052
  * Whether or not the request succeeded.
1858
2053
  */
@@ -1932,6 +2127,7 @@ class EnrollResponse {
1932
2127
  this.customer = customer;
1933
2128
  this.customers = customers;
1934
2129
  this.sigFile = sigFile;
2130
+ this.cardMetadata = cardMetadata;
1935
2131
  }
1936
2132
  }
1937
2133
  exports.EnrollResponse = EnrollResponse;
@@ -2389,7 +2585,7 @@ exports.TermsAndConditionsResponse = TermsAndConditionsResponse;
2389
2585
  */
2390
2586
  class AuthorizationResponse {
2391
2587
  // Constructor with default values for optional fields
2392
- constructor(success = null, error = null, responseDescription = null, approved = null, authCode = undefined, authResponseCode = undefined, transactionId = null, batchId = undefined, transactionRef = undefined, transactionType = null, timestamp = null, tickBlock = null, test = null, destinationAccount = undefined, sig = undefined, partialAuth = null, altCurrency = null, fsaAuth = null, currencyCode = null, requestedAmount = null, authorizedAmount = null, remainingBalance = null, tipAmount = null, taxAmount = null, requestedCashBackAmount = null, authorizedCashBackAmount = null, confirmed = null, cryptoAuthorizedAmount = null, cryptoNetworkFee = null, cryptocurrency = null, cryptoNetwork = null, cryptoReceiveAddress = null, cryptoBlock = null, cryptoTransactionId = null, cryptoPaymentRequest = null, cryptoStatus = null, token = undefined, entryMethod = undefined, paymentType = undefined, network = undefined, logo = undefined, maskedPan = undefined, publicKey = undefined, ScopeAlert = false, cardHolder = undefined, expMonth = undefined, expYear = undefined, avsResponse = null, receiptSuggestions = null, customer = undefined, customers = null, sigFile = undefined, whiteListedCard = undefined, storeAndForward = null, status = null) {
2588
+ constructor(success = null, error = null, responseDescription = null, approved = null, authCode = undefined, authResponseCode = undefined, transactionId = null, batchId = undefined, transactionRef = undefined, transactionType = null, timestamp = null, tickBlock = null, test = null, destinationAccount = undefined, sig = undefined, partialAuth = null, altCurrency = null, fsaAuth = null, currencyCode = null, requestedAmount = null, authorizedAmount = null, remainingBalance = null, tipAmount = null, taxAmount = null, requestedCashBackAmount = null, authorizedCashBackAmount = null, confirmed = null, cryptoAuthorizedAmount = null, cryptoNetworkFee = null, cryptocurrency = null, cryptoNetwork = null, cryptoReceiveAddress = null, cryptoBlock = null, cryptoTransactionId = null, cryptoPaymentRequest = null, cryptoStatus = null, token = undefined, entryMethod = undefined, paymentType = undefined, network = undefined, logo = undefined, maskedPan = undefined, publicKey = undefined, ScopeAlert = false, cardHolder = undefined, expMonth = undefined, expYear = undefined, avsResponse = null, receiptSuggestions = null, customer = undefined, customers = null, sigFile = undefined, whiteListedCard = undefined, storeAndForward = null, status = null, cardMetadata = undefined) {
2393
2589
  /**
2394
2590
  * Whether or not the request succeeded.
2395
2591
  */
@@ -2591,6 +2787,7 @@ class AuthorizationResponse {
2591
2787
  this.whiteListedCard = whiteListedCard;
2592
2788
  this.storeAndForward = storeAndForward;
2593
2789
  this.status = status;
2790
+ this.cardMetadata = cardMetadata;
2594
2791
  }
2595
2792
  }
2596
2793
  exports.AuthorizationResponse = AuthorizationResponse;
@@ -4397,7 +4594,7 @@ exports.Address = Address;
4397
4594
  */
4398
4595
  class MerchantProfile {
4399
4596
  // Constructor with default values for optional fields
4400
- constructor(timeout = null, test = null, merchantId = null, bankMid = null, companyName = null, dbaName = null, invoiceName = null, contactName = null, contactNumber = null, locationName = null, storeNumber = null, partnerRef = null, timeZone = null, batchCloseTime = null, terminalUpdateTime = null, autoBatchClose = null, disableBatchEmails = null, pinEnabled = null, cashBackEnabled = null, storeAndForwardEnabled = null, partialAuthEnabled = null, splitBankAccountsEnabled = null, storeAndForwardFloorLimit = null, publicKey = null, status = null, cashDiscountEnabled = null, surveyTimeout = null, cooldownTimeout = null, tipEnabled = null, promptForTip = null, tipDefaults = null, cashbackPresets = null, ebtEnabled = null, freeRangeRefundsEnabled = null, pinBypassEnabled = null, giftCardsDisabled = null, tcDisabled = null, digitalSignaturesEnabled = null, digitalSignatureReversal = null, billingAddress = null, shippingAddress = null, visa = null, masterCard = null, amex = null, discover = null, jcb = null, unionPay = null, contactlessEmv = null, manualEntryEnabled = null, manualEntryPromptZip = null, manualEntryPromptStreetNumber = null, gatewayOnly = null, bankAccounts = null) {
4597
+ constructor(timeout = null, test = null, merchantId = null, bankMid = null, companyName = null, dbaName = null, invoiceName = null, contactName = null, contactNumber = null, locationName = null, storeNumber = null, partnerRef = null, timeZone = null, batchCloseTime = null, terminalUpdateTime = null, autoBatchClose = null, disableBatchEmails = null, pinEnabled = null, cashBackEnabled = null, storeAndForwardEnabled = null, partialAuthEnabled = null, splitBankAccountsEnabled = null, storeAndForwardFloorLimit = null, publicKey = null, status = null, cashDiscountEnabled = null, surveyTimeout = null, cooldownTimeout = null, tipEnabled = null, promptForTip = null, tipDefaults = null, cashbackPresets = null, ebtEnabled = null, freeRangeRefundsEnabled = null, pinBypassEnabled = null, giftCardsDisabled = null, tcDisabled = null, digitalSignaturesEnabled = null, digitalSignatureReversal = null, billingAddress = null, shippingAddress = null, visa = null, masterCard = null, amex = null, discover = null, jcb = null, unionPay = null, contactlessEmv = null, manualEntryEnabled = null, manualEntryPromptZip = null, manualEntryPromptStreetNumber = null, gatewayOnly = null, bankAccounts = null, passthroughSurchargeEnabled = null) {
4401
4598
  /**
4402
4599
  * The request timeout in seconds.
4403
4600
  */
@@ -4614,6 +4811,10 @@ class MerchantProfile {
4614
4811
  * Bank accounts for split bank account merchants.
4615
4812
  */
4616
4813
  this.bankAccounts = null;
4814
+ /**
4815
+ * That a merchant is allowed to send a surcharge amount directly to the gateway.
4816
+ */
4817
+ this.passthroughSurchargeEnabled = null;
4617
4818
  this.timeout = timeout;
4618
4819
  this.test = test;
4619
4820
  this.merchantId = merchantId;
@@ -4667,6 +4868,7 @@ class MerchantProfile {
4667
4868
  this.manualEntryPromptStreetNumber = manualEntryPromptStreetNumber;
4668
4869
  this.gatewayOnly = gatewayOnly;
4669
4870
  this.bankAccounts = bankAccounts;
4871
+ this.passthroughSurchargeEnabled = passthroughSurchargeEnabled;
4670
4872
  }
4671
4873
  }
4672
4874
  exports.MerchantProfile = MerchantProfile;
@@ -4675,7 +4877,7 @@ exports.MerchantProfile = MerchantProfile;
4675
4877
  */
4676
4878
  class MerchantProfileResponse {
4677
4879
  // Constructor with default values for optional fields
4678
- constructor(success = null, error = null, responseDescription = null, test = null, merchantId = null, bankMid = null, companyName = null, dbaName = null, invoiceName = null, contactName = null, contactNumber = null, locationName = null, storeNumber = null, partnerRef = null, timeZone = null, batchCloseTime = null, terminalUpdateTime = null, autoBatchClose = null, disableBatchEmails = null, pinEnabled = null, cashBackEnabled = null, storeAndForwardEnabled = null, partialAuthEnabled = null, splitBankAccountsEnabled = null, storeAndForwardFloorLimit = null, publicKey = null, status = null, cashDiscountEnabled = null, surveyTimeout = null, cooldownTimeout = null, tipEnabled = null, promptForTip = null, tipDefaults = null, cashbackPresets = null, ebtEnabled = null, freeRangeRefundsEnabled = null, pinBypassEnabled = null, giftCardsDisabled = null, tcDisabled = null, digitalSignaturesEnabled = null, digitalSignatureReversal = null, billingAddress = null, shippingAddress = null, visa = null, masterCard = null, amex = null, discover = null, jcb = null, unionPay = null, contactlessEmv = null, manualEntryEnabled = null, manualEntryPromptZip = null, manualEntryPromptStreetNumber = null, gatewayOnly = null, bankAccounts = null) {
4880
+ constructor(success = null, error = null, responseDescription = null, test = null, merchantId = null, bankMid = null, companyName = null, dbaName = null, invoiceName = null, contactName = null, contactNumber = null, locationName = null, storeNumber = null, partnerRef = null, timeZone = null, batchCloseTime = null, terminalUpdateTime = null, autoBatchClose = null, disableBatchEmails = null, pinEnabled = null, cashBackEnabled = null, storeAndForwardEnabled = null, partialAuthEnabled = null, splitBankAccountsEnabled = null, storeAndForwardFloorLimit = null, publicKey = null, status = null, cashDiscountEnabled = null, surveyTimeout = null, cooldownTimeout = null, tipEnabled = null, promptForTip = null, tipDefaults = null, cashbackPresets = null, ebtEnabled = null, freeRangeRefundsEnabled = null, pinBypassEnabled = null, giftCardsDisabled = null, tcDisabled = null, digitalSignaturesEnabled = null, digitalSignatureReversal = null, billingAddress = null, shippingAddress = null, visa = null, masterCard = null, amex = null, discover = null, jcb = null, unionPay = null, contactlessEmv = null, manualEntryEnabled = null, manualEntryPromptZip = null, manualEntryPromptStreetNumber = null, gatewayOnly = null, bankAccounts = null, passthroughSurchargeEnabled = null) {
4679
4881
  /**
4680
4882
  * Whether or not the request succeeded.
4681
4883
  */
@@ -4900,6 +5102,10 @@ class MerchantProfileResponse {
4900
5102
  * Bank accounts for split bank account merchants.
4901
5103
  */
4902
5104
  this.bankAccounts = null;
5105
+ /**
5106
+ * That a merchant is allowed to send a surcharge amount directly to the gateway.
5107
+ */
5108
+ this.passthroughSurchargeEnabled = null;
4903
5109
  this.success = success;
4904
5110
  this.error = error;
4905
5111
  this.responseDescription = responseDescription;
@@ -4955,6 +5161,7 @@ class MerchantProfileResponse {
4955
5161
  this.manualEntryPromptStreetNumber = manualEntryPromptStreetNumber;
4956
5162
  this.gatewayOnly = gatewayOnly;
4957
5163
  this.bankAccounts = bankAccounts;
5164
+ this.passthroughSurchargeEnabled = passthroughSurchargeEnabled;
4958
5165
  }
4959
5166
  }
4960
5167
  exports.MerchantProfileResponse = MerchantProfileResponse;
@@ -5398,7 +5605,7 @@ exports.UnlinkTokenRequest = UnlinkTokenRequest;
5398
5605
  /**
5399
5606
  * Fields for HSA/FSA transactions.
5400
5607
  */
5401
- class Healthcare {
5608
+ class HealthcareMetadata {
5402
5609
  // Constructor with default values for optional fields
5403
5610
  constructor(types = null, iiasVerified = null, iiasExempt = null) {
5404
5611
  /**
@@ -5419,7 +5626,7 @@ class Healthcare {
5419
5626
  this.iiasExempt = iiasExempt;
5420
5627
  }
5421
5628
  }
5422
- exports.Healthcare = Healthcare;
5629
+ exports.HealthcareMetadata = HealthcareMetadata;
5423
5630
  /**
5424
5631
  * A group of fields for a specific type of healthcare.
5425
5632
  */
@@ -8880,6 +9087,637 @@ class AggregateBillingLineItemStats {
8880
9087
  }
8881
9088
  }
8882
9089
  exports.AggregateBillingLineItemStats = AggregateBillingLineItemStats;
9090
+ /**
9091
+ * Models an individual with 25% or more ownership interest in a company.
9092
+ */
9093
+ class Owner {
9094
+ // Constructor with default values for optional fields
9095
+ constructor(firstName = null, lastName = null, jobTitle = null, taxIdNumber = null, phoneNumber = null, dob = null, ownership = null, address = null, email = null, singleLineAddress = null, entityType = null, dlNumber = null, dlStateOrProvince = null, dlExpiration = null) {
9096
+ /**
9097
+ * The first name of the owner.
9098
+ */
9099
+ this.firstName = null;
9100
+ /**
9101
+ * The last name of the owner.
9102
+ */
9103
+ this.lastName = null;
9104
+ /**
9105
+ * The job title of the owner.
9106
+ */
9107
+ this.jobTitle = null;
9108
+ /**
9109
+ * The tax identification number (SSN) of the owner.
9110
+ */
9111
+ this.taxIdNumber = null;
9112
+ /**
9113
+ * The phone number of the owner.
9114
+ */
9115
+ this.phoneNumber = null;
9116
+ /**
9117
+ * The date of birth of the owner in mm/dd/yyyy format.
9118
+ */
9119
+ this.dob = null;
9120
+ /**
9121
+ * The percentage of ownership.
9122
+ */
9123
+ this.ownership = null;
9124
+ /**
9125
+ * The address of the owner.
9126
+ */
9127
+ this.address = null;
9128
+ /**
9129
+ * The email address of the owner.
9130
+ */
9131
+ this.email = null;
9132
+ /**
9133
+ * A single line representation of the owner's address.
9134
+ */
9135
+ this.singleLineAddress = null;
9136
+ /**
9137
+ * The type of entity this owner represents.
9138
+ */
9139
+ this.entityType = null;
9140
+ /**
9141
+ * The driver's license number of the owner.
9142
+ */
9143
+ this.dlNumber = null;
9144
+ /**
9145
+ * The state that issued the owner's driver's license.
9146
+ */
9147
+ this.dlStateOrProvince = null;
9148
+ /**
9149
+ * The expiration date of the owner's driver's license.
9150
+ */
9151
+ this.dlExpiration = null;
9152
+ this.firstName = firstName;
9153
+ this.lastName = lastName;
9154
+ this.jobTitle = jobTitle;
9155
+ this.taxIdNumber = taxIdNumber;
9156
+ this.phoneNumber = phoneNumber;
9157
+ this.dob = dob;
9158
+ this.ownership = ownership;
9159
+ this.address = address;
9160
+ this.email = email;
9161
+ this.singleLineAddress = singleLineAddress;
9162
+ this.entityType = entityType;
9163
+ this.dlNumber = dlNumber;
9164
+ this.dlStateOrProvince = dlStateOrProvince;
9165
+ this.dlExpiration = dlExpiration;
9166
+ }
9167
+ }
9168
+ exports.Owner = Owner;
9169
+ /**
9170
+ * Models a bank account associated with an application.
9171
+ */
9172
+ class ApplicationAccount {
9173
+ // Constructor with default values for optional fields
9174
+ constructor(name = null, bank = null, accountHolderName = null, routingNumber = null, accountNumber = null) {
9175
+ /**
9176
+ * The name of the bank account.
9177
+ */
9178
+ this.name = null;
9179
+ /**
9180
+ * The name of the bank.
9181
+ */
9182
+ this.bank = null;
9183
+ /**
9184
+ * The name of the account holder.
9185
+ */
9186
+ this.accountHolderName = null;
9187
+ /**
9188
+ * The routing number of the bank.
9189
+ */
9190
+ this.routingNumber = null;
9191
+ /**
9192
+ * The account number.
9193
+ */
9194
+ this.accountNumber = null;
9195
+ this.name = name;
9196
+ this.bank = bank;
9197
+ this.accountHolderName = accountHolderName;
9198
+ this.routingNumber = routingNumber;
9199
+ this.accountNumber = accountNumber;
9200
+ }
9201
+ }
9202
+ exports.ApplicationAccount = ApplicationAccount;
9203
+ /**
9204
+ * Models a merchant application form to add a merchant account.
9205
+ */
9206
+ class MerchantApplication {
9207
+ // Constructor with default values for optional fields
9208
+ constructor(inviteCode = null, dbaName = null, corporateName = null, webSite = null, taxIdNumber = null, entityType = null, stateOfIncorporation = null, merchantType = null, businessDescription = null, yearsInBusiness = null, businessPhoneNumber = null, physicalAddress = null, mailingAddress = null, contactFirstName = null, contactLastName = null, contactPhoneNumber = null, contactEmail = null, contactTitle = null, contactTaxIdNumber = null, contactDOB = null, contactDlNumber = null, contactDlStateOrProvince = null, contactDlExpiration = null, contactHomeAddress = null, contactRole = null, owners = null, manualAccount = null, averageTransaction = null, highTransaction = null, averageMonth = null, highMonth = null, refundPolicy = null, refundDays = null, timeZone = null, batchCloseTime = null, multipleLocations = null, locationName = null, storeNumber = null, ebtRequested = null, fnsNumber = null, ecommerce = null, dropShipping = null, cardPresentPercentage = null, phoneOrderPercentage = null, ecomPercentage = null, billBeforeShipmentDays = null, subscriptionsSupported = null, subscriptionFrequency = null, signerName = null) {
9209
+ /**
9210
+ * The invite code for the merchant.
9211
+ */
9212
+ this.inviteCode = null;
9213
+ /**
9214
+ * The business name your customers know you by (DBA Name).
9215
+ */
9216
+ this.dbaName = null;
9217
+ /**
9218
+ * The name of the legal entity you file your taxes under.
9219
+ */
9220
+ this.corporateName = null;
9221
+ /**
9222
+ * The business website.
9223
+ */
9224
+ this.webSite = null;
9225
+ /**
9226
+ * The business tax identification number (EIN).
9227
+ */
9228
+ this.taxIdNumber = null;
9229
+ /**
9230
+ * The type of business entity.
9231
+ */
9232
+ this.entityType = null;
9233
+ /**
9234
+ * The state where the business is incorporated.
9235
+ */
9236
+ this.stateOfIncorporation = null;
9237
+ /**
9238
+ * The primary type of business (e.g., Retail, Service, etc.).
9239
+ */
9240
+ this.merchantType = null;
9241
+ /**
9242
+ * A short description of the products and services sold.
9243
+ */
9244
+ this.businessDescription = null;
9245
+ /**
9246
+ * The number of years the business has been operating.
9247
+ */
9248
+ this.yearsInBusiness = null;
9249
+ /**
9250
+ * The business telephone number.
9251
+ */
9252
+ this.businessPhoneNumber = null;
9253
+ /**
9254
+ * The physical address of the business.
9255
+ */
9256
+ this.physicalAddress = null;
9257
+ /**
9258
+ * The mailing address of the business.
9259
+ */
9260
+ this.mailingAddress = null;
9261
+ /**
9262
+ * The first name of the primary contact.
9263
+ */
9264
+ this.contactFirstName = null;
9265
+ /**
9266
+ * The last name of the primary contact.
9267
+ */
9268
+ this.contactLastName = null;
9269
+ /**
9270
+ * The phone number of the primary contact.
9271
+ */
9272
+ this.contactPhoneNumber = null;
9273
+ /**
9274
+ * The email address of the primary contact.
9275
+ */
9276
+ this.contactEmail = null;
9277
+ /**
9278
+ * The job title of the primary contact.
9279
+ */
9280
+ this.contactTitle = null;
9281
+ /**
9282
+ * The tax identification number (SSN) of the primary contact.
9283
+ */
9284
+ this.contactTaxIdNumber = null;
9285
+ /**
9286
+ * The date of birth of the primary contact.
9287
+ */
9288
+ this.contactDOB = null;
9289
+ /**
9290
+ * The driver's license number of the primary contact.
9291
+ */
9292
+ this.contactDlNumber = null;
9293
+ /**
9294
+ * The state that issued the primary contact's driver's license.
9295
+ */
9296
+ this.contactDlStateOrProvince = null;
9297
+ /**
9298
+ * The expiration date of the primary contact's driver's license.
9299
+ */
9300
+ this.contactDlExpiration = null;
9301
+ /**
9302
+ * The home address of the primary contact.
9303
+ */
9304
+ this.contactHomeAddress = null;
9305
+ /**
9306
+ * The role of the primary contact in the business.
9307
+ */
9308
+ this.contactRole = null;
9309
+ /**
9310
+ * List of individuals with 25% or more ownership in the company.
9311
+ */
9312
+ this.owners = null;
9313
+ /**
9314
+ * The bank account information for the business.
9315
+ */
9316
+ this.manualAccount = null;
9317
+ /**
9318
+ * The average transaction amount.
9319
+ */
9320
+ this.averageTransaction = null;
9321
+ /**
9322
+ * The highest expected transaction amount.
9323
+ */
9324
+ this.highTransaction = null;
9325
+ /**
9326
+ * The average monthly transaction volume.
9327
+ */
9328
+ this.averageMonth = null;
9329
+ /**
9330
+ * The highest expected monthly transaction volume.
9331
+ */
9332
+ this.highMonth = null;
9333
+ /**
9334
+ * The refund policy of the business.
9335
+ */
9336
+ this.refundPolicy = null;
9337
+ /**
9338
+ * The number of days after purchase that refunds can be issued.
9339
+ */
9340
+ this.refundDays = null;
9341
+ /**
9342
+ * The time zone of the business.
9343
+ */
9344
+ this.timeZone = null;
9345
+ /**
9346
+ * The time when the daily batch should close.
9347
+ */
9348
+ this.batchCloseTime = null;
9349
+ /**
9350
+ * Indicates if the business has multiple locations.
9351
+ */
9352
+ this.multipleLocations = null;
9353
+ /**
9354
+ * The name of this specific business location.
9355
+ */
9356
+ this.locationName = null;
9357
+ /**
9358
+ * The store number for this location.
9359
+ */
9360
+ this.storeNumber = null;
9361
+ /**
9362
+ * Indicates if the business wants to accept EBT cards.
9363
+ */
9364
+ this.ebtRequested = null;
9365
+ /**
9366
+ * The FNS number issued by the USDA for EBT processing.
9367
+ */
9368
+ this.fnsNumber = null;
9369
+ /**
9370
+ * Indicates if the business plans to accept payments through a website.
9371
+ */
9372
+ this.ecommerce = null;
9373
+ /**
9374
+ * Indicates if suppliers ship products directly to customers.
9375
+ */
9376
+ this.dropShipping = null;
9377
+ /**
9378
+ * The percentage of transactions that will be chip or swipe.
9379
+ */
9380
+ this.cardPresentPercentage = null;
9381
+ /**
9382
+ * The percentage of transactions that will be phone orders.
9383
+ */
9384
+ this.phoneOrderPercentage = null;
9385
+ /**
9386
+ * The percentage of transactions that will be e-commerce.
9387
+ */
9388
+ this.ecomPercentage = null;
9389
+ /**
9390
+ * The number of days before shipment that customers are charged.
9391
+ */
9392
+ this.billBeforeShipmentDays = null;
9393
+ /**
9394
+ * Indicates if the business plans to process recurring payments.
9395
+ */
9396
+ this.subscriptionsSupported = null;
9397
+ /**
9398
+ * The frequency of recurring payments (if applicable).
9399
+ */
9400
+ this.subscriptionFrequency = null;
9401
+ /**
9402
+ * The full legal name of the person signing the application.
9403
+ */
9404
+ this.signerName = null;
9405
+ this.inviteCode = inviteCode;
9406
+ this.dbaName = dbaName;
9407
+ this.corporateName = corporateName;
9408
+ this.webSite = webSite;
9409
+ this.taxIdNumber = taxIdNumber;
9410
+ this.entityType = entityType;
9411
+ this.stateOfIncorporation = stateOfIncorporation;
9412
+ this.merchantType = merchantType;
9413
+ this.businessDescription = businessDescription;
9414
+ this.yearsInBusiness = yearsInBusiness;
9415
+ this.businessPhoneNumber = businessPhoneNumber;
9416
+ this.physicalAddress = physicalAddress;
9417
+ this.mailingAddress = mailingAddress;
9418
+ this.contactFirstName = contactFirstName;
9419
+ this.contactLastName = contactLastName;
9420
+ this.contactPhoneNumber = contactPhoneNumber;
9421
+ this.contactEmail = contactEmail;
9422
+ this.contactTitle = contactTitle;
9423
+ this.contactTaxIdNumber = contactTaxIdNumber;
9424
+ this.contactDOB = contactDOB;
9425
+ this.contactDlNumber = contactDlNumber;
9426
+ this.contactDlStateOrProvince = contactDlStateOrProvince;
9427
+ this.contactDlExpiration = contactDlExpiration;
9428
+ this.contactHomeAddress = contactHomeAddress;
9429
+ this.contactRole = contactRole;
9430
+ this.owners = owners;
9431
+ this.manualAccount = manualAccount;
9432
+ this.averageTransaction = averageTransaction;
9433
+ this.highTransaction = highTransaction;
9434
+ this.averageMonth = averageMonth;
9435
+ this.highMonth = highMonth;
9436
+ this.refundPolicy = refundPolicy;
9437
+ this.refundDays = refundDays;
9438
+ this.timeZone = timeZone;
9439
+ this.batchCloseTime = batchCloseTime;
9440
+ this.multipleLocations = multipleLocations;
9441
+ this.locationName = locationName;
9442
+ this.storeNumber = storeNumber;
9443
+ this.ebtRequested = ebtRequested;
9444
+ this.fnsNumber = fnsNumber;
9445
+ this.ecommerce = ecommerce;
9446
+ this.dropShipping = dropShipping;
9447
+ this.cardPresentPercentage = cardPresentPercentage;
9448
+ this.phoneOrderPercentage = phoneOrderPercentage;
9449
+ this.ecomPercentage = ecomPercentage;
9450
+ this.billBeforeShipmentDays = billBeforeShipmentDays;
9451
+ this.subscriptionsSupported = subscriptionsSupported;
9452
+ this.subscriptionFrequency = subscriptionFrequency;
9453
+ this.signerName = signerName;
9454
+ }
9455
+ }
9456
+ exports.MerchantApplication = MerchantApplication;
9457
+ /**
9458
+ * Models a merchant application submission request to add a new merchant account.
9459
+ */
9460
+ class SubmitApplicationRequest {
9461
+ // Constructor with default values for optional fields
9462
+ constructor(timeout = null, test = null, inviteCode = null, dbaName = null, corporateName = null, webSite = null, taxIdNumber = null, entityType = null, stateOfIncorporation = null, merchantType = null, businessDescription = null, yearsInBusiness = null, businessPhoneNumber = null, physicalAddress = null, mailingAddress = null, contactFirstName = null, contactLastName = null, contactPhoneNumber = null, contactEmail = null, contactTitle = null, contactTaxIdNumber = null, contactDOB = null, contactDlNumber = null, contactDlStateOrProvince = null, contactDlExpiration = null, contactHomeAddress = null, contactRole = null, owners = null, manualAccount = null, averageTransaction = null, highTransaction = null, averageMonth = null, highMonth = null, refundPolicy = null, refundDays = null, timeZone = null, batchCloseTime = null, multipleLocations = null, locationName = null, storeNumber = null, ebtRequested = null, fnsNumber = null, ecommerce = null, dropShipping = null, cardPresentPercentage = null, phoneOrderPercentage = null, ecomPercentage = null, billBeforeShipmentDays = null, subscriptionsSupported = null, subscriptionFrequency = null, signerName = null) {
9463
+ /**
9464
+ * The request timeout in seconds.
9465
+ */
9466
+ this.timeout = null;
9467
+ /**
9468
+ * Whether or not to route transaction to the test gateway.
9469
+ */
9470
+ this.test = null;
9471
+ /**
9472
+ * The invite code for the merchant.
9473
+ */
9474
+ this.inviteCode = null;
9475
+ /**
9476
+ * The business name your customers know you by (DBA Name).
9477
+ */
9478
+ this.dbaName = null;
9479
+ /**
9480
+ * The name of the legal entity you file your taxes under.
9481
+ */
9482
+ this.corporateName = null;
9483
+ /**
9484
+ * The business website.
9485
+ */
9486
+ this.webSite = null;
9487
+ /**
9488
+ * The business tax identification number (EIN).
9489
+ */
9490
+ this.taxIdNumber = null;
9491
+ /**
9492
+ * The type of business entity.
9493
+ */
9494
+ this.entityType = null;
9495
+ /**
9496
+ * The state where the business is incorporated.
9497
+ */
9498
+ this.stateOfIncorporation = null;
9499
+ /**
9500
+ * The primary type of business (e.g., Retail, Service, etc.).
9501
+ */
9502
+ this.merchantType = null;
9503
+ /**
9504
+ * A short description of the products and services sold.
9505
+ */
9506
+ this.businessDescription = null;
9507
+ /**
9508
+ * The number of years the business has been operating.
9509
+ */
9510
+ this.yearsInBusiness = null;
9511
+ /**
9512
+ * The business telephone number.
9513
+ */
9514
+ this.businessPhoneNumber = null;
9515
+ /**
9516
+ * The physical address of the business.
9517
+ */
9518
+ this.physicalAddress = null;
9519
+ /**
9520
+ * The mailing address of the business.
9521
+ */
9522
+ this.mailingAddress = null;
9523
+ /**
9524
+ * The first name of the primary contact.
9525
+ */
9526
+ this.contactFirstName = null;
9527
+ /**
9528
+ * The last name of the primary contact.
9529
+ */
9530
+ this.contactLastName = null;
9531
+ /**
9532
+ * The phone number of the primary contact.
9533
+ */
9534
+ this.contactPhoneNumber = null;
9535
+ /**
9536
+ * The email address of the primary contact.
9537
+ */
9538
+ this.contactEmail = null;
9539
+ /**
9540
+ * The job title of the primary contact.
9541
+ */
9542
+ this.contactTitle = null;
9543
+ /**
9544
+ * The tax identification number (SSN) of the primary contact.
9545
+ */
9546
+ this.contactTaxIdNumber = null;
9547
+ /**
9548
+ * The date of birth of the primary contact.
9549
+ */
9550
+ this.contactDOB = null;
9551
+ /**
9552
+ * The driver's license number of the primary contact.
9553
+ */
9554
+ this.contactDlNumber = null;
9555
+ /**
9556
+ * The state that issued the primary contact's driver's license.
9557
+ */
9558
+ this.contactDlStateOrProvince = null;
9559
+ /**
9560
+ * The expiration date of the primary contact's driver's license.
9561
+ */
9562
+ this.contactDlExpiration = null;
9563
+ /**
9564
+ * The home address of the primary contact.
9565
+ */
9566
+ this.contactHomeAddress = null;
9567
+ /**
9568
+ * The role of the primary contact in the business.
9569
+ */
9570
+ this.contactRole = null;
9571
+ /**
9572
+ * List of individuals with 25% or more ownership in the company.
9573
+ */
9574
+ this.owners = null;
9575
+ /**
9576
+ * The bank account information for the business.
9577
+ */
9578
+ this.manualAccount = null;
9579
+ /**
9580
+ * The average transaction amount.
9581
+ */
9582
+ this.averageTransaction = null;
9583
+ /**
9584
+ * The highest expected transaction amount.
9585
+ */
9586
+ this.highTransaction = null;
9587
+ /**
9588
+ * The average monthly transaction volume.
9589
+ */
9590
+ this.averageMonth = null;
9591
+ /**
9592
+ * The highest expected monthly transaction volume.
9593
+ */
9594
+ this.highMonth = null;
9595
+ /**
9596
+ * The refund policy of the business.
9597
+ */
9598
+ this.refundPolicy = null;
9599
+ /**
9600
+ * The number of days after purchase that refunds can be issued.
9601
+ */
9602
+ this.refundDays = null;
9603
+ /**
9604
+ * The time zone of the business.
9605
+ */
9606
+ this.timeZone = null;
9607
+ /**
9608
+ * The time when the daily batch should close.
9609
+ */
9610
+ this.batchCloseTime = null;
9611
+ /**
9612
+ * Indicates if the business has multiple locations.
9613
+ */
9614
+ this.multipleLocations = null;
9615
+ /**
9616
+ * The name of this specific business location.
9617
+ */
9618
+ this.locationName = null;
9619
+ /**
9620
+ * The store number for this location.
9621
+ */
9622
+ this.storeNumber = null;
9623
+ /**
9624
+ * Indicates if the business wants to accept EBT cards.
9625
+ */
9626
+ this.ebtRequested = null;
9627
+ /**
9628
+ * The FNS number issued by the USDA for EBT processing.
9629
+ */
9630
+ this.fnsNumber = null;
9631
+ /**
9632
+ * Indicates if the business plans to accept payments through a website.
9633
+ */
9634
+ this.ecommerce = null;
9635
+ /**
9636
+ * Indicates if suppliers ship products directly to customers.
9637
+ */
9638
+ this.dropShipping = null;
9639
+ /**
9640
+ * The percentage of transactions that will be chip or swipe.
9641
+ */
9642
+ this.cardPresentPercentage = null;
9643
+ /**
9644
+ * The percentage of transactions that will be phone orders.
9645
+ */
9646
+ this.phoneOrderPercentage = null;
9647
+ /**
9648
+ * The percentage of transactions that will be e-commerce.
9649
+ */
9650
+ this.ecomPercentage = null;
9651
+ /**
9652
+ * The number of days before shipment that customers are charged.
9653
+ */
9654
+ this.billBeforeShipmentDays = null;
9655
+ /**
9656
+ * Indicates if the business plans to process recurring payments.
9657
+ */
9658
+ this.subscriptionsSupported = null;
9659
+ /**
9660
+ * The frequency of recurring payments (if applicable).
9661
+ */
9662
+ this.subscriptionFrequency = null;
9663
+ /**
9664
+ * The full legal name of the person signing the application.
9665
+ */
9666
+ this.signerName = null;
9667
+ this.timeout = timeout;
9668
+ this.test = test;
9669
+ this.inviteCode = inviteCode;
9670
+ this.dbaName = dbaName;
9671
+ this.corporateName = corporateName;
9672
+ this.webSite = webSite;
9673
+ this.taxIdNumber = taxIdNumber;
9674
+ this.entityType = entityType;
9675
+ this.stateOfIncorporation = stateOfIncorporation;
9676
+ this.merchantType = merchantType;
9677
+ this.businessDescription = businessDescription;
9678
+ this.yearsInBusiness = yearsInBusiness;
9679
+ this.businessPhoneNumber = businessPhoneNumber;
9680
+ this.physicalAddress = physicalAddress;
9681
+ this.mailingAddress = mailingAddress;
9682
+ this.contactFirstName = contactFirstName;
9683
+ this.contactLastName = contactLastName;
9684
+ this.contactPhoneNumber = contactPhoneNumber;
9685
+ this.contactEmail = contactEmail;
9686
+ this.contactTitle = contactTitle;
9687
+ this.contactTaxIdNumber = contactTaxIdNumber;
9688
+ this.contactDOB = contactDOB;
9689
+ this.contactDlNumber = contactDlNumber;
9690
+ this.contactDlStateOrProvince = contactDlStateOrProvince;
9691
+ this.contactDlExpiration = contactDlExpiration;
9692
+ this.contactHomeAddress = contactHomeAddress;
9693
+ this.contactRole = contactRole;
9694
+ this.owners = owners;
9695
+ this.manualAccount = manualAccount;
9696
+ this.averageTransaction = averageTransaction;
9697
+ this.highTransaction = highTransaction;
9698
+ this.averageMonth = averageMonth;
9699
+ this.highMonth = highMonth;
9700
+ this.refundPolicy = refundPolicy;
9701
+ this.refundDays = refundDays;
9702
+ this.timeZone = timeZone;
9703
+ this.batchCloseTime = batchCloseTime;
9704
+ this.multipleLocations = multipleLocations;
9705
+ this.locationName = locationName;
9706
+ this.storeNumber = storeNumber;
9707
+ this.ebtRequested = ebtRequested;
9708
+ this.fnsNumber = fnsNumber;
9709
+ this.ecommerce = ecommerce;
9710
+ this.dropShipping = dropShipping;
9711
+ this.cardPresentPercentage = cardPresentPercentage;
9712
+ this.phoneOrderPercentage = phoneOrderPercentage;
9713
+ this.ecomPercentage = ecomPercentage;
9714
+ this.billBeforeShipmentDays = billBeforeShipmentDays;
9715
+ this.subscriptionsSupported = subscriptionsSupported;
9716
+ this.subscriptionFrequency = subscriptionFrequency;
9717
+ this.signerName = signerName;
9718
+ }
9719
+ }
9720
+ exports.SubmitApplicationRequest = SubmitApplicationRequest;
8883
9721
  /**
8884
9722
  * A request for customer signature data.
8885
9723
  */
@@ -8950,6 +9788,16 @@ class TerminalAuthorizationRequest {
8950
9788
  }
8951
9789
  }
8952
9790
  exports.TerminalAuthorizationRequest = TerminalAuthorizationRequest;
9791
+ /**
9792
+ * Retrieves card metadata.
9793
+ */
9794
+ class TerminalCardMetadataRequest {
9795
+ constructor(APICredentials, request) {
9796
+ this.APICredentials = APICredentials;
9797
+ this.request = request;
9798
+ }
9799
+ }
9800
+ exports.TerminalCardMetadataRequest = TerminalCardMetadataRequest;
8953
9801
  /**
8954
9802
  * A request for the remaining balance on a payment type.
8955
9803
  */