Automated Merchant Onboarding solution offers a lightweight and efficient way of adding new merchants while ensuring good user experience. With streamlined onboarding and automated payment processing, businesses can quickly and efficiently integrate new merchants. This solution eliminates the need for complex development or manual paperwork, ensuring a hassle-free onboarding process.

For more information on the Automated Merchant Onboarding solution, refer to the following articles:

• Prerequisites

• Working with Automated Merchant Onboarding

• Merchant Onboarding Status Webhooks

• Configuring Automated Merchant Onboarding

To begin with Automated Merchant Onboarding, you must complete an account setup and integration with the system. This includes:

1. Gaining access to the test environment.

2. Configuring specific settings with the help of a support team.

3. Providing key URLs to ensure smooth communication and updates throughout the process.

Our Solutions

Explore our suite of cutting-edge solutions designed to help you integrate, grow, and scale your business with ease. Whether you are a software provider or a merchant, our solutions empower you to accept and manage payments seamlessly while maintaining compliance and security.

Our Layered Approach to Security

Securing your business and customer data is our top priority. Our multi-layered security approach protects transactions from evolving threats while ensuring compliance with industry standards.

Integrating with our platform is a structured, phased journey designed to ensure a seamless experience from planning to production launch. The process is divided into four key phases, each focused on guiding you through specific integration aspects with the support of our dedicated teams.

Integration Journey

JavaScript SDK solution allows you to integrate payments into your website seamlessly. The payment frame ensures adherence to . The payment frame is responsive, allowing you to style content using the host page.

For more information on JavaScript SDK solution, refer to the following articles:

The merchant onboarding process through the API begins with creating a merchant profile. This step involves two key actions:

{
  "hierarchyNodeKey": "1234567800000001",
  "dbaName": "Jane's Sandwiches"
}

For a detailed breakdown of the request and response fields and their descriptions, refer to the reference documentation of Create Merchant Application endpoint.

Working with Automated Merchant Onboarding involves:

• Generating a Merchant Application

• Completing the Application

• Modifying Default Merchant Pricing

The following sample code shows a successful transaction response for a basic sale:

{
   "code":"200",
   "status":"success",
   "exchange-id":"ID-CLADEVGSOPS02-cgw01-58790-1447188033740-0-1146",
   "links":[
      {
         "rel":"transaction",
         "href":"/rest/v2/transactions?id=1107313",
         "id":"1107313"
      }
           ],
   "payload":{
      "transaction":{
         "amount":"3.33",
         "id":"1107313",
         "type":"SALE",
         "result":"APPROVED",
         "card":"XXXXXXXXXXXX1111",
         "csc":"999",
         "authorization-code":"TAS425",
         "batch-string-id":"165",
         "display-message":"Transaction approved",
         "result-code":"000",
         "exp-date":"1020"
                      },
   "payloadType":"transaction"
             },
   "signature":"30
   }

Automated Merchant Onboarding offers flexible pricing options, enabling software partners to modify predefined pricing structures to match their business needs and sales strategies. Instead of using a static pricing model, software partners can retrieve existing pricing templates, modify fees, and apply customized pricing plans at the merchant level.

For more information on modifying default merchant pricing, refer to the following articles:

• Retrieving Existing Pricing Templates

• Modify Pricing Fees and Completing Merchant Application Record

The payment transaction requires expiration date unless you store or provide card tokens to the cardholders.

Credit card expiration date is validated by:

• Using expiration date field values, excluding non-numeric characters.

• Entering the values in four-digits format: two-digit month and two-digit year (MMYY).

Before integrating the iOS framework, ensure the following requirements are met:

• IDTech.xcframework (version 1.1.166.019)

• IDTech.bundle (responsible for translating error codes to messages)

• CocoaLumberJack xcframework

• Firmware VP3300 Bluetooth NEO v1.01.206

To read the card data on the VP3300 card reader when you request a payment through your iOS app on a phone or tablet:

1. Press the power button to turn on the card reader.

