CHcheckout
Disputes

Get dispute details

Returns all the details of a dispute using the dispute identifier.

get/disputes/{dispute_id}

Request

Path parameters

dispute_idstring required

The dispute identifier

Response

Dispute retrieved successfully

idstring

The dispute identifier. This is the same as the payment action ID.

entity_idstring

The client entity linked to this dispute.

sub_entity_idstring

The sub-entity linked to this dispute.

referencestring

An optional reference to identify the dispute.

category'fraudulent' | 'unrecognized' | 'canceled_recurring' | 'product_service_not_received' | 'not_as_described' | 'credit_not_issued' | 'duplicate' | 'incorrect_amount' | 'general'

The reason for the dispute. Find out more

amountnumber

The amount that is being disputed, in the processing currency. This amount can be positive or negative depending on the type of transaction the dispute is received against.

currencystring

The processing currency.

reason_codestring

The reason code provided by the card scheme.

status'evidence_required' | 'evidence_under_review' | 'resolved' | 'won' | 'lost' | 'canceled' | 'expired' | 'accepted' | 'arb_evidence_submitted' | 'arbitration_under_review' | 'arbitration_won' | 'arbitration_lost'

The current status of the dispute.

resolved_reason'rapid_dispute_resolution' | 'negative_amount' | 'already_refunded'

If the dispute is automatically resolved, resolved_reason will contain the reason why it was resolved.

evidence_required_bystring date-time

The deadline by which you must respond to the dispute.

This is equal to the received_on date + n calendar days, where n is the number of days set by the scheme or acquirer.

received_onstring date-time

The date and time at which the dispute was issued.

last_updatestring date-time

The date and time at which the dispute was last updated.

is_ce_candidateboolean

Indicates whether the dispute is eligible for compelling evidence.

segment_idstring

The unique identifier of the business segment that the payment belongs to.

Example response

{
  "id": "dsp_rbhwd2qrg13uhrp2newfarfder",
  "entity_id": "ent_wxglze3wwywujg4nna5fb7ldli",
  "sub_entity_id": "ent_uzm3uxtssvmuxnyrfdffcyjxeu",
  "reference": "dispute-09",
  "category": "fraudulent",
  "amount": 999,
  "currency": "GBP",
  "reason_code": "10.4",
  "status": "evidence_required",
  "resolved_reason": "already_refunded",
  "relevant_evidence": [
    [
      "proof_of_delivery_or_service",
      "compelling_evidence"
    ]
  ],
  "evidence_required_by": "2018-08-21T00:00:00.0000000+00:00",
  "received_on": "2018-08-01T04:00:10.0000000+00:00",
  "last_update": "2018-08-04T10:53:13.0000000+00:00",
  "is_ce_candidate": true,
  "payment": {
    "id": "pay_mbabizu24mvu3mela5njyhpit4",
    "action_id": "act_mbabizu24mvu3mela5njyhpit4",
    "processing_channel_id": "pc_q4dbxom5jbgudnjzjpz7j2z6uq",
    "amount": 999,
    "currency": "GBP",
    "method": "Visa",
    "acquirer_reference_number": "AA246873253573571073808",
    "mcc": "5021",
    "3ds": {
      "version": "2.1.0",
      "enrolled": "Y"
    },
    "eci": "06",
    "processed_on": "2018-08-01T08:18:10.0000000+00:00"
  },
  "evidence_list": [
    {
      "type": "proof_of_delivery_or_service"
    }
  ],
  "evidence_bundle": [
    {
      "dispute_id": "dsp_rbhwd2qrg13uhrp2newfab"
    }
  ],
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/disputes/dsp_rbhwd2qrg13uhrp2newf"
    },
    "evidence": {
      "href": "https://{prefix}.api.checkout.com/disputes/dsp_rbhwd2qrg13uhrp2newf/evidence"
    }
  }
}

Changes

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