Conta BaaS
Área da conta de pagamento criada pelo BaaS. Operações após onboarding aprovado e recebimento das credenciais OAuth da conta. Onboarding e webhooks da plataforma: Plataforma BaaS.
Autenticação
Autenticação da conta BaaS: client_id / client_secret da conta (em geral via webhook AccountCredentials). Todos os pedidos em /api/v2/baas/* desta área exigem Bearer + HMAC. Não há endpoint “status sem HMAC” na árvore da conta.
Pré-requisitos
- Onboarding aprovado (proposta + KYC).
- Credenciais da conta recebidas (webhook da plataforma
AccountCredentials). - Login conta com scopes que cobrem as operações desejadas.
Jornada passo a passo
Ordem recomendada para integrar e testar a conta:
| Passo | Ação | Guia |
|---|---|---|
| 1 | Login da conta (POST /api/v2/auth/login com credenciais da conta) | Auth conta |
| 2 | Validar saldo (GET /api/v2/baas/balances) | Saldo |
| 3 | Chaves Pix (listar, criar, OTP se e-mail/telefone) | Chaves |
| 4 | Pix cash-in (gerar QR, consultar txId) | Cash-in |
| 5 | Pix cash-out (consultar DICT, pagar por chave ou payload) | Cash-out |
| 6 | Boletos (consultar → revisar → confirmar) | Boletos |
| 7 | Extrato e limites | Extrato · Conta |
| 8 | Webhooks da conta (cadastro e receptor) | Webhooks da conta |
Consulta de contrato ativo da conta: Consultar contrato.
O que pertence à conta
| Recurso | Path base |
|---|---|
| Saldo / extrato | /api/v2/baas/balances, /api/v2/baas/statements |
| Chaves Pix | /api/v2/baas/key-managements |
| Pix | /api/v2/baas/pix/cash-in, /api/v2/baas/pix/payments |
| Boletos | /api/v2/baas/bankslip-payments |
| Limites / encerramento | /api/v2/baas/accounts |
| Contrato da conta | GET /api/v2/baas/contracts/{contractId} |
| Webhooks da conta | /api/v2/baas/webhooks |
Token e HMAC
Substitua {{access_token}} e {{hmac_secret}} pelos valores da conta. Não reutilize o token da plataforma BaaS.
Limites e risco
Alteração de limites e encerramento são irreversíveis no produto. Confirme com o titular antes de POST /api/v2/baas/accounts/close.