---
title: "Amend PayTo Agreement Status"
method: PATCH
path: "/agreements/{agreement_uuid}/status"
tags: ["PayTo Agreements"]
---

# Amend PayTo Agreement Status

`PATCH /agreements/{agreement_uuid}/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.

## Path parameters

- `agreement_uuid` string, required

## Request body

- AmendAgreementStatusRequest — Request to change the status of an agreement. **Property descriptions**: - status - Expected status of the agreement post amendment. - reason_code - Reason for status amendment. - reason_description - Amendment reason description. **The following rules apply to this structure**: - ReasonCodeRule: reason_code is mandatory if agreement needs to be 'CANCELLED' or 'SUSPENDED'.
  - `status` 'CANCELLED' | 'SUSPENDED' | 'ACTIVE', required — <p>Identifies the agreement status.</p> <table><tr><td>Code</td><td>Description</td></tr><tr><td>CANCELLED</td><td>Cancel the agreement</td></tr><tr><td>SUSPENDED</td><td>Suspend the agreement</td></tr><tr><td>ACTIVE</td><td>Activate the agreement</td></tr></table><p>Expected status of the agreement post amendment.</p>
  - `reason_code` 'REQCUST' | 'REQINTPRTY' — <p>Reason for status amendment. Supported values:</p> <table><tr><td>Code</td><td>Description</td></tr><tr><td>REQCUST</td><td>Requested by Debtor</td></tr><tr><td>REQINTPRTY</td><td>Requested by Initiating Party</td></tr></table>
  - `reason_description` string — Specifies a character string with a maximum length of 256 characters. Amendment reason description

## Response `202`

Accepted

- AmendAgreementStatusResponse — Specific characteristics of an agreement status amendment response.
  - `agreement_uuid` string — Unique agreement identifier.
  - `agreement_id` string — Unique agreement identifier generated by NPPA.
  - `status` 'CANCELLED' | 'SUSPENDED' | 'ACTIVE' — <p>Current status of the agreement before amendment.</p> <table><tr><td>Code</td><td>Description</td></tr><tr><td>SUSPENDED</td><td>The agreement is suspended.</td></tr><tr><td>ACTIVE</td><td>The agreement is active.</td></tr></table>
  - `created_at` string — creation date.
  - `updated_at` string — modification date.

## Other responses

- `400` — Bad Request <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></r><tr><td>PAYT-ERR-1050</td><td>Mandatory info missing: [FieldName] cannot be null or empty.</td></tr><tr><td>PAYT-ERR-1051</td><td>Invalid Data: [FieldName] provided is invalid.</td></tr><tr><td>PAYT-ERR-1052</td><td>Invalid Data: [FieldName] provided should contain any of the values [Acceptable values].</td></tr><tr><td>PAYT-ERR-1054</td><td>Invalid Data: [FieldName] length is invalid. Expected minimum [MinLength] and maximum [MaxLength].</td></tr><tr><td>PAYT-ERR-1057</td><td>Unrecognized Field: [FieldName] is not a valid field.</td></tr><tr><td>PAYT-ERR-1058</td><td>Invalid Request: request provided is not well-formatted.</td></tr><tr><td>PAYT-ERR-2202</td><td>Amendment request rejected: Invalid status change requested.</td></tr><tr><td>PAYT-ERR-2203</td><td>Reason code is mandatory while suspending or cancelling an agreement.</td></tr></table>
- `401` — Unauthorised <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1000</td><td>Invalid or missing authorisation token.</td></tr></table>
- `403` — Forbidden <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1001</td><td>PayTo feature not available.</td></tr><tr><td>PAYT-ERR-1002</td><td>Request rejected: User associated with the agreement is not active.</td></tr><tr><td>PAYT-ERR-2204</td><td>Agreement can be resumed only by the same party who suspended it.</td></tr></table>
- `404` — Not Found <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2200</td><td>Agreement with provided uuid does not exist.</td></tr></table>
- `409` — Conflict <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2201</td><td>A status amendment for this agreement is already in progress. Please try again later.</td></tr></table>
- `500` — Internal Server Error <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-1003</td><td>An error occurred processing your request. Please try again.</td></tr></table>

---

[API](https://skmtc.net/hellozai/apis/assembly-api.md) · [All operations](https://skmtc.net/hellozai/apis/assembly-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hellozai/assembly-api/revisions/60b528b2e015/schema)