Pular para o conteúdo principal

Solicitando a alteração individual de boleto via WebService

Guilherme Zenata Gines
Atualizado
 
 

Através desta rota é possível realizar algumas alterações de boletos via WebService.

 

Banco Alteração via WS Observações
Banco do Brasil (001) ✔️(v2)  
Caixa (104) ✔️  
Itaú (341) ✔️(v2) Obrigatório habilitar a opção de "Alteração via WS" (ConvenioAlteracaoWebservice) no cadastro de convênio.
Santander (033) ✔️(v2)  
Btg - Pactual (208) ✔️(v1)  
C6 (336) ✔️(v1)  
 

 

 

POST

Homologação:

https://homologacao.plugboleto.com.br/api/v1/boletos/altera/individual

Produção:

https://plugboleto.com.br/api/v1/boletos/altera/individual

 

 

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

 

 

Banco do Brasil - Campos disponíveis para alteração

 

Campo Descrição Exemplo
TituloDataVencimento Alterar a data de vencimento 15/03/2023
TituloCodDesconto Alterar o tipo de desconto 2
TituloDataDesconto Alterar a data do desconto 15/02/2023
TituloValorDescontoTaxa Alterar o valor do desconto 100
TituloCodDesconto2 Alterar o tipo do segundo desconto 2
TituloDataDesconto2 Alterar a data do segundo desconto 15/02/2023
TituloValorDescontoTaxa2 Alterar o valor do segundo desconto 100
TituloCodDesconto3 Alterar o tipo do terceiro desconto 2
TituloDataDesconto3 Alterar a data do terceiro desconto 15/02/2023
TituloValorDescontoTaxa3 Alterar o valor do terceiro desconto 100
TituloValorAbatimento Adicionar, alterar ou reduzir valor de abatimento do boleto 5
TituloValorJuros Alterar o valor/taxa de juros 1,0
TituloCodigoJuros Alterar o código de juros 2
TituloCodigoMulta Alterar o código de multa 1
TituloValorMultaTaxa Alterar o valor da multa 1,0
TituloDataMulta Alterar a data da multa 15/02/2023
TituloCodProtesto Alterar o código de protesto 8
TituloPrazoProtesto Alterar os dias do protesto 30
SacadoEnderecoNumero Alterar o número de endereço do sacado 15
 

Caixa - Campos disponíveis para alteração

 

Campo Descrição Exemplo
TituloNossoNumero
 Alterar o nossoNumero do boleto 123
TituloNumeroDocumento
 Alterar o numero documento do boleto 123
TituloDataVencimento Alterar a data de vencimento 15/03/2023
TituloValor Altera o valor do título 15,00
TituloAceite Alterar o aceite do boleto S
TituloValorAbatimento Alterar o valor do abatimento ou redução do valor do boleto 5
TituloDocEspecie Alterar a espécie do título no banco 1,0
TituloInscricaoSacadorAvalista
 Alterar a inscricao do Sacador Avalista 12345678910
TituloMensagem01 ou 02 Alterar a mensagem 1 ou 2 do boleto 8
 

 

Itaú - Campos disponíveis para alteração 

 

Campo Descrição Exemplo
TituloValor Altera o valor do título 15,00
TituloDataVencimento Alterar a data de vencimento 15/03/2023
TituloCodDesconto 1 - Valor Fixo Até a Data Informada.
2 - Percentual Até a Data Informada.		 1
TituloValorDescontoTaxa Alterar o valor do desconto 100
TituloValorAbatimento Alterar o valor do abatimento ou redução do valor do boleto 5
TituloCodProtesto Alterar o código de protesto 8
TituloPrazoProtesto Alterar a data do protesto 20/02/2023

 

De acordo com a documentação do banco, estes são os boletos cujo o Itaú libera a alteração do valor nominal:

  • 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 que não estejam em processo de protesto;
  • Títulos não descontados;
  • Títulos com Negativação agendada;
  • Títulos com Negativação em andamento;
  • Títulos negativados;

 

 

Santander - Campos disponíveis para alteração

 

Campo Descrição Exemplo
TituloValor Altera o valor do título 15,00
TituloDataVencimento Alterar a data de vencimento 15/03/2023
TituloValorAbatimento Alterar o valor do abatimento ou redução do valor do boleto 5

 

 

 

Btg - Campos disponíveis para alteração

Para realizar alterações no BTG os campos abaixo podem ser utilizados. No entanto, para algumas operações, mais de um campo deverá ser informado.

Exemplo: Alterar vencimento, então caso o boleto tenha sido emitido com Juros e Multa, todos os campos de Juros e Multa deverão ser informados.

 