The Bluetooth settings will turn on and pair automatically with your iOS device. For more information, see Pairing the card reader with an iOS device.

1. Insert the card into the card slot of the reader.

1. Insert the card and wait until the middle LED on the back of the card reader flashes green for two seconds.

For more information, see Card Validations.

Xplor Pay collects and validates all the required information to process transactions for the merchant account. This includes the following steps:

• Gathering merchant demographics

• Configuring pricing

• Setting up and ordering equipment

Once your application is signed, it's time to submit it for processing. By calling the ‘Submit Application’, a merchant can finalize the application and send it to Xplor Pay. At this stage, your merchant application is directed to one of our internal teams who will take care of any necessary setup, such as:

• Underwriting: Xplor Pay reviews the merchant application to assess compliance and manage risk.

• Equipment Activation: Xplor Pay prepares the configured equipment, ensuring it’s ready for immediate use.

This step transitions the merchant from onboarding to operational readiness.

Once the necessary evaluations are complete, the merchant is fully onboarded. Xplor Pay ensures a smooth transition, enabling merchants to start processing payments without delays.

For a detailed breakdown of the request and response fields and their descriptions, refer to the reference documentation of Submit Application endpoint.

Before you start using JavaScript SDK solution, ensure you meet the following prerequisites:

• Use HTTPS for your website.

• Host the JavaScript SDK page on a web server.

• When using the VP8300 USB Card Reader, plug it into a USB port that supports USB 2.0 or later.

• Do not publish your public Key outside of your code.

• See the JavaScript SDK - Browser Support for more information.

By default, payment transactions require security codes (CSC, CID, CVC, CVV, CVV2).

Credit card security codes are validated by:

• Using CSC/CVC field values, excluding non-numeric characters.

JavaScript SDK solution only work with latest versions of:

• Chrome

• Firefox

• Edge

• Safari

Hosted Payments solution only work with latest versions of:

• Chrome

• Firefox

• Edge

• Safari

Merchant Onboarding

Easily onboard merchants with flexible options.

Payment Processing

Support various business models and payment methods, including card-present, card-not-present, and ACH transactions.

Financial Management

Optimize business finances with tools for transparency, control, and efficiency.

Reporting & Maintenance

Gain data insights and manage issues efficiently.

Partner & Merchant Solutions

Empower partners and merchants with tools to streamline management and track performance.

Security

Our multi-layered security approach helps businesses maintain trust and protect sensitive information at every stage of the payment process.

To configure payment page with an optional billing address and headline text:

<script>
        Clearent.setProperty("heading-text", "Complete payment details below");
        Clearent.setProperty("show-billing-address", true);
        Clearent.payButton({"amount": "64.50"});
</script>

This document outlines the steps for integrating merchant onboarding. The following image and step-by-step guides provide a detailed process for integration.

For more information on each integration step, refer to the articles below:

• Creating a Merchant Profile

• Completing the Merchant Application

• Submitting the Signature

• Submitting the Application

ID TECH provides versatile and secure payment readers designed for businesses that require reliable, multi-interface transaction solutions. Below is an overview of two ID TECH models: VP8300 and VP3300.

ID TECH VP8300 READER

The ID TECH VP8300 is a secure, all-in-one countertop card reader designed for retail, hospitality, and other merchant environments.

Additional Resources:

ID TECH VP3300 READER

The ID TECH VP3300 is a compact, versatile payment reader designed to accept multiple payment methods, including magnetic stripe (MagStripe), EMV chip cards, and NFC/contactless transactions such as Apple Pay and Google Pay.

Additional Resources:

To modify merchant pricing, you must first retrieve the available pricing templates from the Automated Merchant Onboarding system. These templates define different pricing structures, which can be assigned to merchants based on their business model and service requirements.

The API () enables integrators to fetch a list of available pricing templates associated with a merchant, which can be used as a base for further modifications.

This includes the following steps:

Hierarchy and Compensation Details ensures that the merchant is correctly classified within the organization and compensation preferences are set.

