Cancel payment dunning

Allows the cancellation of a delinquency. Use the canBeCancelled property returned in the delinquency object to check if the delinquency can be canceled.

If the delinquency has already been initiated, requesting cancellation will change its status to AWAITING_CANCELLATION until it is effectively canceled (CANCELLED).

Requests the cancellation of a payment dunning.

Before using this operation, retrieve the payment dunning and check canBeCancelled. Request the cancellation only when this property indicates that the operation is available.

📘

Cancellation processing

If the payment dunning has already started, the request changes its status to AWAITING_CANCELLATION until the cancellation is actually completed with the CANCELLED status.

In this scenario, the cancellation request does not mean the process is completed immediately. To confirm the final status, use Retrieve a single payment dunning.

Path Params
string
required

Unique identifier of the payment dunning to be cancelled.

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