Get dispute

Endpoint

GET /clients/business/disputes/{id}

Path parameters

string

required

The unique ID of the dispute to retrieve.

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.

Response

boolean

true on success.

string

Human-readable outcome.

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.

Code examples

curl -X GET https://sandbox.stellasbank.com/api/v1/clients/business/disputes/DISPUTE_ID \
  -H "x-api-key: stl_c8e286ca55b0123e0b05da047494f585" \
  -H "x-api-secret: stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0" \
  -H "businessId: YOUR_BUSINESS_ID"

const res = await fetch(
  "https://sandbox.stellasbank.com/api/v1/clients/business/disputes/DISPUTE_ID",
  {
    headers: {
      "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
      "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
      businessId: "YOUR_BUSINESS_ID",
    },
  }
);
const { data } = await res.json();

import requests

res = requests.get(
    "https://sandbox.stellasbank.com/api/v1/clients/business/disputes/DISPUTE_ID",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
)
print(res.json()["data"])

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

Overview

Members

Business

Virtual accounts

Funds

Bulk transfers

Disputes

Subscriptions

Payouts

Audit logs

Settings

Endpoint

Path parameters

Headers

Response

Code examples

Example response

​Endpoint

​Path parameters

​Headers

​Response

​Code examples

​Example response

Endpoint

Path parameters

Headers

Response

Code examples

Example response