Getting Started

The Merchant Onboarding and Hosted Merchant Onboarding APIs enable you to onboard new merchants to the Xplor Pay platform.

All API requests must be authenticated using an Access Key—a secure credential issued by Xplor Pay.

Environments

Use these two environments:

• Integration (INT) — for building and validating your integration.

• Production (live) — for processing live onboarding requests.

Both environments accept authenticated JSON requests over HTTPS using secure HTTP methods and headers.

Software partners can integrate our API in the INT environment after onboarding.

Integration environment

Use the integration environment to test your API implementation before going live. This environment simulates real API behavior for functional testing.

• Set the base URL to: https://gateway-int.clearent.net

• Include your sandbox Access Key in the request header.

• All requests must use secure HTTPS and JSON format.

Production environment

Use the production environment when your integration is ready for live merchant onboarding.

• Set the base URL to: https://gateway.clearent.net

• Include your production Access Key in the request header.

• Use HTTPS and JSON for all production requests.

Authentication

To authenticate with our API endpoints, add following fields in an HTTP header of your request:

Content-Type: application/json
Accept: application/json
AccessKey: Secret access key issued by Xplor Pay

The following table describes the required fields in an HTTP header:

Name	Data type	Required?	Description
Content-Type	String	Required	The media type of the request body. Use application/json.
Accept	String	Required	The expected response format. Use application/json.
AccessKey	String	Required	The secret access key issued by Xplor Pay for authenticating API requests. ReplaceSecret access key issued by Xplor Pay with your actual API access key.

Some endpoints may require additional header fields, such as MerchantId, depending on the specific operation. Refer to individual endpoint documentation for complete header requirements.

Obtain Access Key

To obtain an Access Key:

1

Request sandbox credentials

This key allows you to build, test, and validate your API integration safely in the INT environment.

Contact Xplor Pay Integration Support team to request an Access Key.

2

Complete testing and certification

After your integration is validated and approved, Xplor Pay issues a production Access Key.

3

Receive production credentials

You’ll receive an Access Key to go live using production environment.

Keep this key secure — it should never be shared or exposed publicly.