Required. The 16-digit mWallet account number to reset.
", "example": "4211110000000019", "default": "4211110000000019", "pattern": "^[0-9]{16}$" }, { "name": "pin", "kind": "required", "type": "string", "description": "Required. The new 4-digit numerical pin to set on the mWallet.
", "example": "5678", "default": "5678", "pattern": "^[0-9]{4}$" }, { "name": "dateOfBirth", "kind": "required", "type": "string", "description": "Required. The registered birth date of the customer, or the other date of significance supplied at creation, in ISO 8601 date-time format. Note that the timezone is suppressed; the default timezone is Sydney local time. This value authenticates the reset.
", "example": "1985-07-19T00:00:00", "default": "1985-07-19T00:00: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})?$" } ], "modelRef": "#/components/schemas/mWalletResetPin", "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 PIN was reset.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Response returned when an mWallet PIN is reset.", "customType": "mWalletResetPinResponse_V1", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "Optional. The total time in milliseconds that the Platform took to process the request.
", "example": 73, "default": 73, "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/mWalletResetPinResponse_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": "bgJ3fAqlgLBoEwCTm-FkE", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.mpay.com.au/mWallet/v1/resetPin \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"accountNumber\": \"4211110000000019\",\n \"pin\": \"5678\",\n \"dateOfBirth\": \"1985-07-19T00:00:00\"\n }'" }, { "id": "1lpzmIYXY9BFduDqARDnX", "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\": \"5678\",\n \"dateOfBirth\": \"1985-07-19T00:00:00\"\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/resetPin\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "HLgyhva3y_a8AvaoBhBi9", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/mWallet/v1/resetPin\")\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\": \"5678\",\n \"dateOfBirth\": \"1985-07-19T00:00:00\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "_BK3SdEcjfVrJyswX3B_x", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/mWallet/v1/resetPin\"\n\npayload = json.dumps({\n \"accountNumber\": \"4211110000000019\",\n \"pin\": \"5678\",\n \"dateOfBirth\": \"1985-07-19T00:00:00\"\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": "bgJ3fAqlgLBoEwCTm-FkE" }, "results": { "languages": [ { "id": "5vJzA6TOLm-ITBh3Tyak1", "language": "200", "code": "// Successful validation. The PIN was reset.\n{\n \"durationMs\": 73,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "O8bPF_FhFUYYST9C1JRLF", "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": "MmXqj1fTiNi71RhOdnGsv", "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": "0xHbjLE5z3d1pzhXU5gr5", "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": "5vJzA6TOLm-ITBh3Tyak1" } }, "children": [ { "text": "" } ] }