Disputes

Find disputes

List your organization’s disputes, newest first by default. The list can take up to about a minute to reflect a new or updated dispute; fetch a dispute by ID for its current state. List items never include details.

Pagination is capped at 10000 results: page * limit must not exceed 10000, otherwise the request returns 400, and meta.pages never exceeds 10000 / limit. A missing or non-numeric page or limit uses its default. A page below 1 is treated as 1, a limit above 100 as 100, and a limit below 1 as 10.

GET

disputes

Find disputes

curl --request GET \
  --url https://sandbox-api.paynext.com/disputes \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Version: <x-api-version>'

const options = {
  method: 'GET',
  headers: {'X-API-Version': '<x-api-version>', Authorization: 'Bearer <token>'}
};

fetch('https://sandbox-api.paynext.com/disputes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.paynext.com/disputes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Version", "<x-api-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

import requests

url = "https://sandbox-api.paynext.com/disputes"

headers = {
    "X-API-Version": "<x-api-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.paynext.com/disputes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-API-Version: <x-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "id": "dsp_7c1a2b3c-4d5e-6f70-8a9b-0c1d2e3f4a5b",
      "payment_id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "external_id": "dp_1Nx2yZAbCdEfGh",
      "stage": "DISPUTE",
      "status": "NEEDS_RESPONSE",
      "reason": "FRAUDULENT",
      "disputed_at": "2025-06-20T10:15:00Z",
      "respond_by": "2025-07-04T23:59:59Z",
      "created_at": "2025-06-20T10:20:00Z",
      "updated_at": "2025-06-20T10:20:00Z"
    },
    {
      "id": "dsp_2f9e8d7c-6b5a-4c3d-9e2f-1a0b9c8d7e6f",
      "payment_id": "pay_5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a",
      "external_id": "PP-D-27803",
      "stage": "DISPUTE",
      "status": "WON",
      "reason": "PRODUCT_NOT_RECEIVED",
      "disputed_at": "2025-05-02T08:00:00Z",
      "respond_by": "2025-05-12T08:00:00Z",
      "resolved_at": "2025-06-01T12:00:00Z",
      "created_at": "2025-05-02T08:03:00Z",
      "updated_at": "2025-06-01T12:00:05Z"
    }
  ],
  "meta": {
    "page": 1,
    "pages": 1,
    "limit": 100,
    "total": 2,
    "snapshot_at": ""
  }
}

Authorizations

Authorization

string

header

required

Authentication header of the form api key, where api key is your organization api key.

Headers

X-API-Version

enum<string>

default:2.0.0

required

Specifies the version of the API to use

Available options:

2.0.0

Query Parameters

page

integer

default:1

Page number, starting at 1

limit

integer

default:100

Number of items per page (maximum 100)

Required range: x <= 100

sort

enum<string>

default:disputed_at

Field to sort by

Available options:

disputed_at,

created_at,

updated_at,

respond_by,

resolved_at

order

enum<string>

default:desc

Sort order. Must be lowercase.

Available options:

asc,

desc

status

enum<string>

Filter by dispute status. Case-insensitive.

Available options:

NEEDS_RESPONSE,

EVIDENCE_SUBMITTED,

UNDER_REVIEW,

WON,

LOST,

ACCEPTED,

PREVENTED

stage

enum<string>

Filter by dispute stage. Case-insensitive.

Available options:

RETRIEVAL,

DISPUTE

payment_id

string

Filter by the disputed payment's ID, as pay_<uuid> or a bare UUID

Response

data

object[]

Show child attributes

meta

object

Show child attributes

⌘I

Find disputes

curl --request GET \
  --url https://sandbox-api.paynext.com/disputes \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Version: <x-api-version>'

const options = {
  method: 'GET',
  headers: {'X-API-Version': '<x-api-version>', Authorization: 'Bearer <token>'}
};

fetch('https://sandbox-api.paynext.com/disputes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.paynext.com/disputes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Version", "<x-api-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

import requests

url = "https://sandbox-api.paynext.com/disputes"

headers = {
    "X-API-Version": "<x-api-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.paynext.com/disputes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-API-Version: <x-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "id": "dsp_7c1a2b3c-4d5e-6f70-8a9b-0c1d2e3f4a5b",
      "payment_id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "external_id": "dp_1Nx2yZAbCdEfGh",
      "stage": "DISPUTE",
      "status": "NEEDS_RESPONSE",
      "reason": "FRAUDULENT",
      "disputed_at": "2025-06-20T10:15:00Z",
      "respond_by": "2025-07-04T23:59:59Z",
      "created_at": "2025-06-20T10:20:00Z",
      "updated_at": "2025-06-20T10:20:00Z"
    },
    {
      "id": "dsp_2f9e8d7c-6b5a-4c3d-9e2f-1a0b9c8d7e6f",
      "payment_id": "pay_5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a",
      "external_id": "PP-D-27803",
      "stage": "DISPUTE",
      "status": "WON",
      "reason": "PRODUCT_NOT_RECEIVED",
      "disputed_at": "2025-05-02T08:00:00Z",
      "respond_by": "2025-05-12T08:00:00Z",
      "resolved_at": "2025-06-01T12:00:00Z",
      "created_at": "2025-05-02T08:03:00Z",
      "updated_at": "2025-06-01T12:00:05Z"
    }
  ],
  "meta": {
    "page": 1,
    "pages": 1,
    "limit": 100,
    "total": 2,
    "snapshot_at": ""
  }
}

Introduction

API Reference

Find disputes

Authorizations

Headers

Query Parameters

Response