The Partner Portal simplifies merchant onboarding with a structured, step-by-step approach, ensuring accuracy, compliance, and efficiency. Below is a breakdown of the Merchant Onboarding Process, guiding partners from application submission to final approval.

The following articles detail the steps for successfully onboarding merchants through the Partner Portal:

Integrate the hosted payments solution into your website to securely accept online payments. Copy and paste a few lines of code to add customizable payment options to your existing site.

Integrating the hosted payments solution, you can:

• Customize payment pages, forms, and buttons.

• Style payment pages with custom colors, text, brand logos, images, and checkout options.

• Collect information such as invoice or order numbers for online payment reconciliation.

The following articles show you how to integrate hosted payments into your website:

Before you start using , ensure you meet the following prerequisites.

Required Information

To begin the onboarding process via API, merchants need two key elements:

• Secret Access Key: A unique key provided by Xplor Pay to securely authenticate API requests.

• Unique Merchant Identifier (MID): The ID associated with the merchant application, unique for each merchant and environment.

Available Environments

Below are two environments that support merchant onboarding:

• Sandbox: A secure testing environment for development and integration before going live.

• Production: The live environment for processing real-world transactions once the merchant has successfully completed the onboarding process.

For more information, refer to the following article:

Key Features

Onboarding API empowers merchants with programmatic control over the entire onboarding journey. Its key features include:

• Secure Access: All API requests are authenticated using the Secret Access Key and MID, ensuring robust security throughout the onboarding process.

• Multiple Endpoints: Dedicated endpoints are available for each stage of the onboarding process, enabling precise control over the data provided and allowing merchants to tailor their onboarding experience to specific needs.

The following example is failed transaction response:

Follow the below steps to add the payment form into your website using JavaScript SDK solution:

After into your website, the cardholders can enter the payment information using the form.

JavaScript SDK payment frame allows you to format the content using the style attributes when you call the ClearentSDK.init() method.

The following code sample generates a form where the input fields display blue text by default, and the text changes to purple when the field is selected for input:

Example code:

The following error will be displayed when you set an external resource or data/blob content in the style attributes during formatting the content.

The iOS framework uses the IDTech iOS framework to read credit card data with the mobile card reader.

The following articles explain how to integrate the iOS framework into your app:

The following example is an unauthorized request response for invalid, disabled, or expired key is used during payment process. Also, if the payment transaction was not attempted and no transaction data is included in the error response.

Before you integrate hosted payments, make sure you meet the following prerequisites:

• Use HTTPS for your website.

• Do not publish the public key outside of your code.

• Provide the domain that sends transaction requests in the production environment using our portal.

• See the for more information.

The Equipment section allows users to order and manage the necessary equipment for payment processing. Merchants can request equipment, track existing orders, and update their selections as needed. This step ensures that the merchant has the required hardware to support their payment transactions.

Working with JavaScript SDK involves:

The following example is successful token request response:

The Automated Merchant Onboarding solution allows software partners to track their merchants' application progress using Application Status webhooks. By subscribing to these webhooks, integrators receive updates on any changes to a merchant’s application status. This eliminates the need for manual follow-ups and provides a seamless, automated tracking system.

For more information on merchant onboarding status webhooks, refer to the following document:

We implement the following basic client-side validations with the best security practices on the Xplor Pay servers to improve user experience and reduce errors. These validations prevent attempting the use of your website as a validator for stolen credit cards:

To integrate the iOS framework into your app:

is designed to simplify and streamline the onboarding process for new merchants seeking credit card processing services. It is a RESTful API that utilizes secure HTTPS communication, ensuring reliable and secure data exchange for payment processing.

For more information on the Merchant Onboarding API solution, refer to the following articles:

The following settings are optional and won’t affect your iOS app:

• Set the Allow Non-modular Includes in Framework Modules setting to Yes for your Objective-C and Swift iOS app.

• Add the -Xcc -Wno-error=non-modular-include-in-framework-module to the Other Swift Flags setting for your Swift iOS app:

