Skip to main content
GET
/
disputes
/
list
Disputes - List Disputes
curl --request GET \
  --url https://sandbox.hyperswitch.io/disputes/list \
  --header 'api-key: <api-key>'
[
  {
    "dispute_id": "<string>",
    "payment_id": "<string>",
    "attempt_id": "<string>",
    "amount": "<string>",
    "currency": "AED",
    "dispute_stage": "pre_dispute",
    "dispute_status": "dispute_opened",
    "connector": "<string>",
    "connector_status": "<string>",
    "connector_dispute_id": "<string>",
    "connector_reason": "<string>",
    "connector_reason_code": "<string>",
    "challenge_required_by": "2023-11-07T05:31:56Z",
    "connector_created_at": "2023-11-07T05:31:56Z",
    "connector_updated_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "profile_id": "<string>",
    "merchant_connector_id": "<string>"
  }
]

Authorizations

​
api-key
string
header
required

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Query Parameters

​
limit
integer | null

The maximum number of Dispute Objects to include in the response

​
dispute_status
enum<string>

The status of dispute Status of the dispute

Available options:
dispute_opened,
dispute_expired,
dispute_accepted,
dispute_cancelled,
dispute_challenged,
dispute_won,
dispute_lost
​
dispute_stage
enum<string>

The stage of dispute Stage of the dispute

Available options:
pre_dispute,
dispute,
pre_arbitration,
arbitration,
dispute_reversal
​
reason
string | null

The reason for dispute

​
connector
string | null

The connector linked to dispute

​
received_time
string<date-time> | null

The time at which dispute is received

​
received_time.lt
string<date-time> | null

Time less than the dispute received time

​
received_time.gt
string<date-time> | null

Time greater than the dispute received time

​
received_time.lte
string<date-time> | null

Time less than or equals to the dispute received time

​
received_time.gte
string<date-time> | null

Time greater than or equals to the dispute received time

Response

The dispute list was retrieved successfully

​
dispute_id
string
required

The identifier for dispute

​
payment_id
string
required

The identifier for payment_intent

​
attempt_id
string
required

The identifier for payment_attempt

​
amount
string
required

Connector specific types to send

​
currency
enum<string>
required

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLF,
CLP,
CNY,
COP,
CRC,
CUC,
CUP,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MRU,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SDG,
SEK,
SGD,
SHP,
SLE,
SLL,
SOS,
SRD,
SSP,
STD,
STN,
SVC,
SYP,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VES,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW,
ZWL
​
dispute_stage
enum<string>
required

Stage of the dispute

Available options:
pre_dispute,
dispute,
pre_arbitration,
arbitration,
dispute_reversal
​
dispute_status
enum<string>
required

Status of the dispute

Available options:
dispute_opened,
dispute_expired,
dispute_accepted,
dispute_cancelled,
dispute_challenged,
dispute_won,
dispute_lost
​
connector
string
required

connector to which dispute is associated with

​
connector_status
string
required

Status of the dispute sent by connector

​
connector_dispute_id
string
required

Dispute id sent by connector

​
created_at
string<date-time>
required

Time at which dispute is received

​
connector_reason
string | null

Reason of dispute sent by connector

​
connector_reason_code
string | null

Reason code of dispute sent by connector

​
challenge_required_by
string<date-time> | null

Evidence deadline of dispute sent by connector

​
connector_created_at
string<date-time> | null

Dispute created time sent by connector

​
connector_updated_at
string<date-time> | null

Dispute updated time sent by connector

​
profile_id
string | null

The profile_id associated with the dispute

​
merchant_connector_id
string | null

The merchant_connector_id of the connector / processor through which the dispute was processed

⌘I