Get Transactions by mAccount

POST

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

This API returns transaction details for an mAccount.

Body Parameters

bodymAccountTransactionRequestDetailsrequired
Description
Request body used to select and page the transactions returned for an mAccount.
- accountNumberstring
  Example
  4212800000000001
  Description
  Required. The 16-digit account number that uniquely identifies the mAccount whose transactions are being retrieved.
  Default
  4212800000000001
  Pattern
  ^[0-9]{16}$
- startDatestring
  Example
  2018-07-11T00:00:00
  Description
  Conditional. The start date of the reporting period, in ISO 8601 date-time format such as ''2018-07-11T00:00
  ''. 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 reporting period, in ISO 8601 date-time format such as ''2018-08-11T00:00
  ''. 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}$
- skipinteger
  Description
  Optional. The number of transactions to skip before the first record is returned. Use together with take to page through large result sets.
  Default
  0
  Pattern
  ^[0-9]{1,7}$
- takeinteger
  Example
  100
  Description
  Optional. The maximum number of transactions to return in a single response. Use together with skip to page through large result sets.
  Default
  100
  Pattern
  ^[0-9]{1,4}$
- descendingstring
  Example
  false
  Description
  Optional. Set to ''true'' to sort the returned transaction list in descending order. Accepted values are ''true'' and ''false''. Defaults to ''false''.
  Default
  false
  Pattern
  ^(true|false)$
- useTimestring
  Example
  false
  Description
  Optional. Set to ''true'' to apply the time component of startDate and endDate when frequency is set to ''Custom''. Accepted values are ''true'' and ''false''. Defaults to ''false''.
  Default
  false
  Pattern
  ^(true|false)$
- frequencystring
  Example
  Custom
  Description
  Required. The fixed selection type that determines the reporting period. Accepted values are ''Today'', ''ThisMonth'', ''LastMonth'' and ''Custom''. A maximum of 1 month can be retrieved through frequency = ''Custom''.
  Default
  Custom
  Pattern
  ^(Today|ThisMonth|LastMonth|Custom)$

Responses

200Successful validation. The transaction list was returned.

mAccountTransactionsResponse_V1
Description
Response returned by the Get Transactions by mAccount endpoint.
- openingBalancenumber
  Example
  1500
  Description
  Optional. The balance of the mAccount at the start of the selected reporting period, in Australian dollars.
  Default
  1500
  Pattern
  ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
- closingBalancenumber
  Example
  1750.5
  Description
  Optional. The balance of the mAccount at the end of the selected reporting period, in Australian dollars.
  Default
  1750.5
  Pattern
  ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
- totalDebitsnumber
  Example
  249.5
  Description
  Optional. The sum of all debit amounts within the selected reporting period, in Australian dollars.
  Default
  249.5
  Pattern
  ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
- totalCreditsnumber
  Example
  500
  Description
  Optional. The sum of all credit amounts within the selected reporting period, in Australian dollars.
  Default
  500
  Pattern
  ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
