API OnnixPay
Documentação da API
API REST para receber pagamentos. Requisições e respostas em JSON, autenticação por chave no header x-api-key. Hoje as cobranças são pagas por PIX.
Como funciona
O objeto central é a cobrança (charge). Você cria uma cobrança, entrega o br_code (PIX copia-e-cola) ou o QR ao pagador e recebe um webhook assim que o pagamento cai.
Autenticação
Chave de API no header x-api-key.
Criar cobrança
POST /v1/charges com PIX dinâmico.
Webhooks
Eventos assinados por HMAC.
Princípios da API
amounté sempre um inteiro na menor unidade da moeda: R$ 25,99 vira2599.- Todos os campos de requisição e resposta usam
snake_case(webhook_url,expires_in,br_code). - Operações de escrita exigem o header
Idempotency-Key. Repetir a mesma chamada devolve a cobrança original em vez de criar outra. - Todo erro traz um
codeestável, além do HTTP status.
Requisição
curl https://apiv2.onnixpay.com/v1/charges \
-X POST \
-H "x-api-key: sk_live_sua_chave_aqui" \
-H "Idempotency-Key: pedido-7f3a9c21" \
-H "Content-Type: application/json" \
-d '{
"amount": 2599,
"method": "pix",
"reference": "pedido-1042",
"webhook_url": "https://sualoja.com/webhooks/onnix"
}'Resposta
{
"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"
}