É através do arquivo gerado por essa rota que vamos indicar a alteração no boleto (data de vencimento, valor, etc). Para fazer essa geração, vamos precisar do IdIntegracao do boleto que você deseja gerar na remessa.

Lembrando que, este recurso é utilizado para alterar as informações do título quando o mesmo já consta na base de dados do banco (Registrado) e após a confirmação do banco sobre esta alteração, o arquivo retorno com esta confirmação será conciliado/incluído em nossa base de dados, fazendo com que esta alteração seja realizada em ambas bases de dados.

 

POST

 Homologação:

 Produção:

 

Headers

 

Nome	Descrição	Exemplo
Content-Type	Indica o tipo de arquivo	application/json
cnpj-cedente	CNPJ do Cedente	01001001000113
cnpj-sh	CNPJ da Software House	01001001000113
token-sh	Token da Software House	f22b97c0c9a3d41ac0a3875aba69e5aa

 

Headers (Opcional)

Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:

Nome	Descrição	Exemplo
Content-Type	Indica o tipo de arquivo	application/json
cnpj-cedente	CNPJ do Cedente	01001001000113
token-cedente	Token do Cedente	f22b97c0c9a3d41ac0a3875aba69e5aa1

 

Objeto

 

Para solicitar a impressão, o objeto JSON pode ter os seguintes campos:

 

Campo	Tipo	Descrição
Tipo	string	Tipo da alteração que deseja gerar: 0 - Alteração na data de vencimento. (TituloDataVencimento) 1 - Alteração no valor do título. (TituloValor) 2 - Conceder abatimento. (TituloValorAbatimento) 3 - Cancelar abatimento concedido. (Nenhum campo) 4 - Pedido protesto. (Nenhum campo) 5 - Sustar protesto e baixar boleto. (Nenhum campo) 6 - Sustar protesto e manter em carteira. (Nenhum campo) 7 - Alteração de carteira. (TituloCarteira) 8 - Incluir negativação. 9 - Excluir negativação e manter carteira. 10 - Excluir negativação e baixar titulo.
Boletos	array	Array de boletos com os novos valores. - Limite de 1000 boletos

 

Bancos disponíveis:

Banco	tipo 0	tipo 1	tipo 2	tipo 3	tipo 4	tipo 5	tipo 6	tipo 7	tipo 8	tipo 9	tipo 10
Itaú	✔️	✔️	✔️	✔️	✔️	✔️	✔️	✔️	❌	❌	❌
Bradesco	✔️	✔️	✔️	✔️	✔️	✔️	✔️	✔️	❌	❌	✔️
Banco do Brasil*	✔️	✔️	✔️	✔️	✔️	✔️	✔️	✔️	❌	❌	❌
Santander*	✔️	✔️	✔️	✔️	✔️	✔️	✔️	✔️	❌	❌	❌
Daycoval*	✔️	✔️	✔️	❌	✔️	✔️	✔️	❌	❌	❌	❌
Safra	✔️	✔️	✔️	✔️	✔️	✔️	✔️	❌	❌	❌	❌
CitiBank	✔️	✔️	✔️	✔️	✔️	✔️	✔️	❌	❌	❌	❌
Sicredi*	✔️	✔️	✔️	✔️	✔️	✔️	✔️	❌	✔️	✔️	✔️
Sicoob	✔️	✔️	✔️	✔️	✔️	❌	❌	❌	❌	❌	❌

Obs.: 
* Daycoval : Não disponível quando CNAB 240.

* Santander: Não disponível o tipo 7 quando CNAB 400.

* Sicredi: Não disponível o tipo 7 quando CNAB 400.

* BB com o CNAB 400 não permite alteração no valor do título (tipo 1).

* Alguns bancos costumam não aceitar remessas de alteração de valor para carteiras vinculadas. É importante verificar com sua instituição a possibilidade de uso.

Campos obrigatórios de acordo com o tipo

 

Tipo	Campos obrigatórios	Observações
0	TituloDataVencimento	Deve ser informado uma data posterior a data de vencimento atual, Nova data não deve ser maior que 5 anos que a data atual. Deve ser informada no formato (DD/MM/YYYY).
1	TituloValor	O novo valor do boleto deve ser informado no formato (1000,00).
2	TituloValorAbatimento	O valor do abatimento a ser concedido deve estar no formato (1000,00).
3	Nenhum campo	Nesse tipo não é necessário informar nenhum campo extra além do idintegracao.
4	Nenhum campo	Nesse tipo não é necessário informar nenhum campo extra, além do idintegracao.
5	Nenhum campo	Nesse tipo não é necessário informar nenhum campo extra, além do idintegracao. Nos bancos Banco do Brasil no CNAB 240 e 400 e no Itaú CNAB 240 e 400 esse movimento não existe, sendo assim o comportamento desse tipo, será apenas de sustar protesto, caso necessite sustar protesto e baixar o título, é necessário gerar duas remessas separadas, um com o movimento de sustar protesto, e outro para baixar o boleto.
6	Nenhum campo	Nesse tipo não é necessário informar nenhum campo extra, além do idintegracao. Nos bancos Banco do Brasil no CNAB 240 e 400 e no Itaú CNAB 240 e 400 esse movimento não existe, sendo assim irá para o banco a instrução de apenas sustar o protesto.
7	TituloCarteira	Nesse campo, o valor da nova carteira deve ser informado.
8	Nenhum campo	Incluir negativação.
9	Nenhum campo	Excluir negativação e manter carteira.
10	Nenhum campo	Excluir negativação e baixar titulo.

 

Body

 

Esta rota recebe no corpo (body) da requisição um array de objetos boleto. Esse array vai possuir o IdIntegracao do boleto que será alterado um campo que vai indicar o novo valor (de vencimento ou valor do título). Esse campo vai possuir a mesma nomenclatura dos campos utilizados para a inclusão do boleto e cada um deles será utilizado em um tipo de alteração, vamos lá::

 

Exemplo de JSON para solicitar uma alteração na data de vencimento:

 

Veja que, no exemplo acima, estamos setando o tipo de alteração com o valor "0", e logo abaixo, juntamente com o IdIntegracao também informamos o campo TituloDataVencimento, que irá indicar o valor da nova data de vencimento do boleto.

 

Exemplo de JSON para solicitar uma alteração no valor do título:

 

Neste exemplo estamos setando o tipo de alteração com o valor 0, e logo abaixo, juntamente com o IdIntegracao também informamos o campo TituloValor, que irá indicar o novo valor do boleto.

 

Exemplo de JSON para solicitar uma alteração no valor abatimento:

 

Exemplo de JSON para solicitar uma alteração na carteira:

 

 

Retorno

 

Exemplo de retorno:

 

 

Exemplo de retorno com erro:

 

 

Obs: Caso obtenha o seguinte retorno da API: "Todos os IDs de integração já tem um protocolo associado em um intervalo de 30 minutos",  significa que já houve a geração de um protocolo  do processo de alteração para este boleto a menos de 30 minutos, e é necessário aguardar este tempo, para poder gerar um novo protocolo.

 

Em caso de sucesso, a rota irá retornar um número de protocolo através do campo protocolo. Isso acontece pois a rota é assíncrona. Usando esse número de protocolo, nosso próximo passo é consultá-lo e verificar o resultado do processamento da geração da remessa de alteração.