É 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 |
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) 2 - Alterar valor do abatimento. (TituloValorAbatimento) 3 - Cancelar o abatimento. (TituloValorAbatimento) 4 - Sustar protesto e baixar boleto. 12 - Alterar valor do desconto. (TituloCodDesconto | TituloValorDescontoTaxa) 13 - Alterar valor do Juros. (TituloCodigoJuros | TituloValorJuros) |
| Boletos | array | Array de boletos com os novos valores. |
Campos obrigatórios de acordo com o tipo
| Tipo | Campos obrigatórios | Observações |
|---|---|---|
| 0 | TituloDataVencimento |
|
| 2 | TituloValorAbatimento |
|
| 8 |
| |
| 12 | TituloCodDesconto |
|
| 12 | TituloValorDescontoTaxa |
|
| 13 | TituloCodigoJuros |
|
| 13 | TituloValorJuros |
|
| 14 | TituloCodDesconto |
|
| 14 | TituloDataDesconto |
|
| 15 |
|
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",
},
]
}
Exemplo de JSON para solicitar uma alteração no valor do abatimento:
{
"Tipo": "2",
"Boletos": [
{
"IdIntegracao": "IdIntegracao1",
"TituloValorAbatimento": "5,00",
},
{
"IdIntegracao": "IdIntegracao2",
"TituloValorAbatimento": "5,00",
},
]
}
Exemplo de JSON para solicitar uma alteração no código de desconto:
{
"Tipo": "12",
"Boletos": [
{
"IdIntegracao": "IdIntegracao1",
"TituloCodDescontoTaxa": "1",
},
{
"IdIntegracao": "IdIntegracao2",
"TituloCodDescontoTaxa": "1",
},
]
}
Exemplo de JSON para solicitar uma alteração no valor do Desconto:
{
"Tipo": "12",
"Boletos": [
{
"IdIntegracao": "IdIntegracao1",
"TituloValorDescontoTaxa": "5,00",
},
{
"IdIntegracao": "IdIntegracao2",
"TituloValorDescontoTaxa": "5,00",
},
]
}
Exemplo de JSON para solicitar uma alteração no código de juros:
{
"Tipo": "13",
"Boletos": [
{
"IdIntegracao": "IdIntegracao1",
"TituloCodigoJuros": "1",
},
{
"IdIntegracao": "IdIntegracao2",
"TituloCodigoJuros": "1",
},
]
}
Exemplo de JSON para solicitar uma alteração no valor do juros:
{
"Tipo": "13",
"Boletos": [
{
"IdIntegracao": "IdIntegracao1",
"TituloValorJuros": "5,00",
},
{
"IdIntegracao": "IdIntegracao2",
"TituloValorJuros": "5,00",
},
]
}
Exemplo de JSON para solicitar uma alteração na data de vencimento:
{
"Tipo": "14",
"Boletos": [
{
"IdIntegracao": "IdIntegracao1",
"TituloDataDesconto": "20/06/2018",
},
{
"IdIntegracao": "IdIntegracao2",
"TituloDataDesconto": "20/06/2018",
},
]
}
Exemplo de JSON para solicitar negativação
{
"Tipo": "8",
"Boletos": [
{
"IdIntegracao": "IdIntegracao1"
},
{
"IdIntegracao": "IdIntegracao2"
},
]
}
Exemplo de JSON para solicitar excluir negativação e baixar o boleto
{
"Tipo": "15",
"Boletos": [
{
"IdIntegracao": "IdIntegracao1"
},
{
"IdIntegracao": "IdIntegracao2"
},
]
}
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.