Skip to main content
GET
Listar Cobranças

Descrição

Retorna uma lista paginada das cobranças da empresa, criadas pela API e pelo Dashboard, com filtros por status, método e data. Os depósitos feitos na própria conta não entram na lista.

Headers

string
default:"Bearer YOUR_API_KEY"
required
Bearer token de autenticação. Formato: Bearer YOUR_API_KEY

Query Parameters

integer
default:"10"
Quantidade de resultados (mín: 1, máx: 100)
string
Cursor de paginação: ID da última cobrança da página anterior
string
Filtrar por método de pagamento: pix
string
Filtrar por status: creating, pending, paid, expired, failed, review
string
Data mínima de criação (ISO 8601)
string
Data máxima de criação (ISO 8601)

Exemplo de Requisição


Resposta 200 OK

string
Sempre "list"
array
Lista de cobranças, no mesmo formato da consulta
boolean
true se existem mais resultados
string
URL do endpoint

Paginação

A API usa cursor-based pagination com o campo starting_after:
Quando has_more é true, existem mais resultados. Use o id da última cobrança retornada como starting_after para buscar a próxima página.

Erros