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

Path Parameters

datestringrequired
Example
20200918000000
Description
The start date and time of the report, in yyyyMMddHHmmss format. This becomes the start date of the report if the report is being fetched for a date range. Where endDate is not supplied, the report returns the rejected transactions for the day specified.
Default
20200918000000
Pattern
^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])([01]\d|2[0-3])[0-5]\d[0-5]\d$

Query Parameters

endDatestring
Example
20200918235959
Description
Optional. The end date and time of the report, in yyyyMMddHHmmss format. Use this to fetch the report for a date range that starts at date. If not supplied, the report returns the rejected transactions for the day specified in date.
Default
20200918235959
Pattern
^\d{4}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])([01]\d|2[0-3])[0-5]\d[0-5]\d$
transactionTypestring
Example
NPP
Description
Optional. Filters the report by transaction type. Possible values: DE (Direct Entry) or NPP. If not supplied, both Direct Entry and NPP rejected transactions are returned.
Default
NPP
Pattern
^(DE|NPP)$
pageNumberstring
Example
1
Description
Optional. The page of the report to return. If not provided, it is defaulted to 1.
Default
1
Pattern
^[1-9]\d{0,8}$
pageSizestring
Example
50
Description
Optional. The number of rejected transactions to return per page. If not provided, the page size is defaulted to 50. The maximum allowed is 200.
Default
50
Pattern
^([1-9]|[1-9]\d|1\d{2}|200)$

Header Parameters

acceptstring
Description
Generated from available response content types
Default
text/csv
Allowed
text/csvapplication/json

Responses

200

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

400

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

badRequestResponse_V2
Example
```
{
  "durationMs": 4,
  "status": "Error",
  "statusDescription": "The date supplied is invalid. Provide the date in yyyyMMddHHmmss format, for example 20200918000000."
}
```
Description
Returned when one or more request parameters failed validation.
- durationMsinteger<int64>
  Example
  4
  Description
  The total time, in milliseconds, that the Platform took to process the request before the validation failure was returned.
  Default
  4
  Format
  int64
  Pattern
  ^\d{1,10}$
- statusstring
  Example
  Error
  Description
  The status of the request. A code of Error indicates that the request failed validation and no report was generated.
  Default
  Error
  Pattern
  ^[A-Za-z]{2,50}$
- statusDescriptionstring
  Example
  The date supplied is invalid. Provide the date in yyyyMMddHHmmss format, for example 20200918000000.
  Description
  A description of the validation failure, for example a date or endDate that is not in yyyyMMddHHmmss format.
  Default
  The date supplied is invalid. Provide the date in yyyyMMddHHmmss format, for example 20200918000000.
  Pattern
  ^.{1,500}$

401

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

unauthorisedResponse_V2
Example
```
{
  "durationMs": 2,
  "status": "Unauthorized",
  "statusDescription": "Authentication failed. Supply a valid API key as the basic authentication username."
}
```
Description
Returned when the request could not be authenticated.
- durationMsinteger<int64>
  Example
  2
  Description
  The total time, in milliseconds, that the Platform took to process the request before the authentication failure was returned.
  Default
  2
  Format
  int64
  Pattern
  ^\d{1,10}$
- statusstring
  Example
  Unauthorized
  Description
  The status of the request. A code of Unauthorized indicates that the credentials supplied were not accepted.
  Default
  Unauthorized
  Pattern
  ^[A-Za-z]{2,50}$
- statusDescriptionstring
  Example
  Authentication failed. Supply a valid API key as the basic authentication username.
  Description
  A description of the authentication failure. Check that a valid API key has been supplied as the basic authentication username and that no password has been set.
  Default
  Authentication failed. Supply a valid API key as the basic authentication username.
  Pattern
  ^.{1,500}$

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

internalServerErrorResponse_V2
Example
```
{
  "durationMs": 118,
  "status": "Error",
  "statusDescription": "An unexpected error occurred while processing the request. Please try again later."
}
```
Description
Returned when an unexpected error prevents the Platform from generating the report.
- durationMsinteger<int64>
  Example
  118
  Description
  The total time, in milliseconds, that the Platform took to process the request before the error was returned.
  Default
  118
  Format
  int64
  Pattern
  ^\d{1,10}$
- statusstring
  Example
  Error
  Description
  The status of the request. A code of Error indicates that the request could not be completed and should be retried.
  Default
  Error
  Pattern
  ^[A-Za-z]{2,50}$
- statusDescriptionstring
  Example
  An unexpected error occurred while processing the request. Please try again later.
  Description
  A description of the error. Retry the request and contact Monoova support if the error persists.
  Default
  An unexpected error occurred while processing the request. Please try again later.
  Pattern
  ^.{1,500}$

curl

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'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "text/csv");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.mpay.com.au/receivables/v2/rejectedTransactions/{date}?endDate=20200918235959&transactionType=NPP&pageNumber=1&pageSize=50", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.mpay.com.au/receivables/v2/rejectedTransactions/{date}?endDate=20200918235959&transactionType=NPP&pageNumber=1&pageSize=50")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "text/csv"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.mpay.com.au/receivables/v2/rejectedTransactions/{date}?endDate=20200918235959&transactionType=NPP&pageNumber=1&pageSize=50"

payload = {}
headers = {
   'accept': 'text/csv',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful 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.

400

// Bad request. One or more parameters failed validation, for example a date or endDate that is not in yyyyMMddHHmmss format.
{
  "durationMs": 4,
  "status": "Error",
  "statusDescription": "The date supplied is invalid. Provide the date in yyyyMMddHHmmss format, for example 20200918000000."
}

401

// Unauthorised. 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.
{
  "durationMs": 2,
  "status": "Unauthorized",
  "statusDescription": "Authentication failed. Supply a valid API key as the basic authentication username."
}

500

// Internal server error. An unexpected error prevented the Platform from generating the report. Retry the request and contact Monoova support if the error persists.
{
  "durationMs": 118,
  "status": "Error",
  "statusDescription": "An unexpected error occurred while processing the request. Please try again later."
}