Introdução à API
Como a API da SinapsePay funciona, os ambientes de teste e produção e a sua primeira cobrança PIX em poucos minutos.
A API da SinapsePay emite e acompanha cobranças PIX e boleto na conta da sua empresa, no banco que você conectou pelo painel. O dinheiro cai direto na sua conta; a SinapsePay emite, acompanha, avisa e devolve.
Visão geral
| Base | https://api.sinapsepay.com.br/v1 |
| Formato | JSON (UTF-8), nomes em português, valores em centavos |
| Autenticação | Authorization: Bearer sk_test_… ou sk_live_… |
| Escritas | Idempotency-Key obrigatória em todo POST |
| Datas e horas | ISO 8601 em UTC (2026-10-06T13:53:41Z); datas sem hora como AAAA-MM-DD |
Ambientes
- Teste (
sk_test_): usa as contas em sandbox e o Simulador, que emite, paga e devolve como um banco, sem dinheiro de verdade. - Produção (
sk_live_): usa as contas em produção. Disponível depois que a organização é aprovada.
O mesmo código funciona nos dois: só a chave muda.
Primeira cobrança em 4 passos
- Crie a conta em painel.sinapsepay.com.br.
- Conecte uma conta (no sandbox, o Simulador já resolve) e crie uma integração de PIX Cobrança.
- Crie uma chave de API em Chaves de API, com o escopo
cobrancas:criar. O segredo aparece uma vez: guarde-o. - Chame a API:
curl -X POST https://api.sinapsepay.com.br/v1/cobrancas \
-H "Authorization: Bearer sk_test_..." \
-H "Idempotency-Key: pedido-1042" \
-H "Content-Type: application/json" \
-d '{"valor": 8990, "descricao": "Pedido 1042", "idExterno": "pedido-1042"}'A resposta 201 já traz o QR Code (pix.copiaECola). Mostre-o ao seu cliente; quando ele pagar, a cobrança vira paga e, se você configurou os avisos, o seu sistema recebe cobranca.paga.