Documentação da API

Tudo para o seu sistema emitir cobranças PIX e boleto, acompanhar pagamentos e devolver pela API da SinapsePay.

A API é REST, em português, com valores em centavos e idempotência em toda escrita. Comece pelaintrodução: em poucos minutos você emite a primeira cobrança PIX no sandbox.

Comece aquiIntrodução à APIComo a API da SinapsePay funciona, os ambientes de teste e produção e a sua primeira cobrança PIX em poucos minutos.Comece aquiAutenticação e chaves de APIComo autenticar na API da SinapsePay com chaves sk_test e sk_live, escopos, IPs permitidos, validade, revogação e limite de requisições.CobrançasCobrançasReferência das cobranças PIX e boleto na API da SinapsePay — criar, consultar, o objeto Cobrança, situações e respostas.CobrançasDevoluções de PIXComo devolver um PIX recebido pela API da SinapsePay, total ou parcialmente, em até 90 dias, e acompanhar a devolução até o banco concluir.AvisosAvisos ao seu sistema (webhooks)Receba cobranca.paga e cobranca.devolvida no seu sistema com avisos assinados (HMAC-SHA256), novas tentativas automáticas e exemplos de verificação.ReferênciaIdempotênciaComo usar o cabeçalho Idempotency-Key para repetir chamadas à API da SinapsePay com segurança, sem criar cobranças ou devoluções em dobro.ReferênciaErrosO formato dos erros da API da SinapsePay, os códigos HTTP e os principais códigos de erro, com o que fazer em cada caso.