The Reporting API allows developers to access transaction data and generate reports programmatically. Use it to integrate transaction data with your existing systems and automate reporting.

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.

The following articles provide the information to help you with your integration testing in the Sandbox environment:

• Test Cards & ACH Accounts

• Onboarding API Result Codes

• Transaction Error Generation Data

• Card Response & Result Codes

• ACH Request Validation & Return Codes

Card Security Code (CSC) is a security feature that protects against fraud. It ensures that credit card transactions can't be made without it being in the cardholder's possession.

The following articles explain ACH request validation and return codes used for testing purposes:

• ACH Request Validation Codes

• ACH Return Codes

This document provides an overview of the various APIs available in our system, categorized by their functionality and purpose. Each API serves a specific role in managing different aspects of merchant operations, transactions, and configurations.

For more information, refer to the following articles:

• Merchant Onboarding APIs

• Quest APIs

• Automated Merchant Onboarding Setup API (Launch For Integrators Setup API)

• Reporting API

The Automated Merchant Onboarding Setup API (Launch For Integrators Setup API) provides a lightweight method to add new merchants to the Xplor Pay platform. We manage most of the user experience, simplifying the integration process.

The Equipment Tracking webhook provides notifications when payment terminals are shipped to merchants. This webhook delivers detailed shipping information for each terminal device, including tracking numbers.

Payload Structure Example

The webhook delivers a JSON payload with the following structure:

{
  "event": "Shipped",
  "merchantId": "88880000000123456",
  "orderId": "999990000000987654",
  "payload": {
    "terminals": [
      {
        "name": "Survey Name",
        "trackingNumber": "1Z81T8T20299581550",
        "deviceType": "VP3300 (Bluetooth)",
        "terminalId": 1111,
        "storeNumber": 1111
      }
    ]
  }
}

Field Reference

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

The Onboarding Webhooks provide updates throughout the merchant onboarding process. Boarding Webhooks triggered at different stages of the boarding process. Used to provide API/public keys for integration. These include application status changes and require fixes.

For more information, refer to the following related articles:

• Application Status

• Application Fixes

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

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.

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:

• Webhooks

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.

Hosted Payments solution only work with latest versions of:

• Chrome

• Firefox

• Edge

• Safari

Multiple webhook subscription types are available to help you stay informed about key events related to merchant onboarding, transaction activity, and equipment handling. These webhooks deliver real-time notifications to your configured endpoints, allowing for more responsive and automated workflows.

1. Transaction Webhook

Delivers real-time notifications for transaction events, including successful payments, declines, and refunds. Ideal for updating dashboards, triggering email receipts, or managing reconciliation.

2. Onboarding Webhooks

Provides updates on the merchant onboarding process. Notifications include application status changes, required corrections, and terminal shipping progress.

3. Equipment Tracking and Activation Webhooks

Sends alerts when payment terminals are shipped and enables merchants to activate their terminals upon delivery.

The Automated Merchant Onboarding solution offers various configuration options to customize the merchant onboarding experience, ensuring seamless integration with your business operations. These settings help you tailor branding, communication, user management, and merchant support, creating a streamlined and efficient onboarding process.

Branding Options

Add Logo: Enhance brand recognition by adding your company’s logo to the onboarding interface. A branded experience builds trust and ensures consistency across all touchpoints, giving merchants a familiar and professional environment.

Communication Settings

Set a Postback URL: Define a Postback URL to receive real-time updates on merchant application status changes. This ensures that onboarding-related events—such as application approval, decline, or completion—are automatically communicated to your system, enabling timely and seamless updates.

Modify Support Contact Information

Customize the support email and phone number displayed in automated emails sent during the merchant application process. This ensures that merchants always have the correct contact details when they need assistance.

User Management

Automatically Create User Accounts: Enable automatic user account creation for the Merchant Portal and Virtual Terminal to simplify onboarding. This eliminates manual setup and ensures that merchants gain immediate access to their accounts upon approval.

Reminder Email Configuration

Set Automatic Reminder Intervals: Configure automated reminder emails to encourage merchants to complete their applications before the 7-day expiration period. The default reminder is sent 3 days before expiration, with options to send additional reminders 2 days or 1 day prior.

Application Completion

Predefine Completion of Application Field: Consult with a Xplor Pay representative to determine the best strategy for defining application completion. This ensures that onboarding requirements align with your business model and industry standards.

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).

JavaScript SDK solution only work with latest versions of:

• Chrome

• Firefox

• Edge

• Safari

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

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:

Settings to check duplicate credit card transactions through the Quest Gateway.

