--- title: Recall a Payment Agreement slug: r10-integration/recall-a-payment-agreement createdAt: 2026-10-29T06:44:31.903Z --- { "id": "HCl5ZUggynqWP2Gm3DsDo", "type": "api-oas-v2", "data": { "method": "PATCH", "url": "https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}/recall/{actionId}", "servers": [ { "url": "https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}/recall/{actionId}", "description": "Beta Sandbox URL" } ], "name": "Recall a Payment Agreement", "description": "This endpoint is used to recall a pending payment agreement before it is approved by the payer.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "paymentAgreementUID", "type": "string", "example": "MONPAG12345", "description": "

ID that uniquely identifies the payment agreement. This is the paymentAgreementUID supplied when the agreement was created.

", "default": "MONPAG12345", "pattern": "^[a-zA-Z0-9_-]{1,35}$" }, { "kind": "required", "name": "actionId", "type": "string", "example": "b9c91b0f382b1fa5bf7e87aaad094eee", "description": "

Unique ID of the pending (unapproved) action to recall. This ID is assigned when a new payment agreement is created or when a bilateral amendment is made, and is returned as actionIdentification.

", "default": "b9c91b0f382b1fa5bf7e87aaad094eee", "pattern": "^[A-Za-z0-9_-]{1,35}$" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "BearerAuth", "name": "BearerAuth", "kind": "optional", "type": "http", "description": "

Bearer token (JWT) used to authenticate PayTo API requests. Generate it with the Monoova security token endpoint (/au/security/oauth-v1/Token) using your mAccount number and API key, then send it in the Authorization: Bearer <token> header. Tokens are valid for 24 hours.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK. The pending action was recalled.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Result of a recall request.", "customType": "MandateManager.Application.Common.Dtos.RecallPaymentAgreementActionResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique ID for logging and tracing this request.", "example": "1dabfaa9-abe8-4d2d-a69a-b723079d84ed", "default": "1dabfaa9-abe8-4d2d-a69a-b723079d84ed", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "name": "paymentAgreementUID", "kind": "optional", "type": "string", "nullable": true, "description": "ID that uniquely identifies the payment agreement to the client.", "example": "MONPAG12345", "default": "MONPAG12345", "pattern": "^[a-zA-Z0-9_-]{1,35}$" }, { "name": "actionIdentification", "kind": "optional", "type": "string", "nullable": true, "description": "Unique identification of the recalled action.", "example": "b9c91b0f382b1fa5bf7e87aaad094eee", "default": "b9c91b0f382b1fa5bf7e87aaad094eee", "pattern": "^[a-f0-9]{32}$" }, { "name": "mmsId", "kind": "optional", "type": "string", "nullable": true, "description": "

Unique ID that identifies this payment agreement to the NPP (MMS ID).

", "example": "a9ba56f64baa1dee9ac2d7f87c2621fa", "default": "a9ba56f64baa1dee9ac2d7f87c2621fa", "pattern": "^[a-f0-9]{32}$" }, { "name": "paymentAgreementStatus", "kind": "optional", "type": "string", "nullable": true, "description": "

Status of the payment agreement. Possible values: InProgress, Created, Active, Paused, Cancelled, Rejected, Expired.

", "example": "Cancelled", "default": "Cancelled", "pattern": "^(InProgress|Created|Active|Paused|Cancelled|Rejected|Expired)$" }, { "name": "paymentAgreementStatusDescription", "kind": "optional", "type": "string", "nullable": true, "description": "More detailed description of the status.", "example": "Mandate action recalled", "default": "Mandate action recalled", "pattern": "^.+$" } ], "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.RecallPaymentAgreementActionResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "

Bad Request. The request failed validation. See errors for details.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_RECALL_INVALID\",\"errorMessage\":\"Action b9c91b0f382b1fa5bf7e87aaad094eee in Payment Agreement MONPAG12345 invalid status - must be pending for recall\"}]}", "description": "Error response returned when a request fails.", "customType": "MandateManager.Application.Common.Dtos.ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique ID for logging and tracing this request.", "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "List of errors that occurred while processing the request.", "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto", "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Monoova error code. See PayTo Status and Error Codes for the meaning of each code.

", "example": "PAM_STARTDATE_EARLY", "default": "PAM_STARTDATE_EARLY", "pattern": "^[A-Z]{3}_[A-Z0-9_]+$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

More detailed description of the error, which may include information from the request.

", "example": "paymentDetails.startDate must be future date", "default": "paymentDetails.startDate must be future date", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "

Unauthorized. The bearer token is missing, invalid or expired. Bearer tokens are valid for 24 hours; generate a new token and retry.

", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden. Your account is not permitted to perform this operation.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_FORBIDDEN_ERROR\",\"errorMessage\":\"Not allowed to recall payment agreement action for account 6279059778044302\"}]}", "description": "Error response returned when a request fails.", "customType": "MandateManager.Application.Common.Dtos.ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique ID for logging and tracing this request.", "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "List of errors that occurred while processing the request.", "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto", "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Monoova error code. See PayTo Status and Error Codes for the meaning of each code.

", "example": "PAM_STARTDATE_EARLY", "default": "PAM_STARTDATE_EARLY", "pattern": "^[A-Z]{3}_[A-Z0-9_]+$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

More detailed description of the error, which may include information from the request.

", "example": "paymentDetails.startDate must be future date", "default": "paymentDetails.startDate must be future date", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "Not Found. The payment agreement or the pending action could not be found.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_ACTION_NOT_FOUND_ERROR\",\"errorMessage\":\"Action b9c91b0f382b1fa5bf7e87aaad094eee not found in Payment Agreement MONPAG12345\"}]}", "description": "Error response returned when a request fails.", "customType": "MandateManager.Application.Common.Dtos.ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique ID for logging and tracing this request.", "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "List of errors that occurred while processing the request.", "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto", "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Monoova error code. See PayTo Status and Error Codes for the meaning of each code.

", "example": "PAM_STARTDATE_EARLY", "default": "PAM_STARTDATE_EARLY", "pattern": "^[A-Z]{3}_[A-Z0-9_]+$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

More detailed description of the error, which may include information from the request.

", "example": "paymentDetails.startDate must be future date", "default": "paymentDetails.startDate must be future date", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal Server Error. An unexpected error occurred. Contact Monoova support if the problem persists.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_UNEXPECTED_ERROR\",\"errorMessage\":\"Internal server error. Please contact Monoova support.\"}]}", "description": "Error response returned when a request fails.", "customType": "MandateManager.Application.Common.Dtos.ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique ID for logging and tracing this request.", "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "List of errors that occurred while processing the request.", "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto", "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Monoova error code. See PayTo Status and Error Codes for the meaning of each code.

", "example": "PAM_STARTDATE_EARLY", "default": "PAM_STARTDATE_EARLY", "pattern": "^[A-Z]{3}_[A-Z0-9_]+$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

More detailed description of the error, which may include information from the request.

", "example": "paymentDetails.startDate must be future date", "default": "paymentDetails.startDate must be future date", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse", "isExpanded": true } ] }, { "statusCode": "502", "description": "

Bad Gateway. An upstream service, such as the NPP gateway, returned an error. Retry the request later.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_NPP_GATEWAY_ERROR\",\"errorMessage\":\"Error returned from NPP gateway - service unavailable\"}]}", "description": "Error response returned when a request fails.", "customType": "MandateManager.Application.Common.Dtos.ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique ID for logging and tracing this request.", "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "List of errors that occurred while processing the request.", "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto", "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Monoova error code. See PayTo Status and Error Codes for the meaning of each code.

", "example": "PAM_STARTDATE_EARLY", "default": "PAM_STARTDATE_EARLY", "pattern": "^[A-Z]{3}_[A-Z0-9_]+$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

More detailed description of the error, which may include information from the request.

", "example": "paymentDetails.startDate must be future date", "default": "paymentDetails.startDate must be future date", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse", "isExpanded": true } ] }, { "statusCode": "504", "description": "

Gateway Timeout. An upstream service, such as the NPP gateway, did not respond in time. Retry the request later.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"traceId\":\"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\"errors\":[{\"errorCode\":\"PAM_NPP_GATEWAY_TIMEOUT\",\"errorMessage\":\"Timeout from NPP gateway\"}]}", "description": "Error response returned when a request fails.", "customType": "MandateManager.Application.Common.Dtos.ErrorResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "nullable": true, "description": "Unique ID for logging and tracing this request.", "example": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "default": "4ea61012-2d9b-413d-a5b4-90ad69a68741", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "List of errors that occurred while processing the request.", "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorDto", "customType": "MandateManager.Application.Common.Dtos.ErrorDto[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "nullable": true, "description": "

Monoova error code. See PayTo Status and Error Codes for the meaning of each code.

", "example": "PAM_STARTDATE_EARLY", "default": "PAM_STARTDATE_EARLY", "pattern": "^[A-Z]{3}_[A-Z0-9_]+$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "nullable": true, "description": "

More detailed description of the error, which may include information from the request.

", "example": "paymentDetails.startDate must be future date", "default": "paymentDetails.startDate must be future date", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/MandateManager.Application.Common.Dtos.ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request PATCH \\\n --url https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}/recall/{actionId} \\\n --header 'accept: application/json'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}/recall/{actionId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}/recall/{actionId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api-beta.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}/recall/{actionId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// OK. The pending action was recalled.\n{\n \"traceId\": \"1dabfaa9-abe8-4d2d-a69a-b723079d84ed\",\n \"paymentAgreementUID\": \"MONPAG12345\",\n \"actionIdentification\": \"b9c91b0f382b1fa5bf7e87aaad094eee\",\n \"mmsId\": \"a9ba56f64baa1dee9ac2d7f87c2621fa\",\n \"paymentAgreementStatus\": \"Cancelled\",\n \"paymentAgreementStatusDescription\": \"Mandate action recalled\"\n}" }, { "id": "response-1-400", "language": "400", "code": "// Bad Request. The request failed validation. See errors for details.\n{\n \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n \"errors\": [\n {\n \"errorCode\": \"PAM_STARTDATE_EARLY\",\n \"errorMessage\": \"paymentDetails.startDate must be future date\"\n }\n ]\n}" }, { "id": "response-2-401", "language": "401", "code": "// Unauthorized. The bearer token is missing, invalid or expired. Bearer tokens are valid for 24 hours; generate a new token and retry.\n" }, { "id": "response-3-403", "language": "403", "code": "// Forbidden. Your account is not permitted to perform this operation.\n{\n \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n \"errors\": [\n {\n \"errorCode\": \"PAM_STARTDATE_EARLY\",\n \"errorMessage\": \"paymentDetails.startDate must be future date\"\n }\n ]\n}" }, { "id": "response-4-404", "language": "404", "code": "// Not Found. The payment agreement or the pending action could not be found.\n{\n \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n \"errors\": [\n {\n \"errorCode\": \"PAM_STARTDATE_EARLY\",\n \"errorMessage\": \"paymentDetails.startDate must be future date\"\n }\n ]\n}" }, { "id": "response-5-500", "language": "500", "code": "// Internal Server Error. An unexpected error occurred. Contact Monoova support if the problem persists.\n{\n \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n \"errors\": [\n {\n \"errorCode\": \"PAM_STARTDATE_EARLY\",\n \"errorMessage\": \"paymentDetails.startDate must be future date\"\n }\n ]\n}" }, { "id": "response-6-502", "language": "502", "code": "// Bad Gateway. An upstream service, such as the NPP gateway, returned an error. Retry the request later.\n{\n \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n \"errors\": [\n {\n \"errorCode\": \"PAM_STARTDATE_EARLY\",\n \"errorMessage\": \"paymentDetails.startDate must be future date\"\n }\n ]\n}" }, { "id": "response-7-504", "language": "504", "code": "// Gateway Timeout. An upstream service, such as the NPP gateway, did not respond in time. Retry the request later.\n{\n \"traceId\": \"4ea61012-2d9b-413d-a5b4-90ad69a68741\",\n \"errors\": [\n {\n \"errorCode\": \"PAM_STARTDATE_EARLY\",\n \"errorMessage\": \"paymentDetails.startDate must be future date\"\n }\n ]\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }