Pagar parcelas em lote

Registre e comande o pagamento de parcelas vinculadas às operações de transporte, enviadas em lote. O processamento do lote é realizado de forma síncrona, retornando imediatamente o resultado do pagamento de cada parcela.

Método e rota

• Criação (POST): /frete/lote/pagarParcela/:enterpriseId

Estrutura da requisição

Cabeçalhos

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

  Authorization: Bearer {token}

Corpo

O corpo da requisição deve seguir a estrutura abaixo, onde o array infPgtoOTs contém os dados de pagamento de cada parcela da OT.
Veja aqui a definição completa do schema.

{
  "infPgtoOTs": [
    {
      "cnpj": "12345678912345",
      "numero": 123456789012,
      "ciotCodVerificador": "ABCD",
      "nomeParcela": "Saldo",
      "motivo": "Pagamento final da OT."
    },
    {
      "cnpj": "12345678912345",
      "numero": 123456789013,
      "ciotCodVerificador": "ABCD",
      "nomeParcela": "Saldo",
      "motivo": "Pagamento final da OT."
    }
  ]
}

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").
motivo	string	Descrição do motivo do pagamento para a parcela.

Validações e regras de negócio

Processamento Síncrono:

Ao receber o lote, a API iniciará o processamento síncrono e retornará imediatamente o resultado do pagamento de cada parcela.

Validação dos Dados:

Se algum item do lote tiver dados inválidos, o processamento individual dessa parcela deverá ser marcado como falho, e os erros deverão ser reportados no resultado.

Resposta do POST

Após o envio do lote, a resposta será imediata, informando se o lote foi aceito para processamento e o resultado do processamento de cada pagamento:

Exemplo de resposta de sucesso:

{
  "retornoLotePagamento": [
    {
      "cnpj": "12345678901234",
      "numero": 123456789012,
      "ciotCodVerificador": "ABCD",
      "nomeParcela": "Saldo",
      "sucesso": true,
      "erros": []
    },
    {
      "cnpj": "12345678901234",
      "numero": 123456789013,
      "ciotCodVerificador": "ABCD",
      "nomeParcela": "Saldo",
      "sucesso": false,
      "erros": [
        {
          "codigo": 400,
          "mensagem": "Falha ao processar a operação: Sem saldo em conta de pagamento"
        }
      ]
    }
  ]
}

Exemplo de resposta de erro (global):

{
  "codigo": "400",
  "mensagem": "Erro na validação dos parâmetros do lote."
}

Nome do Campo	Tipo	Descrição
cnpj	string	Identificador do registro do transportador associado à parcela.
numero	number	Número que identifica a parcela ou operação (conforme enviado na requisição).
ciotCodVerificador	string	Código verificador do CIOT.
nomeParcela	string	Nome da parcela (ex.: "Saldo").
sucesso	boolean	Indica se o processamento da parcela foi concluído com sucesso.
erros	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 POST, indicam que o lote foi aceito para processamento.
• 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 para todas as mensagens e códigos de retorno

---

Próximos passos

Altere as parcelas ou consulte o status de uma parcela.

---