Getting Started

The Reporting API provides access to comprehensive merchant-related data, including merchant profiles, transactions, disputes, financial records, and support cases. All API requests must be authenticated using an Access 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 too: https://boarding-sb.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 to access live reporting data.

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

• Include your production Access Key in the request header.

• Use HTTPS and JSON for all production requests.

Authentication

Authenticate each API request using the following HTTP header fields:

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.

Obtaining an Access Key

Your secret Access 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 Access 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 Access Key for use in the live environment. Keep this key secure — it should never be shared or exposed publicly.