API Reference
  1. Ophelos API
  2. Debt Management

Stop debt processing as process exhausted

post
https://api.ophelos.dev/debts//process_exhausted

Closes a debt from Ophelos, for process exhausted.
If the debt is already closed with a final closure code (for example PIF after being paid in full, or RTC after being withdrawn), this operation is a no-op: the existing closure code is preserved and the debt is returned in its current state. Trigger resume first if the debt needs to be reworked.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the debt

Body Params

Optional parameters for process exhausted closure

string

Additional info about the closure

boolean

When set to true, validates that the appropriate configuration is enabled before closing the debt. If the debt has an active payment plan, requires auto_return_with_payment_plan config to be true. If the debt has an active pay later plan, requires auto_return_with_pay_later config to be true. Returns 422 error if validation fails.

Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 2 months ago

Did this page help you?