Consultar status parcela

Consulte o status de parcelas vinculadas às operações de transporte.
A consulta é realizada de forma síncrona, retornando imediatamente o status de cada parcela.

Métodos e rotas

• Consulta (GET): /frete/lote/consultarStatusParcela/{enterpriseID}

Estrutura da requisição

Cabeçalhos

• O token JWT deve ser enviado no header, por exemplo:

  Authorization: Bearer {token}
  

Corpo

O payload JSON deve ser estruturado conforme a referência.

Nome do Campo	Tipo	Descrição
cnpj	string	Identificador do registro (CPF/CNPJ) do transportador responsável pela OT.
numero	number	Número do CIOT ou identificador da parcela.
ciotCodVerificador	string	Código verificador do CIOT associado à operação.
nomeParcela	string	Nome ou identificação da parcela (ex.: "Saldo", "Adiantamento").

Validações e regras de negócio

Processamento síncrono:

Ao receber a consulta, a API iniciará o processamento síncrono e retornará imediatamente o status de cada parcela.

Validação dos dados:

Se tiver dados inválidos, os erros deverão ser reportados no resultado.

Resposta do GET

A resposta será imediata, informando o status da parcela.

Exemplo de resposta de sucesso:

{
	"cnpj": "12345678901234",
  "ciot": 123456789013,
  "ciotCodVerificador": "ABCD",
  "nomeParcela": "Saldo",
  "valor": 1.11,
  "status": "1",
  "dataPagamento": "2025-01-10 15:00:00",
  "mensagens": [
	  {
	    "codigo": 400,
      "mensagem": "Falha ao processar a operação: Sem saldo em conta de pagamento"
    }
  ]
}

Nome do Campo	Tipo	Descrição
cnpj	string	Identificador do registro do transportador associado à parcela.
ciot	number	Número do CIOT.
ciotCodVerificador	string	Código verificador do CIOT.
nomeParcela	string	Nome da parcela (ex.: "Saldo").
valor	decimal	Valor da parcela.
status	string (enum)	Status da parcela: 0 = Em Aberto; 1 = Aguardando Pagamento (em processamento); 2 = Aguardando Solicitação de Pagamento (aguardando aprovação da OT); 3 = Paga; 4 = Cancelada; 5 = Aguardando ação de suporte.
dataPagamento	date	Data e hora de pagamento da parcela.
mensagens	array	Lista de erros associados à parcela.
└─ codigo	number	Código do erro (ex.: 400).
└─ mensagem	string	Descrição do erro ocorrido.

Códigos de Status HTTP

• 200 ou 201: para o GET,indica que a consulta do processamento foi realizada com sucesso.
• 400: erro de validação (dados inválidos no lote).
• 401: não autorizado (token JWT ausente ou inválido).
• 500: erro interno do servidor ou exceções não tratadas.

• codigo: código de retorno da operação.
• mensagem: mensagem informativa referente ao processamento do lote.

Consulte aqui todas as mensagens e códigos de retorno

---

Próximos passos

Veja como reprocessar um pagamento

---