---
title: "Recall PayTo Agreement"
method: PATCH
path: "/agreements/{agreement_uuid}/recall"
tags: ["PayTo Agreements"]
---

# Recall PayTo Agreement

`PATCH /agreements/{agreement_uuid}/recall`

This operation is to recall a pending agreement creation/bilateral amendment authorisation request before it is approved by debtor. By default, all debtor authorization requests expire after 5 days post creation. If a custom expiry duration (anything less than 5 days) has been specified in the request via “response_requested_by” field, then this Recall API should be invoke to expire the authorisation request post the custom duration has elapsed.

 Example - For a use-case, if the debtor should approve/reject the agreement within 15 mins post creation, and if the debtor does not respond within 15 mins, this API should be invoked to recall the agreement creation action post 15 mins.

Recall Agreement Creation - If a custom expiry duration is specified during agreement validation step, this API should be used to recall the pending agreement creation authorisation request.
- Allows recalling agreement authorisation request only for AUPM agreement type.
- After the recall operation is successful, the current agreement would be considered as CANCELLED and a new agreement should be created to seek the debtor’s approval again.

Recall Bilateral Amendment Request - If a custom expiry duration is specified during bilateral agreement amendment, this API should be used to recall the pending amendment authorisation request.
- Allows recalling amendment authorisation requests for both AUPM and MGCR agreement types.
- After the recall operation is successful, the bilateral amendments are discarded and the agreement is not updated. If the changes are still needed, a new amendment request should be created to seek the debtor’s approval again.

## Path parameters

- `agreement_uuid` string, required

## Response `202`

Accepted

- RecallAgreementActionResponse
  - `message` string

## Other responses

- `400` — Bad Request <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2502</td><td>Recall request rejected: Recall action is applicable only for agreements in CREATED/ACTIVE/SUSPENDED statuses.</td></tr><tr><td>PAYT-ERR-2503</td><td>Request to recall agreement creation is already in progress. Please try again later.</td></tr><tr><td>PAYT-ERR-2504</td><td>Recall request rejected: Any bilateral amendment is not in progress for the agreement.</td></tr><tr><td>PAYT-ERR-2505</td><td>Recall request rejected: Request to recall bilateral amendment is already in progress for the agreement. Please try again later.<tr><td>PAYT-ERR-2506</td><td>Recall request rejected: Existing bilateral amendment request cannot be recalled at the moment. Please try again later.</td></tr><tr><td>PAYT-ERR-2508</td><td>Invalid format for url param: agreement_uuid.</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></table>
- `404` — Not Found <table><tr><td><b>Error Code</b></td><td><b>Error Message</b></td></tr><tr><td>PAYT-ERR-2500</td><td>Agreement with provided uuid does not exist.</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)