Finance

List debt settlements (the record of each negative-balance payoff)

GET
/v1/balance/debt-settlements

Authorization

selectkey<token>

API key para requisições autenticadas. Envie sua chave no cabeçalho selectkey (sandbox sk_test_…, produção sk_live_…).

In: header

Query Parameters

limit?integer
offset?integer
sort?string

Sort expression, e.g. "-createdAt"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/balance/debt-settlements"
{
  "offset": 0,
  "limit": 0,
  "total": 5000,
  "page": {
    "offset": {
      "first": 0,
      "prev": 0,
      "next": 0,
      "last": 0
    },
    "current": 0,
    "total": 5000
  },
  "hasMore": true,
  "data": [
    {
      "object": "debt_settlement",
      "id": "string",
      "status": "pending",
      "owedAtIssuance": 0,
      "amount": 5000,
      "paidAmount": 5000,
      "refundedAmount": 5000,
      "currency": "BRL",
      "pix": {
        "qrCodeEmv": "string"
      },
      "expiresAt": "string",
      "paidAt": "string",
      "createdAt": "string"
    }
  ],
  "merchant": {
    "name": "Acme Ltda",
    "merchantId": "string",
    "isSubAccount": true
  },
  "_links": {}
}
{
  "error": {
    "status": "Unauthorized",
    "statusCode": 401,
    "category": "authentication",
    "code": "unauthorized",
    "message": "Authentication is required to access this resource.",
    "resource": "server"
  }
}
{
  "error": {
    "status": "Forbidden",
    "statusCode": 403,
    "category": "authorization",
    "code": "forbidden",
    "message": "You do not have permission to perform this action.",
    "resource": "server"
  }
}
{
  "error": {
    "status": "Internal Server Error",
    "statusCode": 500,
    "category": "server",
    "code": "serverError",
    "message": "An unexpected error occurred. Please try again later.",
    "resource": "server",
    "details": "If the problem persists, contact support with the correlationId from the response headers."
  }
}