Lista as quitações de dívida (o registro de cada acerto de saldo negativo)

GET/v1/balance/debt-settlements

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros de consulta

limitinteger
Tamanho da página (itens por página).
offsetinteger
Posição do primeiro item (a partir de 0).
sortstring
Expressão de ordenação, ex.: "-createdAt"

Respostas

200Sucesso

dataobject[]obrigatório
Os itens desta página.
+12 campos de data
- idstringobrigatório
  Id público da quitação.
- pixobjectobrigatóriopode ser nulo
  O Pix a pagar — só enquanto pending.
  +1 campo de pix
  - qrCodeEmvstringobrigatóriopode ser nulo
    Código copia e cola do Pix.
- amountintegerobrigatório
  Valor do Pix, em centavos.
- objectstringobrigatório
  Sempre debt_settlement.
  Valores:debt_settlement
- paidAtstringobrigatóriopode ser nulo
  Quando foi pago; null até lá.
- statusstringobrigatório
  pending (Pix em aberto), paid, expired (não pago) ou refunded.
  Valores:pendingpaidexpiredrefunded
- currencystringobrigatório
  Sempre BRL.
  Valores:BRL
- createdAtstringobrigatório
  Quando o recurso foi criado (ISO 8601, UTC).
- expiresAtstringobrigatóriopode ser nulo
  Quando o Pix expira.
- paidAmountintegerobrigatóriopode ser nulo
  O que foi pago, em centavos; null até ser pago. O que passar da dívida vira saldo disponível.
- owedAtIssuanceintegerobrigatório
  O que se devia quando o Pix foi emitido, em centavos.
- refundedAmountintegerobrigatório
  O que foi estornado dele, em centavos.
pageobjectobrigatório
Cursores de paginação da lista.
+3 campos de page
- totalintegerobrigatório
  Número total de páginas.
- offsetobjectobrigatório
  O offset para pedir a primeira, a anterior, a próxima e a última página.
  +4 campos de offset
  - lastintegerobrigatório
    Posição da última página.
  - nextintegerobrigatório
    Posição da próxima página (fica nesta quando ela é a última).
  - previntegerobrigatório
    Posição da página anterior (0 na primeira).
  - firstintegerobrigatório
    Posição da primeira página.
- currentintegerobrigatório
  Número da página atual (a primeira é 1).
limitintegerobrigatório
Tamanho da página, como pedido.
totalintegerobrigatório
Número total de itens que atendem aos filtros.
_linksobject
Links para operações relacionadas, por ação (self, create, update, delete, list…).
offsetintegerobrigatório
Posição do primeiro item desta página, como pedido.
hasMorebooleanobrigatório
true quando há mais itens depois desta página.
merchantobject
A conta dona do recurso (o vendedor de registro).
+3 campos de merchant
- namestringobrigatóriopode ser nulo
  Nome fantasia da conta dona do recurso.
- merchantIdstringobrigatóriopode ser nulo
  Id público da conta dona do recurso (bus_…).
- isSubAccountbooleanobrigatório
  true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorLista os movimentos do saldo PróximaEmite (ou devolve o já aberto) Pix para quitar um saldo negativo

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