Saldo, saldo diário e encerramento
Saldo atual, série de saldos diários e encerramento de uma conta, no host
https://tenant.api.corpx.com. Todas as chamadas levam
Authorization: Bearer {token} e X-Tenant-Id.
Saldo
GET /v1/accounts/{accountId}/balance
available é o que a conta pode enviar. locked é o total retido (por
exemplo, uma retenção de MED); a resposta não lista
cada retenção. includeLocks é aceito por compatibilidade e não tem efeito.
Saldo diário
GET /v1/accounts/{accountId}/daily-balance?startDate=2026-06-04&endDate=2026-06-05
Devolve, por dia, a abertura (total / bloqueado / disponível) e os fluxos do
dia, em horário de Brasília. Janela máxima de 30 dias; sem datas, vale os
últimos 30 dias. Só há fechamentos a partir de 2026-06-04 (cutoffDate).
Os fluxos vêm somados por tipo, sempre presentes e com 0 quando não houve
movimento:
A abertura de um dia é a abertura do dia anterior mais as entradas, menos as saídas e as tarifas daquele dia.
Encerrar a conta
POST /v1/accounts/{accountId}/close
Tira o acesso do seu tenant à conta. Pessoas precisam do papel
tenant_manager ou admin; credenciais, do escopo accounts.close (o
legado api2/write também passa). Mande um Idempotency-Key para poder
repetir a chamada com segurança.
A resposta 200 é a mesma quando outro tenant da CorpX ainda opera a conta
e quando o seu é o último. A conta não é apagada: passa a status=closed.
Repetir o pedido numa conta já encerrada no seu tenant devolve o mesmo 200,
sem novo pedido de encerramento.
Quando a conta é só sua, o encerramento é pedido ao liquidante, que só aceita conta zerada: sem saldo disponível e sem saldo bloqueado. O saldo do liquidante é conferido antes:
Nos dois 422 a conta continua ativa e o corpo traz o saldo do liquidante:
A conta bancária em si é encerrada quando o liquidante processa o pedido; o
200 não diz quando.
Outros erros: