You may choose to set your mAccounts to settle automatically every day. If so, the mAccount balance will be brought to zero at 4pm (Sydney time) each business day. Any positive balance will be disbursed to the bank account you have linked; any negative balance will be direct debited from the bank account you have linked. Transactions on weekends, public holidays and after 4pm won’t appear in the settlement report until after 4pm the next business day.
\nThis report returns an array of actual disbursements for each transaction that was settled on the given date. Date is represented by ISO8601 – ‘2016-03-01’ for 1st March 2016.
\nEach entry is a disbursement - a movement of funds out of your mAccount\nthat formed part of that day's settlement. This is the money-out view of the\nday, reported one row per settled transaction, with the fee charged on each.
\nThe disbursementMethod field identifies the rail used:
| Payout type | disbursementMethod | Destination |
|---|---|---|
| NPP (Osko) to a bank account | NppCreditBankAccount | External Australian bank account |
| NPP (Osko) to a PayID | NppCreditPayId | External PayID |
| Direct Credit | directCredit | External Australian bank account |
| Direct Credit to a stored token | token | Tokenised bank account |
| Direct Debit | directDebit | Debits an external bank account |
| BPAY | bpay | BPAY biller, paid from an mWallet |
Required. The settlement date to report on, in ISO 8601 yyyy-MM-dd\nformat. For example, 2016-03-01 returns the settlement that ran on\n1 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 settlement report was generated.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":20,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"settlements\":[{\"uniqueReferenced\":\"43257383821\",\"transactionId\":43343,\"disbursementAmount\":25,\"disbursementMethod\":\"bpay\",\"feeAmountExclGst\":0.335,\"feeAmountGstComponent\":0.0335,\"feeAmountInclGst\":0.3685}]}", "description": "The settlement report returned for the requested date.", "customType": "genericPaymentSettlementResponse_V1", "schema": [ { "name": "settlements", "kind": "optional", "type": "array", "description": "Conditional. The collection of disbursements that were settled on the\nrequested date. Returned as an empty array when no settlement took place\non that date. Patterns and examples are defined on each item field.
", "modelRef": "#/components/schemas/genericPaymentSettlementClass", "customType": "genericPaymentSettlementClass[]", "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": "43257383821", "default": "43257383821", "pattern": "^[A-Za-z0-9\\-_]{1,50}$" }, { "name": "transactionId", "kind": "optional", "type": "integerThe amount disbursed for the transaction, in AUD. A negative value\nindicates funds that were direct debited from the linked bank account to\nclear a negative mAccount balance.
", "example": 25, "default": 25, "format": "double", "pattern": "^-?\\d{1,13}(\\.\\d{1,2})?$" }, { "name": "disbursementMethod", "kind": "optional", "type": "string", "description": "Conditional. The payment method used to disburse the funds, for\nexample bpay. Returned once the disbursement has been executed.
Optional. 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": "feeAmountInclGst", "kind": "optional", "type": "numberOptional. The total fee charged for the transaction, in AUD, including\nGST. This is the sum of feeAmountExclGst and feeAmountGstComponent.
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": "fXrURl-C_IBySlrGWnYhU", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.mpay.com.au/reports/v1/settlement/{date} \\\n --header 'accept: application/json'" }, { "id": "m8aSetx2_qgsIKDbZnUPx", "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/settlement/{date}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "ZWw1U3SdSMifGKzgfN93n", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/reports/v1/settlement/{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": "AX0cdPBCY0AnDbaMWHI3G", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/reports/v1/settlement/{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": "fXrURl-C_IBySlrGWnYhU" }, "results": { "languages": [ { "id": "Vafa78EXULAP02X2KLdGw", "language": "200", "code": "// Successful validation. The settlement report was generated.\n{\n \"settlements\": [\n {\n \"uniqueReferenced\": \"43257383821\",\n \"transactionId\": 43343,\n \"disbursementAmount\": 25,\n \"disbursementMethod\": \"bpay\",\n \"feeAmountExclGst\": 0.335,\n \"feeAmountGstComponent\": 0.0335,\n \"feeAmountInclGst\": 0.3685\n }\n ],\n \"durationMs\": 20,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "zsYzw_FVhL1bYZ6orRiW_", "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": "senw6LfJDyZFEe178IeBR", "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": "Y_6VAY8vTnjSOW75OGNvw", "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": "Vafa78EXULAP02X2KLdGw" } }, "children": [ { "text": "" } ] }