Returns a report of inbound direct debit activity for the requested date. The 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": "2026-08-24", "description": "Required. Date format should be 'yyyy-MM-dd'. The date for which inbound direct debit activity is reported.
", "default": "2026-08-24", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } ], "headerParameters": [], "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": "200 OK. Successful validation. The report was generated and returned.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Inbound Direct Debit Report response.", "customType": "cruInboundDirectDebitReportResponse_V2", "schema": [ { "name": "directDebitDetails", "kind": "optional", "type": "array", "description": "Direct debit details. Each item is one comma separated report row for an inbound direct debit.", "example": "[\"DD00012345,410000123,2026-08-24,75.50,Membership fee\"]", "default": [ "DD00012345,410000123,2026-08-24,75.50,Membership fee" ], "itemType": "string", "customType": "string[]", "itemExample": "DD00012345,410000123,2026-08-24,75.50,Membership fee", "itemDefault": "DD00012345,410000123,2026-08-24,75.50,Membership fee" }, { "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/cruInboundDirectDebitReportResponse_V2", "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": "UphwZjCdye_l8TcqO85OQ", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.mpay.com.au/receivables/v2/inboundDirectDebitReport/{date} \\\n --header 'accept: application/json'" }, { "id": "xtp3WHmurM831lsvtvPsi", "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/receivables/v2/inboundDirectDebitReport/{date}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "CJiud42Gzj33cVgSx2Tic", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/receivables/v2/inboundDirectDebitReport/{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": "wRwB4eZ9TEko3U6dw8R6h", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/receivables/v2/inboundDirectDebitReport/{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": "UphwZjCdye_l8TcqO85OQ" }, "results": { "languages": [ { "id": "tLKwXjEPrmsq990nqXIjn", "language": "200", "code": "// 200 OK. Successful validation. The report was generated and returned.\n{\n \"directDebitDetails\": [\n \"DD00012345,410000123,2026-08-24,75.50,Membership fee\"\n ],\n \"durationMs\": 125,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "HRwWv8OYxSdP8PsghvMnv", "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": "khHm2elgeyTOh1yjyeLHp", "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": "IvyRiBWdkYyd4sQGwZDu5", "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": "tLKwXjEPrmsq990nqXIjn" } }, "children": [ { "text": "" } ] }