CHcheckout
Disputes

Get disputes

Returns a list of all disputes against your business. The results will be returned in reverse chronological order, showing the last modified dispute (for example, where you've recently added a piece of evidence) first. You can use the optional parameters below to skip or limit results.

get/disputes

Request

Query parameters

limitinteger

The numbers of results to return

skipinteger

The number of results to skip

fromstring date-time

The date and time from which to filter disputes, based on the dispute's last_update field

tostring date-time

The date and time until which to filter disputes, based on the dispute's last_update field

idstring

The unique identifier of the dispute

entity_idsstring
Example:ent_wxglze3wwywujg4nna5fb7ldli,ent_vkb5zcy64zoe3cwfmaqvqyqyku

One or more comma-separated client entities. This works like a logical OR operator

sub_entity_idsstring
Example:ent_uzm3uxtssvmuxnyrfdffcyjxeu,ent_hy5wtzwzeuwefmsnjtdhw4scfi

One or more comma-separated sub-entities. This works like a logical OR operator

processing_channel_idsstring
Example:pc_uzm3uxtssvmuxnyrfdffcyjxeu,pc_hy5wtzwzeuwefmsnjtdhw4scfi

One or more comma-separated processing channels. This works like a logical OR operator.

segment_idsstring

One or more comma-separated segments. This works like a logical OR operator.

statusesstring
Example:evidence_required,evidence_under_review

One or more comma-separated statuses. This works like a logical OR operator

payment_idstring

The unique identifier of the payment

payment_referencestring

An optional reference (such as an order ID) that you can use later to identify the payment. Previously known as TrackId

payment_arnstring

The acquirer reference number (ARN) that you can use to query the issuing bank

payment_mccstring

The merchant category code (MCC) of the payment (ISO 18245)

this_channel_onlyboolean

If true, only returns disputes of the specific channel that the secret key is associated with. Otherwise, returns all disputes for that business

Response

Disputes retrieved successfully

limitinteger

The numbers of items to return.

skipinteger

The number of results to skip.

fromstring date-time

The date and time from which to filter disputes, based on the dispute's last_update field.

tostring date-time

The date and time until which to filter disputes, based on the dispute's last_update field.

idstring

The unique identifier of the dispute.

entity_idsstring

One or more comma-separated client entities. This works like a logical OR operator.

sub_entity_idsstring

One or more comma-separated sub-entities. This works like a logical OR operator.

processing_channel_idsstring

One or more comma-separated processing channels. This works like a logical OR operator.

segment_idsstring

One or more comma-separated segments. This works like a logical OR operator.

statusesstring

One or more comma-separated statuses. This works like a logical OR operator.

payment_idstring

The unique identifier of the payment.

payment_referencestring

An optional reference (such as an order ID) that you can use later to identify the payment. Previously known as TrackId.

payment_arnstring

The acquirer reference number (ARN) that you can use to query the issuing bank.

payment_mccstring

The merchant category code (MCC) of the payment (ISO 18245).

this_channel_onlyboolean

If true, only returns disputes of the specific channel that the secret key is associated with. Otherwise, returns all disputes for that business.

total_countinteger

The total number of disputes retrieved (without taking into consideration skip and limit parameters).

Example response

{
  "limit": 10,
  "skip": 10,
  "from": "2018-08-12T01:15:56.0000000+00:00",
  "to": "2018-08-13T11:09:01.0000000+00:00",
  "id": "dsp_rbhwd2qrg13uhrp2newfcd",
  "entity_ids": "ent_wxglze3wwywujg4nna5fb7ldli,ent_vkb5zcy64zoe3cwfmaqvqyqyku",
  "sub_entity_ids": "ent_uzm3uxtssvmuxnyrfdffcyjxeu,ent_hy5wtzwzeuwefmsnjtdhw4scfi",
  "processing_channel_ids": "pc_uzm3uxtssvmuxnyrfdffcyjxeu,pc_hy5wtzwzeuwefmsnjtdhw4scfi",
  "statuses": "evidence_required,evidence_under_review",
  "payment_id": "pay_lzmo6p0i3612judj754w1ngtil",
  "payment_reference": "th7zxa1kcnqmes8",
  "payment_arn": "74548998294293193445538",
  "payment_mcc": "5021",
  "this_channel_only": true,
  "total_count": 1,
  "data": [
    {
      "id": "dsp_rbhwd2qrg13uhrp2newfafreds",
      "entity_id": "ent_wxglze3wwywujg4nna5fb7ldli",
      "sub_entity_id": "ent_uzm3uxtssvmuxnyrfdffcyjxeu",
      "processing_channel": "pc_uzm3uxtssvmuxnyrfdffcyjxeu",
      "category": "fraudulent",
      "status": "evidence_required",
      "amount": 999,
      "currency": "GBP",
      "reason_code": "10.4",
      "payment_id": "pay_88cb4e671m1da22e9bbbyx",
      "payment_action_id": "act_mbabizu24mvu3mela5njyhpit4",
      "payment_reference": "th7zxa1kcnqmes8",
      "payment_arn": "74548998294293193445538",
      "payment_mcc": "5021",
      "payment_method": "VISA",
      "evidence_required_by": "2018-08-22T00:00:00.0000000+00:00",
      "received_on": "2018-08-01T01:15:56.0000000+00:00",
      "last_update": "2018-08-12T04:15:56.0000000+00:00",
      "resolved_reason": "already_refunded",
      "is_ce_candidate": true,
      "_links": {
        "self": {
          "href": "https://{prefix}.api.checkout.com/disputes/dsp_rbhwd2qrg13uhrp2newf"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.