v1

latestOpenAPI 3.1.02026-07-131991131.4 KB
Disputes

Get dispute by id

Returns detailed information about dispute.

get/api/v1/disputes/{disputeId}

Path parameters

dispute_idstring uuid required
Example:dispute id, uuid format

ID of the dispute.

Response

Success. Returns dispute info.

Example response

{
  "dispute": {
    "id": "dispute id, uuid format",
    "attachments": [
      "attachment_1"
    ],
    "payment_id": "payment id, uuid format",
    "amount": "100.00",
    "currency": "AED",
    "created_at": "2018-10-17T00:00:00.000Z",
    "expired_at": "2018-10-17T00:00:00.000Z",
    "status": "new",
    "reason": "unreceived_refund",
    "history": [
      {
        "attachments": [
          "attachment_1"
        ],
        "created_at": "2018-10-17T00:00:00.000Z",
        "created_by": "email address of the source",
        "content": "customer comment",
        "source": "merchant",
        "event_type": "dispute_created",
        "note": "additional comments"
      }
    ],
    "items": [
      {
        "reference_id": "payment id",
        "title": "Order item title",
        "unit_price": "100.00"
      }
    ],
    "order_number": "#1234",
    "comment": "additional comments"
  }
}