É 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:
https://homologacao.plugboleto.com.br/api/v1/boletos/altera/lote
Produção:
https://plugboleto.com.br/api/v1/boletos/altera/lote
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 |
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. 1 - Alteração no valor do título. 2 - Conceder abatimento 3 - Cancelar abatimento concedido 4 - Pedido protesto 5 - Sustar protesto e baixar boleto 6 - Sustar protesto e manter em carteria |
| Boletos | array | Array de boletos com os novos valores. |
Obs.: Os tipos "2","3","4","5" e "6" atualmente está disponíveis para contas do Banco do Brasil, Bradesco, Daycoval, Safra, CityBank, Santander e Itaú. Os demais bancos estão sendo implementados e serão disponibilizados em breve.
Campos obrigatórios de acordo com o tipo
| Tipo | Campos obrigatórios | Observações |
| 0 | TituloDataVencimento |
|
| 1 | TituloValor |
|
| 2 | TituloValorAbatimento |
|
| 3 | Nenhum campo |
|
| 4 | Nenhum campo |
|
| 5 | Nenhum campo |
|
| 6 | Nenhum campo |
|
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:
{
"Tipo": "0",
"Boletos": [
{
"IdIntegracao": "IdIntegracao1",
"TituloDataVencimento": "20/06/2018",
},
{
"IdIntegracao": "IdIntegracao2",
"TituloDataVencimento": "20/06/2018",
},
]
}
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:
{
"Tipo": "1",
"Boletos": [
{
"IdIntegracao": "IdIntegracao1",
"TituloValor": "100,00",
},
{
"IdIntegracao": "IdIntegracao2",
"TituloValor": "200,00",
},
]
}
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.
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_mensagem": "Solicitação pendente de processamento",
"_dados": {
"situacao": "PROCESSANDO",
"protocolo": "SkR1z8B-G"
}
}
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Erro de validação.",
"_dados" : [
{
"_campo": "corpo_requisicao",
"_erro": "O corpo da requisição deve ser um array de IDs de integração.",
}
]
}
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.
Comentários
0 comentário
Por favor, entre para comentar.