Skip to main content

​
Endpoint

GET /clients/business/disputes

​
Headers

​
Authorization
string
required
Bearer YOUR_ACCESS_TOKEN
​
SECRET_KEY
string
required
Your API secret key.
​
businessId
string
required
Your business ID.

​
Query parameters

​
page
integer
Page number. Defaults to 1.
​
limit
integer
Records per page. Defaults to 10.
​
transactionId
string
Filter results to disputes for a specific transaction ID.
​
status
string
Filter by dispute status, e.g. "open", "resolved", "rejected".
​
keyword
string
Search disputes by keyword against the description or transaction ID.
See Pagination for full usage.

​
Response

​
status
boolean
true on success.
​
message
string
Human-readable outcome.
​
data
array
Array of dispute objects.
​
data[].id
string
Unique dispute ID.
​
data[].transactionId
string
The ID of the disputed transaction.
​
data[].description
string
Description of the issue submitted when the dispute was created.
​
data[].status
string
Current status of the dispute.
​
data[].dateCreated
string
ISO 8601 timestamp of when the dispute was filed.
​
pagination
object
Standard pagination envelope. See Pagination.

​
Code examples

curl -X GET "https://sandbox.stellasbank.com/api/v1/clients/business/disputes?page=1&limit=10&status=open" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID"

​
Example response

{
  "status": true,
  "message": "Disputes retrieved successfully",
  "data": [
    {
      "id": "dispute_001",
      "transactionId": "txn_abc001",
      "description": "Amount charged does not match the agreed amount.",
      "status": "open",
      "dateCreated": "2024-06-09T10:00:00.000Z"
    }
  ],
  "pagination": {
    "totalCount": 5,
    "hasNextPage": false,
    "hasPreviousPage": false,
    "nextPage": 0,
    "previousPage": 0,
    "limit": 10,
    "lastPage": 1
  }
}