---
title: Amend Payment Agreement Status Async
slug: api/amend-payment-agreement-status-async
docTags:
createdAt: 2025-01-12T22:58:42.121Z
---
{
"id": "NYIpx61x_njXes4Ejb61G",
"type": "api-oas-v2",
"data": {
"method": "PATCH",
"url": "https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/status",
"servers": [
{
"url": "https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/status",
"description": "Sandbox URL"
},
{
"url": "https://api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/status",
"description": "Production URL"
}
],
"name": "Amend Payment Agreement Status Async",
"description": "This endpoint allows the initiator to change the status of a payment agreement. Available statuses are active, pause or cancel.
\nThe API returns as soon as the amend request has been captured and validated for background processing.
",
"contentType": "application/json-patch+json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "paymentAgreementUID",
"type": "string",
"description": "Id to uniquely Identify a payment agreement."
}
],
"headerParameters": [],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "optional",
"name": "body",
"type": "object",
"description": "",
"customType": "AmendPaymentAgreementStatusDto",
"schema": [
{
"name": "statusChange",
"kind": "optional",
"type": "string",
"example": ""
},
{
"name": "reasonCode",
"kind": "optional",
"type": "string",
"example": ""
},
{
"name": "reasonDescription",
"kind": "optional",
"type": "string",
"example": ""
}
],
"modelRef": "#/components/schemas/AmendPaymentAgreementStatusDto",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "BearerAuth",
"name": "BearerAuth",
"kind": "optional",
"type": "http",
"scheme": "bearer"
}
]
},
"responses": [
{
"statusCode": "202",
"description": "Accepted",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "AsyncResponse",
"schema": [
{
"name": "traceId",
"kind": "optional",
"type": "string",
"description": "Unique id for logging",
"example": ""
},
{
"name": "uniqueRequestId",
"kind": "optional",
"type": "string",
"description": "Server generated unique request identifier.",
"example": ""
}
],
"modelRef": "#/components/schemas/AsyncResponse",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "Bad Request",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "traceId",
"kind": "optional",
"type": "string",
"description": "Unique id for logging",
"example": ""
},
{
"name": "errors",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/ErrorDto",
"customType": "ErrorDto[]",
"schema": [
{
"name": "errorCode",
"kind": "optional",
"type": "string",
"description": "Monoova error code",
"example": ""
},
{
"name": "errorMessage",
"kind": "optional",
"type": "string",
"description": "More detailed description of the specific error which may include information from the specific request.",
"example": ""
}
]
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "404",
"description": "Not Found",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "ErrorResponse",
"schema": [
{
"name": "traceId",
"kind": "optional",
"type": "string",
"description": "Unique id for logging",
"example": ""
},
{
"name": "errors",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/ErrorDto",
"customType": "ErrorDto[]",
"schema": [
{
"name": "errorCode",
"kind": "optional",
"type": "string",
"description": "Monoova error code",
"example": ""
},
{
"name": "errorMessage",
"kind": "optional",
"type": "string",
"description": "More detailed description of the specific error which may include information from the specific request.",
"example": ""
}
]
}
],
"modelRef": "#/components/schemas/ErrorResponse",
"isExpanded": true
}
]
},
{
"statusCode": "500",
"description": "Internal Server Error",
"jsonExample": "",
"isExpanded": true
},
{
"statusCode": "502",
"description": "Bad Gateway",
"jsonExample": "",
"isExpanded": true
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "gAh_JONGNv_Q_jV-lEJuQ",
"language": "curl",
"label": "cURL",
"code": "curl --request PATCH \\\n --url https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/status \\\n --header 'accept: application/json'"
},
{
"id": "jtfWXunYIwvapcq8_MzqS",
"language": "csharp",
"label": "C#",
"code": "var options = new RestClientOptions(\"https://sand-api.monoova.com\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/status\", Method.Patch);\nrequest.AddHeader(\"accept\", \"application/json\");\nrequest.AddHeader(\"content-type\", \"application/json-patch+json\");\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);"
},
{
"id": "nekJQDDQD2vLTgcp3PX0z",
"language": "javascript",
"label": "JavaScript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json-patch+json\");\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/status\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "vd7bdpLKYBvGYglhyGGMk",
"language": "php",
"label": "PHP",
"code": " 'https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreementAsync/{paymentAgreementUID}/status',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'PATCH',\n CURLOPT_HTTPHEADER => array(\n 'accept: application/json',\n 'content-type: application/json-patch+json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
}
],
"selectedLanguageId": "gAh_JONGNv_Q_jV-lEJuQ"
},
"results": {
"languages": [
{
"id": "PVKZ-evFJu5sTpSHdRvh7",
"language": "202",
"code": "// Accepted\n{\n \"traceId\": \"\",\n \"uniqueRequestId\": \"\"\n}"
},
{
"id": "xzdM5tErxSNblz9DmipGw",
"language": "400",
"code": "// Bad Request\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}"
},
{
"id": "9rnyy7M9lqOOtqzKnFoWv",
"language": "404",
"code": "// Not Found\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}"
},
{
"id": "Oalww7C-Hu4PhCbZjQ5MC",
"language": "500",
"code": "// Internal Server Error\n"
},
{
"id": "NhfkH443AVD34kNkFnmsq",
"language": "502",
"code": "// Bad Gateway\n"
}
],
"selectedLanguageId": "PVKZ-evFJu5sTpSHdRvh7"
}
},
"children": [
{
"id": "0d5rALCzmEw32K_Qr6dvf",
"type": "paragraph",
"children": [
{
"text": "This endpoint allows the initiator to change the status of a payment agreement. Available statuses are active, pause or cancel."
}
]
},
{
"id": "DPE8kzd3mnfUn_99MZnYI",
"type": "paragraph",
"children": [
{
"text": "The API returns as soon as the amend request has been captured and validated for background processing."
}
]
}
]
}