@blockchyp/blockchyp-ts 2.28.1 → 2.30.0

package/README.md

@@ -70,6 +70,46 @@ These are the core payment APIs used to execute and work with payment transactio
 
 
 
+#### Surcharge Review
+
+
+
+* **API Credential Types:** Merchant
+* **Required Role:** Payment API Access
+
+This API calculates surcharge information for a payment request.
+
+If you're using BlockChyp's surcharging features, you can use this endpoint
+to preview the surcharge amounts before processing a transaction. This allows
+you to display accurate pricing information to customers before completing
+the payment.
+
+
+
+
+```typescript
+import * as BlockChyp from '@blockchyp/blockchyp-ts';
+
+const client = BlockChyp.newClient({
+  apiKey: 'ZDSMMZLGRPBPRTJUBTAFBYZ33Q',
+  bearerToken: 'ZLBW5NR4U5PKD5PNP3ZP3OZS5U',
+  signingKey: '9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947'
+});
+
+const request = new BlockChyp.PricingRequest();
+
+
+client.surchargeReview(request)
+.then(function(httpResponse) {
+    const response: BlockChyp.PricingResponse = httpResponse.data;
+    console.log('Response: ' + JSON.stringify(response));
+  })
+  .catch(function (error: any) {
+    console.log(error);
+  });
+
+```
+
 #### Charge
 
 

package/_bundles/blockchyp.js

