Skip to main content

​
Visão geral

A API Pix (clearpago), documentada neste portal ClearPago, expõe operações de recebimento (cash-in), envio (cash-out por chave ou QR Code EMV), devolução de recebimento (refund-in), reversão de envio (cash-out reversal) e consultas de ledger e transações, com notificações assinadas para o seu backend. O fluxo é assíncrono: a criação de recursos responde rapidamente; o estado final chega via webhooks do parceiro BaaS e reconciliação automática quando há ambiguidade de rede. Você integra somente a REST e o webhook de saída para o comerciante; a orquestração com a instituição fica encapsulada na plataforma. Base URL (produção): https://api.clearpago.com.br

​
Para quem é esta documentação

  • Engenharia: contratos, headers, códigos de erro, idempotência e assinaturas.
  • Produto: ciclos de vida, o que considerar “pago” ou “confirmado” e prazos (ex.: 89 dias para refund).
  • Operações: estados não terminais, reconciliação, monitoramento e suporte a incidentes.

​
O que você pode fazer

  • Gerar cobranças Pix com QR Code EMV e acompanhar pagamento.
  • Enviar Pix para chave (cpf, cnpj, email, phone, evp) ou a partir de string EMV (pix copia e cola).
  • Devolver recebimentos (parcial/total) dentro do prazo regulatório.
  • Lidar com reversão de envio após confirmação.
  • Registrar URL de notificação e validar entregas com ECDSA no corpo bruto.
  • Conferir lançamentos no ledger e visões agregadas de transação.

​
Arquitetura de integração (lógica)

Seu sistema chama a API; a plataforma fala com o parceiro BaaS. Eventos do parceiro entram em webhooks de entrada (você não implementa isso) e alimentam filas, workers, persistência e outbox de notificações ao comerciante. A API que você expõe é o endpoint de webhook do comerciante (HTTP POST) para receber eventos pix_cash_in, pix_cash_out, pix_cash_in_reversal e pix_cash_out_reversal.

​
Acesso rápido

TemaPágina
Autenticação e token/getting-started/authentication
Quickstart (fluxo mínimo)/getting-started/quickstart
Receber Pix (QR, PENDING / PAID)/guides/receive-pix-cash-in
Enviar Pix (chave)/guides/send-pix-cash-out-key
Webhooks (assinatura, idempotência)/webhooks/clearpago-to-merchant
Ledger e saldo/ledger-and-reconciliation/ledger-overview
Consulte visão geral e modelo assíncrono e convenções de API antes de ir para produção.