The Mobile EMV SDK integration supports the IDTech mobile card reader, which offers:

• Bluetooth connectivity

• Audio jack connectivity

• P2PE technology

• EMV

The Signature Submission step is a crucial part of the merchant onboarding process in the Partner Portal. This step ensures that all necessary contacts and authorized signers are recorded for compliance and verification purposes.

To charge the VP3300 card reader battery:

1. Connect the standard micro-USB cable to the card reader.

2. Insert the adapter into a power socket.

The following table explains the battery charging statuses of the VP3300 card reader:

Sometimes, cardholders might enter a cancelled, non-issued or invalid card number in the . This payment information is validated on the backend when you submit the sale request.

Credit card numbers are validated by:

• Getting the card token.

• Using card number field values, excluding non-numeric characters.

• Passing the remaining digits through the Luhn algorithm.

Our payment processing solutions support various business models, allowing you to accept payments online, in person, on the go, or through recurring subscriptions. This section describes how to integrate with our payment solutions and start processing payments securely and efficiently.

Payment Solutions

Online

Integrate with the following online payment solutions to process transactions on your website:

• JavaScript SDK: Embed a responsive, customizable payment module into your website.

• Hosted Payment Page (HPP): Manage a hosted payment page and customize its fields and layout to meet your needs.

• Transaction API: Integrate your software or terminals with the Quest Payment Gateway using a single REST-based API.

• Paylink: Send customers a secure payment link via SMS and email to complete transactions online.

• Virtual Terminal: Accept online payments using the Virtual Terminal—no hardware required.

In-Person

Process face-to-face transactions securely and efficiently with in-person payment solutions:

• Cloud EMV: Embed payments into your platform without handling PCI DSS compliance or lengthy EMV certifications. Instead of integrating separately with each payment terminal, perform a single integration with cloud.

• JavaScript SDK (USB): Use IDTech VP8300 card reader with a USB connection to accept payments. This configuration removes your payment system from PCI scope.

On the Go

Use Mobile EMV SDKs to process payments on iOS and Android platforms with seamless integration.

• Mobile SDK (Android): Process payments on your Android app.

• Mobile SDK (Apple): Process payments on your iOS app.

Recurring / Subscription

Set up and manage recurring payment plans across a small or large set of customers:

• Recurring Transaction API: Use the REST-based API to leverage a card on file (token) to set up, edit, and manage recurring payment plans.

• Virtual Terminal: Utilize Virtual Terminal to set up and manage recurring payments using various payment methods.

The following guides explain how to integrate with each of the payment processing solutions:

• JavaScript SDK

• Hosted Payments

• Mobile EMV SDK

• ACH Transaction Integration

• Paylink

• Virtual Terminal

• Cloud EMV

Merchant’s consent is collected through signature submission to complete the onboarding application. Once all necessary information has been added, a merchant can easily provide his/her signature in one of the following two ways:

When a merchant attempts to submit the signatures, the system will validate all the entered information and return a list of any issues found. If no issues are detected, merchant can proceed to submit the signatures.

This process ensures that Xplor Pay receives proper authorization while offering flexibility in how signatures are submitted. After submission, no further changes can be made to the merchant through the Merchant Onboarding Boarding API.

{
      "signatureSourceTypeId": 1,
      "signatureSourceTypeName": "OnlineForm",
      "signatureSourceTypeDescription": "Agreement was provided online through an E-Signature system or by indicating on an approved html form."
    }

For a detailed breakdown of the request and response fields and their descriptions, refer to the reference documentation of Signature Submission API.

The 'Merchant Pricing' API is designed to facilitate the management of pricing templates and pricing plans for each onboarding merchant. Xplor Pay offers a streamlined solution to manage these plans and help merchants streamline their pricing strategy.

• Customizable Pricing Plans: With Xplor Pay, merchants can easily create and manage tailored pricing structures, including transaction fees, service charges, and other cost factors to fit the specific needs of each account.

