Consulta de saldo em conta

Permite a consulta do saldo em conta via API para automatizar a gestão dos recursos financeiros necessários ao pagamento das operações de frete, eliminando a dependência do acesso manual ao portal do NDD Cargo.

O parceiro só poderá consultar o saldo em conta das contratantes vinculadas ao seu Cliente ID.

Método e rota

• Solicitação (POST): /consulta/saldo/:enterpriseId
• Consulta (GET): /consulta/saldo/:enterpriseId/:guid

Estrutura da requisição

Cabeçalhos

• Authorization: o token JWT deve ser enviado no header.

  Authorization: Bearer {token}

Corpo

Confira o exemplo abaixo e veja a definição completa para o envio de pedido de consulta de saldo e a consulta do saldo.

Retorno esperado

• A resposta deve estar em formato JSON.
• O retorno deve conter os campos:
  • saldoDisponivel
  • saldoBloqueado
  • dataReferencia
  • moeda

Exemplo de resposta bem-sucedida:

{
"balanceDate": "2025-06-26", 
"availableBalance": 900, 
"blockedBalance": 100, 
"accountingBalance": 1000
}

Exemplo de resposta de erro:

"errors": [
{
"code": "ManagementAccount-001",
"message": "Error Message"
}
]

Códigos de Status HTTP

• 200: Requisição processada com sucesso.
• 400: Parâmetro ausente, inválido ou intervalo de datas incorreto.
• 401: Não autorizado (token JWT ausente ou inválido).
• 403: Requisição autenticada, porém sem permissão para acessar o recurso.
• 404: A conta informada não foi encontrada.
• 500: Erro interno do servidor durante o processamento da requisição.