PayTo Receivables Report

GET

https://api.mpay.com.au/paytoreceivables/v1/report/{date}

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.

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.

Report format: https://developer.monoova.com/receivables-reporting#report-format

datestringRequired. Format: 'yyyyMMddHHmmss'. This becomes the start date of the report if the report is being fetched for a date range.

endDatestringOptional. Format: 'yyyyMMddHHmmss'. Use this to fetch the report for a date range.

skipstringOptional. Number of records to skip. 0 is the first record.

takestringConditional. Number of records to take. Conditional upper limit: if endDate is provided the maximum take is 10000.

accountNumberstringOptional. Payee bank account number.

clientUniqueIdstringOptional. The unique identifier for the account.

payIdstringOptional. Email address for the PayID.

payIdNamestringOptional. Name displayed to the payers.

200200 OK. Successful validation. The report was generated and returned.

400400 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.

401401 Unauthorized. Authentication failed. The API key passed as the basic authentication username is missing, invalid, or not permitted to access reporting.

500500 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.

curl --request GET \
     --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' \
     --header 'accept: application/json'