--- title: Amend Payment Schedule Status slug: api/amend-payment-schedule-status docTags: createdAt: 2025-05-02T04:49:46.118Z --- { "id": "wGYXbOansjFY4pPOnAYDA", "type": "api-oas-v2", "data": { "method": "PATCH", "url": "https://sand-api.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}/status", "servers": [ { "url": "https://sand-api.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}/status", "description": "Sandbox URL" }, { "url": "https://api.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}/status", "description": "Production URL" } ], "name": "Amend Payment Schedule Status", "description": "Amend an existing payment schedule status.", "contentType": "application/json-patch+json", "request": { "pathParameters": [ { "kind": "required", "name": "scheduleId", "type": "string", "description": "Id to uniquely Identify a payment schedule." } ], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "customType": "AmendPaymentScheduleStatusDtoIn", "schema": [ { "name": "status", "kind": "required", "type": "string", "description": "Status to which the schedule will be changed.", "example": "" }, { "name": "statusReasonDescription", "kind": "optional", "type": "string", "description": "Reason for the status change.", "example": "" } ], "modelRef": "#/components/schemas/AmendPaymentScheduleStatusDtoIn", "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": "AmendPaymentScheduleStatusResponse", "schema": [ { "name": "traceId", "kind": "optional", "type": "string", "description": "Unique id for logging", "example": "" }, { "name": "scheduleId", "kind": "optional", "type": "string", "description": "Id to uniquely Identify a payment agreement.", "example": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "Status of the schedule.", "example": "" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Description of the status.", "example": "" }, { "name": "statusReasonCode", "kind": "optional", "type": "string", "description": "ReasonCode for the status.", "example": "" }, { "name": "statusReasonDescription", "kind": "optional", "type": "string", "description": "Description of the reasonCode", "example": "" } ], "modelRef": "#/components/schemas/AmendPaymentScheduleStatusResponse", "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": "503", "description": "Service Unavailable", "jsonExample": "", "isExpanded": true }, { "statusCode": "504", "description": "Gateway Timeout", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "lv3xIF-_BfYt5uKY_gzax", "language": "curl", "label": "cURL", "code": "curl --request PATCH \\\n --url https://sand-api.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}/status \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json-patch+json' \\\n --data '{\n \"status\": \"\"\n }'" }, { "id": "52VBXs0MpmuKSD1xEyS7-", "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/PaymentSchedule/{scheduleId}/status\", Method.Patch);\nrequest.AddHeader(\"accept\", \"application/json\");\nrequest.AddHeader(\"content-type\", \"application/json-patch+json\");\nvar body = @\"{\" + \"\\n\" +\n@\" \"\"status\"\": \"\"\"\"\" + \"\\n\" +\n@\"}\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" }, { "id": "65iDUGa5g8fFfsaN2PDnh", "language": "javascript", "label": "JavaScript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json-patch+json\");\n\nvar raw = JSON.stringify({\n \"status\": \"\"\n});\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://sand-api.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}/status\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "yYqwbLZzaD5WHiXm5bT4v", "language": "php", "label": "PHP", "code": " 'https://sand-api.monoova.com/au/payto/pam-v1/PaymentSchedule/{scheduleId}/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_POSTFIELDS =>'{\n \"status\": \"\"\n}',\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": "lv3xIF-_BfYt5uKY_gzax" }, "results": { "languages": [ { "id": "GKxExvQQOClf1OIiS4YKr", "language": "200", "code": "// OK\n{\n \"traceId\": \"\",\n \"scheduleId\": \"\",\n \"status\": \"\",\n \"statusDescription\": \"\",\n \"statusReasonCode\": \"\",\n \"statusReasonDescription\": \"\"\n}" }, { "id": "br8xL_GnWGMBABtdGvBcZ", "language": "400", "code": "// Bad Request\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}" }, { "id": "t29BsuRdfgCpCREU_IKZ_", "language": "403", "code": "// Forbidden\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}" }, { "id": "RBt-S05EGa1lDN4BA_Ax5", "language": "404", "code": "// Not Found\n{\n \"traceId\": \"\",\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}" }, { "id": "iuWOivlpv9nrg51gQYksp", "language": "500", "code": "// Internal Server Error\n" }, { "id": "CUFr4XZm_hD4gqBm37jdr", "language": "502", "code": "// Bad Gateway\n" }, { "id": "BMX6SQYC9YzoibMlK0shU", "language": "503", "code": "// Service Unavailable\n" }, { "id": "vOdNuUs5CX3z-r4yR_zSX", "language": "504", "code": "// Gateway Timeout\n" } ], "selectedLanguageId": "GKxExvQQOClf1OIiS4YKr" } }, "children": [ { "id": "kFRxQb1LVQZ4aHfMvy6AK", "type": "paragraph", "children": [ { "text": "Amend an existing payment schedule status." } ] } ] }