• Transparent and Competitive Rates: Pricing structures are designed to align with the merchant’s business model, ensuring clarity and offering competitive rates tailored to their needs. Using Xplor Pay's templates, merchants can configure plans that meet their operational requirements.

This endpoint utilizes both POST and PUT methods, enabling users to create a new pricing plan or update existing plans efficiently.

• POST https - /api/pricing/v2/PricingPlan/{merchantNumber}

• PUT https - /api/pricing/v2/PricingPlan/{merchantNumber}/{id}

{
  "pricingFees": [
    {
      "clearentPricingFeeID": 101,
      "pricingFeeDescription": "Transaction Processing Fee",
      "rate": 2.9,
      "fee": 0.30,
      "payInMonth1": 10.00,
      "payInMonth2": 10.00
    },
    {
      "clearentPricingFeeID": 102,
      "pricingFeeDescription": "Monthly Service Fee",
      "rate": 0.0,
      "fee": 25.00,
      "payInMonth1": 25.00,
      "payInMonth2": 25.00
    }
  ],
  "pricingPlanID": 5001,
  "pricingPlanTemplateID": 3002,
  "merchantNumber": "1234567890123456",
  "discountQualificationRangeID": 2,
  "signatureDebitDiscountQualificationRangeID": 3,
  "pricingTypeCode": "INTERCHANGE_PLUS",
  "isAdvancedPricing": true,
  "isEMF": true,
  "isDailySettle": true,
  "includeAssessments": true,
  "effectiveStartDateTimeUTC": "2024-03-01T00:00:00Z",
  "effectiveEndDateTimeUTC": "2025-03-01T00:00:00Z"
}

For a detailed breakdown of the request and response fields and their descriptions, refer to the reference documentation of Pricing Plan API.

Once you have selected a pricing template, you can apply and modify the pricing fees before finalizing the merchant application. Use the Create a Merchant endpoint to:

• Assign a pricing plan to the merchant.

• Modify the pricing fees under the selected plan.

• Complete the merchant application process with the required pricing details.

Adjusting pricing at this stage ensures that each merchant receives a tailored pricing structure that aligns with their business requirements.

This includes the following steps:

{
  "pricingPlan": {
    "pricingFees": [
      {
        "clearentPricingFeeID": 101,
        "pricingFeeDescription": "Transaction Fee",
        "rate": 2.5,
        "fee": 0.30,
        "payInMonth1": 12,
        "payInMonth2": 24
      }
    ],
    "pricingPlanID": 2001,
    "pricingPlanTemplateID": 3001,
    "pricingTypeCode": "STANDARD",
    "isAdvancedPricing": true,
    "isEMF": true,
    "isDailySettle": true,
    "includeAssessments": true
  }
}

{
  "merchantNumber": "123456789",
  "status": "Active",
  "pricingPlan": {
    "pricingFees": [
      {
        "clearentPricingFeeID": 101,
        "pricingFeeDescription": "Transaction Fee",
        "rate": 2.5,
        "fee": 0.30,
        "payInMonth1": 12,
        "payInMonth2": 24
      }
    ],
    "pricingPlanID": 2001,
    "pricingPlanTemplateID": 3001,
    "pricingTypeCode": "STANDARD",
    "isAdvancedPricing": true,
    "isEMF": true,
    "isDailySettle": true,
    "includeAssessments": true
  },
  "message": "Merchant pricing plan successfully applied."
}

After the successful modification of the pricing plan, the merchant application record is updated, and the new pricing structure is applied automatically. This ensures that merchants receive the correct pricing without requiring manual intervention.

The following articles explain you how to integrate hosted payment options into your website:

• Configuring the Pay Now Button

• Configuring Payment Page with an Amount Field

• Configuring Payment Page with an Optional Billing Address and Headline Text

• Configuring Payment Page with the Save Card Option

• Configuring the Add Payment Method Button

• Styling Your Brand on the Payment Page

• Configuring Apple Pay for Web

