Documentação da API Onyx Pag
A API da Onyx Pag permite integrar processamento de pagamentos ao seu aplicativo ou site de forma rápida e segura: cobranças Pix, pagamentos com cartão, consultas, saques e notificações em tempo real — tudo em REST com respostas em JSON.
Introdução
API REST moderna (v2.0), com comunicação em JSON e encoding UTF-8. Com ela você cria cobranças, consulta transações e recebe notificações automáticas de cada mudança de status — integrando em dias, não em meses.
Autenticação
O acesso é feito com um par de chaves de API (pública e privada) gerado no seu painel, usando Basic Authentication. As chaves ficam sob seu controle e podem ser gerenciadas a qualquer momento.
Pagamentos Pix
Crie cobranças Pix com QR Code e copia-e-cola gerados em tempo real, com confirmação instantânea do pagamento. Suporte a dados do cliente, itens da venda, metadados personalizados e rastreamento de campanhas (UTM).
Pagamentos com cartão
Processe transações com cartão de crédito com parcelamento em até 12x, resposta imediata de aprovação e camada adicional de segurança 3D Secure. Os dados do cartão são processados com segurança e não ficam armazenados.
Split de pagamentos
Divida automaticamente o valor de cada transação entre múltiplos recebedores — ideal para marketplaces, plataformas e parcerias. O cálculo e o repasse são feitos pela própria infraestrutura.
Consultas e relatórios
Consulte o status de qualquer transação individual ou liste todas as suas transações com filtros por período, status e paginação. Também é possível consultar os dados cadastrais da sua conta via API.
Saques Pix
Solicite saques do saldo disponível para qualquer chave Pix (CPF, CNPJ, e-mail, telefone ou chave aleatória), com acompanhamento do status de cada solicitação e resumo consolidado da conta.
Webhooks
Receba notificações automáticas em tempo real a cada evento da transação — criação, pagamento confirmado, falha, expiração ou estorno — direto na URL do seu sistema, sem precisar consultar a API repetidamente.
Integração com IA
A documentação inclui um prompt pronto para você colar em qualquer IA (ChatGPT, Claude, Gemini) e gerar o código de integração completo na linguagem ou framework que preferir — PHP, Node.js, Python, Java e outros.
Comece a integrar
A referência técnica completa é disponibilizada junto com o acompanhamento do nosso time durante a integração.
Suporte
Dúvidas de integração? Fale direto com o time de engenharia da Onyx Pag pelo e-mail contato@onyxpag.com ou pelo WhatsApp.