Seção 10

Paginação e Filtros

As listagens usam limit e offset:

ParâmetroPadrãoMáximo
limit20100
offset0—

Formato da resposta:

{
  "items": [ ],
  "total": 134,
  "limit": 20,
  "offset": 0
}

Para a próxima página, some limit ao offset até alcançar total.

Filtros de GET /payments

ParâmetroExemploDescrição
statusPAIDPENDING, PAID, FAILED, CANCELED, REFUNDED, REQUIRES_ACTION
payment_methodPIXPIX, BOLETO, CARD
due_date_from2026-10-01Vencimento a partir de
due_date_to2026-10-31Vencimento até
subscription_id12Cobranças de uma assinatura
curl "https://api.gaudpay.com.br/payments?status=PAID&payment_method=PIX&limit=50" \
  -H "Authorization: Bearer $GAUDPAY_TOKEN"

Busca de clientes

GET /customers?q=maria busca por nome ou documento.