Gestão da Conta
Objetivo
Administrar a conta após o login titular: consultar e alterar limites Pix e encerrar a conta.
Pré-requisito: Login da conta. Scopes baas.accounts.read (GET limites) e baas.accounts.write (POST).
Limites
O GET devolve tetos atuais (chaves legíveis como natural_daytime_limit, pix_automatic, etc.). O POST altera um limite por vez via type + actual_limit em centavos (500000 = R$ 5.000,00).
type | Limite |
|---|---|
0 | Diurno (PF) |
1 | Noturno (PF) |
4 | Diário (PJ) |
5 | Pix automático |
6 | Pix agendado |
- Valor
0bloqueia transações daquele tipo. - Redução não cancela Pix já autorizado em andamento.
- Alteração pode ser imediata ou pendente de aprovação conforme produto.
Encerramento
POST /accounts/close inicia fechamento irreversível. Conta com saldo ou pendências pode retornar 400. Após sucesso, o token da conta deixa de operar.
Contrato HTTP: Listar limites.
Endpoints
Listar Limites
| Método | GET |
| Path | /api/v2/baas/accounts/limits |
Contrato: Listar limites.
Autenticação
Bearer da conta, HMAC. Scope baas.accounts.read.
Regras de negócio
- Use a resposta para escolher o
typecorreto no POST de alteração. - PF usa tipos
0e1; PJ usa4; Pix automático/agendado usam5e6quando habilitados.
Solicitar Alteração de limite
| Método | POST |
| Path | /api/v2/baas/accounts/limits |
Contrato: Alterar limite.
Autenticação
Bearer da conta, HMAC. Scope baas.accounts.write. Corpo JSON idêntico na assinatura HMAC.
Corpo mínimo
| Campo | Regra |
|---|---|
type | 0, 1, 4, 5 ou 6 |
actual_limit | Inteiro em centavos, 0 a 9999999999 |
Regras de negócio
- Um POST por
type; para vários limites, envie um pedido por tipo. 422setypeinválido para PF/PJ da conta.
Encerrar
| Método | POST |
| Path | /api/v2/baas/accounts/close |
Contrato: Encerrar conta.
Autenticação
Bearer da conta, HMAC. Scope baas.accounts.write.
Regras de negócio
- Corpo vazio ou
{}se não houver campos extras. - Propaga encerramento ao provedor bancário integrado; saldo positivo pode impedir fechamento.