# NyxPag API

> Documentação oficial da NyxPag API: cobranças Pix, transferências, saldo, split, MED e webhooks para integrar pagamentos no Brasil.

- [Documentação NyxPag](https://docs.nyxpag.com/index.md): Como integrar Pix na NyxPag: cobranças com QR Code, transferências, split, saldo, MED e webhooks assinados, tudo numa API REST em português.
- [Sua primeira cobrança Pix](https://docs.nyxpag.com/quickstart.md): Crie uma chave, gere uma cobrança Pix, mostre o QR Code ao pagador e confirme o pagamento com a NyxPag API, do zero ao primeiro Pix recebido.
- [Visão geral da NyxPag API](https://docs.nyxpag.com/guides/api-visao-geral.md): Base URL, autenticação, formato de resposta, paginação, IDs, limites e o mapa de todos os endpoints da NyxPag API v1.
- [Autenticação na NyxPag API](https://docs.nyxpag.com/guides/autenticacao.md): Autentique requisições com API Key via Bearer, escolha as permissões certas, entenda cada erro 401 e 403 e proteja suas credenciais.
- [Gestão de chaves da NyxPag](https://docs.nyxpag.com/guides/comece-aqui/api-key.md): Crie, restrinja, troque e revogue API Keys da NyxPag com permissões mínimas, IP allowlist e rotação sem indisponibilidade.
- [Ambientes e como testar sem sandbox](https://docs.nyxpag.com/guides/comece-aqui/ambientes.md): A NyxPag tem um único ambiente, o de produção. Veja como testar com segurança com valores baixos e como validar o seu webhook sem gastar dinheiro.
- [Roteiro de integração com a NyxPag](https://docs.nyxpag.com/guides/comece-aqui/primeira-integracao.md): O passo a passo completo para integrar Pix em produção: chave, webhook, primeira cobrança, validação do fluxo e preparação antes de escalar.
- [Receber por Pix](https://docs.nyxpag.com/guides/pix/receber.md): Crie cobranças Pix, mostre o QR Code e o Copia e Cola, entenda coverFee e confirme o pagamento por webhook com a NyxPag API.
- [Dividir o valor de uma venda (split)](https://docs.nyxpag.com/guides/pix/split.md): Repasse parte de cada cobrança Pix para outras contas NyxPag no momento da aprovação, por valor fixo ou percentual, com limites e erros.
- [Acompanhar transações Pix](https://docs.nyxpag.com/guides/pix/acompanhar.md): Liste transações com paginação e filtros, consulte uma por ID ou externalId, use refresh=true e monte uma conciliação confiável com a NyxPag API.
- [Consultar saldo](https://docs.nyxpag.com/guides/pix/saldo.md): Consulte o saldo disponível e o reservado da sua conta NyxPag com GET /balance e entenda o que cada valor significa antes de transferir.
- [Transferir por Pix](https://docs.nyxpag.com/guides/pix/transferir.md): Envie saldo por Pix usando chave, Copia e Cola ou QR Code com a NyxPag API: formatos de destino, valor mínimo, coverFee, erros e idempotência.
- [Contestações Pix (MED)](https://docs.nyxpag.com/guides/disputas/med.md): Entenda o MED, acompanhe contestações de Pix pela API e por webhook, e saiba o que acontece com o valor retido em cada situação.
- [Idempotência na NyxPag API](https://docs.nyxpag.com/guides/idempotencia.md): Use Idempotency-Key ou externalId para que retentativas de cobrança e transferência Pix nunca virem operações duplicadas, e saiba quando usar uma chave nova.
- [Erros e códigos HTTP](https://docs.nyxpag.com/guides/erros.md): O formato das respostas de erro da NyxPag API, o catálogo completo de error.code, o que fazer em cada status e como repetir com segurança.
- [Limites de requisição](https://docs.nyxpag.com/guides/confiabilidade/limites.md): A cota de 100 requisições por 60 segundos por API Key da NyxPag, como a janela funciona, os cabeçalhos RateLimit e como respeitar o limite sem perder operações.
- [Ciclo de vida das transações](https://docs.nyxpag.com/guides/confiabilidade/ciclo-de-vida.md): Os estados pending, approved, failed, cancelled e refunded, as transições, tipos e direções, e o objeto transação da NyxPag API campo a campo.
- [Antes de ir para produção](https://docs.nyxpag.com/guides/confiabilidade/checklist-producao.md): A lista do que revisar antes de receber dinheiro de verdade com a NyxPag: chaves, idempotência, webhook, estados, limites, conciliação e observabilidade.
- [Perguntas frequentes](https://docs.nyxpag.com/guides/ajuda/faq.md): Respostas rápidas sobre sandbox, idempotência, webhooks, limites, cobrança, transferência, split, MED e o ciclo de vida das transações na NyxPag API.
- [Solução de problemas](https://docs.nyxpag.com/guides/ajuda/troubleshooting.md): Diagnostique erros de autenticação, cobrança, transferência, webhook, assinatura, limite de requisições e saldo na NyxPag API, passo a passo.
- [Glossário](https://docs.nyxpag.com/guides/ajuda/glossario.md): Os termos da NyxPag API explicados: idempotência, externalId, BR Code, coverFee, split, MED, saldo reservado, requestId, assinatura de webhook e mais.
- [Changelog da NyxPag API](https://docs.nyxpag.com/guides/ajuda/changelog.md): Histórico das mudanças relevantes na API pública da NyxPag e na documentação: split, MED, webhooks, destination em transferências e rate limit unificado.
- [Indicadores públicos de transparência](https://docs.nyxpag.com/guides/transparencia.md): O endpoint público GET /transparency devolve totais consolidados da plataforma NyxPag, sem autenticação, cadastro nem consumo da cota de requisições.
- [Webhooks da NyxPag: visão geral](https://docs.nyxpag.com/guides/webhooks.md): Como a NyxPag avisa o seu servidor quando um Pix muda de estado: configuração, regras da URL, entrega, retentativas e boas práticas.
- [Validando a assinatura dos webhooks](https://docs.nyxpag.com/webhooks/assinatura.md): Confira que o webhook veio da NyxPag: HMAC-SHA256 sobre timestamp.corpo, comparação em tempo constante, janela anti-replay e exemplos em Node, Python e PHP.
- [Eventos de transação: transaction.approved, failed e cancelled](https://docs.nyxpag.com/webhooks/transacoes.md): Formato dos webhooks transaction.approved, transaction.failed e transaction.cancelled para cobranças e transferências Pix, com payload completo e como tratar cada um.
- [Eventos de MED: med.created e med.updated](https://docs.nyxpag.com/webhooks/med.md): Formato dos webhooks med.created e med.updated: quando um pagador contesta um Pix, o valor retido e como acompanhar a decisão até a liberação.
- [Consultar indicadores públicos](https://docs.nyxpag.com/api-reference/transparência/consultar-indicadores-públicos.md): Retorna somente totais consolidados. Não exige cadastro, sessão ou API Key.
- [Consultar saldo](https://docs.nyxpag.com/api-reference/saldo/consultar-saldo.md): Permissão necessária: balance:read.
- [Listar transações](https://docs.nyxpag.com/api-reference/transações/listar-transações.md): Permissão necessária: transactions:read.
- [Verificar transação](https://docs.nyxpag.com/api-reference/transações/verificar-transação.md): Permissão necessária: transactions:read. Use refresh=true para consultar o estado mais recente.
- [Criar cobrança Pix](https://docs.nyxpag.com/api-reference/pagamentos/criar-cobrança-pix.md): Permissão necessária: payments:write. Idempotency-Key ou externalId é obrigatório; a mesma chave com payload diferente retorna conflito. A rota de processamento é definida exclusivamente pela administração da conta.
- [Listar contestações MED](https://docs.nyxpag.com/api-reference/med/listar-contestações-med.md): Permissão necessária: transactions:read. Retorna somente MEDs da conta autenticada. A rota é de leitura; criação e decisão são controladas pela NyxPag e pela processadora.
- [Consultar uma contestação MED](https://docs.nyxpag.com/api-reference/med/consultar-uma-contestação-med.md): Permissão necessária: transactions:read. Aceita o ID do MED, da transação NyxPag ou o externalId do pedido.
- [Solicitar transferência Pix](https://docs.nyxpag.com/api-reference/transferências/solicitar-transferência-pix.md): Permissão necessária: transfers:write. Idempotency-Key ou externalId é obrigatório; a mesma chave com payload diferente retorna conflito. O cliente não pode escolher a adquirente.
- [Nova contestação med criada e valor retido](https://docs.nyxpag.com/api-reference/nova-contestação-med-criada-e-valor-retido.md)
- [Situação da contestação med atualizada](https://docs.nyxpag.com/api-reference/situação-da-contestação-med-atualizada.md)
- [Servidor MCP da NyxPag](https://docs.nyxpag.com/guides/mcp.md): Conecte assistentes de IA à NyxPag pelo Model Context Protocol para consultar saldo e transações em modo somente leitura, com segurança.

## OpenAPI Specs

- [openapi](https://api.nyxpag.com.br/v1/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.