Endpoints
List disputes
Endpoints
List disputes
Get a list of disputes
GET
/
disputes
curl --request GET \
--url https://app.disputeninja.io/api/v1/disputes \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "<string>",
"object": "dispute",
"initiated_at": "2023-11-07T05:31:56Z",
"response_due_by": "2023-11-07T05:31:56Z",
"amount": 123,
"currency": "<string>",
"reason": "<string>",
"status": "<string>",
"provider": "<string>",
"evidence": {
"products": [
{
"product_title": "<string>",
"price": 123,
"quantity": 123,
"currency_code": "<string>"
}
],
"delivery_method": "digital",
"merchant_profile": {
"merchant_id": "<string>",
"merchant_name": "<string>",
"merchant_website": "<string>"
},
"shipping_tracking_numbers": [
"<string>"
],
"additional_evidence": {}
}
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Number of disputes to return (default: 10, max: 100)
Required range:
1 < x < 100
Number of disputes to skip (default: 0)
Required range:
x > 0
Response
200
application/json
List of disputes
Unique identifier for the dispute
String representing the object's type
Available options:
dispute
Timestamp when the dispute was initiated
Deadline for responding to the dispute
The disputed amount in the smallest currency unit
Three-letter ISO currency code
The reason for the dispute
Current status of the dispute
The external provider handling the dispute
curl --request GET \
--url https://app.disputeninja.io/api/v1/disputes \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "<string>",
"object": "dispute",
"initiated_at": "2023-11-07T05:31:56Z",
"response_due_by": "2023-11-07T05:31:56Z",
"amount": 123,
"currency": "<string>",
"reason": "<string>",
"status": "<string>",
"provider": "<string>",
"evidence": {
"products": [
{
"product_title": "<string>",
"price": 123,
"quantity": 123,
"currency_code": "<string>"
}
],
"delivery_method": "digital",
"merchant_profile": {
"merchant_id": "<string>",
"merchant_name": "<string>",
"merchant_website": "<string>"
},
"shipping_tracking_numbers": [
"<string>"
],
"additional_evidence": {}
}
}
]
}