--- title: Ping slug: api/ping docTags: createdAt: 2026-08-19T07:13:46.474Z --- { "id": "01xxWdBK79SYdWWp_wd4p", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.mpay.com.au/public/v1/ping", "servers": [ { "url": "https://api.mpay.com.au/public/v1/ping", "description": "Production URL" }, { "url": "https://api.m-pay.com.au/public/v1/ping", "description": "Sandbox URL" } ], "name": "Ping", "description": "The primary purpose of the ping API is to validate that the system is up and running. No Authentication is required.", "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": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful validation. The service is up and running.", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Successful validation. The service is up and running.\n{\n \"version\": \"2.0.5.31\",\n \"environment\": \"Production\",\n \"durationMs\": 12,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "label": "success", "code": "// Service healthy\n{\n \"version\": \"2.0.5.31\",\n \"environment\": \"Production\",\n \"durationMs\": 12,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "publicPingResponse_V1", "schema": [ { "name": "version", "kind": "optional", "type": "string", "description": "The current version of the Monoova Engine API.", "example": "2.0.5.31", "default": "2.0.5.31" }, { "name": "environment", "kind": "optional", "type": "string", "description": "

The environment that served the request, e.g. Production or Sandbox.

", "example": "Production", "default": "Production" }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request.", "example": 12, "default": 12 }, { "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" }, { "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" } ], "modelRef": "#/components/schemas/publicPingResponse_V1", "isExpanded": true } ] }, { "statusCode": "400", "description": "

Bad Request — the request was malformed or failed validation. Review the errors array, correct the request and try again.

", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Bad Request — the request was malformed or failed validation. Review the errors array, correct the request and try again.\n{\n \"status\": \"Invalid\",\n \"statusDescription\": \"The request failed validation.\",\n \"durationMs\": 5,\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The request could not be understood by the server.\",\n \"field\": \"\"\n }\n ]\n}" }, { "label": "badRequest", "code": "// Validation failure\n{\n \"status\": \"Invalid\",\n \"statusDescription\": \"The request failed validation.\",\n \"durationMs\": 5,\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The request could not be understood by the server.\",\n \"field\": null\n }\n ]\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "Standard error envelope returned by the Monoova Engine API.", "customType": "errorResponse_V1", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request. Any value other than 'Ok' indicates the request was not processed successfully.", "example": "Invalid", "default": "Invalid" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

A human-readable description of the failure.

", "example": "The request failed validation.", "default": "The request failed validation." }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "The total time in milliseconds that the Platform took to process the request.", "example": 5, "default": 5 }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of the individual errors that caused the request to fail.", "modelRef": "#/components/schemas/errorDetail_V1", "customType": "errorDetail_V1[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "

The machine-readable error code.

", "example": "InvalidRequest", "default": "InvalidRequest" }, { "name": "message", "kind": "optional", "type": "string", "description": "A description of the individual error.", "example": "The request could not be understood by the server.", "default": "The request could not be understood by the server." }, { "name": "field", "kind": "optional", "type": "string", "description": "

The request field the error relates to, where the error is specific to a single field.

", "example": "", "default": "" } ] } ], "modelRef": "#/components/schemas/errorResponse_V1", "isExpanded": true } ] }, { "statusCode": "401", "description": "

Unauthorized — authentication credentials are missing, malformed or not valid for this environment.

", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Unauthorized — authentication credentials are missing, malformed or not valid for this environment.\n{\n \"status\": \"Invalid\",\n \"statusDescription\": \"The request failed validation.\",\n \"durationMs\": 5,\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The request could not be understood by the server.\",\n \"field\": \"\"\n }\n ]\n}" }, { "label": "unauthorized", "code": "// Missing or invalid credentials\n{\n \"status\": \"Unauthorized\",\n \"statusDescription\": \"Authentication failed for the supplied credentials.\",\n \"durationMs\": 3,\n \"errors\": [\n {\n \"code\": \"Unauthorized\",\n \"message\": \"Valid API credentials were not supplied with the request.\"\n }\n ]\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "Standard error envelope returned by the Monoova Engine API.", "customType": "errorResponse_V1", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request. Any value other than 'Ok' indicates the request was not processed successfully.", "example": "Invalid", "default": "Invalid" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

A human-readable description of the failure.

", "example": "The request failed validation.", "default": "The request failed validation." }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "The total time in milliseconds that the Platform took to process the request.", "example": 5, "default": 5 }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of the individual errors that caused the request to fail.", "modelRef": "#/components/schemas/errorDetail_V1", "customType": "errorDetail_V1[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "

The machine-readable error code.

", "example": "InvalidRequest", "default": "InvalidRequest" }, { "name": "message", "kind": "optional", "type": "string", "description": "A description of the individual error.", "example": "The request could not be understood by the server.", "default": "The request could not be understood by the server." }, { "name": "field", "kind": "optional", "type": "string", "description": "

The request field the error relates to, where the error is specific to a single field.

", "example": "", "default": "" } ] } ], "modelRef": "#/components/schemas/errorResponse_V1", "isExpanded": true } ] }, { "statusCode": "500", "description": "

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

", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Internal Server Error — an unexpected error occurred while processing the request. Retry the request; if the problem persists, contact Monoova support.\n{\n \"status\": \"Invalid\",\n \"statusDescription\": \"The request failed validation.\",\n \"durationMs\": 5,\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The request could not be understood by the server.\",\n \"field\": \"\"\n }\n ]\n}" }, { "label": "serverError", "code": "// Unexpected server error\n{\n \"status\": \"Error\",\n \"statusDescription\": \"An unexpected error occurred while processing the request.\",\n \"durationMs\": 102,\n \"errors\": [\n {\n \"code\": \"InternalServerError\",\n \"message\": \"The request could not be completed. Please try again later.\"\n }\n ]\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "Standard error envelope returned by the Monoova Engine API.", "customType": "errorResponse_V1", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request. Any value other than 'Ok' indicates the request was not processed successfully.", "example": "Invalid", "default": "Invalid" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

A human-readable description of the failure.

", "example": "The request failed validation.", "default": "The request failed validation." }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "The total time in milliseconds that the Platform took to process the request.", "example": 5, "default": 5 }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of the individual errors that caused the request to fail.", "modelRef": "#/components/schemas/errorDetail_V1", "customType": "errorDetail_V1[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "

The machine-readable error code.

", "example": "InvalidRequest", "default": "InvalidRequest" }, { "name": "message", "kind": "optional", "type": "string", "description": "A description of the individual error.", "example": "The request could not be understood by the server.", "default": "The request could not be understood by the server." }, { "name": "field", "kind": "optional", "type": "string", "description": "

The request field the error relates to, where the error is specific to a single field.

", "example": "", "default": "" } ] } ], "modelRef": "#/components/schemas/errorResponse_V1", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "ObgYKUdctkbKyvBKiKizS", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.mpay.com.au/public/v1/ping \\\n --header 'accept: application/json'" }, { "id": "27imj_VUupshw6OepV4XF", "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/public/v1/ping\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "cdW4K6g_rHd6D9DVtDYMi", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/public/v1/ping\")\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": "Cf88Xiq2kU-H9hbV8LPQD", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/public/v1/ping\"\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": "ObgYKUdctkbKyvBKiKizS" }, "results": { "languages": [ { "id": "5Em_ApDl6WaJuACRxYxaZ", "language": "200", "code": "// Successful validation. The service is up and running.\n{\n \"version\": \"2.0.5.31\",\n \"environment\": \"Production\",\n \"durationMs\": 12,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}", "subExamples": [ { "label": "GENERATED", "code": "// Successful validation. The service is up and running.\n{\n \"version\": \"2.0.5.31\",\n \"environment\": \"Production\",\n \"durationMs\": 12,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "label": "success", "code": "// Service healthy\n{\n \"version\": \"2.0.5.31\",\n \"environment\": \"Production\",\n \"durationMs\": 12,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" } ] }, { "id": "iZb_p2LyIA-DM3j3wPcgr", "language": "400", "code": "// Bad Request — the request was malformed or failed validation. Review the errors array, correct the request and try again.\n{\n \"status\": \"Invalid\",\n \"statusDescription\": \"The request failed validation.\",\n \"durationMs\": 5,\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The request could not be understood by the server.\",\n \"field\": \"\"\n }\n ]\n}", "subExamples": [ { "label": "GENERATED", "code": "// Bad Request — the request was malformed or failed validation. Review the errors array, correct the request and try again.\n{\n \"status\": \"Invalid\",\n \"statusDescription\": \"The request failed validation.\",\n \"durationMs\": 5,\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The request could not be understood by the server.\",\n \"field\": \"\"\n }\n ]\n}" }, { "label": "badRequest", "code": "// Validation failure\n{\n \"status\": \"Invalid\",\n \"statusDescription\": \"The request failed validation.\",\n \"durationMs\": 5,\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The request could not be understood by the server.\",\n \"field\": null\n }\n ]\n}" } ] }, { "id": "q2Eo8dFu1jGQybBQKedJb", "language": "401", "code": "// Unauthorized — authentication credentials are missing, malformed or not valid for this environment.\n{\n \"status\": \"Invalid\",\n \"statusDescription\": \"The request failed validation.\",\n \"durationMs\": 5,\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The request could not be understood by the server.\",\n \"field\": \"\"\n }\n ]\n}", "subExamples": [ { "label": "GENERATED", "code": "// Unauthorized — authentication credentials are missing, malformed or not valid for this environment.\n{\n \"status\": \"Invalid\",\n \"statusDescription\": \"The request failed validation.\",\n \"durationMs\": 5,\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The request could not be understood by the server.\",\n \"field\": \"\"\n }\n ]\n}" }, { "label": "unauthorized", "code": "// Missing or invalid credentials\n{\n \"status\": \"Unauthorized\",\n \"statusDescription\": \"Authentication failed for the supplied credentials.\",\n \"durationMs\": 3,\n \"errors\": [\n {\n \"code\": \"Unauthorized\",\n \"message\": \"Valid API credentials were not supplied with the request.\"\n }\n ]\n}" } ] }, { "id": "BSKeSjWDs026JlxsK6RU8", "language": "500", "code": "// Internal Server Error — an unexpected error occurred while processing the request. Retry the request; if the problem persists, contact Monoova support.\n{\n \"status\": \"Invalid\",\n \"statusDescription\": \"The request failed validation.\",\n \"durationMs\": 5,\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The request could not be understood by the server.\",\n \"field\": \"\"\n }\n ]\n}", "subExamples": [ { "label": "GENERATED", "code": "// Internal Server Error — an unexpected error occurred while processing the request. Retry the request; if the problem persists, contact Monoova support.\n{\n \"status\": \"Invalid\",\n \"statusDescription\": \"The request failed validation.\",\n \"durationMs\": 5,\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The request could not be understood by the server.\",\n \"field\": \"\"\n }\n ]\n}" }, { "label": "serverError", "code": "// Unexpected server error\n{\n \"status\": \"Error\",\n \"statusDescription\": \"An unexpected error occurred while processing the request.\",\n \"durationMs\": 102,\n \"errors\": [\n {\n \"code\": \"InternalServerError\",\n \"message\": \"The request could not be completed. Please try again later.\"\n }\n ]\n}" } ] } ], "selectedLanguageId": "5Em_ApDl6WaJuACRxYxaZ" } }, "children": [ { "text": "" } ] }