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.

Xplor Pay provides two environments for testing and production use:

• 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.

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 AccessKey and MerchantId in the request header.

• Include a valid Bearer Token from the Edge service

• Use HTTPS and JSON for all requests.

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

• Use HTTPS and JSON for all 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
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) representing 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.

Obtaining an Access Key

Your Access Key and Edge service credentials are 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 integration credentials Contact Xplor Pay Integration Support to request integration environment credentials, including your Access Key and Edge service access. These credentials allow you to build, test, and validate your API integration safely in the integration environment.

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

3. Receive production credentials You'll receive your production Access Key and Edge service credentials for use in the live environment. Keep these credentials secure—they should never be shared or exposed publicly.