Cancel charges of an installment (pending and overdue)

Removes the pending or overdue payments of an installment.

Use this operation when only the payments that can still be canceled should be removed. Payments that have already been confirmed are not affected.

❗️

Installment deletion

If all payments of the installment are removed, the installment itself is also deleted and cannot be restored.

⚠️

Processing time

Processing time varies according to the number of installments. Set a minimum timeout of 60 seconds for this operation.

The removed payments trigger the PAYMENT_DELETED event. Webhooks are sent for the installment's payments, not for the installment itself.

See the Webhook events for payments.

Path Params
string
required

Unique identifier of the installment that will have charges removed.

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