Documentação que é um show à parte.
Guias completos e exemplos reais para integrar cobranças Pix com a CarecaPay — do sandbox à produção.
Bem-vindo à Documentação CarecaPay!
Tudo que você precisa para integrar pagamentos com segurança, escalabilidade e a cabeça tranquila.
Pix
Cobranças com QR Code copia e cola.
Webhooks
Sua API avisada na hora do pagamento.
Sandbox
Teste tudo sem dinheiro real.
Credenciais
Chaves geradas e revogadas no painel.
Saldo
Disponível e pendente em tempo real.
Erros claros
Códigos estáveis e mensagens em pt-BR.
curl -X POST api-sandbox.carecapay.com/v1/charges \
-H "Authorization: Bearer ccp_secret_..." \
-d '{"amount_cents": 1990}'Documentos populares
Ver todos os documentosAutenticação
Como autenticar suas requisições com o trio de credenciais da CarecaPay.
Criar cobrança Pix
Crie uma cobrança Pix e receba o QR Code copia e cola na resposta.
Webhooks
Sua API é notificada na hora em que a cobrança é paga.
Sandbox
Teste a integração de ponta a ponta sem movimentar dinheiro real.
Consultar cobrança
Busque uma cobrança pelo id ou liste as cobranças da sua conta.
Saldo
Consulte o valor disponível e o pendente da sua conta.
Erros e status
Entenda o envelope de erro, os códigos HTTP e os status de cobrança.
Primeira integração em 4 passos
Ver guia completoCriar sua conta
Cadastre-se pelo site e acesse o painel — sua conta já nasce no ambiente sandbox.
Gerar credencial
No painel, em Chaves de API, crie uma credencial e guarde a chave secreta.
Criar primeira cobrança Pix
Envie um POST /v1/charges autenticado e receba o QR Code copia e cola.
Receber o webhook
Configure sua URL no painel e receba o charge.paid assim que a cobrança for paga.
Feito para desenvolvedores
Integre uma vez. Escale para sempre.
Copie um exemplo real na sua linguagem favorita e faça sua primeira cobrança Pix em minutos.
// npm install carecapay
import CarecaPay from 'carecapay';
const carecapay = new CarecaPay(process.env.CARECAPAY_SECRET_KEY);
const charge = await carecapay.charges.create({
amount_cents: 1990,
description: 'Assinatura Premium',
});
console.log(charge.qr_code); // copia e cola do PixPor que usar a documentação da CarecaPay?
Exemplos reais
Todos os exemplos batem com a API como ela é hoje — copie, cole e funciona.
Sandbox completo
Simule pagamentos e veja o saldo mudar sem gastar um centavo.
Guia passo a passo
Da criação da conta à primeira cobrança paga, sem etapas ocultas.
Referência honesta
Documentamos só o que existe. Recursos novos entram aqui quando lançam.
Pronto para integrar?
Crie sua conta e comece a testar na sandbox agora mesmo.