• Configuring Hosted Payment Page Using Members

• Configuring Hosted Payment Page Using Methods

• Configuring Hosted Payment Page Using Functions

To start a transaction using Xplor Pay iOS framework:

ClearentVP3300Config *config = [[ClearentVP3300Config alloc]init];
        [config setPublicKey:publicKey];
        [config setClearentBaseUrl:baseURL];
        config.contactAutoConfiguration = false;
        config.contactlessAutoConfiguration = false;
        config.contactless = true;
        clearentVP3300 = [[Clearent_VP3300 alloc]  initWithConnectionHandling:self clearentVP3300Configuration:config];
        clearentManualEntry = [[ClearentManualEntry alloc]  init];
        [clearentManualEntry setClearentBaseUrl:baseURL];
        [clearentManualEntry setPublicKey:publicKey];

ClearentPayment *clearentPayment = [[ClearentPayment alloc] init];
    [clearentPayment setAmount:theAmount];
    clearentPayment.amtOther = 0;
    clearentPayment.type = 0;
    clearentPayment.timeout = 10;
    clearentPayment.tags = nil;
    clearentPayment.fallback = true;
    clearentPayment.forceOnline = false;

ClearentConnection *clearentConnection = [[ClearentConnection alloc] initBluetoothWithFriendlyName:self.deviceFriendlyName];

ClearentResponse *response = [clearentVP3300 startTransaction:clearentPayment clearentConnection:clearentConnection];
         if (response.responseType != RESPONSE_SUCCESS) 
         {
             //Notify user the transaction could not be started.
         }

The following example is successful transaction response for a sale with saved card option.

{
   "code":"200",
   "status":"success",
   "exchange-id":"ID-CLADEVGSOPS02-cgw01-58790-1447188033740-0-1125",
   "links":[
      {
         "rel":"transaction",
         "href":"/rest/v2/transactions?id=1107310",
         "id":"1107310"
      },
      {
         "rel":"token",
         "href":"/rest/v2/tokens/1100845274213121111",
         "id":"1136587273219921111"
      }
           ],
   "payload":{
      "transaction":{
         "amount":"64.50",
         "id":"1107310",
         "type":"SALE",
         "result":"APPROVED",
         "billing":{
            "street":"222 Main Street",
            "city":"Springfield",
            "state":"ME",
            "zip":"55105",
            "first-name":"John",
            "last-name":"Adams"
                   },
         "card":"XXXXXXXXXXXX1111",
         "csc":"999",
         "authorization-code":"TAS403",
         "avs-result-code":"Y",
         "batch-string-id":"165",
         "display-message":"Transaction approved",
         "result-code":"000",
         "exp-date":"1019"
                    },
      "payloadType":"transaction"
             },
   "signature":"306502310087aaee89b8c706ceb98c986b4de66a5"
}

Integrating the iOS framework connects your app to the VP3300 mobile card reader using Apple’s Bluetooth implementation in the IDTech framework. The iOS framework sends messages to your app that guide customers during their interaction with the card reader in a transaction. The iOS framework secures the card data after a successful read and sends it to the server. The iOS framework packages the secured card data as an encrypted JSON Web Token (JWT) and sends it to your app through a callback function. You can then send the encrypted JSON Web Token (JWT) to the mobile gateway to process the payment.

The following articles explain how to integrate the iOS framework into your app and start accepting payments:

• Optional settings

• Starting a Bluetooth connection

• Pairing the card reader with an iOS device

• Integrating the iOS framework into your app

• Setting up the iOS framework in your Objective-C app

• Starting a transaction in your iOS app

• Receiving feedback messages

Integrate the Mobile EMV SDK to securely accept payments in your iOS or Android apps and deliver a seamless experience for your customers. The Mobile EMV SDK works with the Quest™ Mobile Payments API to eliminate PCI SSF scope and significantly reduce your merchants’ PCI scope with layered security. The Mobile EMV SDK integration supports audio jack and Bluetooth-enabled mobile card readers, allowing you to accept various payment types, including chip card payments.

