Send a Statement

POST

https://api.mpay.com.au/mAccount/v1/sendStatement

This API generates a detailed PDF statement for delivery via email.

Body Parameters

bodymAccountSelectionFilterrequired
Description
Request body used to select the mAccount and period covered by a statement.
- accountNumberstring
  Example
  4212800000000001
  Description
  Required. The 16-digit account number that uniquely identifies the mAccount the statement is generated for.
  Default
  4212800000000001
  Pattern
  ^[0-9]{16}$
- frequencystring
  Example
  Custom
  Description
  Required. The fixed selection type that determines the period covered by the statement. Accepted values are ''All'', ''Today'', ''ThisMonth'', ''LastMonth'', ''ThisFinancialYear'', ''LastFinancialYear'' and ''Custom''.
  Default
  Custom
  Pattern
  ^(All|Today|ThisMonth|LastMonth|ThisFinancialYear|LastFinancialYear|Custom)$
- startDatestring
  Example
  2018-07-11T00:00:00
  Description
  Conditional. The start date of the statement, in ISO 8601 date-time format. Note that the timezone is suppressed and the default timezone is Sydney local time. Required when frequency is set to ''Custom''.
  Default
  2018-07-11T00:00:00
  Pattern
  ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$
- endDatestring
  Example
  2018-08-11T00:00:00
  Description
  Conditional. The end date of the statement, in ISO 8601 date-time format. Note that the timezone is suppressed and the default timezone is Sydney local time. Required when frequency is set to ''Custom''.
  Default
  2018-08-11T00:00:00
  Pattern
  ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$

Responses

200Successful validation. The statement was queued for delivery.

mAccountSendStatementResponse_V1
Description
Response returned by the Send a Statement endpoint.
- durationMsinteger
  Example
  340
  Description
  Optional. The total time in milliseconds that the Platform took to process the request.
  Default
  340
  Pattern
  ^[0-9]{1,7}$
- statusstring
  Example
  Ok
  Description
  Required. The status of the request. A code of ''Ok'' indicates no errors.
  Default
  Ok
  Pattern
  ^[A-Za-z]{2,40}$
- statusDescriptionstring
  Example
  Operation completed successfully
  Description
  Required. A description of the status. If an ''Ok'' status is returned, then this will be ''Operation completed successfully''.
  Default
  Operation completed successfully
  Pattern
  ^.{1,500}$

400

Bad request. The request could not be processed because one or more fields failed validation, were malformed, or were missing.

errorResponse
Description
Standard error payload returned for 400, 401 and 500 responses.
- durationMsinteger
  Example
  42
  Description
  Optional. The total time in milliseconds that the Platform took to process the request before the error was returned.
  Default
  42
  Pattern
  ^[0-9]{1,7}$
- statusstring
  Example
  Exception
  Description
  Required. The status code of the request. A value other than ''Ok'' indicates that an error occurred.
  Default
  Exception
  Pattern
  ^[A-Za-z]{2,40}$
- statusDescriptionstring
  Example
  One or more validation errors occurred.
  Description
  Required. A human-readable description of the error, explaining why the request was rejected or could not be completed.
  Default
  One or more validation errors occurred.
  Pattern
  ^.{1,500}$
- errorCodestring
  Example
  ValidationError
  Description
  Optional. The Monoova error code associated with the failure. Quote this value when contacting support.
  Default
  ValidationError
  Pattern
  ^[A-Za-z0-9_.-]{1,50}$
- traceLogIdstring
  Example
  a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809
  Description
  Optional. The unique identifier of the trace log entry for this request. Quote this value when contacting Monoova support.
  Default
  a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809
  Pattern
  ^[A-Za-z0-9-]{1,64}$

401

Unauthorized. The API key was missing, invalid, or is not permitted to access the requested mAccount.

errorResponse
Description
Standard error payload returned for 400, 401 and 500 responses.
- durationMsinteger
  Example
  42
  Description
  Optional. The total time in milliseconds that the Platform took to process the request before the error was returned.
  Default
  42
  Pattern
  ^[0-9]{1,7}$
- statusstring
  Example
  Exception
  Description
  Required. The status code of the request. A value other than ''Ok'' indicates that an error occurred.
  Default
  Exception
  Pattern
  ^[A-Za-z]{2,40}$
