This API returns all successful transactions on the given date. Date is represented by ISO8601 - '2016-03-01' for 1st March 2016.
\nThis is the statement view of your mAccount for a single day, covering both\nmoney in and money out. Because it is not tied to the settlement cycle, a\ntransaction appears here on the day it was processed, even if the funds settle\non a later date.
\nFunds received, across every rail the Platform supports:
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Receivable type | Notes |
|---|---|
| NPP (Osko) | Received instantly, including payments addressed to a PayID |
| Direct Credit | Received via Direct Entry, typically 1-2 days |
| Direct Debit | Pulled from the payer's account, typically 1-2 days |
| PayTo | Instant, under an established payment agreement |
| BPAY | Received against your biller code and CRN, typically 1-3 days |
| RTGS | Received instantly |
| Cards | Authorised instantly, settled in 1-2 days |
Required. The transaction date to report on, in ISO 8601 yyyy-MM-dd\nformat. For example, 2016-03-01 returns all successful transactions\nprocessed on 1 March 2016.
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 statement report was generated.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":20,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"transactions\":[{\"uniqueReferenced\":\"43257\",\"transactionId\":36,\"dateTime\":\"2018-09-01T19:19:38\",\"status\":\"OK\",\"totalAmount\":25,\"feeAmountExcludingGst\":0.335,\"feeAmountGstComponent\":0.0335,\"feeAmountIncludingGst\":0.3685}]}", "description": "The statement report returned for the requested date.", "customType": "genericPaymentStatementResponse_V1", "schema": [ { "name": "transactions", "kind": "optional", "type": "array", "description": "Conditional. The collection of transactions that were processed\nsuccessfully on the requested date. Returned as an empty array when no\ntransactions were processed on that date. Patterns and examples are\ndefined on each item field.
", "modelRef": "#/components/schemas/genericPaymentStatementClass", "customType": "genericPaymentStatementClass[]", "schema": [ { "name": "uniqueReferenced", "kind": "optional", "type": "string", "description": "Optional. Your own reference for the transaction, as supplied when the\ntransaction was created. Returned only where a reference was provided.
", "example": "43257", "default": "43257", "pattern": "^[A-Za-z0-9\\-_]{1,50}$" }, { "name": "transactionId", "kind": "optional", "type": "integerThe date and time the transaction was processed, in ISO 8601\nyyyy-MM-ddTHH:mm:ss format, expressed in Sydney time.
The status of the transaction. A code of OK indicates that the\ntransaction was processed successfully.
The total value of the transaction, in AUD, inclusive of any fees. A\nnegative value indicates funds debited from the mAccount.
", "example": 25, "default": 25, "format": "double", "pattern": "^-?\\d{1,13}(\\.\\d{1,2})?$" }, { "name": "feeAmountExcludingGst", "kind": "optional", "type": "numberOptional. The fee charged for the transaction, in AUD, excluding GST.\nReturned where a fee applies to the transaction.
", "example": 0.335, "default": 0.335, "format": "double", "pattern": "^-?\\d{1,13}(\\.\\d{1,4})?$" }, { "name": "feeAmountGstComponent", "kind": "optional", "type": "numberOptional. The GST component of the fee charged for the transaction, in\nAUD. Returned where a fee applies to the transaction.
", "example": 0.0335, "default": 0.0335, "format": "double", "pattern": "^-?\\d{1,13}(\\.\\d{1,4})?$" }, { "name": "feeAmountIncludingGst", "kind": "optional", "type": "numberOptional. The total fee charged for the transaction, in AUD, including\nGST. This is the sum of feeAmountExcludingGst and\nfeeAmountGstComponent.
The total time, in milliseconds, that the Platform took to process the\nrequest.
", "example": 20, "default": 20, "format": "int64", "pattern": "^\\d{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request. A code of Ok indicates that no errors\noccurred.
A description of the status. Where an Ok status is returned, this is\nOperation completed successfully.
The total time, in milliseconds, that the Platform took to process the\nrequest before the validation failure was returned.
", "example": 4, "default": 4, "format": "int64", "pattern": "^\\d{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request. A code of Error indicates that the request\nfailed validation and no report was generated.
Conditional. A description of the validation failure, returned where\nthe Platform can identify the cause. For this endpoint the most common\ncause is a date that is missing or not in ISO 8601 yyyy-MM-dd format.
Unauthorised. The API key is missing, invalid or has been revoked.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":2,\"status\":\"Unauthorized\",\"statusDescription\":\"Authentication failed. Supply a valid API key as the basic authentication username.\"}", "description": "Returned when the request could not be authenticated.", "customType": "unauthorisedResponse_V1", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integerThe total time, in milliseconds, that the Platform took to process the\nrequest before the authentication failure was returned.
", "example": 2, "default": 2, "format": "int64", "pattern": "^\\d{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request. A code of Unauthorized indicates that the\ncredentials supplied were not accepted.
Conditional. A description of the authentication failure, returned\nwhere the Platform can identify the cause. Check that a valid API key has\nbeen supplied as the basic authentication username and that no password\nhas been set.
", "example": "Authentication failed. Supply a valid API key as the basic authentication username.", "default": "Authentication failed. Supply a valid API key as the basic authentication username.", "pattern": "^.{1,500}$" } ], "modelRef": "#/components/schemas/unauthorisedResponse_V1", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal server error. The request could not be completed by the Platform.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":118,\"status\":\"Error\",\"statusDescription\":\"An unexpected error occurred while processing the request. Please try again later.\"}", "description": "Returned when an unexpected error prevents the Platform from completing the request.", "customType": "internalServerErrorResponse_V1", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integerThe total time, in milliseconds, that the Platform took to process the\nrequest before the error was returned.
", "example": 118, "default": 118, "format": "int64", "pattern": "^\\d{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request. A code of Error indicates that the request\ncould not be completed and should be retried.
Conditional. A description of the error, returned where the Platform\ncan identify the cause. Retry the request and contact Monoova support if\nthe error persists.
", "example": "An unexpected error occurred while processing the request. Please try again later.", "default": "An unexpected error occurred while processing the request. Please try again later.", "pattern": "^.{1,500}$" } ], "modelRef": "#/components/schemas/internalServerErrorResponse_V1", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "bhgcyqdX9hmzQretlBEJx", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.mpay.com.au/reports/v1/statement/{date} \\\n --header 'accept: application/json'" }, { "id": "7xcESWgIyX7-LrKZ9YS3U", "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/reports/v1/statement/{date}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "yGy5zcxJM5UQ4UvnMtR5B", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/reports/v1/statement/{date}\")\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": "eS6G5SX2DkvbUasqHgQu9", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/reports/v1/statement/{date}\"\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": "bhgcyqdX9hmzQretlBEJx" }, "results": { "languages": [ { "id": "tvslqbib8mFC8Y41E6IUW", "language": "200", "code": "// Successful validation. The statement report was generated.\n{\n \"transactions\": [\n {\n \"uniqueReferenced\": \"43257\",\n \"transactionId\": 36,\n \"dateTime\": \"2018-09-01T19:19:38\",\n \"status\": \"OK\",\n \"totalAmount\": 25,\n \"feeAmountExcludingGst\": 0.335,\n \"feeAmountGstComponent\": 0.0335,\n \"feeAmountIncludingGst\": 0.3685\n }\n ],\n \"durationMs\": 20,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "utqqKh6mjNchxQm_bDzdg", "language": "400", "code": "// Bad request. The date supplied is missing or is not a valid ISO 8601 date.\n{\n \"durationMs\": 4,\n \"status\": \"Error\",\n \"statusDescription\": \"The date supplied is invalid. Provide the date in ISO 8601 format, for example 2016-03-01.\"\n}" }, { "id": "vqpwlYo0cYRPyMNwnN_oL", "language": "401", "code": "// Unauthorised. The API key is missing, invalid or has been revoked.\n{\n \"durationMs\": 2,\n \"status\": \"Unauthorized\",\n \"statusDescription\": \"Authentication failed. Supply a valid API key as the basic authentication username.\"\n}" }, { "id": "Kt3Smw6OCHwraYD_3YmGV", "language": "500", "code": "// Internal server error. The request could not be completed by the Platform.\n{\n \"durationMs\": 118,\n \"status\": \"Error\",\n \"statusDescription\": \"An unexpected error occurred while processing the request. Please try again later.\"\n}" } ], "selectedLanguageId": "tvslqbib8mFC8Y41E6IUW" } }, "children": [ { "text": "" } ] }