Cancelar um boleto




POST https://sandbox-api.openbank.stone.com.br/api/v1/barcode_payment_invoices/id/cancel

QUERY PARAMS



id* string
Identificador do boleto que se quer cancelar.


O cancelamento do boleto ocorre de forma assíncrona. Após a solicitação de cancelamento ser efetuada com sucesso, o status será alterado para CANCELLATION_REQUESTED.

Assim que o processo de cancelamento terminar, o status será alterado para CANCELLED.
Para acompanhar o processo de cancelamento, utilize a api /barcode_payment_invoices/{id}/ e observe o status do boleto.


Atenção

Não será possível cancelar o boleto caso:

  • exista algum pagamento em progresso
  • o boleto esteja com status SETTLED

Response

200 OK
content-type: application/json

Body


{ }


Última modificação: 01.01.0001