Amend PayTo Agreement Status

Amend Status of a particular agreement via its UUID. Below status amends are possible via this API:

  • ACTIVE -> SUSPENDED
  • ACTIVE -> CANCELLED
  • SUSPENDED -> ACTIVE (only if suspended via Zai)
  • SUSPENDED -> CANCELLED

Only one status amendment is allowed at any given point of time. Example - If a request to suspend the agreement is already in progress, another status change request will not be accepted until the first completes.

Resuming a suspended agreement can only be performed by the party that suspended the agreement.

Hence, moving the agreement from SUSPENDED to ACTIVE will be accepted only if the Suspension was performed via Zai. CANCELLED is final agreement status and hence is irreversible.

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

Identifies the agreement status.

CodeDescription
CANCELLEDCancel the agreement
SUSPENDEDSuspend the agreement
ACTIVEActivate the agreement

Expected status of the agreement post amendment.

Allowed:
string
enum

Reason for status amendment. Supported values:

CodeDescription
REQCUSTRequested by Debtor
REQINTPRTYRequested by Initiating Party
Allowed:
string
length between 1 and 256

Specifies a character string with a maximum length of 256 characters.

Amendment reason description

Responses

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