Ir para o conteúdo
Método URL
POST https://BASE_URL/public/v1/recebiveis/lotes/{idLote}/cancelar

Cancela um lote quando a situação atual permite cancelamento.

Path Params

Campo Tipo Descrição
idLote Número Identificador do lote.

Esta rota não possui Request Body.

Response Body — 200 OK
{
  "status": "sucesso",
  "mensagem": "O lote foi cancelado"
}

Modelo de dados

Retorno

Campo Tipo Descrição
status Texto Status do processamento.
mensagem Texto Mensagem retornada pela API.

Observações

  • Exclusão dos títulos: em operações com Ação após cancelar lote = Apagar títulos atrelados, cancelar um lote de cessão exclui os títulos dele.
  • Reenvio do arquivo: se o lote continha todos os títulos ainda ativos de um arquivo importado, a importação desse arquivo passa ao status Cancelado e o mesmo arquivo pode ser enviado novamente (tela ou SFTP).
  • Quando o arquivo continua bloqueado: lote com apenas parte dos títulos do arquivo, operação com Disponibilizar títulos novamente e operação registrada na BTG não liberam o arquivo — o reenvio continua recusado como arquivo já importado.