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

GET/v1/balance/debt-settlements

Authenticate with the header SelectKey: a sk_test_ key works in the sandbox, a sk_live_ key in production.

Query parameters

limitinteger
Page size (items per page).
offsetinteger
Offset of the first item (0-based).
sortstring
Sort expression, e.g. "-createdAt"

Responses

200OK

dataobject[]required
The items of this page.
+12 fields in data
- idstringrequired
  Public id of the settlement.
- pixobjectrequirednullable
  The Pix to pay — only while pending.
  +1 field in pix
  - qrCodeEmvstringrequirednullable
    Pix copy-and-paste code.
- amountintegerrequired
  Amount of the Pix, in cents.
- objectstringrequired
  Always debt_settlement.
  Values:debt_settlement
- paidAtstringrequirednullable
  When it was paid; null until then.
- statusstringrequired
  pending (Pix open), paid, expired (unpaid) or refunded.
  Values:pendingpaidexpiredrefunded
- currencystringrequired
  Always BRL.
  Values:BRL
- createdAtstringrequired
  When the resource was created (ISO 8601, UTC).
- expiresAtstringrequirednullable
  When the Pix expires.
- paidAmountintegerrequirednullable
  What was paid, in cents; null until paid. What exceeds the debt becomes available balance.
- owedAtIssuanceintegerrequired
  What was owed when the Pix was issued, in cents.
- refundedAmountintegerrequired
  What was refunded of it, in cents.
pageobjectrequired
Paging cursors of the list.
+3 fields in page
- totalintegerrequired
  Total number of pages.
- offsetobjectrequired
  The offset to request the first, previous, next and last pages.
  +4 fields in offset
  - lastintegerrequired
    Offset of the last page.
  - nextintegerrequired
    Offset of the next page (stays on this page when it is the last one).
  - previntegerrequired
    Offset of the previous page (0 on the first page).
  - firstintegerrequired
    Offset of the first page.
- currentintegerrequired
  Current page number (1-based).
limitintegerrequired
Page size, as requested.
totalintegerrequired
Total number of items that match the filters.
_linksobject
Links to related operations, keyed by action (self, create, update, delete, list…).
offsetintegerrequired
Offset of the first item of this page, as requested.
hasMorebooleanrequired
true when there are more items after this page.
merchantobject
The account that owns the resource (the merchant of record).
+3 fields in merchant
- namestringrequirednullable
  Trading name of the account that owns the resource.
- merchantIdstringrequirednullable
  Public id of the account that owns the resource (bus_…).
- isSubAccountbooleanrequired
  true when the resource belongs to a sub-account operated by a marketplace platform.

401Unauthorized (missing or invalid credential)

errorobjectrequired
+8 fields in error
- codestringrequired
- paramsobject[]
- statusstringrequired
- detailsstring
- messagestringrequired
- categorystringrequired
  Values:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringrequired
- statusCodeintegerrequired

403Forbidden (no permission)

errorobjectrequired
+8 fields in error
- codestringrequired
- paramsobject[]
- statusstringrequired
- detailsstring
- messagestringrequired
- categorystringrequired
  Values:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringrequired
- statusCodeintegerrequired

500Internal server error

errorobjectrequired
+8 fields in error
- codestringrequired
- paramsobject[]
- statusstringrequired
- detailsstring
- messagestringrequired
- categorystringrequired
  Values:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringrequired
- statusCodeintegerrequired

PreviousList balance movements NextIssue (or return the open) Pix to settle a negative balance

{ "data": [ { "id": "string", "pix": { "qrCodeEmv": "string" }, "amount": 5000, "object": "debt_settlement", "paidAt": "string", "status": "pending", "currency": "BRL", "createdAt": "string", "expiresAt": "string", "paidAmount": 5000, "owedAtIssuance": 0, "refundedAmount": 5000 } ], "page": { "total": 5000, "offset": { "last": 0, "next": 0, "prev": 0, "first": 0 }, "current": 0 }, "limit": 0, "total": 5000, "_links": {}, "offset": 0, "hasMore": true, "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true } }