patch https://au-0000.api.assemblypay.com/payto/agreements//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.