Sandbox e testes

O sandbox é um deploy separado com provider fake: crie cobranças, simule pagamentos e veja o saldo mudar sem dinheiro real.

Use https://api-sandbox.carecapay.com como base URL. Tudo funciona como em produção — mesmo formato de credencial, mesmas rotas — exceto que nenhum Pix real é gerado e você mesmo dá a baixa nos pagamentos.

POST/v1/charges/{id}/simulate-payment

A baixa fake: marca uma cobrança pendente como paga, como se o pagador tivesse pago. É idempotente — repetir a chamada numa cobrança já paga devolve a mesma resposta.

cURL
curl -X POST https://api-sandbox.carecapay.com/v1/charges/txn_abc123/simulate-payment \
  -H "Authorization: Bearer SUA_CHAVE_SECRETA"
200 OK
{
  "id": "txn_abc123",
  "status": "paid",
  "method": "pix",
  "amount_cents": 1990,
  "currency": "BRL",
  "qr_code": "00020126580014br.gov.bcb.pix...",
  "qr_code_base64": "iVBORw0KGgoAAAANSUhEUgAA...",
  "provider_charge_id": "fake_...",
  "created_at": "2026-07-09T12:00:00Z",
  "paid_at": "2026-07-09T12:03:11Z"
}

Em produção este endpoint responde 403 (not_simulatable): lá a baixa só acontece com a confirmação real do Banco.

Checklist antes de ir para produção

  • Sua integração cria cobranças e trata os erros documentados em Erros e status.
  • Você consulta o status da cobrança para confirmar o pagamento (não assume que foi pago).
  • A chave secreta de produção está guardada num cofre de segredos, fora do código.