OnnixPay

Pagamentos

Listar pagamentos

Lista os pagamentos de saída do Merchant (PIX OUT e TED OUT), do mais recente para o mais antigo. Use os filtros para refinar e a paginação por cursor para percorrer todas as páginas.

GET/v1/payouts

Headers

x-api-keystringobrigatório
Sua chave de API com escopo payout: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, processing, completed, failed, reversed.
methodenumopcional
Filtra por trilho: pix ou ted.
created_afterstringopcional
Apenas pagamentos criados depois deste instante (ISO 8601).
created_beforestringopcional
Apenas pagamentos criados 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.

PIX e TED na mesma lista

A listagem une os dois trilhos (PIX OUT e TED OUT) e os ordena por id (UUIDv7, ordenável por tempo), do mais recente para o mais antigo. Use method para ver apenas um trilho.
Requisição
curl -G https://apiv2.onnixpay.com/v1/payouts \
  -H "x-api-key: sk_live_sua_chave_aqui" \
  -d limit=20 \
  -d status=completed
Resposta
{
  "object": "list",
  "data": [
    {
      "id": "019e9045-8a9b-7f76-9017-297fcf4fd5cf",
      "object": "payout",
      "method": "pix",
      "status": "completed",
      "amount": 5000,
      "currency": "BRL",
      "end_to_end_id": "E1234567820260603...",
      "recipient": {
        "name": "Maria Souza",
        "document": "12345678909",
        "bank_ispb": "60701190",
        "branch": "0001",
        "account": "123456",
        "pix_key": "maria@exemplo.com"
      },
      "description": "Repasse de comissão",
      "reference": "saque-7781",
      "webhook_url": "https://seu-app.com/webhooks/onnix",
      "failure_reason": null,
      "created_at": "2026-06-04T01:35:37.115Z",
      "completed_at": "2026-06-04T01:35:41.882Z",
      "failed_at": null
    }
  ],
  "has_more": true
}
AnteriorConsultar pagamentoPróximo Consultar chave (DICT)