Primeiros passos

Do zero à primeira cobrança Pix paga (no sandbox) em cinco passos.

1. Crie sua conta

Cadastre-se pelo site informando e-mail e senha. Ao final do cadastro você já entra logado no painel.

2. Gere uma credencial

No painel, abra Chaves de API e clique em Nova credencial. Copie a chave secreta na hora — ela aparece uma única vez.

3. Crie uma cobrança

cURL

curl -X POST https://api-sandbox.carecapay.com/v1/charges \
  -H "Authorization: Bearer SUA_CHAVE_SECRETA" \
  -H "Content-Type: application/json" \
  -d '{ "amount_cents": 1990, "description": "Pedido #42" }'

A resposta traz o id da cobrança, o qr_code (copia e cola) e o qr_code_base64 (a imagem do QR já pronta, em PNG) para mostrar ao pagador.

4. Simule o pagamento (sandbox)

cURL

curl -X POST https://api-sandbox.carecapay.com/v1/charges/{id}/simulate-payment \
  -H "Authorization: Bearer SUA_CHAVE_SECRETA"

5. Confira o resultado

GET /v1/charges/{id} mostra a cobrança com status paid.
GET /v1/balance mostra o valor no saldo disponível.
O dashboard do painel reflete a cobrança e o volume do dia.

Em produção o passo 4 não existe: a baixa acontece quando o pagador paga de verdade e o Banco confirma.

6. Configure o webhook (recomendado)

Na integração de verdade, sua aplicação não fica consultando a API: configure um Webhook no painel e o CarecaPay chama a SUA URL com o evento charge.paid no instante em que a cobrança for paga. Veja o guia de Webhooks.