Início rápido
Crie e pague sua primeira cobrança no sandbox em 5 minutos.
1. Crie uma chave de teste
Crie uma conta no painel, mantenha o seletor de ambiente em Teste e gere uma chave em Desenvolvedores, na tela Chaves de API. O sandbox funciona antes da aprovação da sua conta e nenhum dinheiro real é movimentado.
export GATEWAY_API_KEY="sk_test_..."2. Crie uma cobrança
A resposta traz o Pix copia e cola em pix.copyPaste, o QR Code em pix.qrCodeBase64 e uma página pronta em checkoutUrl. A cobrança nasce com status pending.
curl -X POST "https://api.pombopix.com/v1/charges" \
-H "Authorization: Bearer $GATEWAY_API_KEY" \
-H "Idempotency-Key: pedido-0001" \
-H "Content-Type: application/json" \
-d '{
"amount": 15000,
"reference": "PEDIDO-0001",
"description": "Plano anual",
"customer": {
"name": "Ana Souza",
"document": "12345678901",
"email": "ana@example.com"
}
}'3. Simule o pagamento
No sandbox ninguém paga de verdade. Chame o endpoint de simulação com o id da cobrança, ou use o botão na tela da cobrança no painel.
curl -X POST "https://api.pombopix.com/v1/sandbox/charges/7c1e4f2a-3b58-4e0d-9a6c-2f8d1b7e5a10/pay" \
-H "Authorization: Bearer $GATEWAY_API_KEY"4. Confirme o saldo
A cobrança agora está paid, e o valor menos a tarifa entrou em available.
curl "https://api.pombopix.com/v1/balance" \
-H "Authorization: Bearer $GATEWAY_API_KEY"5. Receba o evento
Em produção, você não consulta a API em ciclo: cadastra um endpoint e recebe charge.paid assim que o Pix é confirmado. Veja Webhooks. Para ir ao ar, envie os dados da empresa no painel e, depois da aprovação, troque sk_test_ por sk_live_.