Find a dispute - Documentation - PayNext

GET

/

disputes

/

{id}

Find a dispute

curl --request GET \
  --url https://sandbox-api.paynext.com/disputes/{id} \
  --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/{id}', 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/{id}"

	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/{id}"

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/{id}",
  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;
}

{
  "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",
  "details": {
    "network_reason_code": "10.4",
    "processor_reason_code": "fraudulent"
  },
  "created_at": "2025-06-20T10:20:00Z",
  "updated_at": "2025-06-20T10:20:00Z"
}

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:1.0.0

required

Specifies the version of the API to use

Available options:

1.0.0

Path Parameters

id

string

required

The ID of the dispute to find (dsp_<uuid>)

Response

OK

created_at

string

required

When the dispute was first recorded in PayNext.

Example:

"2026-08-01T10:20:00Z"

disputed_at

string

required

When the dispute was raised.

Example:

"2026-08-01T10:15:00Z"

external_id

string

required

The dispute identifier assigned by the processor.

Example:

"dp_1Nx2yZAbCdEfGh"

id

string

required

Unique identifier of the dispute.

Example:

"dsp_7c1a2b3c-4d5e-6f70-8a9b-0c1d2e3f4a5b"

payment_id

string

required

ID of the disputed payment.

Example:

"pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789"

reason

enum<string>

required

Reason category for the dispute, normalized across processors.

Available options:

FRAUDULENT,

UNRECOGNIZED,

PRODUCT_NOT_RECEIVED,

PRODUCT_UNACCEPTABLE,

SUBSCRIPTION_CANCELED,

CREDIT_NOT_PROCESSED,

DUPLICATE,

GENERAL_NONCOMPLIANT

Example:

"FRAUDULENT"

stage

enum<string>

required

Where the dispute sits in the network's process.

Available options:

RETRIEVAL,

DISPUTE

Example:

"DISPUTE"

status

enum<string>

required

The dispute's current status. WON, LOST, ACCEPTED, and PREVENTED are final. A missed response deadline reports as LOST.

Available options:

NEEDS_RESPONSE,

EVIDENCE_SUBMITTED,

UNDER_REVIEW,

WON,

LOST,

ACCEPTED,

PREVENTED

Example:

"NEEDS_RESPONSE"

updated_at

string

required

When the dispute was last updated in PayNext.

Example:

"2026-08-02T09:00:00Z"

details

object

Processor-specific reference values for the dispute. Which keys appear depends on the processor, and a key with no value is null. Returned by GET /disputes/{id} only; list items never include it. Omitted when the processor supplied no details.

Show child attributes

Example:

{
  "network_reason_code": "10.4",
  "processor_reason_code": "fraudulent"
}

resolved_at

string

When the dispute first reached a final status (WON, LOST, ACCEPTED, or PREVENTED). Omitted while the dispute is open.

Example:

"2026-09-10T08:00:00Z"

respond_by

string

Deadline for your response. Omitted when the processor did not supply one.

Example:

"2026-08-15T23:59:59Z"

⌘I

Find a dispute

curl --request GET \
  --url https://sandbox-api.paynext.com/disputes/{id} \
  --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/{id}', 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/{id}"

	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/{id}"

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/{id}",
  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;
}

{
  "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",
  "details": {
    "network_reason_code": "10.4",
    "processor_reason_code": "fraudulent"
  },
  "created_at": "2025-06-20T10:20:00Z",
  "updated_at": "2025-06-20T10:20:00Z"
}