Pular para o conteúdo principal

Reprocessar pagamento

Permite reprocessar pagamento via API sem a necessidade de acesso ao portal do NDD Cargo.

observação

A API permite reprocessar os pagamentos individualmente. Ou seja, cada requisição deve constar uma única parcela.

Métodos e rotas

  • Solicitação (POST): /frete/lote/reprocessarPagamentoParcela/

Estrutura da requisição

Cabeçalhos

  • Para ambos os métodos, o token JWT deverá ser enviado no header, por exemplo:

    Authorization: Bearer {token}

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

Nome do CampoTipoDescrição
CIOTnumberNúmero do CIOT.
CódigostringCódigo verificador do CIOT.
ParcelastringNome da parcela.

Validações e regras de negócio

  • Todos os campos do payload são obrigatórios.
  • O reprocessamento de pagamento é aplicado exclusivamente às parcelas com status igual a 1.

Resposta do POST

Exemplo de resposta de sucesso 200:

"sucesso": true,
"mensagens":[
{
"código": 161,
"mensagem": "O reprocessamento do pagamento foi realizado com sucesso. O pagamento com Id: 135193, foi reprocessado com sucesso."
}
]

Exemplo de resposta: Nome da parcela nulo ou vazio

{
"NomeParcela":[
"The NomeParcela field is required.",
"O nome da parcela não pode vazio e nem nulo"
]
}

**Exemplo de resposta: Código verificador nulo ou vazio

{
"CodigoVerificador":[
"The CodigoVerificador field is required.",
"O código verificador do CIOT não pode ser vazio e nem nulo"
]
}

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 consultar o roteirizador