Required. The 16-digit account number that uniquely identifies the mAccount whose balance is being retrieved.
", "default": "4212800000000001", "pattern": "^[0-9]{16}$" } ], "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 mAccount financials were returned.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Response returned by the Get mAccount Balance endpoint.", "customType": "mAccountGetFinancialsResponse_V1", "schema": [ { "name": "financials", "kind": "optional", "type": "object", "description": "Optional. The current balances, limits and settlement configuration of an mAccount, including balances and limits. Returned by Get mAccount Balance.
", "modelRef": "#/components/schemas/mAccountFinancials", "customType": "mAccountFinancials", "schema": [ { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Required. The 16-digit account number that uniquely identifies the mAccount these financials belong to.
", "example": "4212800000000001", "default": "4212800000000001", "pattern": "^[0-9]{16}$" }, { "name": "actualBalance", "kind": "optional", "type": "number", "description": "Optional. The actual ledger balance of the mAccount in Australian dollars, including funds that have not yet cleared.
", "example": 1750.5, "default": 1750.5, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "creditLimit", "kind": "optional", "type": "number", "description": "Optional. The credit limit currently applied to the mAccount in Australian dollars.
", "example": 5000, "default": 5000, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "availableToDebit", "kind": "optional", "type": "number", "description": "Optional. The amount in Australian dollars that is currently available to be debited from the mAccount.
", "example": 6750.5, "default": 6750.5, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "availableToCredit", "kind": "optional", "type": "number", "description": "Optional. The amount in Australian dollars that is currently available to be credited to the mAccount.
", "example": 25000, "default": 25000, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "lowerCreditLimit", "kind": "optional", "type": "number", "description": "Optional. The lower bound of the credit limit range permitted for the mAccount in Australian dollars.
", "example": 0, "default": 0, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "upperCreditLimit", "kind": "optional", "type": "number", "description": "Optional. The upper bound of the credit limit range permitted for the mAccount in Australian dollars.
", "example": 10000, "default": 10000, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "minimumSettlementAmount", "kind": "optional", "type": "number", "description": "Optional. The minimum balance in Australian dollars that must be reached before a settlement is generated for the mAccount.
", "example": 100, "default": 100, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "settlementFrequency", "kind": "optional", "type": "string", "description": "Optional. How often settlements are generated for the mAccount. Typical values are ''Daily'', ''Weekly'', ''Monthly'' and ''Never''.
", "example": "Daily", "default": "Daily", "pattern": "^(Daily|Weekly|Monthly|Never)$" }, { "name": "clearedFundsOnly", "kind": "optional", "type": "string", "description": "Optional. Indicates whether only cleared funds may be paid out of the mAccount. Accepted values are ''true'' and ''false''.
", "example": "false", "default": "false", "pattern": "^(true|false)$" }, { "name": "isChildAccount", "kind": "optional", "type": "string", "description": "Optional. Indicates whether the mAccount is a child of a parent mAccount. Accepted values are ''true'' and ''false''.
", "example": "true", "default": "true", "pattern": "^(true|false)$" }, { "name": "isParentAccount", "kind": "optional", "type": "string", "description": "Optional. Indicates whether the mAccount is a parent that has child mAccounts beneath it. Accepted values are ''true'' and ''false''.
", "example": "false", "default": "false", "pattern": "^(true|false)$" }, { "name": "isFeeAccount", "kind": "optional", "type": "string", "description": "Optional. Indicates whether the mAccount is used to collect fees for other mAccounts. Accepted values are ''true'' and ''false''.
", "example": "false", "default": "false", "pattern": "^(true|false)$" }, { "name": "isParentClearedFunds", "kind": "optional", "type": "string", "nullable": true, "description": "Optional. Indicates whether the parent mAccount enforces a cleared funds restriction. Accepted values are ''true'', ''false'' and null when the mAccount has no parent.
", "example": "false", "default": "false", "pattern": "^(true|false)$" }, { "name": "hasSeparateFeeAccount", "kind": "optional", "type": "string", "description": "Optional. Indicates whether fees for the mAccount are charged to a separate fee mAccount. Accepted values are ''true'' and ''false''.
", "example": "true", "default": "true", "pattern": "^(true|false)$" }, { "name": "feeAccountActualBalance", "kind": "optional", "type": "number", "description": "Conditional. The actual balance of the separate fee mAccount in Australian dollars. Returned only when hasSeparateFeeAccount is ''true''.
", "example": 320.75, "default": 320.75, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "clearedFundsAccountFinancials", "kind": "optional", "type": "object", "description": "Conditional. The cleared and uncleared funds position of an mAccount. Returned only when clearedFundsOnly is ''true''.
", "modelRef": "#/components/schemas/mAccountClearedFundsAccount", "customType": "mAccountClearedFundsAccount", "schema": [ { "name": "availableBalance", "kind": "optional", "type": "number", "description": "Optional. The balance in Australian dollars that has cleared and is available for use.
", "example": 1500, "default": 1500, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "unclearedFunds", "kind": "optional", "type": "number", "description": "Optional. The amount in Australian dollars that has been received but has not yet cleared.
", "example": 250.5, "default": 250.5, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "uniqueReferencesWaitingToClear", "kind": "optional", "type": "array", "description": "Optional. The list of unique payment references for funds that have been received but have not yet cleared.
", "example": "[\"INV-100234\",\"INV-100235\"]", "default": [ "INV-100234", "INV-100235" ], "itemType": "string", "customType": "string[]", "itemExample": "INV-100234", "itemDefault": "INV-100234" } ] }, { "name": "feeAccountNumber", "kind": "optional", "type": "string", "description": "Conditional. The 16-digit account number of the separate fee mAccount. Returned only when hasSeparateFeeAccount is ''true''.
", "example": "4212800000000099", "default": "4212800000000099", "pattern": "^[0-9]{16}$" }, { "name": "nppBalance", "kind": "optional", "type": "number", "description": "Optional. The balance in Australian dollars currently available for New Payments Platform (NPP) payouts.
", "example": 1750.5, "default": 1750.5, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "nppPayoutLimit", "kind": "optional", "type": "number", "description": "Optional. The maximum amount in Australian dollars that may be paid out via the New Payments Platform (NPP).
", "example": 20000, "default": 20000, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "iftiNppBalance", "kind": "optional", "type": "number", "description": "Optional. The balance in Australian dollars currently available for International Funds Transfer Instruction (IFTI) NPP payouts.
", "example": 500, "default": 500, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "iftiNppPayoutLimit", "kind": "optional", "type": "number", "description": "Optional. The maximum amount in Australian dollars that may be paid out via IFTI NPP payments.
", "example": 10000, "default": 10000, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "directDebitBalance", "kind": "optional", "type": "number", "description": "Optional. The balance in Australian dollars currently available for direct debit transactions.
", "example": 1250, "default": 1250, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" }, { "name": "directDebitLimit", "kind": "optional", "type": "number", "description": "Optional. The maximum amount in Australian dollars that may be collected by direct debit.
", "example": 15000, "default": 15000, "pattern": "^-?[0-9]{1,13}(\\.[0-9]{1,2})?$" } ] }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "Optional. The total time in milliseconds that the Platform took to process the request.
", "example": 105, "default": 105, "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,40}$" }, { "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/mAccountGetFinancialsResponse_V1", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request. The request could not be processed because one or more fields failed validation, were malformed, or were missing.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "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": 42, "default": 42, "pattern": "^[0-9]{1,7}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "Required. The status code of the request. A value other than ''Ok'' indicates that an error occurred.
", "example": "Exception", "default": "Exception", "pattern": "^[A-Za-z]{2,40}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Required. A human-readable description of the error, explaining why the request was rejected or could not be completed.
", "example": "One or more validation errors occurred.", "default": "One or more validation errors occurred.", "pattern": "^.{1,500}$" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "Optional. The Monoova error code associated with the failure. Quote this value when contacting support.
", "example": "ValidationError", "default": "ValidationError", "pattern": "^[A-Za-z0-9_.-]{1,50}$" }, { "name": "traceLogId", "kind": "optional", "type": "string", "description": "Optional. The unique identifier of the trace log entry for this request. Quote this value when contacting Monoova support.
", "example": "a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809", "default": "a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809", "pattern": "^[A-Za-z0-9-]{1,64}$" } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized. The API key was missing, invalid, or is not permitted to access the requested mAccount.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "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": 42, "default": 42, "pattern": "^[0-9]{1,7}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "Required. The status code of the request. A value other than ''Ok'' indicates that an error occurred.
", "example": "Exception", "default": "Exception", "pattern": "^[A-Za-z]{2,40}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Required. A human-readable description of the error, explaining why the request was rejected or could not be completed.
", "example": "One or more validation errors occurred.", "default": "One or more validation errors occurred.", "pattern": "^.{1,500}$" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "Optional. The Monoova error code associated with the failure. Quote this value when contacting support.
", "example": "ValidationError", "default": "ValidationError", "pattern": "^[A-Za-z0-9_.-]{1,50}$" }, { "name": "traceLogId", "kind": "optional", "type": "string", "description": "Optional. The unique identifier of the trace log entry for this request. Quote this value when contacting Monoova support.
", "example": "a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809", "default": "a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809", "pattern": "^[A-Za-z0-9-]{1,64}$" } ], "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 or contact Monoova support quoting the traceLogId.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "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": 42, "default": 42, "pattern": "^[0-9]{1,7}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "Required. The status code of the request. A value other than ''Ok'' indicates that an error occurred.
", "example": "Exception", "default": "Exception", "pattern": "^[A-Za-z]{2,40}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Required. A human-readable description of the error, explaining why the request was rejected or could not be completed.
", "example": "One or more validation errors occurred.", "default": "One or more validation errors occurred.", "pattern": "^.{1,500}$" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "Optional. The Monoova error code associated with the failure. Quote this value when contacting support.
", "example": "ValidationError", "default": "ValidationError", "pattern": "^[A-Za-z0-9_.-]{1,50}$" }, { "name": "traceLogId", "kind": "optional", "type": "string", "description": "Optional. The unique identifier of the trace log entry for this request. Quote this value when contacting Monoova support.
", "example": "a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809", "default": "a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809", "pattern": "^[A-Za-z0-9-]{1,64}$" } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "7uWo-iz8Og_JwroSIB6xt", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.mpay.com.au/mAccount/v1/financials/{childCardNumber} \\\n --header 'accept: application/json'" }, { "id": "qTRuGnFNxfhk283Qc4Y1H", "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/mAccount/v1/financials/{childCardNumber}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "8flXNahPHd7AwCz-j0fPg", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/mAccount/v1/financials/{childCardNumber}\")\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": "dIrW80_83NT9JXvvlFueR", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/mAccount/v1/financials/{childCardNumber}\"\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": "7uWo-iz8Og_JwroSIB6xt" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Successful validation. The mAccount financials were returned.\n{\n \"financials\": {\n \"accountNumber\": \"4212800000000001\",\n \"actualBalance\": 1750.5,\n \"creditLimit\": 5000,\n \"availableToDebit\": 6750.5,\n \"availableToCredit\": 25000,\n \"lowerCreditLimit\": 0,\n \"upperCreditLimit\": 10000,\n \"minimumSettlementAmount\": 100,\n \"settlementFrequency\": \"Daily\",\n \"clearedFundsOnly\": \"false\",\n \"isChildAccount\": \"true\",\n \"isParentAccount\": \"false\",\n \"isFeeAccount\": \"false\",\n \"isParentClearedFunds\": \"false\",\n \"hasSeparateFeeAccount\": \"true\",\n \"feeAccountActualBalance\": 320.75,\n \"clearedFundsAccountFinancials\": {\n \"availableBalance\": 1500,\n \"unclearedFunds\": 250.5,\n \"uniqueReferencesWaitingToClear\": [\n \"INV-100234\"\n ]\n },\n \"feeAccountNumber\": \"4212800000000099\",\n \"nppBalance\": 1750.5,\n \"nppPayoutLimit\": 20000,\n \"iftiNppBalance\": 500,\n \"iftiNppPayoutLimit\": 10000,\n \"directDebitBalance\": 1250,\n \"directDebitLimit\": 15000\n },\n \"durationMs\": 105,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "response-1-400", "language": "400", "code": "// Bad request. The request could not be processed because one or more fields failed validation, were malformed, or were missing.\n{\n \"durationMs\": 42,\n \"status\": \"Exception\",\n \"statusDescription\": \"One or more validation errors occurred.\",\n \"errorCode\": \"ValidationError\",\n \"traceLogId\": \"a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809\"\n}" }, { "id": "response-2-401", "language": "401", "code": "// Unauthorized. The API key was missing, invalid, or is not permitted to access the requested mAccount.\n{\n \"durationMs\": 42,\n \"status\": \"Exception\",\n \"statusDescription\": \"One or more validation errors occurred.\",\n \"errorCode\": \"ValidationError\",\n \"traceLogId\": \"a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809\"\n}" }, { "id": "response-3-500", "language": "500", "code": "// Internal server error. An unexpected condition prevented the Platform from completing the request. Retry the request or contact Monoova support quoting the traceLogId.\n{\n \"durationMs\": 42,\n \"status\": \"Exception\",\n \"statusDescription\": \"One or more validation errors occurred.\",\n \"errorCode\": \"ValidationError\",\n \"traceLogId\": \"a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809\"\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }