--- title: Get Transaction Status By Unique Reference slug: api/get-transaction-status-by-unique-reference docTags: createdAt: 2025-07-21T23:55:15.400Z --- { "id": "MWfhzzF7bjoQnA5Y6FsM9", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.mpay.com.au/financial/v2/status/{uniqueReference}", "servers": [ { "url": "https://api.mpay.com.au/financial/v2/status/{uniqueReference}", "description": "Production URL" }, { "url": "https://api.m-pay.com.au/financial/v2/status/{uniqueReference}", "description": "Sandbox URL" } ], "name": "Get Transaction Status By Unique Reference", "description": "This API returns the status of a previous transaction. This is important because a directDebit transaction could be dishonoured up to 3 days after the transaction was executed. We recommend subscribing to a webhook to notify you when an dishonour transaction is made.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "uniqueReference", "type": "string", "description": "This is the uniqueReference." } ], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "basicAuth", "name": "basicAuth", "kind": "optional", "type": "http", "scheme": "basic" } ] }, "responses": [ { "statusCode": "200", "description": "successful validation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "gatewayTransactionStatusResponseByDateRange_V2", "schema": [ { "name": "uniqueReference", "kind": "optional", "type": "string", "description": "This is a unique reference generated by the calling service. This is a nonce. Its use is to determine if a request has already been received by the Engine. We strongly recommend sending a uniqueReference in your execution call to avoid duplicate transactions.", "example": "" }, { "name": "fundsClearedDate", "kind": "optional", "type": "string", "description": "Date funds cleared.", "example": "" }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request.", "example": 0 }, { "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": "" }, { "name": "bulkDirectDebits", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/bulkDirectDebitStatusClass", "customType": "bulkDirectDebitStatusClass[]", "schema": [ { "name": "dishonouredDate", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "bsb", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "lodgementReference", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "index", "kind": "optional", "type": "integer", "description": "", "example": 0 }, { "name": "expectedClearanceDateForFunds", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "amount", "kind": "optional", "type": "number", "description": "", "example": "" } ] }, { "name": "transactionStatus", "kind": "optional", "type": "string", "description": "The current status of the transaction.", "example": "" }, { "name": "creditCardPaymentStatus", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/creditCardPaymentStatus", "customType": "creditCardPaymentStatus", "schema": [ { "name": "originalTransactionAmount", "kind": "optional", "type": "number", "description": "", "example": "" }, { "name": "availableAmountToRefund", "kind": "optional", "type": "number", "description": "", "example": "" }, { "name": "isVoidable", "kind": "optional", "type": "boolean", "description": "", "example": "" }, { "name": "isRefundable", "kind": "optional", "type": "boolean", "description": "", "example": "" } ] }, { "name": "completedDate", "kind": "optional", "type": "string", "description": "Date transaction completed.", "example": "" }, { "name": "dishonouredDate", "kind": "optional", "type": "string", "description": "The date on which the transaction was dishonoured, if applicable.", "example": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "This is the status of the request. A code of 'Ok' indicates no errors.", "example": "" }, { "name": "expectedClearanceDateForFunds", "kind": "optional", "type": "string", "description": "Date funds are expected to clear.", "example": "" } ], "modelRef": "#/components/schemas/gatewayTransactionStatusResponseByDateRange_V2", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "iwZdb06qa4jxz9aKSkf7W", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.mpay.com.au/financial/v2/status/{uniqueReference} \\\n --header 'accept: application/json'" }, { "id": "NQZRURFaRJsvft8Ek8ta2", "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/financial/v2/status/{uniqueReference}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "EQ2HW6Dh9eBMvoTygkSjP", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/financial/v2/status/{uniqueReference}\")\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": "fl2JLF_UyV8dKl0CChI-B", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/financial/v2/status/{uniqueReference}\"\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" }, { "id": "LkPvahQi6pwX2ctnY3i3q", "language": "php", "label": "PHP", "code": " 'https://api.mpay.com.au/financial/v2/status/{uniqueReference}',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'accept: application/json',\n 'content-type: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" } ], "selectedLanguageId": "iwZdb06qa4jxz9aKSkf7W" }, "results": { "languages": [ { "id": "Jpo7zqKRuF1ADNYIB7W9H", "language": "200", "code": "// successful validation\n{\n \"uniqueReference\": \"\",\n \"fundsClearedDate\": \"\",\n \"durationMs\": \"\",\n \"statusDescription\": \"\",\n \"bulkDirectDebits\": [\n {\n \"dishonouredDate\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"lodgementReference\": \"\",\n \"index\": \"\",\n \"expectedClearanceDateForFunds\": \"\",\n \"status\": \"\",\n \"amount\": \"\"\n }\n ],\n \"transactionStatus\": \"\",\n \"creditCardPaymentStatus\": {\n \"originalTransactionAmount\": \"\",\n \"availableAmountToRefund\": \"\",\n \"isVoidable\": false,\n \"isRefundable\": false\n },\n \"completedDate\": \"\",\n \"dishonouredDate\": \"\",\n \"status\": \"\",\n \"expectedClearanceDateForFunds\": \"\"\n}" } ], "selectedLanguageId": "Jpo7zqKRuF1ADNYIB7W9H" } }, "children": [ { "text": "" } ] }