@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.
- package/README.md +147 -1
- package/_bundles/blockchyp.js +1010 -55
- package/_bundles/blockchyp.js.map +1 -1
- package/_bundles/blockchyp.min.js +1 -1
- package/_bundles/blockchyp.min.js.map +1 -1
- package/lib/src/client.d.ts +12 -0
- package/lib/src/client.js +20 -0
- package/lib/src/client.js.map +1 -1
- package/lib/src/models.d.ts +907 -13
- package/lib/src/models.js +965 -30
- package/lib/src/models.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +21 -0
- package/src/models.ts +7487 -5928
package/lib/src/models.js
CHANGED
|
@@ -7,10 +7,10 @@
|
|
|
7
7
|
* file will be lost every time the code is regenerated.
|
|
8
8
|
*/
|
|
9
9
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
|
-
exports.
|
|
11
|
-
exports.
|
|
12
|
-
exports.
|
|
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 = 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,
|
|
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.
|
|
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,
|
|
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.
|
|
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;
|
|
@@ -4154,6 +4351,30 @@ class AddTestMerchantRequest {
|
|
|
4154
4351
|
}
|
|
4155
4352
|
}
|
|
4156
4353
|
exports.AddTestMerchantRequest = AddTestMerchantRequest;
|
|
4354
|
+
/**
|
|
4355
|
+
* Models basic information needed to create a gateway merchant.
|
|
4356
|
+
*/
|
|
4357
|
+
class AddGatewayMerchantRequest {
|
|
4358
|
+
// Constructor with default values for optional fields
|
|
4359
|
+
constructor(test = null, profile = null, timeout = null) {
|
|
4360
|
+
/**
|
|
4361
|
+
* Whether or not to route transaction to the test gateway.
|
|
4362
|
+
*/
|
|
4363
|
+
this.test = null;
|
|
4364
|
+
/**
|
|
4365
|
+
* The merchant profile to be boarded.
|
|
4366
|
+
*/
|
|
4367
|
+
this.profile = null;
|
|
4368
|
+
/**
|
|
4369
|
+
* The request timeout in seconds.
|
|
4370
|
+
*/
|
|
4371
|
+
this.timeout = null;
|
|
4372
|
+
this.test = test;
|
|
4373
|
+
this.profile = profile;
|
|
4374
|
+
this.timeout = timeout;
|
|
4375
|
+
}
|
|
4376
|
+
}
|
|
4377
|
+
exports.AddGatewayMerchantRequest = AddGatewayMerchantRequest;
|
|
4157
4378
|
/**
|
|
4158
4379
|
* Models a request for information about the merchant profile.
|
|
4159
4380
|
*/
|
|
@@ -4373,7 +4594,7 @@ exports.Address = Address;
|
|
|
4373
4594
|
*/
|
|
4374
4595
|
class MerchantProfile {
|
|
4375
4596
|
// Constructor with default values for optional fields
|
|
4376
|
-
constructor(timeout = null, test = null, merchantId = 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) {
|
|
4377
4598
|
/**
|
|
4378
4599
|
* The request timeout in seconds.
|
|
4379
4600
|
*/
|
|
@@ -4386,6 +4607,10 @@ class MerchantProfile {
|
|
|
4386
4607
|
* The merchant id.
|
|
4387
4608
|
*/
|
|
4388
4609
|
this.merchantId = null;
|
|
4610
|
+
/**
|
|
4611
|
+
* The primary bank mid.
|
|
4612
|
+
*/
|
|
4613
|
+
this.bankMid = null;
|
|
4389
4614
|
/**
|
|
4390
4615
|
* The merchant's company name.
|
|
4391
4616
|
*/
|
|
@@ -4589,6 +4814,7 @@ class MerchantProfile {
|
|
|
4589
4814
|
this.timeout = timeout;
|
|
4590
4815
|
this.test = test;
|
|
4591
4816
|
this.merchantId = merchantId;
|
|
4817
|
+
this.bankMid = bankMid;
|
|
4592
4818
|
this.companyName = companyName;
|
|
4593
4819
|
this.dbaName = dbaName;
|
|
4594
4820
|
this.invoiceName = invoiceName;
|
|
@@ -4646,7 +4872,7 @@ exports.MerchantProfile = MerchantProfile;
|
|
|
4646
4872
|
*/
|
|
4647
4873
|
class MerchantProfileResponse {
|
|
4648
4874
|
// Constructor with default values for optional fields
|
|
4649
|
-
constructor(success = null, error = null, responseDescription = null, test = null, merchantId = 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) {
|
|
4875
|
+
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) {
|
|
4650
4876
|
/**
|
|
4651
4877
|
* Whether or not the request succeeded.
|
|
4652
4878
|
*/
|
|
@@ -4667,6 +4893,10 @@ class MerchantProfileResponse {
|
|
|
4667
4893
|
* The merchant id.
|
|
4668
4894
|
*/
|
|
4669
4895
|
this.merchantId = null;
|
|
4896
|
+
/**
|
|
4897
|
+
* The primary bank mid.
|
|
4898
|
+
*/
|
|
4899
|
+
this.bankMid = null;
|
|
4670
4900
|
/**
|
|
4671
4901
|
* The merchant's company name.
|
|
4672
4902
|
*/
|
|
@@ -4872,6 +5102,7 @@ class MerchantProfileResponse {
|
|
|
4872
5102
|
this.responseDescription = responseDescription;
|
|
4873
5103
|
this.test = test;
|
|
4874
5104
|
this.merchantId = merchantId;
|
|
5105
|
+
this.bankMid = bankMid;
|
|
4875
5106
|
this.companyName = companyName;
|
|
4876
5107
|
this.dbaName = dbaName;
|
|
4877
5108
|
this.invoiceName = invoiceName;
|
|
@@ -5364,7 +5595,7 @@ exports.UnlinkTokenRequest = UnlinkTokenRequest;
|
|
|
5364
5595
|
/**
|
|
5365
5596
|
* Fields for HSA/FSA transactions.
|
|
5366
5597
|
*/
|
|
5367
|
-
class
|
|
5598
|
+
class HealthcareMetadata {
|
|
5368
5599
|
// Constructor with default values for optional fields
|
|
5369
5600
|
constructor(types = null, iiasVerified = null, iiasExempt = null) {
|
|
5370
5601
|
/**
|
|
@@ -5385,7 +5616,7 @@ class Healthcare {
|
|
|
5385
5616
|
this.iiasExempt = iiasExempt;
|
|
5386
5617
|
}
|
|
5387
5618
|
}
|
|
5388
|
-
exports.
|
|
5619
|
+
exports.HealthcareMetadata = HealthcareMetadata;
|
|
5389
5620
|
/**
|
|
5390
5621
|
* A group of fields for a specific type of healthcare.
|
|
5391
5622
|
*/
|
|
@@ -5625,6 +5856,59 @@ class MerchantPlatformsResponse {
|
|
|
5625
5856
|
}
|
|
5626
5857
|
}
|
|
5627
5858
|
exports.MerchantPlatformsResponse = MerchantPlatformsResponse;
|
|
5859
|
+
/**
|
|
5860
|
+
* Used to up platform configuration for gateway merchants.
|
|
5861
|
+
*/
|
|
5862
|
+
class UpdateMerchantPlatformRequest {
|
|
5863
|
+
// Constructor with default values for optional fields
|
|
5864
|
+
constructor(timeout = null, test = null, platform = null) {
|
|
5865
|
+
/**
|
|
5866
|
+
* The request timeout in seconds.
|
|
5867
|
+
*/
|
|
5868
|
+
this.timeout = null;
|
|
5869
|
+
/**
|
|
5870
|
+
* Whether or not to route transaction to the test gateway.
|
|
5871
|
+
*/
|
|
5872
|
+
this.test = null;
|
|
5873
|
+
/**
|
|
5874
|
+
* The merchant platform configuration.
|
|
5875
|
+
*/
|
|
5876
|
+
this.platform = null;
|
|
5877
|
+
this.timeout = timeout;
|
|
5878
|
+
this.test = test;
|
|
5879
|
+
this.platform = platform;
|
|
5880
|
+
}
|
|
5881
|
+
}
|
|
5882
|
+
exports.UpdateMerchantPlatformRequest = UpdateMerchantPlatformRequest;
|
|
5883
|
+
/**
|
|
5884
|
+
* Echoes back the state of the current platform configuration after a change.
|
|
5885
|
+
*/
|
|
5886
|
+
class UpdateMerchantPlatformResponse {
|
|
5887
|
+
// Constructor with default values for optional fields
|
|
5888
|
+
constructor(success = null, error = null, responseDescription = null, platform = null) {
|
|
5889
|
+
/**
|
|
5890
|
+
* Whether or not the request succeeded.
|
|
5891
|
+
*/
|
|
5892
|
+
this.success = null;
|
|
5893
|
+
/**
|
|
5894
|
+
* The error, if an error occurred.
|
|
5895
|
+
*/
|
|
5896
|
+
this.error = null;
|
|
5897
|
+
/**
|
|
5898
|
+
* A narrative description of the transaction result.
|
|
5899
|
+
*/
|
|
5900
|
+
this.responseDescription = null;
|
|
5901
|
+
/**
|
|
5902
|
+
* The current platform configuration.
|
|
5903
|
+
*/
|
|
5904
|
+
this.platform = null;
|
|
5905
|
+
this.success = success;
|
|
5906
|
+
this.error = error;
|
|
5907
|
+
this.responseDescription = responseDescription;
|
|
5908
|
+
this.platform = platform;
|
|
5909
|
+
}
|
|
5910
|
+
}
|
|
5911
|
+
exports.UpdateMerchantPlatformResponse = UpdateMerchantPlatformResponse;
|
|
5628
5912
|
/**
|
|
5629
5913
|
* Details about a merchant board platform configuration.
|
|
5630
5914
|
*/
|
|
@@ -8576,7 +8860,7 @@ exports.PartnerCommissionBreakdownResponse = PartnerCommissionBreakdownResponse;
|
|
|
8576
8860
|
*/
|
|
8577
8861
|
class MerchantCredentialGenerationRequest {
|
|
8578
8862
|
// Constructor with default values for optional fields
|
|
8579
|
-
constructor(timeout = null, test = null, merchantId = null, deleteProtected = null, roles = null, notes = null) {
|
|
8863
|
+
constructor(timeout = null, test = null, merchantId = null, deleteProtected = null, roles = null, notes = null, credentialType = null) {
|
|
8580
8864
|
/**
|
|
8581
8865
|
* The request timeout in seconds.
|
|
8582
8866
|
*/
|
|
@@ -8601,12 +8885,17 @@ class MerchantCredentialGenerationRequest {
|
|
|
8601
8885
|
* Free form description of the purpose or intent behind the credentials.
|
|
8602
8886
|
*/
|
|
8603
8887
|
this.notes = null;
|
|
8888
|
+
/**
|
|
8889
|
+
* Type of credentials to generate, either API or TOKENIZING. Defaults to API.
|
|
8890
|
+
*/
|
|
8891
|
+
this.credentialType = null;
|
|
8604
8892
|
this.timeout = timeout;
|
|
8605
8893
|
this.test = test;
|
|
8606
8894
|
this.merchantId = merchantId;
|
|
8607
8895
|
this.deleteProtected = deleteProtected;
|
|
8608
8896
|
this.roles = roles;
|
|
8609
8897
|
this.notes = notes;
|
|
8898
|
+
this.credentialType = credentialType;
|
|
8610
8899
|
}
|
|
8611
8900
|
}
|
|
8612
8901
|
exports.MerchantCredentialGenerationRequest = MerchantCredentialGenerationRequest;
|
|
@@ -8615,7 +8904,7 @@ exports.MerchantCredentialGenerationRequest = MerchantCredentialGenerationReques
|
|
|
8615
8904
|
*/
|
|
8616
8905
|
class MerchantCredentialGenerationResponse {
|
|
8617
8906
|
// Constructor with default values for optional fields
|
|
8618
|
-
constructor(success = null, error = null, responseDescription = null, apiKey = null, bearerToken = null, signingKey = null) {
|
|
8907
|
+
constructor(success = null, error = null, responseDescription = null, apiKey = null, bearerToken = null, signingKey = null, tokenizingKey = null) {
|
|
8619
8908
|
/**
|
|
8620
8909
|
* Whether or not the request succeeded.
|
|
8621
8910
|
*/
|
|
@@ -8640,12 +8929,17 @@ class MerchantCredentialGenerationResponse {
|
|
|
8640
8929
|
* The merchant signing key.
|
|
8641
8930
|
*/
|
|
8642
8931
|
this.signingKey = null;
|
|
8932
|
+
/**
|
|
8933
|
+
* The tokenizing key.
|
|
8934
|
+
*/
|
|
8935
|
+
this.tokenizingKey = null;
|
|
8643
8936
|
this.success = success;
|
|
8644
8937
|
this.error = error;
|
|
8645
8938
|
this.responseDescription = responseDescription;
|
|
8646
8939
|
this.apiKey = apiKey;
|
|
8647
8940
|
this.bearerToken = bearerToken;
|
|
8648
8941
|
this.signingKey = signingKey;
|
|
8942
|
+
this.tokenizingKey = tokenizingKey;
|
|
8649
8943
|
}
|
|
8650
8944
|
}
|
|
8651
8945
|
exports.MerchantCredentialGenerationResponse = MerchantCredentialGenerationResponse;
|
|
@@ -8784,23 +9078,654 @@ class AggregateBillingLineItemStats {
|
|
|
8784
9078
|
}
|
|
8785
9079
|
exports.AggregateBillingLineItemStats = AggregateBillingLineItemStats;
|
|
8786
9080
|
/**
|
|
8787
|
-
*
|
|
9081
|
+
* Models an individual with 25% or more ownership interest in a company.
|
|
8788
9082
|
*/
|
|
8789
|
-
class
|
|
8790
|
-
|
|
8791
|
-
|
|
8792
|
-
|
|
9083
|
+
class Owner {
|
|
9084
|
+
// Constructor with default values for optional fields
|
|
9085
|
+
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) {
|
|
9086
|
+
/**
|
|
9087
|
+
* The first name of the owner.
|
|
9088
|
+
*/
|
|
9089
|
+
this.firstName = null;
|
|
9090
|
+
/**
|
|
9091
|
+
* The last name of the owner.
|
|
9092
|
+
*/
|
|
9093
|
+
this.lastName = null;
|
|
9094
|
+
/**
|
|
9095
|
+
* The job title of the owner.
|
|
9096
|
+
*/
|
|
9097
|
+
this.jobTitle = null;
|
|
9098
|
+
/**
|
|
9099
|
+
* The tax identification number (SSN) of the owner.
|
|
9100
|
+
*/
|
|
9101
|
+
this.taxIdNumber = null;
|
|
9102
|
+
/**
|
|
9103
|
+
* The phone number of the owner.
|
|
9104
|
+
*/
|
|
9105
|
+
this.phoneNumber = null;
|
|
9106
|
+
/**
|
|
9107
|
+
* The date of birth of the owner in mm/dd/yyyy format.
|
|
9108
|
+
*/
|
|
9109
|
+
this.dob = null;
|
|
9110
|
+
/**
|
|
9111
|
+
* The percentage of ownership.
|
|
9112
|
+
*/
|
|
9113
|
+
this.ownership = null;
|
|
9114
|
+
/**
|
|
9115
|
+
* The address of the owner.
|
|
9116
|
+
*/
|
|
9117
|
+
this.address = null;
|
|
9118
|
+
/**
|
|
9119
|
+
* The email address of the owner.
|
|
9120
|
+
*/
|
|
9121
|
+
this.email = null;
|
|
9122
|
+
/**
|
|
9123
|
+
* A single line representation of the owner's address.
|
|
9124
|
+
*/
|
|
9125
|
+
this.singleLineAddress = null;
|
|
9126
|
+
/**
|
|
9127
|
+
* The type of entity this owner represents.
|
|
9128
|
+
*/
|
|
9129
|
+
this.entityType = null;
|
|
9130
|
+
/**
|
|
9131
|
+
* The driver's license number of the owner.
|
|
9132
|
+
*/
|
|
9133
|
+
this.dlNumber = null;
|
|
9134
|
+
/**
|
|
9135
|
+
* The state that issued the owner's driver's license.
|
|
9136
|
+
*/
|
|
9137
|
+
this.dlStateOrProvince = null;
|
|
9138
|
+
/**
|
|
9139
|
+
* The expiration date of the owner's driver's license.
|
|
9140
|
+
*/
|
|
9141
|
+
this.dlExpiration = null;
|
|
9142
|
+
this.firstName = firstName;
|
|
9143
|
+
this.lastName = lastName;
|
|
9144
|
+
this.jobTitle = jobTitle;
|
|
9145
|
+
this.taxIdNumber = taxIdNumber;
|
|
9146
|
+
this.phoneNumber = phoneNumber;
|
|
9147
|
+
this.dob = dob;
|
|
9148
|
+
this.ownership = ownership;
|
|
9149
|
+
this.address = address;
|
|
9150
|
+
this.email = email;
|
|
9151
|
+
this.singleLineAddress = singleLineAddress;
|
|
9152
|
+
this.entityType = entityType;
|
|
9153
|
+
this.dlNumber = dlNumber;
|
|
9154
|
+
this.dlStateOrProvince = dlStateOrProvince;
|
|
9155
|
+
this.dlExpiration = dlExpiration;
|
|
8793
9156
|
}
|
|
8794
9157
|
}
|
|
8795
|
-
exports.
|
|
9158
|
+
exports.Owner = Owner;
|
|
8796
9159
|
/**
|
|
8797
|
-
*
|
|
9160
|
+
* Models a bank account associated with an application.
|
|
8798
9161
|
*/
|
|
8799
|
-
class
|
|
8800
|
-
|
|
8801
|
-
|
|
8802
|
-
|
|
8803
|
-
|
|
9162
|
+
class ApplicationAccount {
|
|
9163
|
+
// Constructor with default values for optional fields
|
|
9164
|
+
constructor(name = null, bank = null, accountHolderName = null, routingNumber = null, accountNumber = null) {
|
|
9165
|
+
/**
|
|
9166
|
+
* The name of the bank account.
|
|
9167
|
+
*/
|
|
9168
|
+
this.name = null;
|
|
9169
|
+
/**
|
|
9170
|
+
* The name of the bank.
|
|
9171
|
+
*/
|
|
9172
|
+
this.bank = null;
|
|
9173
|
+
/**
|
|
9174
|
+
* The name of the account holder.
|
|
9175
|
+
*/
|
|
9176
|
+
this.accountHolderName = null;
|
|
9177
|
+
/**
|
|
9178
|
+
* The routing number of the bank.
|
|
9179
|
+
*/
|
|
9180
|
+
this.routingNumber = null;
|
|
9181
|
+
/**
|
|
9182
|
+
* The account number.
|
|
9183
|
+
*/
|
|
9184
|
+
this.accountNumber = null;
|
|
9185
|
+
this.name = name;
|
|
9186
|
+
this.bank = bank;
|
|
9187
|
+
this.accountHolderName = accountHolderName;
|
|
9188
|
+
this.routingNumber = routingNumber;
|
|
9189
|
+
this.accountNumber = accountNumber;
|
|
9190
|
+
}
|
|
9191
|
+
}
|
|
9192
|
+
exports.ApplicationAccount = ApplicationAccount;
|
|
9193
|
+
/**
|
|
9194
|
+
* Models a merchant application form to add a merchant account.
|
|
9195
|
+
*/
|
|
9196
|
+
class MerchantApplication {
|
|
9197
|
+
// Constructor with default values for optional fields
|
|
9198
|
+
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) {
|
|
9199
|
+
/**
|
|
9200
|
+
* The invite code for the merchant.
|
|
9201
|
+
*/
|
|
9202
|
+
this.inviteCode = null;
|
|
9203
|
+
/**
|
|
9204
|
+
* The business name your customers know you by (DBA Name).
|
|
9205
|
+
*/
|
|
9206
|
+
this.dbaName = null;
|
|
9207
|
+
/**
|
|
9208
|
+
* The name of the legal entity you file your taxes under.
|
|
9209
|
+
*/
|
|
9210
|
+
this.corporateName = null;
|
|
9211
|
+
/**
|
|
9212
|
+
* The business website.
|
|
9213
|
+
*/
|
|
9214
|
+
this.webSite = null;
|
|
9215
|
+
/**
|
|
9216
|
+
* The business tax identification number (EIN).
|
|
9217
|
+
*/
|
|
9218
|
+
this.taxIdNumber = null;
|
|
9219
|
+
/**
|
|
9220
|
+
* The type of business entity.
|
|
9221
|
+
*/
|
|
9222
|
+
this.entityType = null;
|
|
9223
|
+
/**
|
|
9224
|
+
* The state where the business is incorporated.
|
|
9225
|
+
*/
|
|
9226
|
+
this.stateOfIncorporation = null;
|
|
9227
|
+
/**
|
|
9228
|
+
* The primary type of business (e.g., Retail, Service, etc.).
|
|
9229
|
+
*/
|
|
9230
|
+
this.merchantType = null;
|
|
9231
|
+
/**
|
|
9232
|
+
* A short description of the products and services sold.
|
|
9233
|
+
*/
|
|
9234
|
+
this.businessDescription = null;
|
|
9235
|
+
/**
|
|
9236
|
+
* The number of years the business has been operating.
|
|
9237
|
+
*/
|
|
9238
|
+
this.yearsInBusiness = null;
|
|
9239
|
+
/**
|
|
9240
|
+
* The business telephone number.
|
|
9241
|
+
*/
|
|
9242
|
+
this.businessPhoneNumber = null;
|
|
9243
|
+
/**
|
|
9244
|
+
* The physical address of the business.
|
|
9245
|
+
*/
|
|
9246
|
+
this.physicalAddress = null;
|
|
9247
|
+
/**
|
|
9248
|
+
* The mailing address of the business.
|
|
9249
|
+
*/
|
|
9250
|
+
this.mailingAddress = null;
|
|
9251
|
+
/**
|
|
9252
|
+
* The first name of the primary contact.
|
|
9253
|
+
*/
|
|
9254
|
+
this.contactFirstName = null;
|
|
9255
|
+
/**
|
|
9256
|
+
* The last name of the primary contact.
|
|
9257
|
+
*/
|
|
9258
|
+
this.contactLastName = null;
|
|
9259
|
+
/**
|
|
9260
|
+
* The phone number of the primary contact.
|
|
9261
|
+
*/
|
|
9262
|
+
this.contactPhoneNumber = null;
|
|
9263
|
+
/**
|
|
9264
|
+
* The email address of the primary contact.
|
|
9265
|
+
*/
|
|
9266
|
+
this.contactEmail = null;
|
|
9267
|
+
/**
|
|
9268
|
+
* The job title of the primary contact.
|
|
9269
|
+
*/
|
|
9270
|
+
this.contactTitle = null;
|
|
9271
|
+
/**
|
|
9272
|
+
* The tax identification number (SSN) of the primary contact.
|
|
9273
|
+
*/
|
|
9274
|
+
this.contactTaxIdNumber = null;
|
|
9275
|
+
/**
|
|
9276
|
+
* The date of birth of the primary contact.
|
|
9277
|
+
*/
|
|
9278
|
+
this.contactDOB = null;
|
|
9279
|
+
/**
|
|
9280
|
+
* The driver's license number of the primary contact.
|
|
9281
|
+
*/
|
|
9282
|
+
this.contactDlNumber = null;
|
|
9283
|
+
/**
|
|
9284
|
+
* The state that issued the primary contact's driver's license.
|
|
9285
|
+
*/
|
|
9286
|
+
this.contactDlStateOrProvince = null;
|
|
9287
|
+
/**
|
|
9288
|
+
* The expiration date of the primary contact's driver's license.
|
|
9289
|
+
*/
|
|
9290
|
+
this.contactDlExpiration = null;
|
|
9291
|
+
/**
|
|
9292
|
+
* The home address of the primary contact.
|
|
9293
|
+
*/
|
|
9294
|
+
this.contactHomeAddress = null;
|
|
9295
|
+
/**
|
|
9296
|
+
* The role of the primary contact in the business.
|
|
9297
|
+
*/
|
|
9298
|
+
this.contactRole = null;
|
|
9299
|
+
/**
|
|
9300
|
+
* List of individuals with 25% or more ownership in the company.
|
|
9301
|
+
*/
|
|
9302
|
+
this.owners = null;
|
|
9303
|
+
/**
|
|
9304
|
+
* The bank account information for the business.
|
|
9305
|
+
*/
|
|
9306
|
+
this.manualAccount = null;
|
|
9307
|
+
/**
|
|
9308
|
+
* The average transaction amount.
|
|
9309
|
+
*/
|
|
9310
|
+
this.averageTransaction = null;
|
|
9311
|
+
/**
|
|
9312
|
+
* The highest expected transaction amount.
|
|
9313
|
+
*/
|
|
9314
|
+
this.highTransaction = null;
|
|
9315
|
+
/**
|
|
9316
|
+
* The average monthly transaction volume.
|
|
9317
|
+
*/
|
|
9318
|
+
this.averageMonth = null;
|
|
9319
|
+
/**
|
|
9320
|
+
* The highest expected monthly transaction volume.
|
|
9321
|
+
*/
|
|
9322
|
+
this.highMonth = null;
|
|
9323
|
+
/**
|
|
9324
|
+
* The refund policy of the business.
|
|
9325
|
+
*/
|
|
9326
|
+
this.refundPolicy = null;
|
|
9327
|
+
/**
|
|
9328
|
+
* The number of days after purchase that refunds can be issued.
|
|
9329
|
+
*/
|
|
9330
|
+
this.refundDays = null;
|
|
9331
|
+
/**
|
|
9332
|
+
* The time zone of the business.
|
|
9333
|
+
*/
|
|
9334
|
+
this.timeZone = null;
|
|
9335
|
+
/**
|
|
9336
|
+
* The time when the daily batch should close.
|
|
9337
|
+
*/
|
|
9338
|
+
this.batchCloseTime = null;
|
|
9339
|
+
/**
|
|
9340
|
+
* Indicates if the business has multiple locations.
|
|
9341
|
+
*/
|
|
9342
|
+
this.multipleLocations = null;
|
|
9343
|
+
/**
|
|
9344
|
+
* The name of this specific business location.
|
|
9345
|
+
*/
|
|
9346
|
+
this.locationName = null;
|
|
9347
|
+
/**
|
|
9348
|
+
* The store number for this location.
|
|
9349
|
+
*/
|
|
9350
|
+
this.storeNumber = null;
|
|
9351
|
+
/**
|
|
9352
|
+
* Indicates if the business wants to accept EBT cards.
|
|
9353
|
+
*/
|
|
9354
|
+
this.ebtRequested = null;
|
|
9355
|
+
/**
|
|
9356
|
+
* The FNS number issued by the USDA for EBT processing.
|
|
9357
|
+
*/
|
|
9358
|
+
this.fnsNumber = null;
|
|
9359
|
+
/**
|
|
9360
|
+
* Indicates if the business plans to accept payments through a website.
|
|
9361
|
+
*/
|
|
9362
|
+
this.ecommerce = null;
|
|
9363
|
+
/**
|
|
9364
|
+
* Indicates if suppliers ship products directly to customers.
|
|
9365
|
+
*/
|
|
9366
|
+
this.dropShipping = null;
|
|
9367
|
+
/**
|
|
9368
|
+
* The percentage of transactions that will be chip or swipe.
|
|
9369
|
+
*/
|
|
9370
|
+
this.cardPresentPercentage = null;
|
|
9371
|
+
/**
|
|
9372
|
+
* The percentage of transactions that will be phone orders.
|
|
9373
|
+
*/
|
|
9374
|
+
this.phoneOrderPercentage = null;
|
|
9375
|
+
/**
|
|
9376
|
+
* The percentage of transactions that will be e-commerce.
|
|
9377
|
+
*/
|
|
9378
|
+
this.ecomPercentage = null;
|
|
9379
|
+
/**
|
|
9380
|
+
* The number of days before shipment that customers are charged.
|
|
9381
|
+
*/
|
|
9382
|
+
this.billBeforeShipmentDays = null;
|
|
9383
|
+
/**
|
|
9384
|
+
* Indicates if the business plans to process recurring payments.
|
|
9385
|
+
*/
|
|
9386
|
+
this.subscriptionsSupported = null;
|
|
9387
|
+
/**
|
|
9388
|
+
* The frequency of recurring payments (if applicable).
|
|
9389
|
+
*/
|
|
9390
|
+
this.subscriptionFrequency = null;
|
|
9391
|
+
/**
|
|
9392
|
+
* The full legal name of the person signing the application.
|
|
9393
|
+
*/
|
|
9394
|
+
this.signerName = null;
|
|
9395
|
+
this.inviteCode = inviteCode;
|
|
9396
|
+
this.dbaName = dbaName;
|
|
9397
|
+
this.corporateName = corporateName;
|
|
9398
|
+
this.webSite = webSite;
|
|
9399
|
+
this.taxIdNumber = taxIdNumber;
|
|
9400
|
+
this.entityType = entityType;
|
|
9401
|
+
this.stateOfIncorporation = stateOfIncorporation;
|
|
9402
|
+
this.merchantType = merchantType;
|
|
9403
|
+
this.businessDescription = businessDescription;
|
|
9404
|
+
this.yearsInBusiness = yearsInBusiness;
|
|
9405
|
+
this.businessPhoneNumber = businessPhoneNumber;
|
|
9406
|
+
this.physicalAddress = physicalAddress;
|
|
9407
|
+
this.mailingAddress = mailingAddress;
|
|
9408
|
+
this.contactFirstName = contactFirstName;
|
|
9409
|
+
this.contactLastName = contactLastName;
|
|
9410
|
+
this.contactPhoneNumber = contactPhoneNumber;
|
|
9411
|
+
this.contactEmail = contactEmail;
|
|
9412
|
+
this.contactTitle = contactTitle;
|
|
9413
|
+
this.contactTaxIdNumber = contactTaxIdNumber;
|
|
9414
|
+
this.contactDOB = contactDOB;
|
|
9415
|
+
this.contactDlNumber = contactDlNumber;
|
|
9416
|
+
this.contactDlStateOrProvince = contactDlStateOrProvince;
|
|
9417
|
+
this.contactDlExpiration = contactDlExpiration;
|
|
9418
|
+
this.contactHomeAddress = contactHomeAddress;
|
|
9419
|
+
this.contactRole = contactRole;
|
|
9420
|
+
this.owners = owners;
|
|
9421
|
+
this.manualAccount = manualAccount;
|
|
9422
|
+
this.averageTransaction = averageTransaction;
|
|
9423
|
+
this.highTransaction = highTransaction;
|
|
9424
|
+
this.averageMonth = averageMonth;
|
|
9425
|
+
this.highMonth = highMonth;
|
|
9426
|
+
this.refundPolicy = refundPolicy;
|
|
9427
|
+
this.refundDays = refundDays;
|
|
9428
|
+
this.timeZone = timeZone;
|
|
9429
|
+
this.batchCloseTime = batchCloseTime;
|
|
9430
|
+
this.multipleLocations = multipleLocations;
|
|
9431
|
+
this.locationName = locationName;
|
|
9432
|
+
this.storeNumber = storeNumber;
|
|
9433
|
+
this.ebtRequested = ebtRequested;
|
|
9434
|
+
this.fnsNumber = fnsNumber;
|
|
9435
|
+
this.ecommerce = ecommerce;
|
|
9436
|
+
this.dropShipping = dropShipping;
|
|
9437
|
+
this.cardPresentPercentage = cardPresentPercentage;
|
|
9438
|
+
this.phoneOrderPercentage = phoneOrderPercentage;
|
|
9439
|
+
this.ecomPercentage = ecomPercentage;
|
|
9440
|
+
this.billBeforeShipmentDays = billBeforeShipmentDays;
|
|
9441
|
+
this.subscriptionsSupported = subscriptionsSupported;
|
|
9442
|
+
this.subscriptionFrequency = subscriptionFrequency;
|
|
9443
|
+
this.signerName = signerName;
|
|
9444
|
+
}
|
|
9445
|
+
}
|
|
9446
|
+
exports.MerchantApplication = MerchantApplication;
|
|
9447
|
+
/**
|
|
9448
|
+
* Models a merchant application submission request to add a new merchant account.
|
|
9449
|
+
*/
|
|
9450
|
+
class SubmitApplicationRequest {
|
|
9451
|
+
// Constructor with default values for optional fields
|
|
9452
|
+
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) {
|
|
9453
|
+
/**
|
|
9454
|
+
* The request timeout in seconds.
|
|
9455
|
+
*/
|
|
9456
|
+
this.timeout = null;
|
|
9457
|
+
/**
|
|
9458
|
+
* Whether or not to route transaction to the test gateway.
|
|
9459
|
+
*/
|
|
9460
|
+
this.test = null;
|
|
9461
|
+
/**
|
|
9462
|
+
* The invite code for the merchant.
|
|
9463
|
+
*/
|
|
9464
|
+
this.inviteCode = null;
|
|
9465
|
+
/**
|
|
9466
|
+
* The business name your customers know you by (DBA Name).
|
|
9467
|
+
*/
|
|
9468
|
+
this.dbaName = null;
|
|
9469
|
+
/**
|
|
9470
|
+
* The name of the legal entity you file your taxes under.
|
|
9471
|
+
*/
|
|
9472
|
+
this.corporateName = null;
|
|
9473
|
+
/**
|
|
9474
|
+
* The business website.
|
|
9475
|
+
*/
|
|
9476
|
+
this.webSite = null;
|
|
9477
|
+
/**
|
|
9478
|
+
* The business tax identification number (EIN).
|
|
9479
|
+
*/
|
|
9480
|
+
this.taxIdNumber = null;
|
|
9481
|
+
/**
|
|
9482
|
+
* The type of business entity.
|
|
9483
|
+
*/
|
|
9484
|
+
this.entityType = null;
|
|
9485
|
+
/**
|
|
9486
|
+
* The state where the business is incorporated.
|
|
9487
|
+
*/
|
|
9488
|
+
this.stateOfIncorporation = null;
|
|
9489
|
+
/**
|
|
9490
|
+
* The primary type of business (e.g., Retail, Service, etc.).
|
|
9491
|
+
*/
|
|
9492
|
+
this.merchantType = null;
|
|
9493
|
+
/**
|
|
9494
|
+
* A short description of the products and services sold.
|
|
9495
|
+
*/
|
|
9496
|
+
this.businessDescription = null;
|
|
9497
|
+
/**
|
|
9498
|
+
* The number of years the business has been operating.
|
|
9499
|
+
*/
|
|
9500
|
+
this.yearsInBusiness = null;
|
|
9501
|
+
/**
|
|
9502
|
+
* The business telephone number.
|
|
9503
|
+
*/
|
|
9504
|
+
this.businessPhoneNumber = null;
|
|
9505
|
+
/**
|
|
9506
|
+
* The physical address of the business.
|
|
9507
|
+
*/
|
|
9508
|
+
this.physicalAddress = null;
|
|
9509
|
+
/**
|
|
9510
|
+
* The mailing address of the business.
|
|
9511
|
+
*/
|
|
9512
|
+
this.mailingAddress = null;
|
|
9513
|
+
/**
|
|
9514
|
+
* The first name of the primary contact.
|
|
9515
|
+
*/
|
|
9516
|
+
this.contactFirstName = null;
|
|
9517
|
+
/**
|
|
9518
|
+
* The last name of the primary contact.
|
|
9519
|
+
*/
|
|
9520
|
+
this.contactLastName = null;
|
|
9521
|
+
/**
|
|
9522
|
+
* The phone number of the primary contact.
|
|
9523
|
+
*/
|
|
9524
|
+
this.contactPhoneNumber = null;
|
|
9525
|
+
/**
|
|
9526
|
+
* The email address of the primary contact.
|
|
9527
|
+
*/
|
|
9528
|
+
this.contactEmail = null;
|
|
9529
|
+
/**
|
|
9530
|
+
* The job title of the primary contact.
|
|
9531
|
+
*/
|
|
9532
|
+
this.contactTitle = null;
|
|
9533
|
+
/**
|
|
9534
|
+
* The tax identification number (SSN) of the primary contact.
|
|
9535
|
+
*/
|
|
9536
|
+
this.contactTaxIdNumber = null;
|
|
9537
|
+
/**
|
|
9538
|
+
* The date of birth of the primary contact.
|
|
9539
|
+
*/
|
|
9540
|
+
this.contactDOB = null;
|
|
9541
|
+
/**
|
|
9542
|
+
* The driver's license number of the primary contact.
|
|
9543
|
+
*/
|
|
9544
|
+
this.contactDlNumber = null;
|
|
9545
|
+
/**
|
|
9546
|
+
* The state that issued the primary contact's driver's license.
|
|
9547
|
+
*/
|
|
9548
|
+
this.contactDlStateOrProvince = null;
|
|
9549
|
+
/**
|
|
9550
|
+
* The expiration date of the primary contact's driver's license.
|
|
9551
|
+
*/
|
|
9552
|
+
this.contactDlExpiration = null;
|
|
9553
|
+
/**
|
|
9554
|
+
* The home address of the primary contact.
|
|
9555
|
+
*/
|
|
9556
|
+
this.contactHomeAddress = null;
|
|
9557
|
+
/**
|
|
9558
|
+
* The role of the primary contact in the business.
|
|
9559
|
+
*/
|
|
9560
|
+
this.contactRole = null;
|
|
9561
|
+
/**
|
|
9562
|
+
* List of individuals with 25% or more ownership in the company.
|
|
9563
|
+
*/
|
|
9564
|
+
this.owners = null;
|
|
9565
|
+
/**
|
|
9566
|
+
* The bank account information for the business.
|
|
9567
|
+
*/
|
|
9568
|
+
this.manualAccount = null;
|
|
9569
|
+
/**
|
|
9570
|
+
* The average transaction amount.
|
|
9571
|
+
*/
|
|
9572
|
+
this.averageTransaction = null;
|
|
9573
|
+
/**
|
|
9574
|
+
* The highest expected transaction amount.
|
|
9575
|
+
*/
|
|
9576
|
+
this.highTransaction = null;
|
|
9577
|
+
/**
|
|
9578
|
+
* The average monthly transaction volume.
|
|
9579
|
+
*/
|
|
9580
|
+
this.averageMonth = null;
|
|
9581
|
+
/**
|
|
9582
|
+
* The highest expected monthly transaction volume.
|
|
9583
|
+
*/
|
|
9584
|
+
this.highMonth = null;
|
|
9585
|
+
/**
|
|
9586
|
+
* The refund policy of the business.
|
|
9587
|
+
*/
|
|
9588
|
+
this.refundPolicy = null;
|
|
9589
|
+
/**
|
|
9590
|
+
* The number of days after purchase that refunds can be issued.
|
|
9591
|
+
*/
|
|
9592
|
+
this.refundDays = null;
|
|
9593
|
+
/**
|
|
9594
|
+
* The time zone of the business.
|
|
9595
|
+
*/
|
|
9596
|
+
this.timeZone = null;
|
|
9597
|
+
/**
|
|
9598
|
+
* The time when the daily batch should close.
|
|
9599
|
+
*/
|
|
9600
|
+
this.batchCloseTime = null;
|
|
9601
|
+
/**
|
|
9602
|
+
* Indicates if the business has multiple locations.
|
|
9603
|
+
*/
|
|
9604
|
+
this.multipleLocations = null;
|
|
9605
|
+
/**
|
|
9606
|
+
* The name of this specific business location.
|
|
9607
|
+
*/
|
|
9608
|
+
this.locationName = null;
|
|
9609
|
+
/**
|
|
9610
|
+
* The store number for this location.
|
|
9611
|
+
*/
|
|
9612
|
+
this.storeNumber = null;
|
|
9613
|
+
/**
|
|
9614
|
+
* Indicates if the business wants to accept EBT cards.
|
|
9615
|
+
*/
|
|
9616
|
+
this.ebtRequested = null;
|
|
9617
|
+
/**
|
|
9618
|
+
* The FNS number issued by the USDA for EBT processing.
|
|
9619
|
+
*/
|
|
9620
|
+
this.fnsNumber = null;
|
|
9621
|
+
/**
|
|
9622
|
+
* Indicates if the business plans to accept payments through a website.
|
|
9623
|
+
*/
|
|
9624
|
+
this.ecommerce = null;
|
|
9625
|
+
/**
|
|
9626
|
+
* Indicates if suppliers ship products directly to customers.
|
|
9627
|
+
*/
|
|
9628
|
+
this.dropShipping = null;
|
|
9629
|
+
/**
|
|
9630
|
+
* The percentage of transactions that will be chip or swipe.
|
|
9631
|
+
*/
|
|
9632
|
+
this.cardPresentPercentage = null;
|
|
9633
|
+
/**
|
|
9634
|
+
* The percentage of transactions that will be phone orders.
|
|
9635
|
+
*/
|
|
9636
|
+
this.phoneOrderPercentage = null;
|
|
9637
|
+
/**
|
|
9638
|
+
* The percentage of transactions that will be e-commerce.
|
|
9639
|
+
*/
|
|
9640
|
+
this.ecomPercentage = null;
|
|
9641
|
+
/**
|
|
9642
|
+
* The number of days before shipment that customers are charged.
|
|
9643
|
+
*/
|
|
9644
|
+
this.billBeforeShipmentDays = null;
|
|
9645
|
+
/**
|
|
9646
|
+
* Indicates if the business plans to process recurring payments.
|
|
9647
|
+
*/
|
|
9648
|
+
this.subscriptionsSupported = null;
|
|
9649
|
+
/**
|
|
9650
|
+
* The frequency of recurring payments (if applicable).
|
|
9651
|
+
*/
|
|
9652
|
+
this.subscriptionFrequency = null;
|
|
9653
|
+
/**
|
|
9654
|
+
* The full legal name of the person signing the application.
|
|
9655
|
+
*/
|
|
9656
|
+
this.signerName = null;
|
|
9657
|
+
this.timeout = timeout;
|
|
9658
|
+
this.test = test;
|
|
9659
|
+
this.inviteCode = inviteCode;
|
|
9660
|
+
this.dbaName = dbaName;
|
|
9661
|
+
this.corporateName = corporateName;
|
|
9662
|
+
this.webSite = webSite;
|
|
9663
|
+
this.taxIdNumber = taxIdNumber;
|
|
9664
|
+
this.entityType = entityType;
|
|
9665
|
+
this.stateOfIncorporation = stateOfIncorporation;
|
|
9666
|
+
this.merchantType = merchantType;
|
|
9667
|
+
this.businessDescription = businessDescription;
|
|
9668
|
+
this.yearsInBusiness = yearsInBusiness;
|
|
9669
|
+
this.businessPhoneNumber = businessPhoneNumber;
|
|
9670
|
+
this.physicalAddress = physicalAddress;
|
|
9671
|
+
this.mailingAddress = mailingAddress;
|
|
9672
|
+
this.contactFirstName = contactFirstName;
|
|
9673
|
+
this.contactLastName = contactLastName;
|
|
9674
|
+
this.contactPhoneNumber = contactPhoneNumber;
|
|
9675
|
+
this.contactEmail = contactEmail;
|
|
9676
|
+
this.contactTitle = contactTitle;
|
|
9677
|
+
this.contactTaxIdNumber = contactTaxIdNumber;
|
|
9678
|
+
this.contactDOB = contactDOB;
|
|
9679
|
+
this.contactDlNumber = contactDlNumber;
|
|
9680
|
+
this.contactDlStateOrProvince = contactDlStateOrProvince;
|
|
9681
|
+
this.contactDlExpiration = contactDlExpiration;
|
|
9682
|
+
this.contactHomeAddress = contactHomeAddress;
|
|
9683
|
+
this.contactRole = contactRole;
|
|
9684
|
+
this.owners = owners;
|
|
9685
|
+
this.manualAccount = manualAccount;
|
|
9686
|
+
this.averageTransaction = averageTransaction;
|
|
9687
|
+
this.highTransaction = highTransaction;
|
|
9688
|
+
this.averageMonth = averageMonth;
|
|
9689
|
+
this.highMonth = highMonth;
|
|
9690
|
+
this.refundPolicy = refundPolicy;
|
|
9691
|
+
this.refundDays = refundDays;
|
|
9692
|
+
this.timeZone = timeZone;
|
|
9693
|
+
this.batchCloseTime = batchCloseTime;
|
|
9694
|
+
this.multipleLocations = multipleLocations;
|
|
9695
|
+
this.locationName = locationName;
|
|
9696
|
+
this.storeNumber = storeNumber;
|
|
9697
|
+
this.ebtRequested = ebtRequested;
|
|
9698
|
+
this.fnsNumber = fnsNumber;
|
|
9699
|
+
this.ecommerce = ecommerce;
|
|
9700
|
+
this.dropShipping = dropShipping;
|
|
9701
|
+
this.cardPresentPercentage = cardPresentPercentage;
|
|
9702
|
+
this.phoneOrderPercentage = phoneOrderPercentage;
|
|
9703
|
+
this.ecomPercentage = ecomPercentage;
|
|
9704
|
+
this.billBeforeShipmentDays = billBeforeShipmentDays;
|
|
9705
|
+
this.subscriptionsSupported = subscriptionsSupported;
|
|
9706
|
+
this.subscriptionFrequency = subscriptionFrequency;
|
|
9707
|
+
this.signerName = signerName;
|
|
9708
|
+
}
|
|
9709
|
+
}
|
|
9710
|
+
exports.SubmitApplicationRequest = SubmitApplicationRequest;
|
|
9711
|
+
/**
|
|
9712
|
+
* A request for customer signature data.
|
|
9713
|
+
*/
|
|
9714
|
+
class TerminalCaptureSignatureRequest {
|
|
9715
|
+
constructor(APICredentials, request) {
|
|
9716
|
+
this.APICredentials = APICredentials;
|
|
9717
|
+
this.request = request;
|
|
9718
|
+
}
|
|
9719
|
+
}
|
|
9720
|
+
exports.TerminalCaptureSignatureRequest = TerminalCaptureSignatureRequest;
|
|
9721
|
+
/**
|
|
9722
|
+
* Information needed to test connectivity with a terminal.
|
|
9723
|
+
*/
|
|
9724
|
+
class TerminalPingRequest {
|
|
9725
|
+
constructor(APICredentials, request) {
|
|
9726
|
+
this.APICredentials = APICredentials;
|
|
9727
|
+
this.request = request;
|
|
9728
|
+
}
|
|
8804
9729
|
}
|
|
8805
9730
|
exports.TerminalPingRequest = TerminalPingRequest;
|
|
8806
9731
|
/**
|
|
@@ -8853,6 +9778,16 @@ class TerminalAuthorizationRequest {
|
|
|
8853
9778
|
}
|
|
8854
9779
|
}
|
|
8855
9780
|
exports.TerminalAuthorizationRequest = TerminalAuthorizationRequest;
|
|
9781
|
+
/**
|
|
9782
|
+
* Retrieves card metadata.
|
|
9783
|
+
*/
|
|
9784
|
+
class TerminalCardMetadataRequest {
|
|
9785
|
+
constructor(APICredentials, request) {
|
|
9786
|
+
this.APICredentials = APICredentials;
|
|
9787
|
+
this.request = request;
|
|
9788
|
+
}
|
|
9789
|
+
}
|
|
9790
|
+
exports.TerminalCardMetadataRequest = TerminalCardMetadataRequest;
|
|
8856
9791
|
/**
|
|
8857
9792
|
* A request for the remaining balance on a payment type.
|
|
8858
9793
|
*/
|