simulate debtor [sandbox]

post

https://api.sandbox.zeptopayments.com/payto/agreements/{agreement_uid}/simulate_debtor_action

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

Path Params

agreement_uid

string

required

A supplied unique ID

Body Params

debtor_action

string

enum

required

The debtor action to be triggered for simulation

Allowed:

reason

string

enum

required

Reason for the agreement being cancelled

narrative

string | null

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

Headers

Zepto-API-Version

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

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request