@@ -29597,6 +29597,12 @@ class BlockChypClient {
     locate(request) {
         return this._gatewayRequest('post', '/api/terminal-locate', request);
     }
+    /**
+     * Calculates surcharge information for a payment request.
+     */
+    surchargeReview(request) {
+        return this._gatewayRequest('post', '/api/surcharge-review', request);
+    }
     /**
      * Captures a preauthorization.
      */
@@ -30367,7 +30373,8 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 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.UpdateTokenResponse = exports.UpdateTokenRequest = 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;
 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 = exports.TransactionDisplayItem = exports.TransactionDisplayDiscount = void 0;
 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 = exports.MerchantPlatform = exports.UpdateMerchantPlatformResponse = void 0;
-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 = exports.PartnerCommissionBreakdownResponse = exports.PartnerCommissionBreakdownRequest = void 0;
+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.PricingResponse = exports.ErrorType = exports.PricingResponseData = exports.PricingResponseAttributes = exports.PricingRequest = exports.PricingRequestData = exports.PricingRequestAttributes = exports.PricingMerchantSettings = exports.StateCheckSettings = exports.SubmitApplicationRequest = exports.MerchantApplication = exports.ApplicationAccount = exports.Owner = exports.AggregateBillingLineItemStats = exports.AggregateBillingLineItem = exports.BuyRateLineItem = exports.MerchantCredentialGenerationResponse = exports.MerchantCredentialGenerationRequest = exports.PartnerCommissionBreakdownResponse = exports.PartnerCommissionBreakdownRequest = void 0;
+exports.CoreResponse = exports.PreviousTransaction = exports.Subtotals = exports.RequestAmount = void 0;
 // CardType is used to differentiate credit, debit, and EBT.
 var CardType;
 (function (CardType) {
@@ -31515,7 +31522,7 @@ exports.WhiteListedCard = WhiteListedCard;
  */
 class AuthorizationRequest {
     // Constructor with default values for optional fields
-    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, country = 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, shippingAmount = undefined, processorId = undefined, externalCustomerId = undefined) {
+    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, country = 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, totalDiscountAmount = undefined, shippingAmount = undefined, dutyAmount = undefined, processorId = undefined, externalCustomerId = undefined, destinationCountryCode = undefined, shipFromPostalCode = undefined, shipToPostalCode = undefined, orderDate = undefined) {
         /**
          * The request timeout in seconds.
          */
@@ -31642,9 +31649,15 @@ class AuthorizationRequest {
         this.healthcareTotal = healthcareTotal;
         this.ebtTotal = ebtTotal;
         this.cardMetadataLookup = cardMetadataLookup;
+        this.totalDiscountAmount = totalDiscountAmount;
         this.shippingAmount = shippingAmount;
+        this.dutyAmount = dutyAmount;
         this.processorId = processorId;
         this.externalCustomerId = externalCustomerId;
+        this.destinationCountryCode = destinationCountryCode;
+        this.shipFromPostalCode = shipFromPostalCode;
+        this.shipToPostalCode = shipToPostalCode;
+        this.orderDate = orderDate;
     }
 }
 exports.AuthorizationRequest = AuthorizationRequest;
@@ -32109,7 +32122,7 @@ exports.RefundRequest = RefundRequest;
  */
 class CaptureRequest {
     // Constructor with default values for optional fields
-    constructor(timeout = null, test = null, transactionRef = undefined, autogeneratedRef = null, async = null, queue = null, waitForRemovedCard = false, force = false, orderRef = undefined, destinationAccount = undefined, testCase = undefined, transactionId = null, currencyCode = null, amount = null, taxExempt = null, surcharge = null, cashDiscount = null, tipAmount = undefined, taxAmount = undefined, shipmentCount = null, shipmentNumber = null) {
+    constructor(timeout = null, test = null, transactionRef = undefined, autogeneratedRef = null, async = null, queue = null, waitForRemovedCard = false, force = false, orderRef = undefined, destinationAccount = undefined, testCase = undefined, transactionId = null, currencyCode = null, amount = null, taxExempt = null, surcharge = null, cashDiscount = null, tipAmount = undefined, taxAmount = undefined, shipmentCount = null, shipmentNumber = null, passthroughSurcharge = undefined) {
         /**
          * The request timeout in seconds.
          */
@@ -32187,6 +32200,7 @@ class CaptureRequest {
         this.taxAmount = taxAmount;
         this.shipmentCount = shipmentCount;
         this.shipmentNumber = shipmentNumber;
+        this.passthroughSurcharge = passthroughSurcharge;
     }
 }
 exports.CaptureRequest = CaptureRequest;
@@ -33618,7 +33632,7 @@ exports.TransactionDisplayDiscount = TransactionDisplayDiscount;
  */
 class TransactionDisplayItem {
     // Constructor with default values for optional fields
-    constructor(id = null, description = null, price = null, quantity = null, extended = null, unitCode = null, commodityCode = null, productCode = null, discounts = null) {
+    constructor(id = null, description = null, price = null, quantity = null, extended = null, unitCode = null, commodityCode = null, productCode = null, discounts = null, taxAmount = undefined, taxRate = undefined, discountCode = undefined) {
         /**
          * A unique value identifying the item. This is not required, but recommended since it is
          * required to update or delete line items.
@@ -33667,6 +33681,9 @@ class TransactionDisplayItem {
         this.commodityCode = commodityCode;
         this.productCode = productCode;
         this.discounts = discounts;
+        this.taxAmount = taxAmount;
+        this.taxRate = taxRate;
+        this.discountCode = discountCode;
     }
 }
 exports.TransactionDisplayItem = TransactionDisplayItem;
@@ -40366,6 +40383,261 @@ class SubmitApplicationRequest {
     }
 }
 exports.SubmitApplicationRequest = SubmitApplicationRequest;
+/**
+ * Models settings related to state checks for a merchant.
+ */
+class StateCheckSettings {
+    // Constructor with default values for optional fields
+    constructor(enabled = null, surchargeExemptStates = null) {
+        /**
+         * If state checks are enabled for the merchant.
+         */
+        this.enabled = null;
+        /**
+         * The list of states that are exempt from surcharges.
+         */
+        this.surchargeExemptStates = null;
+        this.enabled = enabled;
+        this.surchargeExemptStates = surchargeExemptStates;
+    }
+}
+exports.StateCheckSettings = StateCheckSettings;
+/**
+ * Models merchant settings and configuration.
+ */
+class PricingMerchantSettings {
+    // Constructor with default values for optional fields
+    constructor(account = null, gateway = null, surchargingEnabled = null, customSurchargePercent = 0, reducedRate = false, inversePricingEnabled = false, creditDiscountRate = 0, acquiringSolution = null, acceptDebit = false, stateCheckSettings = undefined) {
+        /**
+         * The merchant account identifier.
+         */
+        this.account = null;
+        /**
+         * The gateway identifier.
+         */
+        this.gateway = null;
+        /**
+         * Whether surcharging is enabled for the merchant.
+         */
+        this.surchargingEnabled = null;
+        /**
+         * The acquiring solution identifier.
+         */
+        this.acquiringSolution = null;
+        this.account = account;
+        this.gateway = gateway;
+        this.surchargingEnabled = surchargingEnabled;
+        this.customSurchargePercent = customSurchargePercent;
+        this.reducedRate = reducedRate;
+        this.inversePricingEnabled = inversePricingEnabled;
+        this.creditDiscountRate = creditDiscountRate;
+        this.acquiringSolution = acquiringSolution;
+        this.acceptDebit = acceptDebit;
+        this.stateCheckSettings = stateCheckSettings;
+    }
+}
+exports.PricingMerchantSettings = PricingMerchantSettings;
+/**
+ * Models the attributes for a pricing request.
+ */
+class PricingRequestAttributes {
+    // Constructor with default values for optional fields
+    constructor(cardNumber = undefined, token = null, merchantIdentifier = undefined, amount = null, country = undefined, postalCode = undefined, state = undefined, merchantSettings = undefined) {
+        /**
+         * The payment token.
+         */
+        this.token = null;
+        /**
+         * The transaction amount.
+         */
+        this.amount = null;
+        this.cardNumber = cardNumber;
+        this.token = token;
+        this.merchantIdentifier = merchantIdentifier;
+        this.amount = amount;
+        this.country = country;
+        this.postalCode = postalCode;
+        this.state = state;
+        this.merchantSettings = merchantSettings;
+    }
+}
+exports.PricingRequestAttributes = PricingRequestAttributes;
+/**
+ * Models the data wrapper for a pricing request.
+ */
+class PricingRequestData {
+    // Constructor with default values for optional fields
+    constructor(type = null, attributes = null) {
+        /**
+         * The type of the request.
+         */
+        this.type = null;
+        /**
+         * The pricing request attributes.
+         */
+        this.attributes = null;
+        this.type = type;
+        this.attributes = attributes;
+    }
+}
+exports.PricingRequestData = PricingRequestData;
+/**
+ * Models a pricing request.
+ */
+class PricingRequest {
+    // Constructor with default values for optional fields
+    constructor(timeout = null, test = null, data = null) {
+        /**
+         * The request timeout in seconds.
+         */
+        this.timeout = null;
+        /**
+         * Whether or not to route transaction to the test gateway.
+         */
+        this.test = null;
+        /**
+         * The pricing request data.
+         */
+        this.data = null;
+        this.timeout = timeout;
+        this.test = test;
+        this.data = data;
+    }
+}
+exports.PricingRequest = PricingRequest;
+/**
+ * Models pricing response data for new handler for pricing api responses.
+ */
+class PricingResponseAttributes {
+    // Constructor with default values for optional fields
+    constructor(surchargePercent = null, surchargeAmount = null, surchargeExempt = null, cardType = null, cardToken = undefined, brand = null, bin = null, commercialIndicator = null, disclosure = undefined, debitCategory = null, countryIssued = null, uuid = null) {
+        /**
+         * The surcharge percentage.
+         */
+        this.surchargePercent = null;
+        /**
+         * The surcharge amount.
+         */
+        this.surchargeAmount = null;
+        /**
+         * If the transaction is exempt from surcharges.
+         */
+        this.surchargeExempt = null;
+        /**
+         * The type of card.
+         */
+        this.cardType = null;
+        /**
+         * The card brand.
+         */
+        this.brand = null;
+        /**
+         * The bank identification number.
+         */
+        this.bin = null;
+        /**
+         * The commercial card indicator.
+         */
+        this.commercialIndicator = null;
+        /**
+         * The debit card category.
+         */
+        this.debitCategory = null;
+        /**
+         * The country where the card was issued.
+         */
+        this.countryIssued = null;
+        /**
+         * The unique identifier for the pricing response.
+         */
+        this.uuid = null;
+        this.surchargePercent = surchargePercent;
+        this.surchargeAmount = surchargeAmount;
+        this.surchargeExempt = surchargeExempt;
+        this.cardType = cardType;
+        this.cardToken = cardToken;
+        this.brand = brand;
+        this.bin = bin;
+        this.commercialIndicator = commercialIndicator;
+        this.disclosure = disclosure;
+        this.debitCategory = debitCategory;
+        this.countryIssued = countryIssued;
+        this.uuid = uuid;
+    }
+}
+exports.PricingResponseAttributes = PricingResponseAttributes;
+/**
+ * Models the data wrapper for a pricing response.
+ */
+class PricingResponseData {
+    // Constructor with default values for optional fields
+    constructor(type = null, attributes = null) {
+        /**
+         * The type of the response.
+         */
+        this.type = null;
+        /**
+         * The pricing response attributes.
+         */
+        this.attributes = null;
+        this.type = type;
+        this.attributes = attributes;
+    }
+}
+exports.PricingResponseData = PricingResponseData;
+/**
+ * Models an error response.
+ */
+class ErrorType {
+    // Constructor with default values for optional fields
+    constructor(status = null, title = null, detail = null) {
+        /**
+         * The HTTP status code.
+         */
+        this.status = null;
+        /**
+         * The error title.
+         */
+        this.title = null;
+        /**
+         * The detailed error message.
+         */
+        this.detail = null;
+        this.status = status;
+        this.title = title;
+        this.detail = detail;
+    }
+}
+exports.ErrorType = ErrorType;
+/**
+ * Models a pricing response.
+ */
+class PricingResponse {
+    // Constructor with default values for optional fields
+    constructor(success = null, error = null, responseDescription = null, data = null) {
+        /**
+         * Whether or not the request succeeded.
+         */
+        this.success = null;
+        /**
+         * The error, if an error occurred.
+         */
+        this.error = null;
+        /**
+         * A narrative description of the transaction result.
+         */
+        this.responseDescription = null;
+        /**
+         * The pricing response data.
+         */
+        this.data = null;
+        this.success = success;
+        this.error = error;
+        this.responseDescription = responseDescription;
+        this.data = data;
+    }
+}
+exports.PricingResponse = PricingResponse;
 /**
  * A request for customer signature data.
  */