Sign in

v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
PayTo Agreements

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.

patch/agreements/{agreement_uuid}/status

Path parameters

agreement_uuidstring required
Example:d0c40d95-95b7-449b-9835-3c97c0386585

Request body

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_descriptionstring

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

Amendment reason description

Example request

{
  "status": "SUSPENDED",
  "reason_description": "Reason description"
}

Response

Accepted

agreement_uuidstring

Unique agreement identifier.

agreement_idstring

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_atstring

creation date.

updated_atstring

modification date.

Example response

{
  "agreement_uuid": "ae07556e-22ef-11eb-adc1-0242ac12000",
  "agreement_id": "ef0fcd9799431ef783204966f010603c",
  "status": "ACTIVE",
  "created_at": "2022-03-21 16:25:00.190831",
  "updated_at": "2022-03-22 16:25:00.190831"
}