Required. The 16-digit mWallet account number to update.
", "example": "4211110000000019", "default": "4211110000000019", "pattern": "^[0-9]{16}$" }, { "name": "pin", "kind": "required", "type": "string", "description": "Required. The 4-digit numerical pin registered against the mWallet, used to authenticate the update.
", "example": "1234", "default": "1234", "pattern": "^[0-9]{4}$" }, { "name": "name", "kind": "optional", "type": "string", "description": "Optional. The full name of the customer. Supply only when the name is changing.
", "example": "Jane Citizen", "default": "Jane Citizen", "pattern": "^[A-Za-z0-9 '\\-\\.]{1,100}$" }, { "name": "nickName", "kind": "optional", "type": "string", "description": "Optional. A short form name of the customer. Can be empty.
", "example": "Jane", "default": "Jane", "pattern": "^[A-Za-z0-9 '\\-\\.]{0,50}$" }, { "name": "phone", "kind": "optional", "type": "string", "description": "Conditional. The contact phone number, which is not used for authentication. Required in conjunction with the email address, and must start with 0. All non-numeric characters are stripped.
", "example": "0400000000", "default": "0400000000", "pattern": "^0[0-9]{9}$" }, { "name": "Email", "kind": "optional", "type": "string", "description": "Conditional. The contact email, which is not used for authentication. Required in conjunction with the phone number. Limited to 300 characters, must contain @ and follow normal email format conventions, and is converted to lowercase.
", "example": "jane.citizen@example.com", "default": "jane.citizen@example.com", "pattern": "^[A-Za-z0-9._%+\\-]+@[A-Za-z0-9.\\-]+\\.[A-Za-z]{2,}$" }, { "name": "options", "kind": "optional", "type": "array", "description": "Optional. An array of additional key and value options, for example MobileForSms.
", "modelRef": "#/components/schemas/optionItem", "customType": "optionItem[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "description": "Conditional. The unique identifier of the value. Required when an options array entry is supplied. For example MobileForSms.
", "example": "MobileForSms", "default": "MobileForSms", "pattern": "^[A-Za-z0-9_]{1,50}$" }, { "name": "value", "kind": "optional", "type": "string", "description": "Conditional. The actual value represented by the key. Required when an options array entry is supplied.
", "example": "0400000000", "default": "0400000000", "pattern": "^.{1,200}$" } ] }, { "name": "ABN", "kind": "optional", "type": "string", "description": "Optional. The company ABN of the mAccount. All non-numeric characters are stripped.
", "example": "51824753556", "default": "51824753556", "pattern": "^[0-9]{11}$" } ], "modelRef": "#/components/schemas/mWalletUpdate", "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 mWallet was updated.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Response returned when an mWallet is updated.", "customType": "mWalletUpdateResponse_V1", "schema": [ { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Optional. The 16-digit account number of the mWallet that was updated.
", "example": "4211110000000019", "default": "4211110000000019", "pattern": "^[0-9]{16}$" }, { "name": "mWallet", "kind": "optional", "type": "object", "description": "Optional. The full detail of the mWallet after the update was applied.
", "modelRef": "#/components/schemas/mWalletDetails", "customType": "mWalletDetails", "schema": [ { "name": "createdDateTime", "kind": "optional", "type": "string", "description": "Optional. The date that this customer was created, in ISO 8601 date-time format. Note that the timezone is suppressed; the example timezone is Sydney local time.
", "example": "2026-02-11T09:15:00", "default": "2026-02-11T09:15:00", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,7})?$" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Optional. The 16-digit account number that uniquely identifies the customer.
", "example": "4211110000000019", "default": "4211110000000019", "pattern": "^[0-9]{16}$" }, { "name": "name", "kind": "optional", "type": "string", "description": "Optional. The customer's full name.
", "example": "Jane Citizen", "default": "Jane Citizen", "pattern": "^[A-Za-z0-9 '\\-\\.]{1,100}$" }, { "name": "nickName", "kind": "optional", "type": "string", "description": "Optional. A short form name of the customer.
", "example": "Jane", "default": "Jane", "pattern": "^[A-Za-z0-9 '\\-\\.]{0,50}$" }, { "name": "email", "kind": "optional", "type": "string", "description": "Optional. The email address of the customer.
", "example": "jane.citizen@example.com", "default": "jane.citizen@example.com", "pattern": "^[A-Za-z0-9._%+\\-]+@[A-Za-z0-9.\\-]+\\.[A-Za-z]{2,}$" }, { "name": "mobile", "kind": "optional", "type": "string", "description": "Optional. The mobile phone number of the customer.
", "example": "0400000000", "default": "0400000000", "pattern": "^0[0-9]{9}$" }, { "name": "lastTransactionDate", "kind": "optional", "type": "string", "description": "Optional. The date of the last transaction that the customer performed, in ISO 8601 date-time format. This is an empty string if there are no transactions. Note that the timezone is suppressed; the example timezone is Sydney local time.
", "example": "2026-08-14T16:42:10", "default": "2026-08-14T16:42:10", "pattern": "^([0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,7})?)?$" }, { "name": "contactPhone", "kind": "optional", "type": "string", "description": "Optional. The contact phone number for the customer. Can be a mobile or a landline.
", "example": "0298765432", "default": "0298765432", "pattern": "^0[0-9]{9}$" }, { "name": "authenticationEmail", "kind": "optional", "type": "string", "description": "Optional. The unique email address used to authenticate the customer. Can be null.
", "example": "jane.citizen@example.com", "default": "jane.citizen@example.com", "pattern": "^([A-Za-z0-9._%+\\-]+@[A-Za-z0-9.\\-]+\\.[A-Za-z]{2,})?$" }, { "name": "authenticationMobile", "kind": "optional", "type": "string", "description": "Optional. The unique mobile number used to authenticate the customer. Can be null.
", "example": "0400000000", "default": "0400000000", "pattern": "^(0[0-9]{9})?$" }, { "name": "authenticationLandLine", "kind": "optional", "type": "string", "description": "Optional. The unique telephone number used to authenticate the customer. Can be null.
", "example": "0298765432", "default": "0298765432", "pattern": "^(0[0-9]{9})?$" }, { "name": "registeredByMAccountNumber", "kind": "optional", "type": "string", "description": "Optional. The 16-digit account number of the mAccount that created the customer.
", "example": "4211110000000027", "default": "4211110000000027", "pattern": "^[0-9]{16}$" }, { "name": "isOnHold", "kind": "optional", "type": "string", "description": "Optional. Indicates whether the customer's account has been put on hold. Returned as the text value 'true' or 'false'.
", "example": "false", "default": "false", "pattern": "^(true|false)$" }, { "name": "isClosed", "kind": "optional", "type": "string", "description": "Optional. Indicates whether the customer's account has been closed. Returned as the text value 'true' or 'false'.
", "example": "false", "default": "false", "pattern": "^(true|false)$" }, { "name": "isStolen", "kind": "optional", "type": "string", "description": "Optional. Indicates whether the mWallet has been reported as stolen. Returned as the text value 'true' or 'false'.
", "example": "false", "default": "false", "pattern": "^(true|false)$" }, { "name": "isRegistered", "kind": "optional", "type": "string", "description": "Optional. Indicates whether the mWallet is registered and able to purchase restricted items from the mAccount, such as BPAY. Returned as the text value 'true' or 'false'.
", "example": "true", "default": "true", "pattern": "^(true|false)$" }, { "name": "financials", "kind": "optional", "type": "object", "description": "Optional. The current financial position of the mWallet.
", "modelRef": "#/components/schemas/mWalletFinancials", "customType": "mWalletFinancials", "schema": [ { "name": "actualBalance", "kind": "optional", "type": "number", "description": "Optional. The current remaining balance on the mWallet, in AUD.
", "example": 250.75, "default": 250.75, "pattern": "^-?[0-9]{1,10}(\\.[0-9]{1,2})?$" }, { "name": "availableSpend", "kind": "optional", "type": "number", "description": "Optional. The amount of funds that can be debited from the mWallet, in AUD.
", "example": 250.75, "default": 250.75, "pattern": "^-?[0-9]{1,10}(\\.[0-9]{1,2})?$" }, { "name": "availableLoad", "kind": "optional", "type": "number", "description": "Optional. The amount of funds that can be credited to the mWallet, in AUD.
", "example": 9749.25, "default": 9749.25, "pattern": "^-?[0-9]{1,10}(\\.[0-9]{1,2})?$" }, { "name": "maximumBalance", "kind": "optional", "type": "number", "description": "Optional. The maximum balance the mWallet is permitted to hold, in AUD. Returned by the financials endpoint only.
", "example": 10000, "default": 10000, "pattern": "^-?[0-9]{1,10}(\\.[0-9]{1,2})?$" } ] }, { "name": "options", "kind": "optional", "type": "array", "description": "Optional. An array of additional key and value options held against the mWallet.
", "modelRef": "#/components/schemas/optionItem", "customType": "optionItem[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "description": "Conditional. The unique identifier of the value. Required when an options array entry is supplied. For example MobileForSms.
", "example": "MobileForSms", "default": "MobileForSms", "pattern": "^[A-Za-z0-9_]{1,50}$" }, { "name": "value", "kind": "optional", "type": "string", "description": "Conditional. The actual value represented by the key. Required when an options array entry is supplied.
", "example": "0400000000", "default": "0400000000", "pattern": "^.{1,200}$" } ] }, { "name": "ABN", "kind": "optional", "type": "string", "description": "Optional. The company ABN of the mAccount. All non-numeric characters are stripped.
", "example": "51824753556", "default": "51824753556", "pattern": "^[0-9]{11}$" } ] }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "Optional. The total time in milliseconds that the Platform took to process the request.
", "example": 96, "default": 96, "pattern": "^[0-9]{1,7}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "Required. The status of the request. A code of 'Ok' indicates no errors.
", "example": "Ok", "default": "Ok", "pattern": "^[A-Za-z]{2,30}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Required. 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/mWalletUpdateResponse_V1", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request. The request failed validation - for example a mandatory field is missing, a value does not match the documented pattern, or the mWallet could not be found.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":24,\"status\":\"Fail\",\"statusDescription\":\"The pin must be exactly 4 numeric digits.\",\"errorCode\":\"ValidationError\"}", "description": "Standard error payload returned for 400, 401 and 500 responses.
", "customType": "errorResponse", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "Optional. The total time in milliseconds that the Platform took to process the request before the error was returned.
", "example": 24, "default": 24, "pattern": "^[0-9]{1,7}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "Required. The status of the request. A value other than 'Ok' indicates the request did not succeed, for example 'Fail', 'Unauthorized' or 'Exception'.
", "example": "Fail", "default": "Fail", "pattern": "^[A-Za-z]{2,30}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Required. A human readable description of the error that occurred.
", "example": "The pin must be exactly 4 numeric digits.", "default": "The pin must be exactly 4 numeric digits.", "pattern": "^.{1,500}$" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "Optional. A short machine readable code identifying the error condition. Use this value when logging or raising a support request.
", "example": "ValidationError", "default": "ValidationError", "pattern": "^[A-Za-z0-9_]{1,50}$" } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized. The basic authentication credentials are missing, malformed or the supplied API key is not valid for this operation.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":8,\"status\":\"Unauthorized\",\"statusDescription\":\"Authentication failed. Supply a valid API key as the basic authentication username.\",\"errorCode\":\"Unauthorized\"}", "description": "Standard error payload returned for 400, 401 and 500 responses.
", "customType": "errorResponse", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "Optional. The total time in milliseconds that the Platform took to process the request before the error was returned.
", "example": 24, "default": 24, "pattern": "^[0-9]{1,7}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "Required. The status of the request. A value other than 'Ok' indicates the request did not succeed, for example 'Fail', 'Unauthorized' or 'Exception'.
", "example": "Fail", "default": "Fail", "pattern": "^[A-Za-z]{2,30}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Required. A human readable description of the error that occurred.
", "example": "The pin must be exactly 4 numeric digits.", "default": "The pin must be exactly 4 numeric digits.", "pattern": "^.{1,500}$" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "Optional. A short machine readable code identifying the error condition. Use this value when logging or raising a support request.
", "example": "ValidationError", "default": "ValidationError", "pattern": "^[A-Za-z0-9_]{1,50}$" } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal server error. An unexpected condition prevented the Platform from completing the request. Retry the request and contact Monoova support if the error persists.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":1503,\"status\":\"Exception\",\"statusDescription\":\"An unexpected error occurred while processing the request.\",\"errorCode\":\"InternalServerError\"}", "description": "Standard error payload returned for 400, 401 and 500 responses.
", "customType": "errorResponse", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "Optional. The total time in milliseconds that the Platform took to process the request before the error was returned.
", "example": 24, "default": 24, "pattern": "^[0-9]{1,7}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "Required. The status of the request. A value other than 'Ok' indicates the request did not succeed, for example 'Fail', 'Unauthorized' or 'Exception'.
", "example": "Fail", "default": "Fail", "pattern": "^[A-Za-z]{2,30}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Required. A human readable description of the error that occurred.
", "example": "The pin must be exactly 4 numeric digits.", "default": "The pin must be exactly 4 numeric digits.", "pattern": "^.{1,500}$" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "Optional. A short machine readable code identifying the error condition. Use this value when logging or raising a support request.
", "example": "ValidationError", "default": "ValidationError", "pattern": "^[A-Za-z0-9_]{1,50}$" } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "0bC1IR1FtvsHChZiDjta2", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.mpay.com.au/mWallet/v1/update \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data-raw '{\n \"accountNumber\": \"4211110000000019\",\n \"pin\": \"1234\",\n \"name\": \"Jane Citizen\",\n \"nickName\": \"Jane\",\n \"phone\": \"0400000000\",\n \"Email\": \"jane.citizen@example.com\",\n \"options\": [\n {\n \"key\": \"MobileForSms\",\n \"value\": \"0400000000\"\n }\n ],\n \"ABN\": \"51824753556\"\n }'" }, { "id": "9yablhhtDflw_yIhQ-EsZ", "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 \"accountNumber\": \"4211110000000019\",\n \"pin\": \"1234\",\n \"name\": \"Jane Citizen\",\n \"nickName\": \"Jane\",\n \"phone\": \"0400000000\",\n \"Email\": \"jane.citizen@example.com\",\n \"options\": [\n {\n \"key\": \"MobileForSms\",\n \"value\": \"0400000000\"\n }\n ],\n \"ABN\": \"51824753556\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.mpay.com.au/mWallet/v1/update\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "vyjSIfLq5iMogknnY1dNM", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/mWallet/v1/update\")\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 \"accountNumber\": \"4211110000000019\",\n \"pin\": \"1234\",\n \"name\": \"Jane Citizen\",\n \"nickName\": \"Jane\",\n \"phone\": \"0400000000\",\n \"Email\": \"jane.citizen@example.com\",\n \"options\": [\n {\n \"key\": \"MobileForSms\",\n \"value\": \"0400000000\"\n }\n ],\n \"ABN\": \"51824753556\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "OvN51typs8TvVZ6zk6BeA", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/mWallet/v1/update\"\n\npayload = json.dumps({\n \"accountNumber\": \"4211110000000019\",\n \"pin\": \"1234\",\n \"name\": \"Jane Citizen\",\n \"nickName\": \"Jane\",\n \"phone\": \"0400000000\",\n \"Email\": \"jane.citizen@example.com\",\n \"options\": [\n {\n \"key\": \"MobileForSms\",\n \"value\": \"0400000000\"\n }\n ],\n \"ABN\": \"51824753556\"\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": "0bC1IR1FtvsHChZiDjta2" }, "results": { "languages": [ { "id": "FU-4RBtmhmmJoz0mkMeve", "language": "200", "code": "// Successful validation. The mWallet was updated.\n{\n \"accountNumber\": \"4211110000000019\",\n \"mWallet\": {\n \"createdDateTime\": \"2026-02-11T09:15:00\",\n \"accountNumber\": \"4211110000000019\",\n \"name\": \"Jane Citizen\",\n \"nickName\": \"Jane\",\n \"email\": \"jane.citizen@example.com\",\n \"mobile\": \"0400000000\",\n \"lastTransactionDate\": \"2026-08-14T16:42:10\",\n \"contactPhone\": \"0298765432\",\n \"authenticationEmail\": \"jane.citizen@example.com\",\n \"authenticationMobile\": \"0400000000\",\n \"authenticationLandLine\": \"0298765432\",\n \"registeredByMAccountNumber\": \"4211110000000027\",\n \"isOnHold\": \"false\",\n \"isClosed\": \"false\",\n \"isStolen\": \"false\",\n \"isRegistered\": \"true\",\n \"financials\": {\n \"actualBalance\": 250.75,\n \"availableSpend\": 250.75,\n \"availableLoad\": 9749.25,\n \"maximumBalance\": 10000\n },\n \"options\": [\n {\n \"key\": \"MobileForSms\",\n \"value\": \"0400000000\"\n }\n ],\n \"ABN\": \"51824753556\"\n },\n \"durationMs\": 96,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "U5FGTG7NBvNB2j2rBTp69", "language": "400", "code": "// Bad request. The request failed validation - for example a mandatory field is missing, a value does not match the documented pattern, or the mWallet could not be found.\n{\n \"durationMs\": 24,\n \"status\": \"Fail\",\n \"statusDescription\": \"The pin must be exactly 4 numeric digits.\",\n \"errorCode\": \"ValidationError\"\n}" }, { "id": "MPWQglCcPJPwkaLW5MEP5", "language": "401", "code": "// Unauthorized. The basic authentication credentials are missing, malformed or the supplied API key is not valid for this operation.\n{\n \"durationMs\": 24,\n \"status\": \"Fail\",\n \"statusDescription\": \"The pin must be exactly 4 numeric digits.\",\n \"errorCode\": \"ValidationError\"\n}" }, { "id": "vr8MQ-EsmbzArbKYZY3NH", "language": "500", "code": "// Internal server error. An unexpected condition prevented the Platform from completing the request. Retry the request and contact Monoova support if the error persists.\n{\n \"durationMs\": 24,\n \"status\": \"Fail\",\n \"statusDescription\": \"The pin must be exactly 4 numeric digits.\",\n \"errorCode\": \"ValidationError\"\n}" } ], "selectedLanguageId": "FU-4RBtmhmmJoz0mkMeve" } }, "children": [ { "text": "" } ] }