OnnixPay

Cobranças

O objeto Charge

Uma cobrança (charge) representa uma intenção de recebimento. Ao criar, geramos um PIX dinâmico; quando o pagamento entra, a cobrança passa a paid e disparamos um webhook.

Atributos

idstringopcional
Identificador único da cobrança (UUID).
objectstringopcional
Sempre "charge".
statusenumopcional
Um de pending, paid, expired, canceled, failed.
amountintegeropcional
Valor em centavos (R$ 25,99 = 2599).
currencystringopcional
Sempre "BRL" no MVP.
methodenumopcional
Método de pagamento: pix (boleto e cartão no roadmap).
referencestring | nullopcional
Seu identificador livre (ex.: número do pedido). Eco do que você enviou, presente também em todos os eventos de webhook da cobrança.
payerobjectopcional
Pagador real: name e document que o banco identificou na liquidação, o mesmo que aparece no extrato. Enquanto a cobrança não é paga, repete o pagador solicitado.
payer_requestobjectopcional
Pagador solicitado: o que veio no payer da criação. Compare com payer para conferir se quem pagou é quem deveria pagar.
pixobject | nullopcional
Presente quando method = pix. Contém br_code (copia-e-cola EMV), txid e end_to_end_id (preenchido após o pagamento).
webhook_urlstring | nullopcional
URL que recebe os eventos desta cobrança específica, além dos webhooks do Merchant.
expires_atstring | nullopcional
Data/hora ISO 8601 de expiração do QR.
paid_atstring | nullopcional
Data/hora ISO 8601 da confirmação do pagamento.
created_atstringopcional
Data/hora ISO 8601 de criação.
O objeto
{
  "id": "019e8f03-2d48-7f9b-9d8e-eb22404754b2",
  "object": "charge",
  "status": "pending",
  "amount": 2599,
  "currency": "BRL",
  "method": "pix",
  "reference": "pedido-1042",
  "payer": { "name": "Maria Souza", "document": "12345678909" },
  "payer_request": { "name": "Maria Souza", "document": "12345678909" },
  "pix": {
    "br_code": "00020101021226930014br.gov.bcb.pix...6304CACD",
    "txid": "kk6g232xel65a0daee4dd13kk4000637343",
    "end_to_end_id": null
  },
  "webhook_url": "https://sualoja.com/webhooks/onnix",
  "expires_at": "2026-06-03T20:16:32.703Z",
  "paid_at": null,
  "created_at": "2026-06-03T19:46:33.585Z"
}
AnteriorIdempotênciaPróximo Criar cobrança