Introdução
A CarecaPay é uma API de pagamentos Pix: você cria cobranças por REST+JSON e acompanha tudo pelo painel.
A API é REST com corpos JSON. Você cria uma conta pelo site, gera credenciais no painel e usa a chave secreta para criar cobranças Pix. Cada cobrança devolve um QR Code copia e cola pronto para o seu checkout.
Conceitos
- Conta — sua conta no painel é também o seu merchant. Quem cria cobranças em nome dela são as credenciais.
- Credencial — par de client_id e chave secreta. A secreta autentica cobranças; gere e revogue no painel.
- Cobrança — um Pix com valor em centavos. Nasce pending e vira paid quando o pagamento é confirmado.
- Saldo — soma do que já foi pago (disponível) e do que ainda está pendente, por ambiente.
Ambientes
| Parâmetro | Tipo | Descrição |
|---|---|---|
sandbox | https://api-sandbox.carecapay.com | Testes. Provider fake, pagamentos simulados, nenhum dinheiro real. |
produção | https://api.carecapay.com | Dinheiro real. A baixa das cobranças vem da confirmação do Banco. |
Os dois ambientes são separados. Credenciais de sandbox não funcionam em produção, e vice-versa.
Próximos passos
- Siga os Primeiros passos para sair do zero à primeira cobrança.
- Leia Autenticação para entender o par de credenciais.
- Use o Sandbox para testar sem risco antes de ir para produção.
- Configure Webhooks para sua API ser notificada quando a cobrança for paga.