Returns a report of PayTo transactions for the day with associated details. If requested multiple times on the current date (calendar day, AEDT), the report is cumulative. E.g. if, on the same day, a report is requested at 10am and another one at 1pm, the report at 1pm will contain all the transactions already contained in the 10am report, in addition to any new transactions. PayTo transactions may arrive at anytime, we recommend subscribing to a webhook to receive new transaction notifications.
\nThe report is an application/octet-stream, columns are comma separated. Where a comma (,) or double quote (\") is present in any of the below fields, the field will be encased in double quotes and/or escaped as per RFC4180.
\nReport format: https://developer.monoova.com/receivables-reporting#report-format
", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "date", "type": "string", "example": "20260824000000", "description": "Required. Format: 'yyyyMMddHHmmss'. This becomes the start date of the report if the report is being fetched for a date range.
", "default": "20260824000000", "pattern": "^\\d{14}$" } ], "headerParameters": [], "queryParameters": [ { "kind": "optional", "name": "endDate", "type": "string", "example": "20260824235959", "description": "Optional. Format: 'yyyyMMddHHmmss'. Use this to fetch the report for a date range.
", "default": "20260824235959", "pattern": "^\\d{14}$" }, { "kind": "optional", "name": "skip", "type": "string", "example": "0", "description": "Optional. Number of records to skip. 0 is the first record.
", "default": "0", "pattern": "^\\d{1,9}$" }, { "kind": "optional", "name": "take", "type": "string", "example": "1000", "description": "Conditional. Number of records to take. Conditional upper limit: if endDate is provided the maximum take is 10000.
", "default": "1000", "pattern": "^\\d{1,5}$" }, { "kind": "optional", "name": "accountNumber", "type": "string", "example": "410000123", "description": "Optional. Payee bank account number.
", "default": "410000123", "pattern": "^[0-9]{1,34}$" }, { "kind": "optional", "name": "clientUniqueId", "type": "string", "example": "CUID-000123", "description": "Optional. The unique identifier for the account.
", "default": "CUID-000123", "pattern": "^[A-Za-z0-9_\\-\\.]{1,50}$" }, { "kind": "optional", "name": "payId", "type": "string", "example": "payments@yourcompany.com.au", "description": "Optional. Email address for the PayID.
", "default": "payments@yourcompany.com.au", "pattern": "^[^@\\s]+@[^@\\s]+\\.[A-Za-z]{2,}$" }, { "kind": "optional", "name": "payIdName", "type": "string", "example": "Your Company Pty Ltd", "description": "Optional. Name displayed to the payers.
", "default": "Your Company Pty Ltd", "pattern": "^[A-Za-z0-9 .,'&\\-]{1,140}$" } ], "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": "200 OK. Successful validation. The report was generated and returned.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "PayTo Receivables Report response.", "customType": "payToReportResponse_V1", "schema": [ { "name": "ndeFileDetails", "kind": "optional", "type": "array", "description": "NDE file details. Each item is one comma separated report row for a received PayTo transaction.", "example": "[\"TR22345678,410000123,20260824101500,250.00,PayTo Agreement 55\"]", "default": [ "TR22345678,410000123,20260824101500,250.00,PayTo Agreement 55" ], "itemType": "string", "customType": "string[]", "itemExample": "TR22345678,410000123,20260824101500,250.00,PayTo Agreement 55", "itemDefault": "TR22345678,410000123,20260824101500,250.00,PayTo Agreement 55" }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request.", "example": 125, "default": 125, "pattern": "^\\d{1,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]{2,40}$" }, { "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": "^.{1,500}$" } ], "modelRef": "#/components/schemas/payToReportResponse_V1", "isExpanded": true } ] }, { "statusCode": "400", "description": "400 Bad Request. The request could not be processed because one or more supplied values are missing or incorrectly formatted, for example a date that does not match the required format.
", "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": "This value represents the total time in milliseconds that the Platform took to process the request before the error was returned.", "example": 12, "default": 12, "pattern": "^\\d{1,9}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "Status code of the failed request, for example 'BadRequest', 'Unauthorized' or 'InternalServerError'.
", "example": "BadRequest", "default": "BadRequest", "pattern": "^[A-Za-z]{2,40}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Human readable description of why the request failed. Quote this value when contacting Monoova support.", "example": "The date supplied is not in the required format.", "default": "The date supplied is not in the required format.", "pattern": "^.{1,500}$" }, { "name": "errors", "kind": "optional", "type": "array", "description": "Optional. One or more field level error messages. Present when the Platform can attribute the failure to specific request values; omitted otherwise.
", "example": "[\"date: value must match the format 'yyyy-MM-dd'.\"]", "default": [ "date: value must match the format 'yyyy-MM-dd'." ], "itemType": "string", "customType": "string[]", "itemExample": "date: value must match the format 'yyyy-MM-dd'.", "itemDefault": "date: value must match the format 'yyyy-MM-dd'." } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "401 Unauthorized. Authentication failed. The API key passed as the basic authentication username is missing, invalid, or not permitted to access reporting.
", "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": "This value represents the total time in milliseconds that the Platform took to process the request before the error was returned.", "example": 12, "default": 12, "pattern": "^\\d{1,9}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "Status code of the failed request, for example 'BadRequest', 'Unauthorized' or 'InternalServerError'.
", "example": "BadRequest", "default": "BadRequest", "pattern": "^[A-Za-z]{2,40}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Human readable description of why the request failed. Quote this value when contacting Monoova support.", "example": "The date supplied is not in the required format.", "default": "The date supplied is not in the required format.", "pattern": "^.{1,500}$" }, { "name": "errors", "kind": "optional", "type": "array", "description": "Optional. One or more field level error messages. Present when the Platform can attribute the failure to specific request values; omitted otherwise.
", "example": "[\"date: value must match the format 'yyyy-MM-dd'.\"]", "default": [ "date: value must match the format 'yyyy-MM-dd'." ], "itemType": "string", "customType": "string[]", "itemExample": "date: value must match the format 'yyyy-MM-dd'.", "itemDefault": "date: value must match the format 'yyyy-MM-dd'." } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] }, { "statusCode": "500", "description": "500 Internal Server Error. An unexpected error occurred while generating the report. Retry the request; if the error persists contact Monoova support quoting the status description.
", "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": "This value represents the total time in milliseconds that the Platform took to process the request before the error was returned.", "example": 12, "default": 12, "pattern": "^\\d{1,9}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "Status code of the failed request, for example 'BadRequest', 'Unauthorized' or 'InternalServerError'.
", "example": "BadRequest", "default": "BadRequest", "pattern": "^[A-Za-z]{2,40}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Human readable description of why the request failed. Quote this value when contacting Monoova support.", "example": "The date supplied is not in the required format.", "default": "The date supplied is not in the required format.", "pattern": "^.{1,500}$" }, { "name": "errors", "kind": "optional", "type": "array", "description": "Optional. One or more field level error messages. Present when the Platform can attribute the failure to specific request values; omitted otherwise.
", "example": "[\"date: value must match the format 'yyyy-MM-dd'.\"]", "default": [ "date: value must match the format 'yyyy-MM-dd'." ], "itemType": "string", "customType": "string[]", "itemExample": "date: value must match the format 'yyyy-MM-dd'.", "itemDefault": "date: value must match the format 'yyyy-MM-dd'." } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "LoWt3LQrmIczAZzEfimLO", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.mpay.com.au/paytoreceivables/v1/report/{date}?endDate=20260824235959&skip=0&take=1000&accountNumber=410000123&clientUniqueId=CUID-000123&payId=payments%40yourcompany.com.au&payIdName=Your%20Company%20Pty%20Ltd' \\\n --header 'accept: application/json'" }, { "id": "q7zw9upx1fvap0Udzrpts", "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/paytoreceivables/v1/report/{date}?endDate=20260824235959&skip=0&take=1000&accountNumber=410000123&clientUniqueId=CUID-000123&payId=payments@yourcompany.com.au&payIdName=Your Company Pty Ltd\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "iuqGY0fnfp8lpRYQhIKtQ", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/paytoreceivables/v1/report/{date}?endDate=20260824235959&skip=0&take=1000&accountNumber=410000123&clientUniqueId=CUID-000123&payId=payments@yourcompany.com.au&payIdName=Your Company Pty Ltd\")\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": "nA-dl_MdzexWIo-vdG9JJ", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/paytoreceivables/v1/report/{date}?endDate=20260824235959&skip=0&take=1000&accountNumber=410000123&clientUniqueId=CUID-000123&payId=payments@yourcompany.com.au&payIdName=Your Company Pty Ltd\"\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": "LoWt3LQrmIczAZzEfimLO" }, "results": { "languages": [ { "id": "WEmD5DQCXlg3pXrBDn-L7", "language": "200", "code": "// 200 OK. Successful validation. The report was generated and returned.\n{\n \"ndeFileDetails\": [\n \"TR22345678,410000123,20260824101500,250.00,PayTo Agreement 55\"\n ],\n \"durationMs\": 125,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "8oeDADlQ28DCXyD5pNYjm", "language": "400", "code": "// 400 Bad Request. The request could not be processed because one or more supplied values are missing or incorrectly formatted, for example a date that does not match the required format.\n{\n \"durationMs\": 12,\n \"status\": \"BadRequest\",\n \"statusDescription\": \"The date supplied is not in the required format.\",\n \"errors\": [\n \"date: value must match the format 'yyyy-MM-dd'.\"\n ]\n}" }, { "id": "aIU9gbkZhRzgFq75VH3Eu", "language": "401", "code": "// 401 Unauthorized. Authentication failed. The API key passed as the basic authentication username is missing, invalid, or not permitted to access reporting.\n{\n \"durationMs\": 12,\n \"status\": \"BadRequest\",\n \"statusDescription\": \"The date supplied is not in the required format.\",\n \"errors\": [\n \"date: value must match the format 'yyyy-MM-dd'.\"\n ]\n}" }, { "id": "ntiHnxd3Gd2FtrFv8J47Y", "language": "500", "code": "// 500 Internal Server Error. An unexpected error occurred while generating the report. Retry the request; if the error persists contact Monoova support quoting the status description.\n{\n \"durationMs\": 12,\n \"status\": \"BadRequest\",\n \"statusDescription\": \"The date supplied is not in the required format.\",\n \"errors\": [\n \"date: value must match the format 'yyyy-MM-dd'.\"\n ]\n}" } ], "selectedLanguageId": "WEmD5DQCXlg3pXrBDn-L7" } }, "children": [ { "text": "" } ] }