- statusDescriptionstring
  Example
  One or more validation errors occurred.
  Description
  Required. A human-readable description of the error, explaining why the request was rejected or could not be completed.
  Default
  One or more validation errors occurred.
  Pattern
  ^.{1,500}$
- errorCodestring
  Example
  ValidationError
  Description
  Optional. The Monoova error code associated with the failure. Quote this value when contacting support.
  Default
  ValidationError
  Pattern
  ^[A-Za-z0-9_.-]{1,50}$
- traceLogIdstring
  Example
  a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809
  Description
  Optional. The unique identifier of the trace log entry for this request. Quote this value when contacting Monoova support.
  Default
  a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809
  Pattern
  ^[A-Za-z0-9-]{1,64}$

500Internal server error. An unexpected condition prevented the Platform from completing the request. Retry the request or contact Monoova support quoting the traceLogId.

errorResponse
Description
Standard error payload returned for 400, 401 and 500 responses.
- durationMsinteger
  Example
  42
  Description
  Optional. The total time in milliseconds that the Platform took to process the request before the error was returned.
  Default
  42
  Pattern
  ^[0-9]{1,7}$
- statusstring
  Example
  Exception
  Description
  Required. The status code of the request. A value other than ''Ok'' indicates that an error occurred.
  Default
  Exception
  Pattern
  ^[A-Za-z]{2,40}$
- statusDescriptionstring
  Example
  One or more validation errors occurred.
  Description
  Required. A human-readable description of the error, explaining why the request was rejected or could not be completed.
  Default
  One or more validation errors occurred.
  Pattern
  ^.{1,500}$
- errorCodestring
  Example
  ValidationError
  Description
  Optional. The Monoova error code associated with the failure. Quote this value when contacting support.
  Default
  ValidationError
  Pattern
  ^[A-Za-z0-9_.-]{1,50}$
- traceLogIdstring
  Example
  a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809
  Description
  Optional. The unique identifier of the trace log entry for this request. Quote this value when contacting Monoova support.
  Default
  a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809
  Pattern
  ^[A-Za-z0-9-]{1,64}$

curl

curl --request POST \
     --url https://api.mpay.com.au/mAccount/v1/sendStatement \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "accountNumber": "4212800000000001",
     "frequency": "Custom",
     "startDate": "2018-07-11T00:00:00",
     "endDate": "2018-08-11T00:00:00"
     }'

javascript

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

var raw = JSON.stringify({
   "accountNumber": "4212800000000001",
   "frequency": "Custom",
   "startDate": "2018-07-11T00:00:00",
   "endDate": "2018-08-11T00:00:00"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.mpay.com.au/mAccount/v1/sendStatement", 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/mAccount/v1/sendStatement")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "accountNumber": "4212800000000001",
   "frequency": "Custom",
   "startDate": "2018-07-11T00:00:00",
   "endDate": "2018-08-11T00:00:00"
})

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

python

import requests
import json

url = "https://api.mpay.com.au/mAccount/v1/sendStatement"

payload = json.dumps({
   "accountNumber": "4212800000000001",
   "frequency": "Custom",
   "startDate": "2018-07-11T00:00:00",
   "endDate": "2018-08-11T00:00:00"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// Successful validation. The statement was queued for delivery.
{
  "durationMs": 340,
  "status": "Ok",
  "statusDescription": "Operation completed successfully"
}

400

// Bad request. The request could not be processed because one or more fields failed validation, were malformed, or were missing.
{
  "durationMs": 42,
  "status": "Exception",
  "statusDescription": "One or more validation errors occurred.",
  "errorCode": "ValidationError",
  "traceLogId": "a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809"
}

401

// Unauthorized. The API key was missing, invalid, or is not permitted to access the requested mAccount.
{
  "durationMs": 42,
  "status": "Exception",
  "statusDescription": "One or more validation errors occurred.",
  "errorCode": "ValidationError",
  "traceLogId": "a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809"
}

500

// Internal server error. An unexpected condition prevented the Platform from completing the request. Retry the request or contact Monoova support quoting the traceLogId.
{
  "durationMs": 42,
  "status": "Exception",
  "statusDescription": "One or more validation errors occurred.",
  "errorCode": "ValidationError",
  "traceLogId": "a1b2c3d4-5e6f-7081-92a3-b4c5d6e7f809"
}