Disputes Responses

The Dispute Response API allows you to submit a response for a specific dispute case by uploading supporting evidence files and optional text commentary.

Base URLs

Environment	URL
Integration	https://horizon-service-int.clearent.net/
Production	https://horizon-service.clearent.net/

Headers

Content-Type: application/json
Accept: application/json
AccessKey: Secret access key issued by Xplor Pay
MerchantId: Id of the merchant

Access Token

All API requests require an access token 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.

Available Endpoints

• Submit the Response Against a Dispute Case: POST /api/disputes/v2.0/responses

Usage Information

Ensure you meet the following conditions to submit a response for cases:

Dispute Response Conditions:

• Eligible Case Types: Only Chargebacks and Retrievals are allowed.

• Status Requirements: The case must be in Awaiting Response or New Activity status.

• When cases aren’t eligible for response:

  • Case status is UnderReview or Completed ? Returns 406 Not Acceptable.

  • Case type is not Chargeback or Retrieval Request (e.g., Reversal) ? Returns 406 Not Acceptable.

  • For Pre-Arb or Arb cases? returns 406 Not Acceptable with the below message:

Note: You cannot respond to this case type using Xplor’s dispute management tool. The merchant will receive a letter in the mail with instructions on how to pursue the case or accept the dispute. For more information, call the Chargeback & Disputes Department at +1.844.663.8797. Please have the case number ready. Pursuing this type of case can incur significant fees for the losing party.

Evidence Submission Allowed For: Retrievals, Chargebacks

Field	Limit
caseNumber	Required
responseMessage	Max 500 characters
evidences	Only .tiff, .tif, .pdf, .jpg, .jpeg allowed
File Size	Max 10 MB per file (configurable)
File Name	Max 50 characters (configurable)

Request Example

The request example to submit the response against a dispute case from the Dispute Management API can be written as:

curl -H "Content-Type: application/json" -X POST "https://horizon-service.clearent.net/api/disputes/v2.0/responses" -d '{
    "caseNumber": "CHB123456789",
    "response": "Response message",
    "responseType": 1 (can be only 1 or 2)
}'

Request Schema

The POST endpoint to submit a request against the dispute case objects. Refer to the below sample request, which includes both response text and attachment details:

{
  "caseNumber": "ABC123456789",
  "response": "My response message",
  "responseType": number (can be only 1 or 2)
}

Note: Providing only the response text without attachments may return an error for certain dispute case types.

Response Schema Properties

Element or Property	Data Type	Description
CaseNumber	String	The unique number assigned to a dispute case.
Response	String	The message provided by the merchant as a response.
responseType	Number	Indicates the type of response: 1 = Accept? Adds “I Accept” to response. 2 = Reject? Adds “I Reject” to response.