---
title: Unilateral Amendment
slug: api/unilateral-amendment
docTags:
createdAt: 2025-01-12T22:58:42.121Z
---
{
"id": "uciR0rjq15SGULBzhLuJN",
"type": "api-oas-v2",
"data": {
"method": "PATCH",
"url": "https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}/unilateral",
"servers": [
{
"url": "https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}/unilateral",
"description": "Sandbox URL"
},
{
"url": "https://api.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}/unilateral",
"description": "Production URL"
}
],
"name": "Unilateral Amendment",
"description": "Unilateral changes to a payment agreement can be done without the payer’s approval. The only fields that can be changed unilaterally are the payee object and agreement descriptions.
",
"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": "AmendUnilateralDetailsDto",
"schema": [
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "Reason for the mandate setup as narrative text.\n\nEither \"description\" or \"short_description\" must exist on the agreement.\n\nset to \"-\" to remove.",
"example": ""
},
{
"name": "shortDescription",
"kind": "optional",
"type": "string",
"description": "Reason for the mandate setup as narrative text.\n\nEither \"description\" or \"short_description\" must exist on the agreement.\n\nset to \"-\" to remove.",
"example": ""
},
{
"name": "payeeDetails",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/PayeeDetailsDto",
"customType": "PayeeDetailsDto",
"schema": [
{
"name": "payeeType",
"kind": "optional",
"type": "string",
"description": "ype of payee; Organisation or Individual.",
"example": ""
},
{
"name": "payeeLinkedBsb",
"kind": "optional",
"type": "string",
"description": "BSB number.\n\nFor Create, required if 'payeeLinkedPayId' and 'payeeLinkedPayIdType' are not provided.\n\nProhibited if payeeLinkedPayId is provided.",
"example": ""
},
{
"name": "payeeLinkedAccount",
"kind": "optional",
"type": "string",
"description": "Bank Account Number.\n\nRequired if 'payeeLinkedPayId' and 'payeeLinkedPayIdType' are not provided.\n\nProhibited if payeeLinkedPayId is provided.\n\nMust not be all zeros or spaces.",
"example": ""
},
{
"name": "payeeLinkedPayId",
"kind": "optional",
"type": "string",
"description": "PayID.\n\nEmail, phone number, ABN, ACN or Organisation name.\n\nRequired if 'payeeLinkedBsb' and 'payeeLinkedAccount' are not provided.\n\nProhibited if payeeLinkedAccount is provided.\n\nRequired format depends on the payeeLinkedPayIdType",
"example": ""
},
{
"name": "payeeLinkedPayIdType",
"kind": "optional",
"type": "string",
"description": "PayID Type.\n\nRequired if 'payeeLinkedBsb' and 'payeeLinkedAccount' are not provided.\n\nProhibited if payeeLinkedAccount is provided.",
"example": ""
},
{
"name": "payeeAccountName",
"kind": "optional",
"type": "string",
"description": "Bank Account Name\n\nCan only provide payeeAccountName in the payload if crediting an external BSB. Mandatory if crediting a PayID.\n\nAllowed external payeeAccountNames may also be white-listed in the Account configuration.",
"example": ""
},
{
"name": "ultimatePayee",
"kind": "optional",
"type": "string",
"description": "Name by which the ultimate party is known, and which is usually used to identify that party.\n\nCan only provide ultimatePayee in the payload if crediting an external BSB.\n\nAllowed external ultimatePayee names may also be white-listed in the Account configuration.",
"example": ""
}
]
}
],
"modelRef": "#/components/schemas/AmendUnilateralDetailsDto",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "BearerAuth",
"name": "BearerAuth",
"kind": "optional",
"type": "http",
"scheme": "bearer"
}
]
},
"responses": [
{
"statusCode": "200",
"description": "OK",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "AmendUnilateralDetailsResponse",
"schema": [
{
"name": "traceId",
"kind": "optional",
"type": "string",
"description": "Unique id for logging",
"example": ""
},
{
"name": "paymentAgreementUID",
"kind": "optional",
"type": "string",
"description": "Id to uniquely Identify a payment agreement to the client.",
"example": ""
},
{
"name": "mmsId",
"kind": "optional",
"type": "string",
"description": "This is the unique ID that identifies this payment agreement to NPP.",
"example": ""
},
{
"name": "actionIdentification",
"kind": "optional",
"type": "string",
"description": "Unique identification of the Amend action.",
"example": ""
}
],
"modelRef": "#/components/schemas/AmendUnilateralDetailsResponse",
"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": "403",
"description": "Forbidden",
"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
},
{
"statusCode": "504",
"description": "Gateway Timeout",
"jsonExample": "",
"isExpanded": true
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "OspeyFlo5CzYz54nhBU-P",
"language": "curl",
"label": "cURL",
"code": "curl --request PATCH \\\n --url https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}/unilateral \\\n --header 'accept: application/json'"
},
{
"id": "cTweKEtdsZ5LtjgNE3087",
"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/PaymentAgreement/{paymentAgreementUID}/unilateral\", 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": "b24O3EmBYInOB4eOXgQ0O",
"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/PaymentAgreement/{paymentAgreementUID}/unilateral\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "odv5JEey8otcTSdJlagje",
"language": "php",
"label": "PHP",
"code": " 'https://sand-api.monoova.com/au/payto/pam-v1/PaymentAgreement/{paymentAgreementUID}/unilateral',\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": "OspeyFlo5CzYz54nhBU-P"
},
"results": {
"languages": [
{
"id": "UR0RNW_RGl8uAGfbZo8dk",
"language": "200",
"code": "// OK\n{\n \"traceId\": \"\",\n \"paymentAgreementUID\": \"\",\n \"mmsId\": \"\",\n \"actionIdentification\": \"\"\n}"
},
{
"id": "D64RObL0JYmW7jm45AlMv",
"language": "400",
"code": "// Bad Request\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}"
},
{
"id": "dsrWA0iSCjge0FnvloQ5Q",
"language": "403",
"code": "// Forbidden\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}"
},
{
"id": "nMsbahvHr8F42JKJVhSb5",
"language": "404",
"code": "// Not Found\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}"
},
{
"id": "km-k0a5jXweK9apG3dSJJ",
"language": "500",
"code": "// Internal Server Error\n"
},
{
"id": "QokRv3K_auzxe5zl4Lnp9",
"language": "502",
"code": "// Bad Gateway\n"
},
{
"id": "4KgkMDexKd43Ku6hCyDv8",
"language": "504",
"code": "// Gateway Timeout\n"
}
],
"selectedLanguageId": "UR0RNW_RGl8uAGfbZo8dk"
}
},
"children": [
{
"id": "bwMzA0Acr3Nls8g6b1QPb",
"type": "paragraph",
"children": [
{
"text": "Unilateral changes to a payment agreement can be done without the payer’s approval. The only fields that can be changed unilaterally are the payee object and agreement descriptions."
}
]
}
]
}