The following articles explain how to integrate the Mobile EMV SDK with your iOS and Android apps:

• VP3300 Mobile Card Reader

• iOS Framework

• Android Framework

To pair the VP3300 card reader with an iOS device:

1. Turn on Bluetooth in the iOS device’s settings.

2. Install your iOS app on the device.

The following table explains the Bluetooth settings on the VP3300 card reader:

To set up the iOS framework for your Objective-C app:

#import <ClearentIdtechIOSFramework/ClearentIdtechIOSFramework.h>

@interface ViewController : UIViewController<UIAlertViewDelegate,Clearent_Public_IDTech_VP3300_Delegate, UIActionSheetDelegate,MFMailComposeViewControllerDelegate>

@interface ViewController : UIViewController<UIAlertViewDelegate,Clearent_Public_IDTech_VP3300_Delegate, UIActionSheetDelegate,MFMailComposeViewControllerDelegate>,ClearentManualEntryDelegate

- (void)successTransactionToken:(ClearentTransactionToken *)clearentTransactionToken;

- (void)feedback:(ClearentFeedback *)clearentFeedback;

-(void) deviceConnected;

-(void) deviceDisconnected;

Clearent_VP3300 *clearentVP3300;
ClearentManualEntry *clearentManualEntry;

To start a connection using iOS Framework:

ClearentConnection *connection = [[ClearentConnection alloc] initBluetoothSearch];
                                  [clearentVP3300 startConnection:connection];

- (void) bluetoothDevices:(NSArray *)bluetoothDevices;

A success message appears on your website when a transaction is completed successfully.

Add the ClearentOnSuccess function to your website to detect successful transactions and return a JSON object with the raw and signed server response.

The following sample code includes the raw and JSON-formatted response, along with the message and transaction ID for a successful transaction:

<script>
        // called after successful complete
           function ClearentOnSuccess(responseRaw,ResponseJSON)
        {
            console.log("transaction successful");
            console.log(responseRaw);
            console.log(ResponseJSON);
        // use JS short-circuiting to determine if we have a transaction id
           if(ResponseJSON.payload && ResponseJSON.payload.transaction && ResponseJSON.payload.transaction.id)
        {
           console.log("transaction id = " + ResponseJSON.payload.transaction.id);
        }
        else
        {
            console.log("transaction id not found");
        }
        }
</script>

You can validate the response before completing the transaction:

• Using a hash signature: The hash is made up of the response object. You can validate the response parameters on your server to check whether the parameters are tampered with. You can also ensure the response is valid and the transaction ID is unique.

• Using API: You can check whether the transaction ID in the response matches the client-side transaction ID.

• Using the Virtual Terminal: You can search for the transaction ID manually to validate the transaction details.

The Hosted Payments Page returns all transaction responses in raw strings and JSON-formatted representations. These responses include Xplor Pay's signature for verification. (For more information, see Response Validations)

The following examples are various types of transaction responses that you will receive from the Hosted Payments Page:

• Successful Transaction Response

• Successful Transaction Response for a Billing Address

• Failed Transaction Response

• Unauthorized Request Response

• Successful Transaction Response for a Token

• Successful Token Request Response

A range of payment terminals are available to support different business environments. Choose from countertop models, PIN pads, mobile terminals, or compact card readers. Each device supports EMV chip, magnetic stripe, and NFC contactless payments for fast and secure transactions. With end-to-end or point-to-point encryption and EMV certification, they ensure compliance and data protection.

DEJAVOO

Dejavoo Z Line

Dejavoo QD Line

PAX

PAX A Series

ID TECH

PAX technology provides a range of advanced payment terminals designed to meet diverse business needs. Below is an overview of three notable PAX models of A Series: the A35, A80, and A920Pro.

PAX A Series

PAX A35

The PAX A35 is a high-performance, smart device tailored for various retail scenarios. Its ergonomic design and advanced features make it suitable for high-volume, fast-paced environments.

