Skip to main content

​
Endpoint

GET /clients/business/disputes/{id}

​
Path parameters

​
id
string
required
The unique ID of the dispute to retrieve.

​
Headers

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

​
Response

​
status
boolean
true on success.
​
message
string
Human-readable outcome.
​
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.

​
Code examples

curl -X GET https://sandbox.stellasbank.com/api/v1/clients/business/disputes/DISPUTE_ID \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID"

​
Example response

{
  "status": true,
  "message": "Dispute 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"
  }
}