cancel agreement

post

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

Path Params

agreement_uid

string

required

A supplied unique ID

Body Params

reason

string

enum

required

Reason for the agreement being cancelled

Allowed:

narrative

string | null

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

sandbox

object

SANDBOX ONLY: Parameter that allows you to simulate the certain scenarios related to the cancellation of an agreement to aid integrators while testing their control flows.

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

401unauthorized

422Unprocessable Entity