List disputes

Endpoint

GET /clients/business/disputes

Headers

string

required

Your public API key.

string

required

Your API secret. Use a stl_test_... value in sandbox, stl_live_... in production.

string

required

Your business ID.

Query parameters

integer

Page number. Defaults to 1.

integer

Records per page. Defaults to 10.

string

Filter results to disputes for a specific transaction ID.

string

Filter by dispute status, e.g. "open", "resolved", "rejected".

string

Search disputes by keyword against the description or transaction ID.

See Pagination for full usage.

Response

boolean

true on success.

string

Human-readable outcome.

array

Array of dispute objects.

string

Unique dispute ID.

string

The ID of the disputed transaction.

string

Description of the issue submitted when the dispute was created.

string

Current status of the dispute.

string

ISO 8601 timestamp of when the dispute was filed.

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 "x-api-key: stl_c8e286ca55b0123e0b05da047494f585" \
  -H "x-api-secret: stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0" \
  -H "businessId: YOUR_BUSINESS_ID"

const params = new URLSearchParams({ page: 1, limit: 10, status: "open" });
const res = await fetch(
  `https://sandbox.stellasbank.com/api/v1/clients/business/disputes?${params}`,
  {
    headers: {
      "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
      "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
      businessId: "YOUR_BUSINESS_ID",
    },
  }
);
const { data, pagination } = await res.json();

import requests

res = requests.get(
    "https://sandbox.stellasbank.com/api/v1/clients/business/disputes",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
    params={"page": 1, "limit": 10, "status": "open"},
)
print(res.json())

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
  }
}

Overview

Members

Business

Virtual accounts

Funds

Bulk transfers

Disputes

Subscriptions

Payouts

Audit logs

Settings

Endpoint

Headers

Query parameters

Response

Code examples

Example response

​Endpoint

​Headers

​Query parameters

​Response

​Code examples

​Example response

Endpoint

Headers

Query parameters

Response

Code examples

Example response