Getting Started

The Payments APIs enables you to process transactions across multiple payment methods, including cards, terminal, ACH, mobile, batches, recurring payments, and gateway settings.

All API requests must be authenticated using an API 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.

All new software partners will be onboarded to the INT environment. The current legacy sandbox environment will be retired on 31 March 2026.

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 API Key in the request header.

• All requests must use HTTPS and JSON format.

Production environment

Use the production environment when your integration is ready to process live transactions.

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

• Include your production API 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 or application/xml
Accept: application/json or application/xml
API-Key: Secret API 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 or application/xml.
Accept	String	Required	The expected response format. Use application/json or application/xml.
API-Key	String	Required	The secret API key issued by Xplor Pay for authenticating API requests. ReplaceSecret API key issued by Xplor Pay with your actual API key.

You may include additional authentication fields, such as Mobilejwt or Achmobilejwt, depending on the payment method used.

Obtaining API Key

To obtain API 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 API Key.

2

Complete testing and certification

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

3

Receive production credentials

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

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