---
title: Get Account Status By BankAccount
slug: api/get-account-status-by-bankaccount
docTags:
createdAt: 2026-10-20T23:26:28.693Z
---
{
"id": "3EoPlE09O4ZI4PoaSukvZ",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://api.mpay.com.au/receivables/v1/statusByBankAccount/{bankAccountNumber}",
"servers": [
{
"url": "https://api.mpay.com.au/receivables/v1/statusByBankAccount/{bankAccountNumber}",
"description": "Production"
},
{
"url": "https://api.m-pay.com.au/receivables/v1/statusByBankAccount/{bankAccountNumber}",
"description": "Sandbox"
}
],
"name": "Get Account Status By BankAccount",
"description": "This API is used for checking the status of a bank account using the bank account number. This API will only return statuses for virtual accounts belonging to the parent mAccount.",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "bankAccountNumber",
"type": "string",
"example": "123456789",
"description": "Required. The account number of the virtual account whose status you want to retrieve. Must belong to the parent mAccount you are authenticated as.",
"default": "123456789",
"minLength": 9,
"maxLength": 9,
"pattern": "^[0-9]{9}$"
}
],
"headerParameters": [],
"queryParameters": [
{
"kind": "optional",
"name": "bsb",
"type": "string",
"example": "012-345",
"description": "Optional. The BSB number corresponding to the account. Supply it to disambiguate when the same account number exists under more than one BSB. If omitted, the default BSB registered against your mAccount is used.
",
"default": "012-345",
"minLength": 6,
"maxLength": 7,
"pattern": "^[0-9]{3}-?[0-9]{3}$"
}
],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "basicAuth",
"name": "basicAuth",
"kind": "optional",
"type": "http",
"description": "To authenticate using basic authentication, generate an API key and pass it as the username. No password is required.
",
"scheme": "basic"
}
],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "successful validation",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"bsb\":\"012-345\",\"bankAccountNumber\":\"123456789\",\"bankAccountName\":\"Acme Pty Ltd\",\"clientUniqueId\":\"93bf57eb1e2c42cf8101509b4356741e\",\"isActive\":true,\"durationMs\":42,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\"}",
"description": "The current details and status of a single virtual account.",
"customType": "cuscalStatusResponse_V1",
"schema": [
{
"name": "bsb",
"kind": "optional",
"type": "string",
"description": "The BSB number corresponding to the account. Always returned.",
"example": "012-345",
"default": "012-345",
"minLength": 6,
"maxLength": 7,
"pattern": "^[0-9]{3}-?[0-9]{3}$"
},
{
"name": "bankAccountNumber",
"kind": "optional",
"type": "string",
"description": "The account number of the virtual account. Always returned.",
"example": "123456789",
"default": "123456789",
"minLength": 9,
"maxLength": 9,
"pattern": "^[0-9]{9}$"
},
{
"name": "bankAccountName",
"kind": "optional",
"type": "string",
"description": "The name of the virtual account. This will be defaulted to your registered Trading Name. Up to 32 characters: letters, numbers, spaces and the symbols & ' ( ) + , - . /.
",
"example": "Acme Pty Ltd",
"default": "Acme Pty Ltd",
"minLength": 1,
"maxLength": 32,
"pattern": "^[A-Za-z0-9 &'()+,./\\-]{1,32}$"
},
{
"name": "clientUniqueId",
"kind": "optional",
"type": "string",
"description": "The identifier assigned to the account when it was created. Where no value was supplied on creation, this is the value Monoova generated.
",
"example": "93bf57eb1e2c42cf8101509b4356741e",
"default": "93bf57eb1e2c42cf8101509b4356741e",
"minLength": 1,
"maxLength": 50,
"pattern": "^[A-Za-z0-9_-]{1,50}$"
},
{
"name": "isActive",
"kind": "optional",
"type": "boolean",
"nullable": true,
"description": "Conditional. Returned as null while the account is still being registered. Indicates whether the account is Active or Inactive. Inactive account numbers will return all payments made to that account number.
",
"example": true,
"default": true,
"pattern": "^(true|false)$"
},
{
"name": "durationMs",
"kind": "optional",
"type": "integer",
"description": "This value represents the total time in milliseconds that the Platform took to process the request.",
"example": 42,
"default": 42,
"format": "int64",
"minimum": 0,
"pattern": "^[0-9]+$"
},
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "This is the status of the request. A code of Ok indicates no errors.
",
"example": "Ok",
"default": "Ok",
"pattern": "^(Ok|Error)$"
},
{
"name": "statusDescription",
"kind": "optional",
"type": "string",
"description": "This is a description of the status. If an Ok status is returned, then this will be Operation completed successfully.
",
"example": "Operation completed successfully",
"default": "Operation completed successfully",
"minLength": 1,
"maxLength": 255,
"pattern": "^.{1,255}$"
}
],
"modelRef": "#/components/schemas/cuscalStatusResponse_V1",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "Bad Request — the request was malformed or contained invalid parameters.
",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"status\":\"Error\",\"statusDescription\":\"One or more validation errors occurred\",\"errorCode\":\"InvalidBankAccountNumber\",\"errorMessage\":\"The supplied bankAccountNumber is not a valid Automatcher account number for this mAccount.\",\"durationMs\":12}",
"description": "Returned for 400, 401 and 500 responses. errorCode and errorMessage identify the specific failure.
",
"customType": "errorResponse_V1",
"schema": [
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "This is the status of the request. A code of Error indicates the request was not processed.
",
"example": "Error",
"default": "Error",
"pattern": "^(Ok|Error)$"
},
{
"name": "statusDescription",
"kind": "optional",
"type": "string",
"description": "This is a short description of the status.",
"example": "One or more validation errors occurred",
"default": "One or more validation errors occurred",
"minLength": 1,
"maxLength": 255,
"pattern": "^.{1,255}$"
},
{
"name": "errorCode",
"kind": "optional",
"type": "string",
"description": "Conditional. Returned when the Platform can attribute the failure to a specific condition. A machine-readable code identifying the error.
",
"example": "InvalidBankAccountNumber",
"default": "InvalidBankAccountNumber",
"minLength": 1,
"maxLength": 50,
"pattern": "^[A-Za-z0-9_.-]{1,50}$"
},
{
"name": "errorMessage",
"kind": "optional",
"type": "string",
"description": "Conditional. Returned alongside errorCode. A human-readable explanation of the error, including the field at fault where one can be identified.
",
"example": "The supplied bankAccountNumber is not a valid Automatcher account number for this mAccount.",
"default": "The supplied bankAccountNumber is not a valid Automatcher account number for this mAccount.",
"minLength": 1,
"maxLength": 500,
"pattern": "^.{1,500}$"
},
{
"name": "durationMs",
"kind": "optional",
"type": "integer",
"description": "This value represents the total time in milliseconds that the Platform took to process the request.",
"example": 12,
"default": 12,
"format": "int64",
"minimum": 0,
"pattern": "^[0-9]+$"
}
],
"modelRef": "#/components/schemas/errorResponse_V1",
"isExpanded": true
}
]
},
{
"statusCode": "401",
"description": "Unauthorized — authentication failed, or the API key was missing or invalid.
",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"status\":\"Error\",\"statusDescription\":\"Authentication failed\",\"errorCode\":\"Unauthorized\",\"errorMessage\":\"The API key is missing or invalid. Pass your API key as the basic authentication username.\",\"durationMs\":8}",
"description": "Returned for 400, 401 and 500 responses. errorCode and errorMessage identify the specific failure.
",
"customType": "errorResponse_V1",
"schema": [
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "This is the status of the request. A code of Error indicates the request was not processed.
",
"example": "Error",
"default": "Error",
"pattern": "^(Ok|Error)$"
},
{
"name": "statusDescription",
"kind": "optional",
"type": "string",
"description": "This is a short description of the status.",
"example": "One or more validation errors occurred",
"default": "One or more validation errors occurred",
"minLength": 1,
"maxLength": 255,
"pattern": "^.{1,255}$"
},
{
"name": "errorCode",
"kind": "optional",
"type": "string",
"description": "Conditional. Returned when the Platform can attribute the failure to a specific condition. A machine-readable code identifying the error.
",
"example": "InvalidBankAccountNumber",
"default": "InvalidBankAccountNumber",
"minLength": 1,
"maxLength": 50,
"pattern": "^[A-Za-z0-9_.-]{1,50}$"
},
{
"name": "errorMessage",
"kind": "optional",
"type": "string",
"description": "Conditional. Returned alongside errorCode. A human-readable explanation of the error, including the field at fault where one can be identified.
",
"example": "The supplied bankAccountNumber is not a valid Automatcher account number for this mAccount.",
"default": "The supplied bankAccountNumber is not a valid Automatcher account number for this mAccount.",
"minLength": 1,
"maxLength": 500,
"pattern": "^.{1,500}$"
},
{
"name": "durationMs",
"kind": "optional",
"type": "integer",
"description": "This value represents the total time in milliseconds that the Platform took to process the request.",
"example": 12,
"default": 12,
"format": "int64",
"minimum": 0,
"pattern": "^[0-9]+$"
}
],
"modelRef": "#/components/schemas/errorResponse_V1",
"isExpanded": true
}
]
},
{
"statusCode": "500",
"description": "Internal Server Error — an unexpected error occurred while processing the request.
",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"status\":\"Error\",\"statusDescription\":\"An unexpected error occurred\",\"errorCode\":\"InternalServerError\",\"errorMessage\":\"An unexpected error occurred while processing the request. Please retry, and contact support@monoova.com if the problem persists.\",\"durationMs\":30}",
"description": "Returned for 400, 401 and 500 responses. errorCode and errorMessage identify the specific failure.
",
"customType": "errorResponse_V1",
"schema": [
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "This is the status of the request. A code of Error indicates the request was not processed.
",
"example": "Error",
"default": "Error",
"pattern": "^(Ok|Error)$"
},
{
"name": "statusDescription",
"kind": "optional",
"type": "string",
"description": "This is a short description of the status.",
"example": "One or more validation errors occurred",
"default": "One or more validation errors occurred",
"minLength": 1,
"maxLength": 255,
"pattern": "^.{1,255}$"
},
{
"name": "errorCode",
"kind": "optional",
"type": "string",
"description": "Conditional. Returned when the Platform can attribute the failure to a specific condition. A machine-readable code identifying the error.
",
"example": "InvalidBankAccountNumber",
"default": "InvalidBankAccountNumber",
"minLength": 1,
"maxLength": 50,
"pattern": "^[A-Za-z0-9_.-]{1,50}$"
},
{
"name": "errorMessage",
"kind": "optional",
"type": "string",
"description": "Conditional. Returned alongside errorCode. A human-readable explanation of the error, including the field at fault where one can be identified.
",
"example": "The supplied bankAccountNumber is not a valid Automatcher account number for this mAccount.",
"default": "The supplied bankAccountNumber is not a valid Automatcher account number for this mAccount.",
"minLength": 1,
"maxLength": 500,
"pattern": "^.{1,500}$"
},
{
"name": "durationMs",
"kind": "optional",
"type": "integer",
"description": "This value represents the total time in milliseconds that the Platform took to process the request.",
"example": 12,
"default": 12,
"format": "int64",
"minimum": 0,
"pattern": "^[0-9]+$"
}
],
"modelRef": "#/components/schemas/errorResponse_V1",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "elHroUNU8fIW3E_EKifFr",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url 'https://api.mpay.com.au/receivables/v1/statusByBankAccount/{bankAccountNumber}?bsb=012-345' \\\n --header 'accept: application/json'"
},
{
"id": "wEDJ1ms-l7wjFTo-piQzt",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.mpay.com.au/receivables/v1/statusByBankAccount/{bankAccountNumber}?bsb=012-345\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "tfKULmm4NLPqemqTNTlWC",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/receivables/v1/statusByBankAccount/{bankAccountNumber}?bsb=012-345\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "yIUP5ldIoHh0uCaOfl3Pk",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/receivables/v1/statusByBankAccount/{bankAccountNumber}?bsb=012-345\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "elHroUNU8fIW3E_EKifFr"
},
"results": {
"languages": [
{
"id": "umuGmPVOBHDlG8WvcVZd8",
"language": "200",
"code": "// successful validation\n{\n \"bsb\": \"012-345\",\n \"bankAccountNumber\": \"123456789\",\n \"bankAccountName\": \"Acme Pty Ltd\",\n \"clientUniqueId\": \"93bf57eb1e2c42cf8101509b4356741e\",\n \"isActive\": true,\n \"durationMs\": 42,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}"
},
{
"id": "62a7Y8bmEAwReKekeDDvY",
"language": "400",
"code": "// Bad Request — the request was malformed or contained invalid parameters.\n{\n \"status\": \"Error\",\n \"statusDescription\": \"One or more validation errors occurred\",\n \"errorCode\": \"InvalidBankAccountNumber\",\n \"errorMessage\": \"The supplied bankAccountNumber is not a valid Automatcher account number for this mAccount.\",\n \"durationMs\": 12\n}"
},
{
"id": "41mSqR38OGyVhxUXktrc0",
"language": "401",
"code": "// Unauthorized — authentication failed, or the API key was missing or invalid.\n{\n \"status\": \"Error\",\n \"statusDescription\": \"One or more validation errors occurred\",\n \"errorCode\": \"InvalidBankAccountNumber\",\n \"errorMessage\": \"The supplied bankAccountNumber is not a valid Automatcher account number for this mAccount.\",\n \"durationMs\": 12\n}"
},
{
"id": "CHD-KwP-f87OUTMMXIy-v",
"language": "500",
"code": "// Internal Server Error — an unexpected error occurred while processing the request.\n{\n \"status\": \"Error\",\n \"statusDescription\": \"One or more validation errors occurred\",\n \"errorCode\": \"InvalidBankAccountNumber\",\n \"errorMessage\": \"The supplied bankAccountNumber is not a valid Automatcher account number for this mAccount.\",\n \"durationMs\": 12\n}"
}
],
"selectedLanguageId": "umuGmPVOBHDlG8WvcVZd8"
}
},
"children": [
{
"text": ""
}
]
}