Solicitando alteração de boleto - Em lote (CNAB e WebService)

É através desta 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 CNAB ou por WS caso você tenham ativado esta funcionalidade. 

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.

Índice 

1. CNAB
2. WebService

POST

 Homologação:

 Produção:

Headers

Headers (Opcional)

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

Objeto

CNAB

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

Bancos disponíveis:

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).

* BB com o CNAB 240 não permite alteração de concessão de desconto (tipo 16).

* 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

WebService

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:

Exemplo de JSON para solicitar uma alteração de concessão de desconto:

Neste exemplo estamos setando o tipo de alteração com o valor 16, e logo abaixo, juntamente com o IdIntegracao também informamos os campos TituloDataDesconto, TituloCodDesconto, TituloValorDescontoTaxa, que irão indicar as informações para a concessão de desconto para o boleto.

Exemplo de JSON para solicitar uma alteração de concessão de desconto via WebService: 

Neste exemplo estamos setando o tipo de alteração com o valor 16, e logo abaixo, juntamente com o IdIntegracao também informamos os campos TituloDataDesconto, TituloCodDesconto, TituloValorDescontoTaxa, que irão indicar as informações para a concessão de desconto para o boleto.

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.