Cancelar Boletos
Patch Boletos {ID} - Cancelar
Por esse método PATCH é possível cancelar boletos com Status gerado ou solicitar cancelamento para boletos com Status Remessa e Confirmado, bastando apenas inserir o seu ID ou código, conforme aparece no BankPlus.
 |
Atenção | |||||||
| Para melhor visualização das imagens, clique sobre elas. | ||||||||
1.1 - Cancelando boleto de status Gerado:
Ao selecionar o método PATCH à esquerda, na lista de métodos do Postman, coloque o ID do boleto que deseja cancelar na URL à direita, cole o Token, gerado no serviço API Rest, no campo Value da aba Headers e clique no botão Send, veja as imagens abaixo:
No campo abaixo, no Postman, podemos notar a mensagem de "Ok", confirmando que o boleto foi cancelado. Observe que o ID no nosso exemplo é o 460, inserido na URL após "/boletos/":
GET [http://localhost:9992/api/v2/QA/cobranca/boletos/460/cancelar].
Veja na imagem abaixo, na tela de Títulos Bancários no Addon o novo status desse boleto:
GET [http://localhost:9992/api/v2/QA/cobranca/boletos/460/cancelar].
Veja na imagem abaixo, na tela de Títulos Bancários no Addon o novo status desse boleto:
1.2 - Solicitando o cancelamento dos boletos de status Remessa:
Para cancelar boletos com status Remessa e Confirmado, é necessário antes realizar uma parametrização no Addon para permitir esse cancelamento.
Acesse BankPlus → Cobrança → Configurações → Parâmetros Gerais → aba Cobrança → marque o flag "Permitir alterar boleto registrado para aguardando cancelamento" → clique em Atualizar:
Para cancelar boletos com status Remessa e Confirmado, é necessário antes realizar uma parametrização no Addon para permitir esse cancelamento.
Acesse BankPlus → Cobrança → Configurações → Parâmetros Gerais → aba Cobrança → marque o flag "Permitir alterar boleto registrado para aguardando cancelamento" → clique em Atualizar:
 |
Dica | |||||||
| Para mais informações sobre cancelamento de boletos registrados, acesse: Permitir Alterar Boleto Registrado para Aguardando Cancelamento. | ||||||||
Depois dessa definição descrita acima, basta seguir o mesmo procedimento, colar o Token gerado no serviço API Rest no campo Value da aba Headers. Em seguida, inserir o ID do boleto na URL e clicar no botão Send:
Observe que o ID do boleto no nosso exemplo é o 666, como destacado na imagem acima e no campo abaixo, aparecerá a mensagem "Ok", já no Addon, ficará o status de "Aguardando Cancelamento", veja abaixo:
1.3 - Solicitando cancelamento dos boletos de status Confirmado:
Insira o ID desse boleto na URL do método, no Postman, cole o Token no seu respectivo campo Value, na aba Headers e clique no botão Send:
Insira o ID desse boleto na URL do método, no Postman, cole o Token no seu respectivo campo Value, na aba Headers e clique no botão Send:
Repare que a mensagem é a mesma da operação anterior (Ok), confirmando a solicitação do cancelamento.
E no Addon, veja que antes da execução do comando no Postman, o Status é Confirmado:
E no Addon, veja que antes da execução do comando no Postman, o Status é Confirmado:
Após executar o método no Postman, o Status ficará como Aguardando Cancelamento:
