Optional. The number of records that were requested.
", "default": "10", "pattern": "^[0-9]+$" } ], "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 response. The wallet's BPAY history was returned.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "bPayHistoryResponse_V1", "schema": [ { "name": "history", "kind": "optional", "type": "array", "description": "The array of BPAY history items, sorted by the count property descending.
", "modelRef": "#/components/schemas/bPayHistoryItemClass", "customType": "bPayHistoryItemClass[]", "schema": [ { "name": "billerCode", "kind": "optional", "type": "string", "description": "The BPAY biller code the payments were made to.", "example": "123456", "default": "123456", "pattern": "^[0-9]+$" }, { "name": "customerReferenceNumber", "kind": "optional", "type": "string", "description": "The BPAY Customer Reference Number (CRN) used for the payments.
", "example": "987654321", "default": "987654321", "pattern": "^[0-9]+$" }, { "name": "billerName", "kind": "optional", "type": "string", "description": "The registered name of the BPAY biller.", "example": "Example Biller Pty Ltd", "default": "Example Biller Pty Ltd", "pattern": "^.+$" }, { "name": "count", "kind": "optional", "type": "integer", "description": "The number of BPAY payments made to this biller and CRN combination in the wallet's history.", "example": 5, "default": 5, "pattern": "^[0-9]+$" } ] }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request.", "example": 42, "default": 42, "pattern": "^[0-9]+$" }, { "name": "status", "kind": "optional", "type": "string", "description": "This is the status of the request. A code of 'Ok' indicates no errors.", "example": "Ok", "default": "Ok", "pattern": "^[A-Za-z]+$" }, { "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": "Operation completed successfully", "default": "Operation completed successfully", "pattern": "^.+$" } ], "modelRef": "#/components/schemas/bPayHistoryResponse_V1", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request. The request was malformed or contained invalid parameters.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "The standard error envelope returned when a request cannot be completed.", "customType": "errorResponse_V1", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "The status code indicating the type of error that occurred.", "example": "Error", "default": "Error", "pattern": "^[A-Za-z]+$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "A human-readable description of the error that occurred.
", "example": "The request could not be processed.", "default": "The request could not be processed.", "pattern": "^.+$" }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request.", "example": 42, "default": 42, "pattern": "^[0-9]+$" } ], "modelRef": "#/components/schemas/errorResponse_V1", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized. Authentication failed because the API key was missing or invalid.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "The standard error envelope returned when a request cannot be completed.", "customType": "errorResponse_V1", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "The status code indicating the type of error that occurred.", "example": "Error", "default": "Error", "pattern": "^[A-Za-z]+$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "A human-readable description of the error that occurred.
", "example": "The request could not be processed.", "default": "The request could not be processed.", "pattern": "^.+$" }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request.", "example": 42, "default": 42, "pattern": "^[0-9]+$" } ], "modelRef": "#/components/schemas/errorResponse_V1", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal Server Error. An unexpected error occurred while processing the request.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "The standard error envelope returned when a request cannot be completed.", "customType": "errorResponse_V1", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "The status code indicating the type of error that occurred.", "example": "Error", "default": "Error", "pattern": "^[A-Za-z]+$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "A human-readable description of the error that occurred.
", "example": "The request could not be processed.", "default": "The request could not be processed.", "pattern": "^.+$" }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request.", "example": 42, "default": 42, "pattern": "^[0-9]+$" } ], "modelRef": "#/components/schemas/errorResponse_V1", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "ghxpEPJOOUIE-Kgxeaz_K", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.mpay.com.au/bpay/v1/history/{accountNumber}?take=10' \\\n --header 'accept: application/json'" }, { "id": "lf03l1sxkv8hTfDuJ2a0t", "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/bpay/v1/history/{accountNumber}?take=10\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "QGiaUc8AMepCkHcnd6KX7", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/bpay/v1/history/{accountNumber}?take=10\")\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": "zC5jjM5k4aVLF3SCYf1Cb", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/bpay/v1/history/{accountNumber}?take=10\"\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": "ghxpEPJOOUIE-Kgxeaz_K" }, "results": { "languages": [ { "id": "vGtYm6B0npO5WALFvjsDV", "language": "200", "code": "// Successful response. The wallet's BPAY history was returned.\n{\n \"history\": [\n {\n \"billerCode\": \"123456\",\n \"customerReferenceNumber\": \"987654321\",\n \"billerName\": \"Example Biller Pty Ltd\",\n \"count\": 5\n }\n ],\n \"durationMs\": 42,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "7JX777fsvqGn8u-AUAU0l", "language": "400", "code": "// Bad Request. The request was malformed or contained invalid parameters.\n{\n \"status\": \"Error\",\n \"statusDescription\": \"The request could not be processed.\",\n \"durationMs\": 42\n}" }, { "id": "RDn6JwS09QZjNxLG_dWsy", "language": "401", "code": "// Unauthorized. Authentication failed because the API key was missing or invalid.\n{\n \"status\": \"Error\",\n \"statusDescription\": \"The request could not be processed.\",\n \"durationMs\": 42\n}" }, { "id": "IcOOqz3FuFe11Gnk8FsCI", "language": "500", "code": "// Internal Server Error. An unexpected error occurred while processing the request.\n{\n \"status\": \"Error\",\n \"statusDescription\": \"The request could not be processed.\",\n \"durationMs\": 42\n}" } ], "selectedLanguageId": "vGtYm6B0npO5WALFvjsDV" } }, "children": [ { "text": "" } ] }