Getting Started

The Payments APIs enable you to process transactions across multiple payment methods, including cards, mobile, and ACH. All API requests must be authenticated using an API Key—a secure credential issued by Xplor Pay.

Xplor Pay provides two environments for testing and production use:

• Sandbox (development/test) — 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.

Sandbox environment

Use the sandbox environment to test your integration before going live.

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

• Include your sandbox API Key in the request header.

• Use HTTPS for all requests.

• Use either JSON or XML for request and response formats.

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

• Use HTTPS for all requests.

• Use either JSON or XML for request and response formats.

Authentication

Authenticate each API request using the following HTTP header fields:

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.
AccessKey	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 an Access Key

Your API Key is issued by Xplor Pay. Our integration support team provides hands-on assistance throughout the testing and certification process.

To obtain your Access Keys:

1. Request sandbox credentials Contact Xplor Pay Integration Support to request a sandbox API Key. This key allows you to build, test, and validate your API integration safely in the sandbox environment.

2. Complete testing and certification Once your integration has been validated and approved, Xplor Pay will provide production credentials.

3. Receive production credentials You’ll receive your production API Key for use in the live environment. Keep this key secure — it should never be shared or exposed publicly.