The following articles explain card responses and result codes used for testing purposes:

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:

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.

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:

Transaction Webhooks notify merchants of transaction success and failure, especially important for recurring and offline transactions. The Transaction Webhook delivers notifications for all transaction events performed by a merchant account. Below listed are some of the Supported Transaction Events:

• Authorization

• Capture

• Sale

• Forced Sale

• Refund

• Unmatched Refund

• Void

• ACH Credit

• ACH Debit

Sample Payload

The webhook payload is identical to the response for a transaction event, with an added digital signature for verification. Refer to the sample code below:

To register your Webhooks URL, send the endpoint details to the Integrations team. Direct configuration of endpoints through the system isn’t currently available.

The Integrations team will complete the registration on your behalf and confirm once your endpoint is successfully configured.

Secure Your Endpoint

Security is critical when working with webhooks. Integration team require integrators to:

• Use HTTPS endpoint.

• Restrict IP addresses (if applicable)

Verify Your Signature

Each webhook request includes a secure signature header to confirm its authenticity. Verifying this signature helps ensure the payload was sent by Xplor Pay.

Webhook Notifications

Once your endpoint is registered and webhooks are configured, you will begin receiving event notifications relevant to your merchant account.

Refer to the sample structure of webhook notifications:

Retry Logic

If your endpoint does not acknowledge receipt of a webhook (i.e., returns a non-2xx status), the system will automatically retry the callback. A 2xx status code (e.g., 200 OK) indicates successful receipt of the webhook, and no retry will be attempted.

Non-2xx status codes (e.g., 400 Bad Request, 500 Internal Server Error) indicate failure. The system will retry the request based on the retry policy.

• Total Attempts: Up to 3 delivery attempts

• Retry Strategy: Exponential backoff is applied between each attempt

This ensures reliable delivery of webhook events, even if your endpoint is temporarily unavailable.

Testing Webhooks

To test your webhook integration, make sure your endpoint returns a proper HTTP status code to indicate the result of processing the request. To help you test different webhook response scenarios in the INT (integration) environment, the system recognizes special keywords in the merchant’s DBA (Doing Business As) name field. Use the following naming conventions to simulate specific onboarding outcomes:

• [DECL] – The application will be marked as Declined after signing. A webhook will be triggered with the "Declined" status.

• [PEND] – The application will move to Pended status after signing. You will receive a webhook indicating this status change.

• [APPR] – The application will be marked as Approved after signing, and a corresponding webhook will be sent.

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.

Working with Automated Merchant Onboarding involves:

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

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:

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:

You can quickly and easily configure the text and behavior of your payment page popup:

Webhook allows you to receive notifications when specific events occur, such as changes to a merchant account or application submission. Instead of repeatedly polling the API for updates, your endpoint receives HTTP requests instantly making your integration more efficient, scalable, and responsive.

For more information on webhooks, refer to the following articles:

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

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

The Equipment Tracking & Activation webhooks deliver notifications about payment terminal shipments and activation events. Equipment Webhooks notify when equipment (physical terminals, virtual terminals, JavaScript SDK, or mobile gateway) is onboarded. These webhooks enable you to track terminal deliveries and manage the activation process for your merchants.

For more information, refer to these related articles:

Working with JavaScript SDK involves:

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 '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.

Our integration platform provides separate sandbox and production environments, creating a reliable and secure foundation for testing and deploying your solutions. The sandbox environment is designed to closely replicate production conditions, allowing you to thoroughly test and refine your integrations before transitioning to the live production environment.

Environment URLs

Use the following sandbox and production URLs to connect to their respective services.

Sandbox URLs

The following table provides the sandbox URLs for different services:

Production URLs

The following table provides the production URLs for different services:

Go-Live Checklist