- itemsmAccountTransactionLineItem[]
  Description
  Optional. The list of transaction line items that fall within the selected reporting period.
  - rowOrderinteger
    Example
    1
    Description
    Optional. The position of this transaction within the returned result set, starting at 1.
    Default
    1
    Pattern
    ^[0-9]{1,7}$
  - mPaymentsIdinteger
    Example
    987654
    Description
    Optional. The unique identifier of the payment in the Monoova payments system.
    Default
    987654
    Pattern
    ^[0-9]{1,12}$
  - transactionIdinteger
    Example
    123456
    Description
    Optional. The unique identifier of the transaction.
    Default
    123456
    Pattern
    ^[0-9]{1,12}$
  - dateTimestring
    Example
    2018-07-12T09:30:00
    Description
    Optional. The date and time the transaction was recorded, in ISO 8601 date-time format. The default timezone is Sydney local time.
    Default
    2018-07-12T09:30:00
    Pattern
    ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$
  - mWalletAccountNumberstring
    Example
    4212800000000001
    Description
    Optional. The 16-digit account number of the mAccount the transaction was recorded against.
    Default
    4212800000000001
    Pattern
    ^[0-9]{16}$
  - subTransactionTypestring
    Example
    DirectCredit
    Description
    Optional. The sub-type of the transaction, such as ''DirectCredit'', ''DirectDebit'', ''NPP'' or ''Fee''.
    Default
    DirectCredit
    Pattern
    ^[A-Za-z ]{1,50}$
  - transactionTypestring
    Example
    Credit
    Description
    Optional. The type of the transaction, such as ''Credit'', ''Debit'' or ''Transfer''.
    Default
    Credit
    Pattern
    ^[A-Za-z ]{1,50}$
  - transactionDescriptionstring
    Example
    Inbound direct credit
    Description
    Optional. The system-generated description of the transaction type.
    Default
    Inbound direct credit
    Pattern
    ^.{0,200}$
  - creditnumber
    Example
    500
    Description
    Optional. The amount credited to the mAccount by this transaction, in Australian dollars. Returns 0 for debit transactions.
    Default
    500
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - debitnumber
    Description
    Optional. The amount debited from the mAccount by this transaction, in Australian dollars. Returns 0 for credit transactions.
    Default
    0
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - runningBalancenumber
    Example
    1750.5
    Description
    Optional. The balance of the mAccount in Australian dollars immediately after this transaction was applied.
    Default
    1750.5
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - descriptionstring
    Example
    Payment for invoice 100234
    Description
    Optional. The free-text description supplied with the transaction by the originator.
    Default
    Payment for invoice 100234
    Pattern
    ^.{0,200}$
  - isWaitingForFundsToClearstring
    Example
    false
    Description
    Optional. Indicates whether the funds for this transaction are still waiting to clear. Accepted values are ''true'' and ''false''.
    Default
    false
    Pattern
    ^(true|false)$
  - uniqueReferencestring
    Example
    INV-100234
    Description
    Optional. The unique reference supplied with the transaction, used to reconcile the payment.
    Default
    INV-100234
    Pattern
    ^[A-Za-z0-9 _.-]{1,50}$
  - sourceMAccountCardNumberstring
    Example
    4212800000000002
    Description
    Conditional. The 16-digit account number of the mAccount the funds were transferred from. Returned only for transfers between mAccounts.
    Default
    4212800000000002
    Pattern
    ^[0-9]{16}$
  - destinationMAccountCardNumberstring
    Example
    4212800000000001
    Description
    Conditional. The 16-digit account number of the mAccount the funds were transferred to. Returned only for transfers between mAccounts.
    Default
    4212800000000001
    Pattern
    ^[0-9]{16}$
- durationMsinteger
  Example
  260
  Description
  Optional. The total time in milliseconds that the Platform took to process the request.
  Default
  260
  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/transactions \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "accountNumber": "4212800000000001",
     "startDate": "2018-07-11T00:00:00",
     "endDate": "2018-08-11T00:00:00",
     "take": 100,
     "descending": "false",
     "useTime": "false",
     "frequency": "Custom"
     }'

javascript

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

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

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

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

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",
   "startDate": "2018-07-11T00:00:00",
   "endDate": "2018-08-11T00:00:00",
   "take": 100,
   "descending": "false",
   "useTime": "false",
   "frequency": "Custom"
})

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

python

import requests
import json

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

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

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

print(response.text)

200

// Successful validation. The transaction list was returned.
{
  "openingBalance": 1500,
  "closingBalance": 1750.5,
  "totalDebits": 249.5,
  "totalCredits": 500,
  "items": [
    {
      "rowOrder": 1,
      "mPaymentsId": 987654,
      "transactionId": 123456,
      "dateTime": "2018-07-12T09:30:00",
      "mWalletAccountNumber": "4212800000000001",
      "subTransactionType": "DirectCredit",
      "transactionType": "Credit",
      "transactionDescription": "Inbound direct credit",
      "credit": 500,
      "debit": 0,
      "runningBalance": 1750.5,
      "description": "Payment for invoice 100234",
      "isWaitingForFundsToClear": "false",
      "uniqueReference": "INV-100234",
      "sourceMAccountCardNumber": "4212800000000002",
      "destinationMAccountCardNumber": "4212800000000001"
    }
  ],
  "durationMs": 260,
  "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"
}