Documentação da API Pix: tudo o que o seu time precisa para integrar
A documentação é aberta, sem cadastro e sem pedir acesso: API v2 (a mais indicada para integrações novas) e API v1. Cada página traz as rotas, os campos, os erros e exemplos, e há um arquivo llms.txt para assistentes de programação lerem tudo de uma vez.
O que você encontra
Autenticação
Troca de credenciais por token de 1 hora e chaves com permissões separadas (saldo, extrato, cobrar, enviar Pix, transferir, boletos, webhooks).
Receber Pix
Cobrança dinâmica com txid, copia e cola e consulta do status até CONCLUIDA.
Enviar Pix
Pagamento por chave Pix ou QR Code copia e cola, com x-idempotency-key e estados PROCESSING, LIQUIDATED e CANCELED.
Saldo, extrato e comprovante
Consulta do saldo disponível, extrato da conta e comprovante em PDF.
Boletos
Consulta do código e pagamento de boletos pela API.
Webhooks
Avisos de Pix recebido, enviado e que falhou, assinados com HMAC. Veja webhooks de Pix.
Sandbox
Chave de teste com saldo de mentira e comandos para simular pagamento e falha. Veja o sandbox.
Pensada para humanos e para assistentes de IA
O arquivo llms.txt da API v2 reúne a documentação em texto simples, com tabelas de permissões, estados e erros, no formato que ferramentas como assistentes de código leem bem. Se o seu time usa um assistente para programar, aponte o endereço para ele e peça a integração.
Há também uma página com o passo a passo para desenvolvedores e outra sobre como migrar de outra provedora.
Como começar
Abra sua conta
Cadastre-se pelo site, envie os dados e os documentos pedidos e acompanhe a análise do cadastro.
Cobre pelo painel ou integre pela API
Gere cobranças Pix pelo painel ou conecte seu sistema pela API, começando pela chave de teste (sandbox), que não mexe em dinheiro de verdade.
Receba e acompanhe
Receba o aviso de pagamento por webhook, libere o pedido e confira tudo no extrato e nos relatórios.
Perguntas frequentes
A documentação da API é pública?
Sim. Qualquer pessoa lê a documentação v2 e a v1 sem cadastro. Para usar a API em produção é preciso ter conta aprovada e criar uma chave.
Qual a URL base da API v2?
https://bank.paguemais.com/api/v2. O sandbox usa a mesma URL base, com uma chave de teste.
Existe um arquivo para assistentes de IA lerem a documentação?
Sim, o llms.txt da API v2, com rotas, permissões, estados, erros e exemplos em texto simples.
Qual versão usar?
A v2 segue o desenho das APIs de Pix mais usadas do mercado e é a indicada para integrações novas. A v1 continua funcionando ao mesmo tempo e traz funções extras, como links de pagamento e split.
Posso testar antes de abrir conta?
A chave de sandbox é criada no painel, que exige cadastro. A leitura da documentação é livre.
Documentação da API Pix: tudo o que o seu time precisa para integrar
A documentação é aberta, sem cadastro e sem pedir acesso: API v2 (a mais indicada para integrações novas) e API v1. Cada página traz as rotas, os…
Veja também
- API Pix para desenvolvedoresGuia rápido da API Pix: crie a chave, gere o token, cobre com PUT /cob, envie Pix com idempotência e receba webhooks assinados. Sandbox para testar.
- Sandbox da API PixAmbiente de teste da API Pix: simule cobranças, pagamentos e falhas com chave de teste separada, sem mover dinheiro real, antes de ir à produção.
- Webhook de Pix assinadoReceba aviso de Pix recebido, Pix enviado e Pix que falhou por webhook assinado. Veja como validar a assinatura e tratar avisos repetidos.
- Migrar de outra provedora de PixA API v2 segue o desenho das APIs de Pix mais usadas: em geral basta trocar a URL base e as credenciais. Veja o que existe, o que não existe e como testar.