v1

latestOpenAPI 3.1.02026-07-131991131.4 KB

Disputes

Get disputes list

Returns list of 100 recently created disputes.

get/api/v1/disputes

Query parameters

statusesstring[]

Dispute status. If not set, then all statuses will be in result.

created_at_gtestring

Example:created_at_gte=2022-12-01T00:00:00Z

Filter disputes created after or at the specified date and time.

created_at_ltestring

Example:created_at_lte=2022-12-01T00:00:00Z

Filter disputes created before or at the specified date and time.

page_tokenstring

To load the next page of disputed items provide page token. This code can be obtained from the next_page_token variable in the response of dispute list. If next_page_token is empty in response, it means last page of disputes has been reached.

Response

Success. Returns a list of disputes.

next_page_tokenstring required

Example response

{
  "disputes": [
    {
      "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",
      "items": [
        {
          "reference_id": "payment id",
          "title": "Order item title",
          "unit_price": "100.00"
        }
      ],
      "order_number": "#1234",
      "comment": "additional comments"
    }
  ],
  "next_page_token": "next_page_token"
}