Disputes Reporting

Get Submitted Dispute Response

get

Retrieve all merchant-submitted responses for a specific dispute case including comments and associated evidence file names.

Path parameters

caseNumberstringRequired

The unique dispute case identification number. Example: CN12345678.

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/api/disputes/v2.0/merchantdisputes/{caseNumber}/responses

HTTPcURLJavaScriptPython

GET /api/disputes/v2.0/merchantdisputes/{caseNumber}/responses HTTP/1.1
Accept: */*

{
  "responses": [
    {
      "responseId": "string",
      "caseNumber": "string",
      "merchantNumber": "string",
      "response": "string",
      "createDateTimeUtc": "2025-12-08T10:30:00.000Z",
      "attachments": [
        {
          "attachmentId": 1,
          "fileName": "string"
        }
      ]
    }
  ]
}

Get Dispute Case History

get

Retrieve the history of a specific dispute case number including all status updates.

Path parameters

caseNumberstringRequired

The unique dispute case identification number.

Responses

200

Success

application/json

resellerHnkstring · nullableOptional

The hierarchy node key (HNK) of the reseller associated with the merchant.

Example: text

resellerDbastring · nullableOptional

The reseller's Doing Business As (DBA) name.

Example: text

parentHnkstring · nullableOptional

The hierarchy node key (HNK) of the parent entity in the merchant hierarchy.

Example: text

parentDbastring · nullableOptional

The parent entity's Doing Business As (DBA) name.

Example: text

midstring · nullableOptional

The merchant's unique identification number.

Example: text

midLegalNamestring · nullableOptional

The merchant's legal registered business name.

Example: text

midDbastring · nullableOptional

The merchant's Doing Business As (DBA) name.

Example: text

familyIdstring · nullableOptional

The merchant's family or portfolio identifier used for internal grouping.

Example: text

caseNumberstring · nullableOptional

The unique dispute case number assigned to the merchant dispute.

Example: text

caseTypestring · nullableOptional

Type of the dispute case involved. Possible values: Chargeback, Retrieval Request.

Example: text

reasonstring · nullableOptional

The reason description explaining why the dispute was initiated.

Example: text

cardNumberstring · nullableOptional

The masked or last 4 digits of the card number used in the original transaction.

Example: text

cardTypestring · nullableOptional

The brand of the payment card used in the transaction.

Example: text

transactionTypestring · nullableOptional

The type of transaction involved in the dispute. Possible values: 05 - retail sale, 06 - credit, 07 - cash advance, 08 - quasi cash.

Example: text

originalTrxnFundsFlowstring · nullableOptional

Indicates whether the original transaction was funded, reversed, or settled.

Example: text

originalReferenceNumberstring · nullableOptional

The processor-assigned reference number for the original transaction associated with dispute.

Example: text

referenceNumberstring · nullableOptional

Reference number associated with the chargeback or dispute case.

Example: text

transactionDatestring · nullableOptional

Date when the original transaction occurred. Format: YYYY-MM-DD.

Example: text

transactionAmountnumber · doubleOptional

Amount of the original transaction.

Example: 1

caseExpirationDatestring · nullableOptional

Date when the dispute case expires if no action is taken.

Example: text

caseResolvedDatestring · nullableOptional

Date when the dispute case was resolved. Format: YYYY-MM-DD.

Example: text

403

Forbidden

application/json

404

Not Found

application/json

get

/api/disputes/v2.0/merchantdisputes/{caseNumber}

HTTPcURLJavaScriptPython

GET /api/disputes/v2.0/merchantdisputes/{caseNumber} HTTP/1.1
Accept: */*

{
  "resellerHnk": "text",
  "resellerDba": "text",
  "parentHnk": "text",
  "parentDba": "text",
  "mid": "text",
  "midLegalName": "text",
  "midDba": "text",
  "familyId": "text",
  "caseNumber": "text",
  "caseType": "text",
  "reason": "text",
  "cardNumber": "text",
  "cardType": "text",
  "transactionType": "text",
  "originalTrxnFundsFlow": "text",
  "originalReferenceNumber": "text",
  "referenceNumber": "text",
  "transactionDate": "text",
  "transactionAmount": 1,
  "caseExpirationDate": "text",
  "caseResolvedDate": "text",
  "statusHistory": [
    {
      "status": "text",
      "disputeDate": "text",
      "disputeAmount": 1,
      "merchantAmount": 1,
      "respondByDate": "text",
      "responseDate": "text"
    }
  ]
}

Get Dispute Cases

get

Retrieve a list of merchant dispute cases based on filtering and sorting capabilities.

Query parameters

FromDatestring · date-timeOptional

Filters the results by the start date of the dispute cases. Default is the first day of the current month.

ToDatestring · date-timeOptional

Filters the results by the end date of the dispute cases. Default is today's date.

CardBrandNamestringOptional

Filters the results by the card brand name. For example: Visa, Mastercard, Amex, Discover. Defaults to all card brands. Comma-separated values are not supported.

StatusstringOptional

Filters the results by the dispute status. For example: New Activity, Awaiting Response.

PageNumberinteger · int32Optional

Specifies the page number of results to return when pagination is applied. Default: 1.

PageSizeinteger · int32Optional

Specifies the number of results to return per page. Default: 25.

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

500

Server Error

application/json

get

/api/disputes/v2.0/merchantdisputes

HTTPcURLJavaScriptPython

GET /api/disputes/v2.0/merchantdisputes HTTP/1.1
Accept: */*

{
  "data": [
    {
      "resellerHnk": "text",
      "resellerDba": "text",
      "parentHnk": "text",
      "parentDba": "text",
      "mid": "text",
      "midLegalName": "text",
      "midDba": "text",
      "familyId": "text",
      "caseNumber": "text",
      "caseType": "text",
      "reason": "text",
      "status": "text",
      "cardNumber": "text",
      "cardType": "text",
      "transactionType": "text",
      "originalTrxnFundsFlow": "text",
      "originalReferenceNumber": "text",
      "referenceNumber": "text",
      "transactionDate": "text",
      "transactionAmount": 1,
      "disputeDate": "text",
      "disputeAmount": 1,
      "merchantAmount": 1,
      "respondByDate": "text",
      "caseExpirationDate": "text",
      "responseDate": "text",
      "caseResolvedDate": "text"
    }
  ],
  "page": {
    "number": 1,
    "size": 1,
    "sort": {
      "field": {
        "ANY_ADDITIONAL_PROPERTY": "ASC"
      }
    },
    "first": true,
    "last": true,
    "totalPages": 1,
    "numberOfElements": 1,
    "totalElements": 1
  }
}