Cancela o boleto (com ou sem dar baixa)

DELETE 
/charge/bank-slip/:idbankslip

Cancela o boleto junto ao emissor. Sem ValuePaid/DatePaid o boleto é apenas cancelado e a conta a receber vinculada permanece em aberto; informando os dois, o boleto passa para 5 Baixa manual e o pagamento é registrado — usado quando o cliente já pagou por outro meio. Nesse modo de baixa, o lançamento financeiro só acontece quando existe uma conta a receber ainda em aberto (0 Aberto, 1 Vencido ou 6 Vence hoje) amarrada ao boleto e uma conta bancária associada à integração; se qualquer uma das duas faltar, o boleto é baixado mas nenhum pagamento é lançado. O cancelamento só existe nas integrações Itaú e Banco Inter, e o boleto precisa estar em 1 Ag. Pagamento ou 3 Pendente.

Request

Responses

200

Boleto cancelado (e pagamento registrado quando aplicável). Retorna um array com um objeto — o detalhe completo do boleto já atualizado, com os mesmos campos de GET /charge/bank-slip/{idbankslip}. O detalhe é lido sem reconsultar o emissor.

400

Mensagens (prefixo [BadRequest]):

• Boleto não encontrado
• Status boleto não permite cancelar
• Integração não cadastrada
• Integração não tem recurso de cancelamento
• Não foi possível cancelar o boleto. Tente novamente. — falha de rede ou tempo esgotado ao acionar o emissor.
• Boleto cancelado, mas não foi possível carregá-lo. Atualize a tela. — cancelamento concluído, mas a releitura do boleto falhou.