Ensure the following items are completed before transitioning to production:

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 (Pricing Plan 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:

[
    {
      "pricingPlanTemplateID": 101,
      "hierarchyNodeKey": "987654321",
      "templateName": "Standard Pricing Plan",
      "pricingTypeCode": "STANDARD",
      "isAdvancedPricing": false,
      "isDefaultTemplate": true,
      "isDisabled": false,
      "templateFees": [
        {
          "clearentPricingFeeID": 2001,
          "clearentPricingFeeDescription": "Transaction Fee",
          "isEditable": true,
          "isRequired": true,
          "isVisible": true,
          "isFee": true,
          "isRate": true,
          "isPayInMonthRequired1": false,
          "isPayInMonthRequired2": false,
          "defaultRate": 2.5,
          "minRate": 2.0,
          "maxRate": 3.5,
          "defaultFee": 0.30,
          "minFee": 0.25,
          "maxFee": 0.50,
          "rateLabel": "Percentage Rate",
          "feeLabel": "Fixed Fee"
        }
      ],
      "templateSettings": [
        {
          "pricingPlanSettingID": 5001,
          "settingName": "Daily Settlement",
          "description": "Enable daily settlement for transactions.",
          "isVisible": true,
          "isEditable": true,
          "defaultValue": true
        }
      ],
      "attributes": [
        {
          "name": "Region",
          "value": "USA",
          "type": "String"
        },
        {
          "name": "Currency",
          "value": "USD",
          "type": "String"
        }
      ]
    }
]

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 Merchant Onboarding portal.

• See the Browser Support for more information.

JavaScript SDK solution allows you to integrate payments into your website seamlessly. The payment frame ensures adherence to PCI Security Standard Council - Best Practices for Securing E-commerce. 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:

• Prerequisites

• Working with JavaScript SDK

• Card Validations

• Configuring with JavaScript SDK

Sometimes, cardholders might enter a cancelled, non-issued or invalid card number in the Payment Form. 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.

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:

• Prerequisites

• Integrating the Hosted Payments

• Transaction Responses

• Response Validations

• Card Validations

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.

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

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

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

To complete a merchant application:

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 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.

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:

<script type="text/javascript">
    ClearentSDK.init({
        "baseUrl": "https://gateway-sb.clearent.net",
        "pk": "YOUR PUBLIC KEY GOES HERE",
        "styles": ".form-control{color: blue;}.form-control:focus{color: purple;}"
    });
</script>

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

To configure the Pay Now button to your website:

<script type="text/javascript" id="clearent-hpp" src="https://hpp-sb.clearent.net/js/clearent.js"></script>
<script>
       Clearent.payButton({"pk":"307a301406072a864.....8ce3d076fde833c136b", "amount": "64.50"});
</script>

The following button link will be displayed to accept payments and donations on your website.

When your customers click the Pay Now button to pay, the following hosted payment page will be displayed. The hosted payment page has fields to enter the card details for your customers.

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.

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 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 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:

Each merchant application goes through multiple stages before approval and onboarding. The webhook sends notifications when an application moves into one of the following states:

Webhook Event Structure

The Application Status Webhook sends structured JSON payloads to the subscribed endpoint when an application status changes. The payload includes the following fields:

• event – The current status of the application.

• merchantId – The unique merchant account identification number.

• payload – An empty set for most statuses

Application Status Webhook Examples

Below are sample webhook payloads for each application status:

Pended

Manual Review

Approved

Declined Status

Boarded Status

The Application Summary page provides an at-a-glance view of the merchant application’s progress in the Partner Portal. This page allows users to track the status of different sections, access merchant details, and manage the application as needed. Users can download the application or delete it if required.

Next Steps

• If any section is marked as In Progress or Pending, users should click on the respective section to complete the required information.

• Once all sections display Completed, navigate to the Submit section to finalize and submit the application.

• Users should verify all details for accuracy before submission to prevent processing delays.

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:

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

• : Manage a hosted payment page and customize its fields and layout to meet your needs.

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

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

• : 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:

• : 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.

• : Use card reader with a USB connection to accept payments. This configuration removes your payment system from PCI scope.

On the Go

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

• : Process payments on your Android app.

• : Process payments on your iOS app.

Recurring / Subscription

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

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

• : 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:

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

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.

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

The Application Fixes webhook event to notify about data validation issues detected in merchant applications. These events are triggered by validation checks during the underwriting process.

Event Names

The following webhook event types are used to surface validation errors:

• BusinessFixes

• ContactFixes

Each event provides details about the issue, the affected contact, and recommended corrections.

Payload Structure Example

The webhook payload includes one or more validation messages for specific contacts. Each message contains a human-readable description and a code identifying the type of issue. Refer to the sample code below:

Message Codes

Each code corresponds to a specific type of validation issue. Use these codes to programmatically handle or display user-friendly error messages in your application interface.

Handling Validation Events

To improve the merchant experience and avoid pended applications:

• Monitor for BusinessFixes and ContactFixes events.

• Display validation messages to the merchant during the application process.

• Allow merchants to update their information before submitting the application.

Google Pay allows you to make secure payments using an internet browser.

The following articles help you with Google Pay payment method.

Prerequisites

Follow the prerequisites below before you incorporate Google Pay on your website:

• Serve an HTTPS webpage with a TLS domain-validated certificate.

• Use one of the following supported web browsers:

  • Google Chrome

  • Mozilla Firefox

  • Apple Safari

  • Microsoft Edge

  • Opera

  • UCWeb

• Add a payment method to your Google account using the Getting Started with Google Pay reference.

• Adhere to the Google Pay and Wallet APIs Acceptable Use Policy.

• Implement the manual card entry of the JavaScript SDK solution.

Supported Payment Methods

You must have the payment and address information of your customers who use Google Pay.

Supported Cards

• Visa

• MasterCard

• American Express

• Discover

Merchant Capabilities

• Credit cards (Visa or Mastercard)

• Debit cards (Visa or Mastercard)

Getting Started

Follow the below steps to start using the Google Pay on your website:

ClearentSDK.googlePayAvailable()

Configuring the onClick Event

Follow the below steps to configure the onClick event for your payment process:

const request = {
	"total": {
		"label": "Sasha's Mustard Shop",
		"amount": "0.01",
		"type": "final"
	}
};
const buttonConfig = {
	"buttonColor": "default",
	"buttonType": "buy",
	"buttonLocale": "en",
	"buttonSizeMode": "fill"
};
ClearentSDK.init({
	"baseUrl": "https://gateway-sb.clearent.net",
	"pk": "Your public key",
	"enableGooglePay": true,
	"googlePayRequest": request,
	"googlePayButtonConfig": buttonConfig
});

<script type="text/javascript">
            // When you get a successful token response and
            // use this to make a sale/auth on your backend
            function ClearentTokenSuccess(raw, json) {
                console.log("ClearentTokenSuccess");
                console.log(raw);
                console.log(json);
                // now you can send the token to your server
                // to complete the transaction via mobile-gateway
            }
            function ClearentTokenError(raw, json) {
                console.log("ClearentTokenError");
                console.log(raw);
                console.log(json);
            }
        </script>

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

{
  "merchantNumber": "9876543210123456",
  "metadata": {
    "exchangeId": "EX123456",
    "timestamp": "2025-02-17T17:57:49.203Z"
  },
  "orderCreateTime": {
    "calendarType": "ISO8601",
    "fieldsComputed": 0,
    "fieldsNormalized": 0,
    "firstDayOfWeek": 1,
    "lenient": true,
    "minimalDaysInFirstWeek": 4,
    "time": "2025-02-17T17:57:49.203Z",
    "timeInMillis": 1708186669203,
    "timeZone": {
      "displayName": "Eastern Standard Time",
      "dstsavings": 3600,
      "id": "EST",
      "rawOffset": -18000
    },
    "weekDateSupported": true,
    "weekYear": 2025,
    "weeksInWeekYear": 52,
    "zoneShared": true
  },
  "orderId": "ORD-20250217-001",
  "orderItems": [
    {
      "completionDate": "02/17/2025 05:57 PM",
      "errors": [],
      "manufacturer": "Verifone",
      "orderItemId": 1001,
      "orderItemMetadata": [
        {
          "apiKey": "API-KEY-123",
          "orderStatus": "Shipped",
          "productManufacturer": "Verifone",
          "productModel": "VX520",
          "publicKey": "PUBLIC-KEY-456",
          "salesforceCaseNumber": "SF-789654",
          "serialNumber": "SN-00123456789",
          "storeNumber": 101,
          "tcn": "TCN-ABC123",
          "terminalId": 56789,
          "trackingNumber": "1Z999AA10123456784",
          "vNumber": "VNUM-98765"
        }
      ],
      "productName": "Verifone VX520 Terminal",
      "productType": "Hardware",
      "quantity": 2,
      "surveyValid": true,
      "trackingNumber": "1Z999AA10123456784",
      "validFrontends": ["POS System"]
    }
  ],
  "orderModifyTime": {
    "calendarType": "ISO8601",
    "fieldsComputed": 0,
    "fieldsNormalized": 0,
    "firstDayOfWeek": 1,
    "lenient": true,
    "minimalDaysInFirstWeek": 4,
    "time": "2025-02-18T10:00:00.000Z",
    "timeInMillis": 1708260000000,
    "timeZone": {
      "displayName": "Eastern Standard Time",
      "dstsavings": 3600,
      "id": "EST",
      "rawOffset": -18000
    },
    "weekDateSupported": true,
    "weekYear": 2025,
    "weeksInWeekYear": 52,
    "zoneShared": true
  },
  "resubmit": false,
  "status": "Active",
  "validFrontends": ["POS System", "E-commerce"]
}

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

Webhooks help you to stay in sync by sending real-time event notifications to your specified endpoint.

To learn about webhooks in detail, refer to the following articles:

• Transaction Webhook

• Onboarding Webhooks

• Equipment Tracking & Activation Webhooks

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

A secure, signed JSON Web Token (JWT) is generated when the cardholder selects the Submit button on your payment form.

To receive a secure and signed JWT and complete the payment on your backend:

ClearentSDK.getPaymentToken();

ClearentSDK.getPaymentToken().then(
    (result) => {
        // this function is called if getting a payment token was successful
        console.log("ClearentTokenSuccess");
        console.log(result);
    },
    (error) => {
        // this function is called if getting a payment token failed
        console.log("ClearentTokenError");
        console.log(error);
    }
);

{
   "code":"200",
   "status":"success",
   "exchange-id":"ID-clearent-mobile-jwt-1-c32bfe39-d454-4e34-8b4f-94d850643e48",
   "payload":{
      "mobile-jwt":{
         "jwt":"eyJhbGciOi23UzIh4iJ9.eyJsYXN0LWZvdXIiOiIxMrkP8iwid
                HlwZSI6Ik1BTlVBTCIsImV4cCI6MTU0NzY0NjU2MSwidG9rZW4iOiIxMTAwMDAw
                MDAwMDEzNTkyIn0.eT8c_5yUzxCxL2MEtmbG444eTFRW7OxzRF7x4uRIo-U",
         "last-four":"1111"
      },
      "payloadType":"mobile-jwt"
   }
}

POST /rest/v2/mobile/transactions/sale
Accept:application/json
Content-Type:application/json
api-key:YOUR_API_KEY_GOES_HERE
mobilejwt:eyJhbGciOi23UzIh4iJ9.eyJsYXN0LWZvdXIiOiIxMrkP8iwid
 HlwZSI6Ik1BTlVBTCIsImV4cCI6MTU0NzY0NjU2MSwidG9rZW4iOiIxMTAw
 MDAwMDAwMDEzNTkyIn0.eT8c_5yUzxCxL2MEtmbG444eTFRW7OxzRF7x4uRIo-U
Body
{
    "type": "SALE",
    "amount": "15.55",
    "software-type": "AwesomePOSSoftware",
    "software-type-version":"1"
}

You will receive the below response after successful transaction or an error response if the transaction fails.

{
    "code": "200",
    "status": "success",
    "exchange-id": "ID-clearent-mobile-gateway-1-2a6b56d3-c660-4810-95ea-9fb9a21c6634",
    "payload": {
        "transaction": {
            "amount": "15.55",
            "id": "2586119",
            "type": "SALE",
            "result": "APPROVED",
            "card": "XXXXXXXXXXXX1111",
            "csc": "999",
            "authorization-code": "TAS022",
            "batch-string-id": "938",
            "display-message": "Transaction approved",
            "result-code": "000",
            "exp-date": "1220",
            "software-type": "AwesomePOSSoftware",
            "card-type": "VISA",
            "last-four": "1111"
        },
        "payloadType": "transaction"
    }
}

Example: Decoded, unencrypted, signed JWT

What is Merchant Onboarding?

Merchant Onboarding is the process of registering, verifying, and enabling a business to start accepting payments on a payment platform. This involves collecting essential business information, verifying the identity of business owners, and evaluating risks to ensure compliance with legal and financial regulations. It is a crucial first step for seamless integration and efficient transaction processing.

Merchant Onboarding Options

We provide a range of flexible and customizable onboarding solutions tailored to suit different business needs and levels of technical expertise.

• Automated Merchant Onboarding: A hosted, pre-built onboarding solution, designed to streamline merchant onboarding with configurable workflows.

• Manual Submission via Partner Portal: A simple way to onboard merchants by entering their details into the Partner Portal for review and approval.

• API Integration: Enables seamless onboarding with direct API connections, providing full control over the user experience.

Choose the option that best fits your use case:

Additional Services

If you prefer a hands-off approach to merchant onboarding, we offer comprehensive support services to streamline the process. Our team can collaborate with you to develop a tailored Go-to-Market Strategy, including sales and marketing planning, to accelerate your business growth, and our experienced specialists can handle the entire merchant onboarding process on your behalf.

This option allows you to focus on your core business while ensuring compliance, reducing risk, and providing a seamless onboarding experience for your merchants.

with us to know more.

Merchant Onboarding Process

Regardless of the merchant onboarding method you choose, the onboarding process typically follows these key steps:

1. Collect Merchant Information (via Merchant Application form)

2. Sign & Submit (Merchant Application)

3. Merchant Verification & Underwriting (including Business Verification, Signer Verification, Risk Evaluation)

4. Request for Additional Information (if needed)

5. Approval or Rejection of the merchant application