Campo Descrição Exemplo
TituloValor Altera o valor do título "15,00"
TituloDataVencimento Alterar a data de vencimento "15/03/2025"
TituloDataLimite Altarar a data limite "15/03/2025"
TituloCodigoJuros Alterar o código de juros 1
TituloDataJuros Alterar a data de juros "15/03/2025"
TituloValorJuros Alterar o valor do juros "2,54"
TituloCodigoMulta Alterar o código da multa "1"
TituloDataMulta Altarar a data de multa "15/03/2025"
TituloValorMultaTaxa Alterar o valor da multa "2,40"
TituloCodDesconto Alterar o código do desconto 2
TituloDataDesconto Alterar a data do desconto "15/03/2025"
TituloValorDescontoTaxa Alterar o valor do desconto "1,40"
TituloMensagem01 Alterar a descrição do boleto "texto"

 

 

Banco C6 - Campos disponíveis para alteração

Campo Descrição Exemplo
TituloValor Altera o valor do título 60,06
TituloDataVencimento Alterar a data de vencimento 15/03/2023
TituloCodDesconto Alterar o tipo de desconto 2
TituloDataDesconto Alterar a data do desconto 15/02/2023
TituloValorDescontoTaxa Alterar o valor do desconto 100
TituloCodDesconto2 Alterar o tipo do segundo desconto 2
TituloDataDesconto2 Alterar a data do segundo desconto 15/02/2023
TituloValorDescontoTaxa2 Alterar o valor do segundo desconto 100
TituloCodDesconto3 Alterar o tipo do terceiro desconto 2
TituloDataDesconto3 Alterar a data do terceiro desconto 15/02/2023
TituloValorDescontoTaxa3 Alterar o valor do terceiro desconto 100
TituloValorJuros Alterar o valor/taxa de juros 1,0
TituloCodigoJuros Alterar o código de juros 2
TituloDataJuros Altera a data do juros 15/02/2023
TituloCodigoMulta Alterar o código de multa 1
TituloValorMultaTaxa Alterar o valor da multa 1,0
TituloDataMulta Altera a data da multa 15/02/2023

 


Como mandar as alterações para todos os bancos da lista
 

Exemplo de JSON para solicitar uma alteração na data de vencimento:
 
{
  "Boleto": {
    "IdIntegracao": "C1ZURGRR5",
    "TituloDataVencimento": "01/05/2023"
  }
}
 
Retorno
 
Exemplo de retorno:
 
{
  "_status": "sucesso",
  "_mensagem": "Solicitação pendente de processamento",
  "_dados": {
    "situacao": "PROCESSANDO",
    "protocolo": "77WLTGFK7"
  }
}
 
Exemplo de retorno com erro:
 
{
  "_status": "erro",
  "_mensagem": "Erro de validação.",
  "_dados": [
    {
      "_campo": "corpo_requisicao",
      "_erro": [
        "O campo SacadoEnderecoBairro é obrigatório."
      ]
    }
  ]
}
 
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 de alteração. O protocolo pode ser consultado na rota descrita em consultar remessa de alteração.
Exemplo de JSON para solicitar uma alteração na data de vencimento:
 
{
  "Boleto": {
    "IdIntegracao": "C1ZURGRR5",
    "TituloDataVencimento": "01/05/2023"
  }
}
 
Retorno
 
Exemplo de retorno:
 
{
  "_status": "sucesso",
  "_mensagem": "Solicitação pendente de processamento",
  "_dados": {
    "situacao": "PROCESSANDO",
    "protocolo": "77WLTGFK7"
  }
}
 
Exemplo de retorno com erro:
 
{
  "_status": "erro",
  "_mensagem": "Erro de validação.",
  "_dados": [
    {
      "_campo": "corpo_requisicao",
      "_erro": [
        "O campo SacadoEnderecoBairro é obrigatório."
      ]
    }
  ]
}
 
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 de alteração. O protocolo pode ser consultado na rota descrita em consultar remessa de alteração.

 

 

Exemplo de JSON para solicitar uma alteração na data de vencimento:
 
{
  "Boleto": {
    "IdIntegracao": "C1ZURGRR5",
    "TituloDataVencimento": "01/05/2023"
  }
}
 
Retorno
 
Exemplo de retorno:
 
{
  "_status": "sucesso",
  "_mensagem": "Solicitação pendente de processamento",
  "_dados": {
    "situacao": "PROCESSANDO",
    "protocolo": "77WLTGFK7"
  }
}
 
Exemplo de retorno com erro:
 
{
  "_status": "erro",
  "_mensagem": "Erro de validação.",
  "_dados": [
    {
      "_campo": "corpo_requisicao",
      "_erro": [
        "O campo SacadoEnderecoBairro é obrigatório."
      ]
    }
  ]
}
 
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 de alteração. O protocolo pode ser consultado na rota descrita em consultar remessa de alteração.

Relativo a

Artigos relacionados

Comentários

0 comentário

Por favor, entre para comentar.