Cancelar pagamento de contas

Permite o cancelamento do pagamento de conta. Utilize a propriedade canBeCancelled do objeto bill para verificar se o pagamento de conta pode ser cancelado.
Ao ser cancelado o pagamento da conta não será realizado.

Cancela um pagamento de conta que ainda esteja elegível para cancelamento.

Antes de solicitar o cancelamento, consulte o pagamento e valide canBeCancelled. O fato de o pagamento existir não significa que ele ainda possa ser cancelado.

Quando o cancelamento é concluído, o pagamento não será executado e passa para o estado CANCELLED.

📘

Acompanhamento do cancelamento

Utilize o evento BILL_CANCELLED para sincronizar a mudança de estado na sua integração.

Consulte os eventos para Pague Contas.

Para consultar o pagamento antes da operação, utilize Recuperar um único pagamento de conta.

Conteúdos relacionados

Guides

Biblioteca de Erros

Path Params
string
required

Identificador único do pagamento de conta a ser cancelado

Body Params
Responses

404

Not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json