--- title: Update a PayID's Name slug: api/update-a-payids-name docTags: createdAt: 2026-09-15T03:50:53.144Z --- { "id": "8eSWyittFJgNTe0YnroVh", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.mpay.com.au/receivables/v1/payid/updatePayIdName", "servers": [ { "url": "https://api.mpay.com.au/receivables/v1/payid/updatePayIdName", "description": "Production URL" }, { "url": "https://api.m-pay.com.au/receivables/v1/payid/updatePayIdName", "description": "Sandbox URL" } ], "name": "Update a PayID's Name", "description": "Use this endpoint to change the name of a PayID.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "Request body used to change the name of an existing PayID.", "customType": "PayIdUpdateNameBody_V1", "schema": [ { "name": "payId", "kind": "required", "type": "string", "description": "Email address for the PayID whose name is being updated.", "example": "jane.doe@monoova.me", "default": "jane.doe@monoova.me", "pattern": "^[A-Za-z0-9._%+-]{1,64}@[A-Za-z0-9-]{1,63}(\\.[A-Za-z0-9-]{1,63})+$" }, { "name": "payIdName", "kind": "required", "type": "string", "description": "New name displayed to the payers in order to identify you. This replaces the name currently held against the PayID.", "example": "Jane Doe Holdings Pty Ltd", "default": "Jane Doe Holdings Pty Ltd", "pattern": "^[A-Za-z0-9 &.,'\\-]{1,140}$" }, { "name": "bankAccountNumber", "kind": "required", "type": "string", "description": "

The bank account number for the account against which the PayID was registered. Digits only — do not include spaces or separators.

", "example": "410000123", "default": "410000123", "pattern": "^[0-9]{6,10}$" }, { "name": "bsb", "kind": "optional", "type": "string", "description": "

Optional. BSB parameter. If not specified, the service will use the MAccount's configured Default BSB. If a Default BSB has not been configured, then the Monoova Default BSB will be used.

", "example": "123-456", "default": "123-456", "pattern": "^[0-9]{3}-?[0-9]{3}$" } ], "modelRef": "#/components/schemas/PayIdUpdateNameBody_V1", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "basicAuth", "name": "basicAuth", "kind": "optional", "type": "http", "description": "

To authenticate using basic authentication, generate an API key and pass it as the username. No password is required.

", "scheme": "basic" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful validation. The PayID name was updated.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Response returned by the Update a PayID's Name endpoint.", "customType": "PayIdUpdateNameResponse_V1", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request.", "example": 88, "default": 88, "format": "int32", "pattern": "^[0-9]{1,9}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "This is the status of the request. A code of 'Ok' indicates no errors.", "example": "Ok", "default": "Ok", "pattern": "^[A-Za-z]{2,50}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

This is a description of the status. If an 'Ok' status is returned, then this will be 'Operation completed successfully'.

", "example": "Operation completed successfully", "default": "Operation completed successfully", "pattern": "^.{1,500}$" } ], "modelRef": "#/components/schemas/PayIdUpdateNameResponse_V1", "isExpanded": true } ] }, { "statusCode": "400", "description": "

Bad Request — the request could not be processed because one or more fields failed validation, or the PayID or account details supplied are not valid.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":18,\"status\":\"Fail\",\"statusDescription\":\"Request validation failed. bankAccountNumber is required and must contain digits only.\"}", "description": "

Standard error payload returned for 400, 401 and 500 responses.

", "customType": "ErrorResponse", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request before the error was returned.", "example": 18, "default": 18, "format": "int32", "pattern": "^[0-9]{1,9}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "This is the status of the request. Any value other than 'Ok' indicates the request was not processed successfully.", "example": "Fail", "default": "Fail", "pattern": "^[A-Za-z]{2,50}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

This is a description of the status, explaining why the request was rejected or could not be completed.

", "example": "Request validation failed. bankAccountNumber is required and must contain digits only.", "default": "Request validation failed. bankAccountNumber is required and must contain digits only.", "pattern": "^.{1,500}$" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "

Unauthorized — the API key supplied in the basic authentication header is missing, invalid, or not permitted to access this resource.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":5,\"status\":\"Unauthorized\",\"statusDescription\":\"Authentication failed. Supply a valid API key as the basic authentication username.\"}", "description": "

Standard error payload returned for 400, 401 and 500 responses.

", "customType": "ErrorResponse", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request before the error was returned.", "example": 18, "default": 18, "format": "int32", "pattern": "^[0-9]{1,9}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "This is the status of the request. Any value other than 'Ok' indicates the request was not processed successfully.", "example": "Fail", "default": "Fail", "pattern": "^[A-Za-z]{2,50}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

This is a description of the status, explaining why the request was rejected or could not be completed.

", "example": "Request validation failed. bankAccountNumber is required and must contain digits only.", "default": "Request validation failed. bankAccountNumber is required and must contain digits only.", "pattern": "^.{1,500}$" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "500", "description": "

Internal Server Error — an unexpected error occurred while processing the request. Retry the request; if the error persists, contact Monoova support and quote the statusDescription.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":3021,\"status\":\"Error\",\"statusDescription\":\"An unexpected error occurred while processing the request. Please try again later.\"}", "description": "

Standard error payload returned for 400, 401 and 500 responses.

", "customType": "ErrorResponse", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request before the error was returned.", "example": 18, "default": 18, "format": "int32", "pattern": "^[0-9]{1,9}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "This is the status of the request. Any value other than 'Ok' indicates the request was not processed successfully.", "example": "Fail", "default": "Fail", "pattern": "^[A-Za-z]{2,50}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

This is a description of the status, explaining why the request was rejected or could not be completed.

", "example": "Request validation failed. bankAccountNumber is required and must contain digits only.", "default": "Request validation failed. bankAccountNumber is required and must contain digits only.", "pattern": "^.{1,500}$" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "gI5QUIvfX4XH9JQv5fh00", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.mpay.com.au/receivables/v1/payid/updatePayIdName \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data-raw '{\n \"payId\": \"jane.doe@monoova.me\",\n \"payIdName\": \"Jane Doe Holdings Pty Ltd\",\n \"bankAccountNumber\": \"410000123\",\n \"bsb\": \"123-456\"\n }'" }, { "id": "7N_OL78udmC6nVTx6iP49", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"payId\": \"jane.doe@monoova.me\",\n \"payIdName\": \"Jane Doe Holdings Pty Ltd\",\n \"bankAccountNumber\": \"410000123\",\n \"bsb\": \"123-456\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.mpay.com.au/receivables/v1/payid/updatePayIdName\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "-XIWRwwH-XK8BzRyLxUnp", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/receivables/v1/payid/updatePayIdName\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"payId\": \"jane.doe@monoova.me\",\n \"payIdName\": \"Jane Doe Holdings Pty Ltd\",\n \"bankAccountNumber\": \"410000123\",\n \"bsb\": \"123-456\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "yhEeHAGCuuyIF-UL-97KW", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/receivables/v1/payid/updatePayIdName\"\n\npayload = json.dumps({\n \"payId\": \"jane.doe@monoova.me\",\n \"payIdName\": \"Jane Doe Holdings Pty Ltd\",\n \"bankAccountNumber\": \"410000123\",\n \"bsb\": \"123-456\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "gI5QUIvfX4XH9JQv5fh00" }, "results": { "languages": [ { "id": "73kwFxeu5VV3BJekQSUAk", "language": "200", "code": "// Successful validation. The PayID name was updated.\n{\n \"durationMs\": 88,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "vbP2__OOgXkEu9k95g-Su", "language": "400", "code": "// Bad Request — the request could not be processed because one or more fields failed validation, or the PayID or account details supplied are not valid.\n{\n \"durationMs\": 18,\n \"status\": \"Fail\",\n \"statusDescription\": \"Request validation failed. bankAccountNumber is required and must contain digits only.\"\n}" }, { "id": "PTMICzJuTYO8t0kmCgCnJ", "language": "401", "code": "// Unauthorized — the API key supplied in the basic authentication header is missing, invalid, or not permitted to access this resource.\n{\n \"durationMs\": 18,\n \"status\": \"Fail\",\n \"statusDescription\": \"Request validation failed. bankAccountNumber is required and must contain digits only.\"\n}" }, { "id": "OU0F6p36ChPlRdDljuvhG", "language": "500", "code": "// Internal Server Error — an unexpected error occurred while processing the request. Retry the request; if the error persists, contact Monoova support and quote the statusDescription.\n{\n \"durationMs\": 18,\n \"status\": \"Fail\",\n \"statusDescription\": \"Request validation failed. bankAccountNumber is required and must contain digits only.\"\n}" } ], "selectedLanguageId": "73kwFxeu5VV3BJekQSUAk" } }, "children": [ { "text": "" } ] }