Additional Resources:

• PAX A Series Quick Reference Guide for Integrated Devices (PAX A80, PAX A920, & PAX A35)

• Essential Technical Specification

PAX A80

The PAX A80 is a reliable countertop device that can also function as an indoor portable terminal. Its robust design and comprehensive features make it a reliable choice for businesses seeking efficiency and security.

Additional Resources:

• PAX A Series Quick Reference Guide for Integrated Devices (PAX A80, PAX A920, & PAX A35)

• PAX A Series Quick Reference Guide (PAX A920 & PAX A80)

• SwipeSimple PAX A80 Activation Guide

• Essential Technical Specification

PAX A920Pro

The PAX A920Pro is a mobile touchscreen Android terminal that combines the features of an Android tablet with a powerful payment terminal. Its sleek and compact design makes it ideal for dynamic retail or hospitality environments.

Additional Resources:

• PAX A Series Quick Reference Guide for Integrated Devices (PAX A80, PAX A920, & PAX A35)

• PAX A Series Quick Reference Guide (PAX A920 & PAX A80)

• SwipeSimple PAX A920 Activation Guide

• Essential Technical Specification

The Merchant’s Onboarding begins with creating a new application in the Partner Portal. To create a new merchant application in the Partner Portal:

The Site Survey step ensures that the merchant's physical location and business operations are verified before onboarding. This step is crucial for compliance and fraud prevention.

To complete a merchant application:

The Profile Details page captures key business metrics, sales profile, and vendor details to assess transaction behavior and business operations.

You can offer customers the option to securely save their card information for future purchases using our vault.

To configure the save card option for the payment page:

<script>
       Clearent.setProperty("show-save-card-option", true);
       Clearent.payButton({"amount": "64.50"});
</script>

You can also provide the option for customers to add a payment method on your payment page, allowing them to use it for future payments. See Configuring the Add Payment Method Button for more information.

To configure the payment page with an amount field:

<script>
       Clearent.setProperty("heading-text", "Complete payment details below");
       Clearent.payButton({"amount": "64.50"});
</script>

To generate a merchant application:

Use an API-driven workflow to onboard new merchants. This automated process streamlines the workflow from application submission to equipment activation, helping merchants get started quickly.

The following image and step-by-step guide outline the integration flow:

The Banking Information step allows users to securely add and manage bank accounts for transactions, including deposits, fees, and chargebacks. This step ensures that the merchant's banking details align with their legal business name or DBA (Doing Business As) name.

The Pricing section allows you to configure the merchant's pricing model, card type acceptance, fees, and other settlement-related details.

The 'Equipment Ordering' API facilitates the submission of completed equipment surveys for selected products. Xplor Pay simplifies hardware provisioning, ensuring seamless integration for transaction processing.

• Equipment Surveys: Merchants select the equipment they need, such as POS systems or card readers. For each product, Xplor Pay provides a tailored survey with specific questions.

• Hardware Provisioning: After completing the survey, merchants submit the details to Xplor Pay, which prepares the devices.

All hardware is configured and linked to the MID for seamless integration with Xplor Pay's payment system. This process ensures a streamlined approach to configuring and ordering equipment efficiently.

Utilizing the POST method, it allows users to submit their equipment orders after retrieving and completing a dynamic survey tailored to the chosen product.

• POST /api/merchant/{merchantNumber}/equipment

For a detailed breakdown of the request and response fields and their descriptions, refer to the reference documentation of API.

Refer to the following table to configure the payment page on your website:

The Business Information page collects essential details about the merchant’s business, including address, contact details, legal information, and operational status.

The Review & Submit step is the final stage of the merchant onboarding process in the Partner Portal. This step allows users to verify all entered details, resolve any outstanding errors, and submit the application for approval.

Once submitted, the application will be reviewed by the system. Users may receive notifications regarding the approval status or additional actions required.

The following example is successful transaction response for a sale with billing address:

The following articles are about validations of transaction responses that you will receive from the Hosted Payments Page: