Guia de APIs
Use esta documentação para integrar:- Geração de cobrança (CASHIN)
- Consulta de transações
- Transferências/saques (CASHOUT)
- Consulta de saldo
- Webhooks de atualização
Fluxo recomendado
1. Autenticação
1. Autenticação
Gere sua
sk_live_prod_* no painel e use no header Authorization: Bearer ….2. Gerar transação PIX
2. Gerar transação PIX
Chame
POST /v1/integrations/create-transaction e exiba o pixCode para pagamento.3. Acompanhar status
3. Acompanhar status
Consulte por
transactionId no endpoint GET /v1/integrations/list-transactions.4. Saques e comprovante
4. Saques e comprovante
Para saque, use
POST /v1/integrations/create-cashout. Quando concluir, use o receiptUrl HTML.Acesso rápido
Gerar transação PIX
Endpoint principal para criar cobranças.
Listar transações
Filtros, paginação e consulta pontual por UUID.
Solicitar transferência
Crie saques com idempotência e validação de saldo.
Consultar saldo
Retorna disponivel, reservas e total sacado.
