OnnixPay

Cobranças

Listar cobranças

Lista as cobranças do Merchant, da mais recente para a mais antiga. Use os filtros para refinar e a paginação por cursor para percorrer todas as páginas.

GET/v1/charges

Headers

x-api-keystringobrigatório
Sua chave de API com escopo charge:read.

Parâmetros de query

limitintegeropcionaldefault: 20
Itens por página (1–100).
starting_afterstringopcional
Cursor de paginação: o id do último item da página anterior. Retorna os próximos itens mais antigos que ele.
statusenumopcional
Filtra por situação: pending, paid, expired, canceled, failed.
methodenumopcional
Filtra por método: pix, boleto, card.
created_afterstringopcional
Apenas cobranças criadas depois deste instante (ISO 8601).
created_beforestringopcional
Apenas cobranças criadas antes deste instante (ISO 8601).

Paginação por cursor

A resposta é um objeto list com data (os recursos) e has_more. Enquanto has_more for true, pegue o id do último item de data e passe-o em starting_after para obter a próxima página.

Ordenação estável

Os ids são UUIDv7 (ordenáveis por tempo), então a lista vem sempre da mais recente para a mais antiga e a paginação não “pula” itens mesmo com novas cobranças sendo criadas.
Requisição
curl -G https://apiv2.onnixpay.com/v1/charges \
  -H "x-api-key: sk_live_sua_chave_aqui" \
  -d limit=20 \
  -d status=paid
Resposta
{
  "object": "list",
  "data": [
    {
      "id": "019e93c8-4d42-7bfb-8e22-d0af69e68d9d",
      "object": "charge",
      "status": "paid",
      "amount": 2599,
      "currency": "BRL",
      "method": "pix",
      "reference": "pedido-1042",
      "payer": { "name": "MARIA S SOUZA", "document": "12345678909" },
      "payer_request": { "name": "Maria Souza", "document": "12345678909" },
      "pix": {
        "br_code": "00020101...6304CACD",
        "txid": "kk6g232xel65a0daee4dd13kk4000637343",
        "end_to_end_id": "E1234567820260603..."
      },
      "webhook_url": "https://sualoja.com/webhooks/onnix",
      "expires_at": "2026-06-04T13:00:00.000Z",
      "paid_at": "2026-06-04T12:05:31.000Z",
      "created_at": "2026-06-04T12:00:00.000Z"
    }
  ],
  "has_more": true
}
AnteriorConsultar cobrançaPróximo O objeto Payout