base path: 

api.itau.com.br

sandbox path: https://devportal.itau.com.br/sandboxapi/itau-ep9-gtw-cash-management-ext-v2/v2

Baixa Imediata

[PATCH] /cash_management/v2/boletos/{idBoleto}/baixa

API responsável por efetuar a baixa em um boleto. O processo de baixa consiste na ação de cancelar o boleto. O comando de baixa pode ser realizado pelo beneficiário, que
é o contratante do serviço de Cobrança e quem cedeu os títulos de crédito ao Banco para que esse realizasse a sua cobrança.

Os boletos elegíveis para serem baixados são:

 Títulos cadastrados no sistema;

 Títulos abertos (não baixados e liquidados);

 Títulos não pagos (sem baixa operacional);

 Títulos vencidos;

 Títulos não vencidos;

 Títulos não protestados;

 Títulos com instrução de protesto cadastrada;

 Títulos em processo de protesto*;

 Titulos negativados;

 Títulos com instrução de negativação cadastrada;

 Títulos em processo de negativação;

*Caso o titulo esteja em processo de protesto, o sistema sustará automaticamente o boleto e baixará o título. Caso o título esteja em processo de negativação, o sistema
fará a exclusão da negativação automaticamente e baixará o título. Não deve ser solicitado a baixa do título no mesmo dia da emissão, para carteiras 156/157.

A seguir estão expostos os parâmetros exigidos por essa API e a descrição deles. Para obter mais informações de onde conseguir o x-itau-apikey, e o x-itau-correlationID,
acesse o tópico ‘Informações necessárias’.

Parâmetros
 Tipo Tipo
Parâmetro Obrigatório Descrição
Parâmetro Dado

client_id gerado pela autenticação Oauth utilizado para autorizar o consumo de

x-itau-apikey header string sim
uma aplicação requisitante.

identificador de correlação utilizado como um agrupar dentro da estrutura de

x-itau-
header string sim audit trail e que permite relacionar uma mesma chamada passando em diversas
correlationID
aplicações/sistemas diferentes.

A implementação de um flowID permite identificar qual é a funcionalidade de

negócio sendo executada na aplicação. Por exemplo, dentro de uma mesma
aplicação, várias telas ou linhas de negócio diferentes podem acessar a mesma
API. Quando é identificado que algumas chamadas a uma determinada API estão
x-itau-flowID header string sim
dando erro, através do flowID, podemos descobrir que as chamadas são de uma
tela específica e com isso solucionar o problema mais rápido do que se não
tivéssemos essa informação no log. Ter o flowID nos logs também permite extrair
algum tipo de métrica através do log.

Dados para identificação do boleto para alteração, sendo composto por: Código
Agência - Obrigatório (4 caracteres) Código Conta Corrente - Obrigatório (7
idBoleto path string sim caracteres) Dígito verificador (DAC) - Obrigatório (1 caracter) Código Carteira -
Obrigatório (3 caracteres) Nosso Número - Obrigatório (8 ou 16 caracteres) -
Máximo de 23 ou 31 caracteres

Exemplo de Entrada

 PATCH /cash_management/v2/boletos/15000005206110900123522/baixa

Body:

{}

Códigos de Resposta
 Código de Status Descrição

204 Alteração/Instrução realizada com sucesso

201 O recurso foi criado de forma síncrona

400 parâmetros incorretos

401 Não autorizado

403 Acesso proibido

404 Recurso inexistente

405 Método não permitido

422 Dados informados estão fora do escopo definido para o campo

428 Pré-requisito necessário

500 Erro inesperado

501 Não implementado

503 Serviço indisponível

Exemplo de Saídas

 (status = 204 (No content), application/json)

{}

 (status = 400, application/json)

{
 "codigo": "400",

"mensagem": "Erro na validação de Campos.",

"campos": [

"campo": "idBoleto",

"mensagem": "Id Boleto inválido",

"valor": "111111111"

 (status = 422, application/json)

Obs: Exemplo não replicável na virtualização

"codigo": "422",

"mensagem": "Entradas Bloqueadas, conta suspensa em cobrança.",

"campos": [{

"campo": "categoria_cobranca",

"mensagem": "Entradas Bloqueadas, conta suspensa em cobrança.",

"valor":

}]

 (status = 422, application/json)

Obs: Exemplo não replicável na virtualização

{

"codigo": "422",

"mensagem": "Ação não permitida, conta migrada",

"campos": [{

"campo": "beneficiário",

"mensagem": "Ação não permitida, conta migrada",

"valor": null

}]

 (status = 422, application/json)

Obs: Exemplo não replicável na virtualização

"codigo": "422",

"mensagem": "Erro na validação de Campos",

"campos": [{

"campo": "situacaoGeral",

"mensagem": "Alteração não permitida para título já baixado ou liquidado",

"valor": "BAIXADO"

}]

 (status = 422, application/json)

Obs: Exemplo não replicável na virtualização

{
 "codigo": "422",

"mensagem": "Erro na validação de Campos.",

"campos": [{

"campo": "data.dado_boleto.desconto.codigo_tipo_desconto",

"mensagem": "Alteração não permitida para título descontado",

"valor": "Descontado"

}]

 (status = 422, application/json)

Obs: Exemplo não replicável na virtualização

"codigo": "422",

"mensagem": "Erro na validação de Campos.",

"campos": [{

"campo": "situacaoGeral",

"mensagem": "Ação não permitida para título em processo de liquidação",

"valor": "EM_PAGAMENTO"

}]