OnnixPay

Cobranças

Consultar cobrança

Recupera uma cobrança pelo seu id. Útil para conferir o status e o end_to_end_id após o pagamento.

GET/v1/charges/:id

Headers

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

Parâmetros de caminho

idstringobrigatório
O identificador (UUID) da cobrança.

Prefira webhooks ao polling

Para saber quando uma cobrança foi paga, 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/charges/019e8f03-2d48-7f9b-9d8e-eb22404754b2 \
  -H "x-api-key: sk_live_sua_chave_aqui"
Resposta
{
  "id": "019e8f03-2d48-7f9b-9d8e-eb22404754b2",
  "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": "00020101021226930014br.gov.bcb.pix...6304CACD",
    "txid": "kk6g232xel65a0daee4dd13kk4000637343",
    "end_to_end_id": "E1234567820260603..."
  },
  "webhook_url": "https://sualoja.com/webhooks/onnix",
  "expires_at": "2026-06-03T20:16:32.703Z",
  "paid_at": "2026-06-03T19:52:10.114Z",
  "created_at": "2026-06-03T19:46:33.585Z"
}
Não encontrada
{
  "code": "CHARGE_NOT_FOUND",
  "message": "Cobrança não encontrada."
}
AnteriorCriar cobrançaPróximo Listar cobranças