Required. The 16-digit account number that uniquely identifies the mAccount the statement is generated for.
", "example": "4212800000000001", "default": "4212800000000001", "pattern": "^[0-9]{16}$" }, { "name": "frequency", "kind": "optional", "type": "string", "description": "Required. The fixed selection type that determines the period covered by the statement. Accepted values are ''All'', ''Today'', ''ThisMonth'', ''LastMonth'', ''ThisFinancialYear'', ''LastFinancialYear'' and ''Custom''.
", "example": "Custom", "default": "Custom", "pattern": "^(All|Today|ThisMonth|LastMonth|ThisFinancialYear|LastFinancialYear|Custom)$" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "Conditional. The start date of the statement, in ISO 8601 date-time format. Note that the timezone is suppressed and the default timezone is Sydney local time. Required when frequency is set to ''Custom''.
", "example": "2018-07-11T00:00:00", "default": "2018-07-11T00:00:00", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "Conditional. The end date of the statement, in ISO 8601 date-time format. Note that the timezone is suppressed and the default timezone is Sydney local time. Required when frequency is set to ''Custom''.
", "example": "2018-08-11T00:00:00", "default": "2018-08-11T00:00:00", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$" } ], "modelRef": "#/components/schemas/mAccountSelectionFilter", "isExpanded": true } ], "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 statement was queued for delivery.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Response returned by the Send a Statement endpoint.", "customType": "mAccountSendStatementResponse_V1", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "Optional. The total time in milliseconds that the Platform took to process the request.
", "example": 340, "default": 340, "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/mAccountSendStatementResponse_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": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.mpay.com.au/mAccount/v1/sendStatement \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"accountNumber\": \"4212800000000001\",\n \"frequency\": \"Custom\",\n \"startDate\": \"2018-07-11T00:00:00\",\n \"endDate\": \"2018-08-11T00:00:00\"\n }'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"accountNumber\": \"4212800000000001\",\n \"frequency\": \"Custom\",\n \"startDate\": \"2018-07-11T00:00:00\",\n \"endDate\": \"2018-08-11T00:00:00\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.mpay.com.au/mAccount/v1/sendStatement\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/mAccount/v1/sendStatement\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"accountNumber\": \"4212800000000001\",\n \"frequency\": \"Custom\",\n \"startDate\": \"2018-07-11T00:00:00\",\n \"endDate\": \"2018-08-11T00:00:00\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/mAccount/v1/sendStatement\"\n\npayload = json.dumps({\n \"accountNumber\": \"4212800000000001\",\n \"frequency\": \"Custom\",\n \"startDate\": \"2018-07-11T00:00:00\",\n \"endDate\": \"2018-08-11T00:00:00\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Successful validation. The statement was queued for delivery.\n{\n \"durationMs\": 340,\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": "" } ] }