Getting Started

The Disputes API provides direct access to dispute data and management tools, enabling you to handle the complete lifecycle of payment dispute cases. Use this API to retrieve dispute information, monitor case status, and submit responses with supporting documentation.

All API requests must be authenticated using an Access Key and Bearer Token—secure credentials issued by Xplor Pay.

Environments

Use these two environments:

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

• Production (live) — for managing live dispute cases

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://horizon-service-int.clearent.net/

• Include your sandbox AccessKey and MerchantId in the request header.

• Include a valid Bearer Token from the Edge service.

• All requests must use secure HTTPS and JSON format.

Production environment

Use the Production environment when your integration is ready for live dispute management.

• Set the base URL to: https://horizon-service.clearent.net/

• Include your production AccessKey and MerchantId in the request header.

• Include a valid Bearer Token from the Edge service.

• All requests must use secure HTTPS and JSON format.

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
MerchantId: Unique identifier for the merchant

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.
MerchantId	String	Required	Unique identifier for the merchant whose disputes you want to access.

Access Token requirements

All API requests require an access token obtained from the Edge service. Include the MerchantId in the token request to authorize access for that merchant.

Requirement	Details
Token Type	Bearer token with claim tgt_hnk (Targeted Hierarchy Node Key) represent the merchant.
Token Request	Include MerchantId or caseNumber in the request header as per necessity.

Note:

The /MerchantDisputes endpoint filters disputes based on the MerchantNumber extracted from the tgt_hnk claim in the access token.

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.

• Disputes Management