This endpoint allows you to remove an existing installment plan when it still meets the necessary rules for deletion.
Removal can be used when an installment plan was created by mistake or when it should no longer remain available for payment before its settlement has started.
When to useUse this endpoint only when there is a need to permanently cancel an installment plan that has not yet entered a flow that prevents its removal.
Before performing the deletion, validate whether the installment plan meets the eligibility rules described below.
Rules for removal
Removal is only allowed for installment plans that:
- have charges with status awaiting payment or overdue;
- do not have an anticipation process in progress;
- do not have an associated negative credit reporting process.
If any of these conditions are not met, the request will be refused.
ImportantEligibility for removal is determined by the current state of the installment plan at the time of the request.
Parameter used
This endpoint receives the unique identifier (id) of the installment plan that will be removed.
Make sure to use the correct identifier, as the operation is applied directly to the informed installment plan.
How removal works
When removal is successfully completed, the installment plan ceases to exist and can no longer be used in API operations or consulted as an active installment plan.
This operation is definitive and there is no endpoint to restore a removed installment plan.
Best practices
Before requesting removal, it is recommended to:
- consult the installment plan to confirm its current state;
- check that there is no linked anticipation process;
- check that there is no negative credit reporting process in progress;
- confirm that deletion is really necessary, since the operation is irreversible.
These validations help avoid refused attempts and improper deletions.
Scenario example
A common scenario is the creation of an incorrect installment plan by an integration, before any related operational process has started.
In this situation, the application can remove the installment plan and, if necessary, create a new one with the correct information.
Operational impact
Removing the installment plan may impact internal application processes that store references to this resource.
After deletion, it is recommended to update the installment plan status in the source system to avoid consultation or operation attempts on a resource that no longer exists.
Since the operation is definitive, it should be used with caution in production environments.
Related content
If your integration uses other resources related to the installment plan lifecycle, also see:
- Installment plan consultation;
- Installment plan creation;
- Receivables anticipation;
- Negative credit reporting of charges.
Not found