Required. The 16-digit account number that uniquely identifies the mWallet. All non-numeric characters are stripped before processing.
", "default": "4211110000000019", "pattern": "^[0-9]{16}$" }, { "kind": "required", "name": "pin", "type": "string", "example": "1234", "description": "Required. The 4-digit numeric PIN registered against the mWallet. The PIN authenticates the customer for this operation.
", "default": "1234", "pattern": "^[0-9]{4}$" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "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 reopened.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Response returned when a closed mWallet is reopened.", "customType": "mWalletReopenResponse_V1", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "Optional. The total time in milliseconds that the Platform took to process the request.
", "example": 61, "default": 61, "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/mWalletReopenResponse_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": "1a8lgiQmFR8lDT5MRkg6_", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.mpay.com.au/mWallet/v1/reopen/{cardNumber}/{pin} \\\n --header 'accept: application/json'" }, { "id": "OMafTyaHS6ulgDYrg3wO7", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.mpay.com.au/mWallet/v1/reopen/{cardNumber}/{pin}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "fDahjeC0yW844Smj8G2Fz", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/mWallet/v1/reopen/{cardNumber}/{pin}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "5ikBK7KsJuDXdyG2VreFZ", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/mWallet/v1/reopen/{cardNumber}/{pin}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "1a8lgiQmFR8lDT5MRkg6_" }, "results": { "languages": [ { "id": "UTrIG-GxIjFor12KRAWoR", "language": "200", "code": "// Successful validation. The mWallet was reopened.\n{\n \"durationMs\": 61,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "wCjM3dFiQoMT3SOc7k2Y-", "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": "g4Wugww0teYkok88gjHmN", "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": "9i9WWTqRZiGh893Gct2Qs", "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": "UTrIG-GxIjFor12KRAWoR" } }, "children": [ { "text": "" } ] }