OnnixPay

Pagamentos

Consultar pagamento

Recupera um pagamento pelo seu id, PIX ou TED, o mesmo endpoint serve para ambos. Útil para conferir o status e o end_to_end_id após a confirmação.

GET/v1/payouts/:id

Headers

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

Parâmetros de caminho

idstringobrigatório
O identificador (UUID) do pagamento.

Prefira webhooks ao polling

Para saber quando um pagamento foi concluído, use webhooks em vez de consultar em loop. Se precisar conciliar, consulte com parcimônia respeitando o rate limit.
Requisição
curl https://apiv2.onnixpay.com/v1/payouts/019e9045-8a9b-7f76-9017-297fcf4fd5cf \
  -H "x-api-key: sk_live_sua_chave_aqui"
Resposta
{
  "id": "019e9045-8a9b-7f76-9017-297fcf4fd5cf",
  "object": "payout",
  "method": "pix",
  "status": "completed",
  "amount": 5000,
  "currency": "BRL",
  "end_to_end_id": "E60701190202606040135...",
  "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:39.402Z",
  "failed_at": null
}
Não encontrado
{
  "code": "PAYOUT_NOT_FOUND",
  "message": "Pagamento não encontrado"
}
AnteriorCriar pagamentoPróximo Listar pagamentos