simulate debtor [sandbox]

SANDBOX ONLY Enables simulation of actions debtor party can trigger for an agreement: amendment, cancellation, suspension & reactivation

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

A supplied unique ID

Body Params
string
enum
required

The debtor action to be triggered for simulation

Allowed:
string
enum
required

Reason for the agreement being cancelled

string | null

Free text field to store a description to accompany the given reason

Headers
string
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses
202

accepted

403

forbidden

404

Not Found

500

Internal Server Error

Callbacks
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json