Get mAccount Balance

GET

https://api.mpay.com.au/mAccount/v1/financials/{childCardNumber}

This API will return the current financials for an mAccount.

Path Parameters

childCardNumberstringrequired
Example
4212800000000001
Description
Required. The 16-digit account number that uniquely identifies the mAccount whose balance is being retrieved.
Default
4212800000000001
Pattern
^[0-9]{16}$

Responses

200Successful validation. The mAccount financials were returned.

mAccountGetFinancialsResponse_V1
Description
Response returned by the Get mAccount Balance endpoint.
- financialsmAccountFinancials
  Description
  Optional. The current balances, limits and settlement configuration of an mAccount, including balances and limits. Returned by Get mAccount Balance.
  - accountNumberstring
    Example
    4212800000000001
    Description
    Required. The 16-digit account number that uniquely identifies the mAccount these financials belong to.
    Default
    4212800000000001
    Pattern
    ^[0-9]{16}$
  - actualBalancenumber
    Example
    1750.5
    Description
    Optional. The actual ledger balance of the mAccount in Australian dollars, including funds that have not yet cleared.
    Default
    1750.5
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - creditLimitnumber
    Example
    5000
    Description
    Optional. The credit limit currently applied to the mAccount in Australian dollars.
    Default
    5000
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - availableToDebitnumber
    Example
    6750.5
    Description
    Optional. The amount in Australian dollars that is currently available to be debited from the mAccount.
    Default
    6750.5
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - availableToCreditnumber
    Example
    25000
    Description
    Optional. The amount in Australian dollars that is currently available to be credited to the mAccount.
    Default
    25000
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - lowerCreditLimitnumber
    Description
    Optional. The lower bound of the credit limit range permitted for the mAccount in Australian dollars.
    Default
    0
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - upperCreditLimitnumber
    Example
    10000
    Description
    Optional. The upper bound of the credit limit range permitted for the mAccount in Australian dollars.
    Default
    10000
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - minimumSettlementAmountnumber
    Example
    100
    Description
    Optional. The minimum balance in Australian dollars that must be reached before a settlement is generated for the mAccount.
    Default
    100
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - settlementFrequencystring
    Example
    Daily
    Description
    Optional. How often settlements are generated for the mAccount. Typical values are ''Daily'', ''Weekly'', ''Monthly'' and ''Never''.
    Default
    Daily
    Pattern
    ^(Daily|Weekly|Monthly|Never)$
  - clearedFundsOnlystring
    Example
    false
    Description
    Optional. Indicates whether only cleared funds may be paid out of the mAccount. Accepted values are ''true'' and ''false''.
    Default
    false
    Pattern
    ^(true|false)$
  - isChildAccountstring
    Example
    true
    Description
    Optional. Indicates whether the mAccount is a child of a parent mAccount. Accepted values are ''true'' and ''false''.
    Default
    true
    Pattern
    ^(true|false)$
  - isParentAccountstring
    Example
    false
    Description
    Optional. Indicates whether the mAccount is a parent that has child mAccounts beneath it. Accepted values are ''true'' and ''false''.
    Default
    false
    Pattern
    ^(true|false)$
  - isFeeAccountstring
    Example
    false
    Description
    Optional. Indicates whether the mAccount is used to collect fees for other mAccounts. Accepted values are ''true'' and ''false''.
    Default
    false
    Pattern
    ^(true|false)$
  - isParentClearedFundsstring
    Example
    false
    Description
    Optional. Indicates whether the parent mAccount enforces a cleared funds restriction. Accepted values are ''true'', ''false'' and null when the mAccount has no parent.
    Default
    false
    Pattern
    ^(true|false)$
  - hasSeparateFeeAccountstring
    Example
    true
    Description
    Optional. Indicates whether fees for the mAccount are charged to a separate fee mAccount. Accepted values are ''true'' and ''false''.
    Default
    true
    Pattern
    ^(true|false)$
  - feeAccountActualBalancenumber
    Example
    320.75
    Description
    Conditional. The actual balance of the separate fee mAccount in Australian dollars. Returned only when hasSeparateFeeAccount is ''true''.
    Default
    320.75
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - clearedFundsAccountFinancialsmAccountClearedFundsAccount
    Description
    Conditional. The cleared and uncleared funds position of an mAccount. Returned only when clearedFundsOnly is ''true''.
    - availableBalancenumber
      Example
      1500
      Description
      Optional. The balance in Australian dollars that has cleared and is available for use.
      Default
      1500
      Pattern
      ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
    - unclearedFundsnumber
      Example
      250.5
      Description
      Optional. The amount in Australian dollars that has been received but has not yet cleared.
      Default
      250.5
      Pattern
      ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
    - uniqueReferencesWaitingToClearstring[]
      Example
      [ "INV-100234", "INV-100235" ]
      Description
      Optional. The list of unique payment references for funds that have been received but have not yet cleared.
      Default
      INV-100234,INV-100235
  - feeAccountNumberstring
    Example
    4212800000000099
    Description
    Conditional. The 16-digit account number of the separate fee mAccount. Returned only when hasSeparateFeeAccount is ''true''.
    Default
    4212800000000099
    Pattern
    ^[0-9]{16}$
  - nppBalancenumber
    Example
    1750.5
    Description
    Optional. The balance in Australian dollars currently available for New Payments Platform (NPP) payouts.
    Default
    1750.5
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - nppPayoutLimitnumber
    Example
    20000
    Description
    Optional. The maximum amount in Australian dollars that may be paid out via the New Payments Platform (NPP).
    Default
    20000
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - iftiNppBalancenumber
    Example
    500
    Description
    Optional. The balance in Australian dollars currently available for International Funds Transfer Instruction (IFTI) NPP payouts.
    Default
    500
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - iftiNppPayoutLimitnumber
    Example
    10000
    Description
    Optional. The maximum amount in Australian dollars that may be paid out via IFTI NPP payments.
    Default
    10000
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - directDebitBalancenumber
    Example
    1250
    Description
    Optional. The balance in Australian dollars currently available for direct debit transactions.
    Default
    1250
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
  - directDebitLimitnumber
    Example
    15000
    Description
    Optional. The maximum amount in Australian dollars that may be collected by direct debit.
    Default
    15000
    Pattern
    ^-?[0-9]{1,13}(\.[0-9]{1,2})?$
