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).

Endpoint responsible for requesting the cancellation of a dunning request.

This call should be used when the dunning request can still be canceled according to the rules of the process.


Request parameter

id - Unique identifier of the dunning request to be canceled.


Important rule about cancellation

Before requesting cancellation, the integration should check the canBeCancelled property returned in the dunning request object.

When this property indicates that cancellation is allowed, the request can be submitted normally.

If the dunning process has already started, once cancellation is requested the record will move to the AWAITING_CANCELLATION status until the process is effectively completed with the CANCELLED status.


When to use this endpoint

This endpoint is useful in scenarios such as:

  • canceling a dunning request submitted by mistake
  • operational rollback before the process is completed
  • interrupting the flow due to agreement, payment, or administrative decision
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