Quickstart
Faça sua primeira chamada em menos de 10 minutos.
Autenticação
Gere e configure seu token Bearer.
Receber Pix (Cash-in)
Cobranças com QR Code EMV e notificação de pagamento.
Enviar Pix (Cash-out)
Transferências por chave Pix ou string EMV.
Webhooks
Receba notificações assinadas para cada evento.
Referência da API
Contratos completos de todos os endpoints.
O que é a ClearPago
A ClearPago é a camada de integração Pix entre o seu sistema e o parceiro bancário (BaaS). Você consome apenas a API REST e implementa um endpoint de notificação HTTP; toda a orquestração com a instituição financeira fica encapsulada na plataforma. Base URL (produção):https://api.clearpago.com.br
O que você pode integrar
Cobranças Pix
Gere cobranças com QR Code EMV e acompanhe o pagamento em tempo real via webhook.
Envio Pix
Envie Pix por chave (CPF, CNPJ, e-mail, telefone, EVP) ou pix copia e cola (string EMV).
Devoluções
Devolva recebimentos parcial ou totalmente em até 89 dias, com rastreio completo.
Webhooks assinados
Receba notificações ECDSA P-256 de cada evento:
pix_cash_in, pix_cash_out, pix_cash_in_reversal, pix_cash_out_reversal.Ledger
Consulte lançamentos de crédito e débito por operação confirmada.
Reconciliação
Resolva estados ambíguos com consulta autoritativa ao parceiro BaaS.
Fluxo de integração
O modelo é assíncrono: a criação de recursos responde rapidamente com estado inicial; o estado final chega via webhook e, quando necessário, via reconciliação automática.Para quem é esta documentação
| Perfil | Foco principal |
|---|---|
| Engenharia | Contratos, headers, idempotência, assinaturas, ciclo de vida, erros. |
| Produto | O que considerar “pago” e “confirmado”, prazos regulatórios, devoluções. |
| Operações | Estados não terminais, reconciliação, monitoramento, suporte a incidentes. |
Próximos passos
Autentique-se
Gere seu token em Autenticação e configure o header
Authorization: Bearer.Siga o Quickstart
Crie um cash-in, receba o webhook e consulte o status em Quickstart.
Entenda os conceitos
Leia Arquitetura, Ciclo de vida e Modelo de status antes de ir para produção.
Configure webhooks
Registre sua URL e implemente a verificação de assinatura em Webhooks.
Valide com o checklist
Revise o Checklist de primeira integração e o Checklist de produção.