- durationMsinteger
  Example
  105
  Description
  Optional. The total time in milliseconds that the Platform took to process the request.
  Default
  105
  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 GET \
     --url https://api.mpay.com.au/mAccount/v1/financials/{childCardNumber} \
     --header 'accept: application/json'

javascript

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

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

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

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

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

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

python

import requests
import json

url = "https://api.mpay.com.au/mAccount/v1/financials/{childCardNumber}"

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

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

print(response.text)

200

// Successful validation. The mAccount financials were returned.
{
  "financials": {
    "accountNumber": "4212800000000001",
    "actualBalance": 1750.5,
    "creditLimit": 5000,
    "availableToDebit": 6750.5,
    "availableToCredit": 25000,
    "lowerCreditLimit": 0,
    "upperCreditLimit": 10000,
    "minimumSettlementAmount": 100,
    "settlementFrequency": "Daily",
    "clearedFundsOnly": "false",
    "isChildAccount": "true",
    "isParentAccount": "false",
    "isFeeAccount": "false",
    "isParentClearedFunds": "false",
    "hasSeparateFeeAccount": "true",
    "feeAccountActualBalance": 320.75,
    "clearedFundsAccountFinancials": {
      "availableBalance": 1500,
      "unclearedFunds": 250.5,
      "uniqueReferencesWaitingToClear": [
        "INV-100234"
      ]
    },
    "feeAccountNumber": "4212800000000099",
    "nppBalance": 1750.5,
    "nppPayoutLimit": 20000,
    "iftiNppBalance": 500,
    "iftiNppPayoutLimit": 10000,
    "directDebitBalance": 1250,
    "directDebitLimit": 15000
  },
  "durationMs": 105,
  "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"
}