Rejected Transactions Report

GET

https://api.mpay.com.au/receivables/v2/rejectedTransactions/{date}

Returns a report of all rejected transactions for the day with associated details. This includes Direct Entry (DE) and NPP receivables. If requested multiple times on the current date (calendar day, AEDT), the report is cumulative.

What this report returns

Each row is a receivables payment that was rejected, with the reason for the rejection and its status. For example, a payment from a source account that does not match a whitelist entry for the receiving Automatcher account is rejected with the reason Non Whitelisted Source Account.

The report is returned as comma-separated values (CSV). The first row holds the column headers, and each following row is one rejected transaction. Every column is described in the 200 response below.

Source account details (SourceBsb, SourceAccountNumber and SourceAccountName) do not appear by default. Please contact Monoova for further information.

Requesting the report

Supply date on its own to return the rejected transactions for that day.
Add endDate to return the rejected transactions for a date range that starts at date.
Add transactionType to return only DE or only NPP transactions.
Use pageNumber and pageSize to page through the results. Each page holds 50 transactions unless you set a different pageSize, up to a maximum of 200.

Field conventions

Request parameters marked Optional can be left out of the request. Every report column is always included in the report. Columns marked Optional are left blank where no value exists for the transaction, and columns marked Conditional are populated only where the stated condition is met, for example for NPP transactions only.

Possible transaction codes

Code	Transaction description
13	Externally initiated debit items
50	Externally initiated credit items, with the exception of those bearing transaction codes 51 to 57
51	Australian Government Security Interest
52	Family Allowance
53	Pay
54	Pension
55	Allotment
56	Dividend
57	Debenture/Note Interest

datestringThe start date and time of the report, in <code>yyyyMMddHHmmss</code> format. This becomes the start date of the report if the report is being fetched for a date range. Where <code>endDate</code> is not supplied, the report returns the rejected transactions for the day specified.

endDatestringOptional. The end date and time of the report, in <code>yyyyMMddHHmmss</code> format. Use this to fetch the report for a date range that starts at <code>date</code>. If not supplied, the report returns the rejected transactions for the day specified in <code>date</code>.

transactionTypestringOptional. Filters the report by transaction type. Possible values: <code>DE</code> (Direct Entry) or <code>NPP</code>. If not supplied, both Direct Entry and NPP rejected transactions are returned.

pageNumberstringOptional. The page of the report to return. If not provided, it is defaulted to 1.

pageSizestringOptional. The number of rejected transactions to return per page. If not provided, the page size is defaulted to 50. The maximum allowed is 200.

acceptstringGenerated from available response content types

200Successful validation. The rejected transactions report was generated and is returned as comma-separated values (CSV): a header row followed by one row per rejected transaction. The schema below describes each column, in the order the columns appear.

400Bad request. One or more parameters failed validation, for example a <code>date</code> or <code>endDate</code> that is not in <code>yyyyMMddHHmmss</code> format.

401Unauthorised. The API key supplied as the basic authentication username is missing or invalid. In the live environment, the Sign-In Account is locked for one hour after five failed authentication attempts.

500Internal server error. An unexpected error prevented the Platform from generating the report. Retry the request and contact Monoova support if the error persists.

curl --request GET \
     --url 'https://api.mpay.com.au/receivables/v2/rejectedTransactions/{date}?endDate=20200918235959&transactionType=NPP&pageNumber=1&pageSize=50' \
     --header 'accept: text/csv'