Menu
Documentation

Accounts (Contas)

Modulo tecnico: accounts

  • Endpoints HTTP: 16
  • MessagePattern/mensageria: nao incluido nesta pagina.

Funcoes

FuncaoMetodoRota
Consultar titular por documentoGET/hb/accounts/account-holders
Atualizar titular da contaPUT/hb/accounts/account-holders
Consultar saldo da contaGET/hb/accounts/balance
Criar conta empresarialPOST/hb/accounts/business
Solicitar encerramento de contaPOST/hb/accounts/closure-requests
Consultar status do encerramentoGET/hb/accounts/closure-requests/:request_id
Consultar lancamentos futurosGET/hb/accounts/future-transactions
Consultar conta individualGET/hb/accounts/individual
Criar conta individualPOST/hb/accounts/individual
Enviar documento da conta individualPOST/hb/accounts/individual/document
Enviar documento publicoPOST/hb/accounts/individual/document/public
Listar contas individuaisGET/hb/accounts/individuals
Consultar movimentacoes da contaGET/hb/accounts/movements
Consultar comprovante de transacaoGET/hb/accounts/receipts
Consultar extrato da contaGET/hb/accounts/statement
Gerar extrato em PDFGET/hb/accounts/statement/pdf

Formato padrao de resposta

Envelope de sucesso (interceptor global):

{
  "status_code": 200,
  "success": true,
  "message": "OK",
  "data": {}
}

Envelope de erro (filtro global):

{
  "status_code": 400,
  "code": "VALIDATION_ERROR",
  "message": "Erro de validacao",
  "timestamp": "2026-02-13T00:00:00.000Z",
  "path": "/exemplo",
  "details": []
}