List All Disputes

GEThttps://api.omise.co/disputes

Retrieve a paginated list of all disputes in your account, including open, pending, won, and lost disputes.

---

🔑API Credentials

▼

---

Request Parameters

Additional - 5 fieldsAdditional Parameters

▼

---

Responses

200

Successful retrieval

Returns a list object containing dispute objects and pagination metadata.

Response includes:

• object - Always "list"
• data - Array of dispute objects
• limit - Number of results per page
• offset - Number of results skipped
• total - Total number of disputes matching filters
• from - Start date of filter range
• to - End date of filter range
• order - Sort order used

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid date format (must be ISO 8601)
• Limit exceeds maximum (100)
• Invalid order parameter
• Negative offset or limit values

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

---

Code samples

cURL

curl https://api.omise.co/disputes \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "limit=20" \
  -d "offset=0" \
  -d "order=reverse_chronological"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

disputes = Omise::Dispute.list({
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

disputes = omise.Dispute.list(
    limit=20,
    offset=0,
    order='reverse_chronological'
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const disputes = await omise.disputes.list({
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$disputes = OmiseDispute::retrieve([
    'limit' => 20,
    'offset' => 0,
    'order' => 'reverse_chronological'
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

ScopedList<Dispute> disputes = client.disputes().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var disputes = await client.Disputes.GetList(new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

disputes, _ := client.ListDisputes(&operations.ListDisputes{
    Limit:  20,
    Offset: 0,
})

---

Error and result codes

Common Error Codes

Code	Description	Resolution
bad_request	Invalid parameters	Check date format and parameter values
authentication_failure	Invalid API key	Verify your secret key is correct
invalid_date_format	Date not in ISO 8601 format	Use YYYY-MM-DDTHH:MM:SSZ format

Dispute Status Values

Status	Description
open	Newly initiated, awaiting your response
pending	Under review with merchant response submitted
won	Merchant won the dispute
lost	Merchant lost the dispute

---

Try it out

Additional - 5 fields

▼