--- title: List Whitelist Source Accounts slug: api/list-whitelist-source-accounts docTags: createdAt: 2026-10-19T00:29:59.016Z --- { "id": "YVQexTynjhNYCoczRnLBD", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.mpay.com.au/receivables/v1/whitelisting/list/{automatcherBankAccountNumber}", "servers": [ { "url": "https://api.mpay.com.au/receivables/v1/whitelisting/list/{automatcherBankAccountNumber}", "description": "Production URL" }, { "url": "https://api.m-pay.com.au/receivables/v1/whitelisting/list/{automatcherBankAccountNumber}", "description": "Sandbox URL" } ], "name": "List Whitelist Source Accounts", "description": "This endpoint will list all whitelisted source account details linked to the queried Automatcher account number.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "automatcherBankAccountNumber", "type": "string", "example": "300000123", "description": "

Valid receivables bank account number belonging to the Sign-in mAccount. This is the Automatcher account whose whitelist entries are returned.

", "default": "300000123", "pattern": "^[0-9]{3,9}$" } ], "headerParameters": [], "queryParameters": [ { "kind": "optional", "name": "bsb", "type": "string", "example": "123-456", "description": "

Optional BSB parameter specifying the branch identifier for Australian banks. Accepts either 6 digits or with a hyphen as '999-999'. If not specified, the service will use the MAccount's configured 'Default BSB'. If a 'Default BSB' has not been configured, then the Monoova 'Default BSB' will be used.

", "default": "123-456", "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": "

200 Success. The request passed validation and the whitelist entry was created, updated or returned. Check the status and statusDescription fields for the outcome of the operation.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"automatcherBankAccountNumber\":\"300000123\",\"automatcherBsb\":\"123-456\",\"sourceAccount\":[{\"id\":10525,\"bsbNumber\":\"123-456\",\"accountNumber\":\"123456789\",\"accountName\":\"Sample Source Account\",\"accountStatus\":\"Enabled\"}],\"durationMs\":20,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\"}", "description": "", "customType": "cruWhiteListSourceAccountResponse_V1", "schema": [ { "name": "automatcherBankAccountNumber", "kind": "optional", "type": "string", "description": "

Valid receivables bank account number belonging to the Sign-in mAccount. Echoes the Automatcher account that the returned whitelist entries belong to.

", "example": "300000123", "default": "300000123", "pattern": "^[0-9]{3,9}$" }, { "name": "automatcherBsb", "kind": "optional", "type": "string", "description": "

Optional BSB parameter specifying the branch identifier for Australian banks. Accepts either 6 digits or with a hyphen as '999-999'. If not specified, the service will use the MAccount's configured 'Default BSB'. If a 'Default BSB' has not been configured, then the Monoova 'Default BSB' will be used.

", "example": "123-456", "default": "123-456", "pattern": "^[0-9]{3}-?[0-9]{3}$" }, { "name": "sourceAccount", "kind": "optional", "type": "array", "description": "

Collection of whitelisted source (paying) account entries held against the Automatcher account. An empty collection means no whitelist rules are currently configured.

", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "

Unique identifier of the whitelist source account entry, assigned by Monoova. Optional when creating an entry, as the id is generated by the service and returned in the response. Required when updating an entry so that the correct rule is amended. Use the list endpoint to retrieve the id of an existing entry.

", "example": 10525, "default": 10525, "format": "int64", "pattern": "^[0-9]{1,10}$" }, { "name": "bsbNumber", "kind": "optional", "type": "string", "description": "

Conditional 6 digits with a '-', specifying the branch identifier of the source (paying) account. At least one of BSB/AccountNumber or AccountName is required. When bsbNumber is supplied, accountNumber must also be supplied.

", "example": "123-456", "default": "123-456", "pattern": "^[0-9]{3}-[0-9]{3}$" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "

Conditional 3 to 9 digit bank account number of the source (paying) account. At least one of BSB/AccountNumber or AccountName is required. When accountNumber is supplied, bsbNumber must also be supplied.

", "example": "123456789", "default": "123456789", "pattern": "^[0-9]{3,9}$" }, { "name": "accountName", "kind": "optional", "type": "string", "description": "

Conditional Account name of the source (paying) account, matched against the remitter name on the inbound payment. At least one of BSB/AccountNumber or AccountName is required, so this field is required when a BSB and account number are not supplied.

", "example": "Sample Source Account", "default": "Sample Source Account", "pattern": "^[A-Za-z0-9 '&./-]{1,140}$" }, { "name": "accountStatus", "kind": "optional", "type": "string", "description": "

Account status; either Enabled or Disabled. Set the status to 'Enabled' to accept payments for the set of rules defined. Set it to 'Disabled' to stop applying the rule without removing it. The status can always be updated if the rule no longer applies, using the update endpoint.

", "example": "Enabled", "default": "Enabled", "pattern": "^(Enabled|Disabled)$" } ] }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "

Time taken by the service to process the request, in milliseconds.

", "example": 20, "default": 20, "format": "int32", "pattern": "^[0-9]{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "

Outcome of the request. Returns 'Ok' when the request was processed successfully, or 'Error' when the request could not be processed.

", "example": "Ok", "default": "Ok", "pattern": "^[A-Za-z]{2,30}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

Plain language description of the outcome of the request. Returns 'Operation completed successfully' when the request was processed successfully, otherwise describes the reason the request was not processed.

", "example": "Operation completed successfully", "default": "Operation completed successfully", "pattern": "^.{1,500}$" } ], "modelRef": "#/components/schemas/cruWhiteListSourceAccountResponse_V1", "isExpanded": true } ] }, { "statusCode": "400", "description": "

400 Bad Request. The request could not be processed because one or more fields failed validation, for example a malformed BSB, an account number outside the permitted length, or a request that supplies neither a BSB and account number nor an account name.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":15,\"status\":\"Error\",\"statusDescription\":\"The request failed validation. See the errors collection for details.\",\"errors\":[{\"code\":\"InvalidAccountNumber\",\"field\":\"sourceAccount.accountNumber\",\"message\":\"The account number must be between 3 and 9 digits.\"}]}", "description": "

Error envelope returned with the 400, 401 and 500 responses. The envelope repeats the durationMs, status and statusDescription fields of the success response and adds an errors collection describing each individual failure.

", "customType": "cruWhiteListSourceAccountErrorResponse_V1", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "

Time taken by the service to process the request, in milliseconds.

", "example": 15, "default": 15, "format": "int32", "pattern": "^[0-9]{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "Outcome of the request. Returns 'Error' when the request could not be processed.", "example": "Error", "default": "Error", "pattern": "^[A-Za-z]{2,30}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Plain language description of why the request was not processed. Quote this value when contacting Monoova support.", "example": "The request failed validation. See the errors collection for details.", "default": "The request failed validation. See the errors collection for details.", "pattern": "^.{1,500}$" }, { "name": "errors", "kind": "optional", "type": "array", "description": "Collection of the individual errors that caused the request to fail. One entry is returned per failed validation rule.", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "

Short machine readable code identifying the error, suitable for branching logic in your integration.

", "example": "InvalidAccountNumber", "default": "InvalidAccountNumber", "pattern": "^[A-Za-z0-9_.-]{1,50}$" }, { "name": "field", "kind": "optional", "type": "string", "description": "

Optional Name of the request field that caused the error, using dot notation for nested fields. Returned as an empty string when the error does not relate to a single field.

", "example": "sourceAccount.accountNumber", "default": "sourceAccount.accountNumber", "pattern": "^[A-Za-z0-9_.\\[\\]]{0,100}$" }, { "name": "message", "kind": "optional", "type": "string", "description": "Plain language description of the individual error and how to correct it.", "example": "The account number must be between 3 and 9 digits.", "default": "The account number must be between 3 and 9 digits.", "pattern": "^.{1,500}$" } ] } ], "modelRef": "#/components/schemas/cruWhiteListSourceAccountErrorResponse_V1", "isExpanded": true } ] }, { "statusCode": "401", "description": "

401 Unauthorized. Authentication failed. The API key was missing, malformed, expired, or is not permitted to access the whitelisting endpoints for the requested mAccount.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":5,\"status\":\"Error\",\"statusDescription\":\"Authentication failed.\",\"errors\":[{\"code\":\"Unauthorized\",\"field\":\"Authorization\",\"message\":\"The API key supplied as the basic authentication username is missing or invalid.\"}]}", "description": "

Error envelope returned with the 400, 401 and 500 responses. The envelope repeats the durationMs, status and statusDescription fields of the success response and adds an errors collection describing each individual failure.

", "customType": "cruWhiteListSourceAccountErrorResponse_V1", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "

Time taken by the service to process the request, in milliseconds.

", "example": 15, "default": 15, "format": "int32", "pattern": "^[0-9]{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "Outcome of the request. Returns 'Error' when the request could not be processed.", "example": "Error", "default": "Error", "pattern": "^[A-Za-z]{2,30}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Plain language description of why the request was not processed. Quote this value when contacting Monoova support.", "example": "The request failed validation. See the errors collection for details.", "default": "The request failed validation. See the errors collection for details.", "pattern": "^.{1,500}$" }, { "name": "errors", "kind": "optional", "type": "array", "description": "Collection of the individual errors that caused the request to fail. One entry is returned per failed validation rule.", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "

Short machine readable code identifying the error, suitable for branching logic in your integration.

", "example": "InvalidAccountNumber", "default": "InvalidAccountNumber", "pattern": "^[A-Za-z0-9_.-]{1,50}$" }, { "name": "field", "kind": "optional", "type": "string", "description": "

Optional Name of the request field that caused the error, using dot notation for nested fields. Returned as an empty string when the error does not relate to a single field.

", "example": "sourceAccount.accountNumber", "default": "sourceAccount.accountNumber", "pattern": "^[A-Za-z0-9_.\\[\\]]{0,100}$" }, { "name": "message", "kind": "optional", "type": "string", "description": "Plain language description of the individual error and how to correct it.", "example": "The account number must be between 3 and 9 digits.", "default": "The account number must be between 3 and 9 digits.", "pattern": "^.{1,500}$" } ] } ], "modelRef": "#/components/schemas/cruWhiteListSourceAccountErrorResponse_V1", "isExpanded": true } ] }, { "statusCode": "500", "description": "500 Internal Server Error. An unexpected error occurred while processing the request. The request was not completed and can be retried. Quote the statusDescription when contacting Monoova support.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":120,\"status\":\"Error\",\"statusDescription\":\"An unexpected error occurred while processing the request.\",\"errors\":[{\"code\":\"InternalServerError\",\"field\":\"\",\"message\":\"The request could not be completed. Please retry or contact Monoova support.\"}]}", "description": "

Error envelope returned with the 400, 401 and 500 responses. The envelope repeats the durationMs, status and statusDescription fields of the success response and adds an errors collection describing each individual failure.

", "customType": "cruWhiteListSourceAccountErrorResponse_V1", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "

Time taken by the service to process the request, in milliseconds.

", "example": 15, "default": 15, "format": "int32", "pattern": "^[0-9]{1,10}$" }, { "name": "status", "kind": "optional", "type": "string", "description": "Outcome of the request. Returns 'Error' when the request could not be processed.", "example": "Error", "default": "Error", "pattern": "^[A-Za-z]{2,30}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "Plain language description of why the request was not processed. Quote this value when contacting Monoova support.", "example": "The request failed validation. See the errors collection for details.", "default": "The request failed validation. See the errors collection for details.", "pattern": "^.{1,500}$" }, { "name": "errors", "kind": "optional", "type": "array", "description": "Collection of the individual errors that caused the request to fail. One entry is returned per failed validation rule.", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "

Short machine readable code identifying the error, suitable for branching logic in your integration.

", "example": "InvalidAccountNumber", "default": "InvalidAccountNumber", "pattern": "^[A-Za-z0-9_.-]{1,50}$" }, { "name": "field", "kind": "optional", "type": "string", "description": "

Optional Name of the request field that caused the error, using dot notation for nested fields. Returned as an empty string when the error does not relate to a single field.

", "example": "sourceAccount.accountNumber", "default": "sourceAccount.accountNumber", "pattern": "^[A-Za-z0-9_.\\[\\]]{0,100}$" }, { "name": "message", "kind": "optional", "type": "string", "description": "Plain language description of the individual error and how to correct it.", "example": "The account number must be between 3 and 9 digits.", "default": "The account number must be between 3 and 9 digits.", "pattern": "^.{1,500}$" } ] } ], "modelRef": "#/components/schemas/cruWhiteListSourceAccountErrorResponse_V1", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "0-lb-TedVQbjDTbvaTdUd", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.mpay.com.au/receivables/v1/whitelisting/list/{automatcherBankAccountNumber}?bsb=123-456' \\\n --header 'accept: application/json'" }, { "id": "t6PwYe44_8r3ORcErnQvd", "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/whitelisting/list/{automatcherBankAccountNumber}?bsb=123-456\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "tagG1oDMFU420rJmfLCQS", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/receivables/v1/whitelisting/list/{automatcherBankAccountNumber}?bsb=123-456\")\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": "Nzi7_shvHOO1aM56kN7u6", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/receivables/v1/whitelisting/list/{automatcherBankAccountNumber}?bsb=123-456\"\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": "0-lb-TedVQbjDTbvaTdUd" }, "results": { "languages": [ { "id": "qmegrN808HrQi384QlFYE", "language": "200", "code": "// 200 Success. The request passed validation and the whitelist entry was created, updated or returned. Check the status and statusDescription fields for the outcome of the operation.\n{\n \"automatcherBankAccountNumber\": \"300000123\",\n \"automatcherBsb\": \"123-456\",\n \"sourceAccount\": [\n {\n \"id\": 10525,\n \"bsbNumber\": \"123-456\",\n \"accountNumber\": \"123456789\",\n \"accountName\": \"Sample Source Account\",\n \"accountStatus\": \"Enabled\"\n }\n ],\n \"durationMs\": 20,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "4pvY6XP12AWLBElhnhpsk", "language": "400", "code": "// 400 Bad Request. The request could not be processed because one or more fields failed validation, for example a malformed BSB, an account number outside the permitted length, or a request that supplies neither a BSB and account number nor an account name.\n{\n \"durationMs\": 15,\n \"status\": \"Error\",\n \"statusDescription\": \"The request failed validation. See the errors collection for details.\",\n \"errors\": [\n {\n \"code\": \"InvalidAccountNumber\",\n \"field\": \"sourceAccount.accountNumber\",\n \"message\": \"The account number must be between 3 and 9 digits.\"\n }\n ]\n}" }, { "id": "SAneIkNuaKN_jmuvQJ7-u", "language": "401", "code": "// 401 Unauthorized. Authentication failed. The API key was missing, malformed, expired, or is not permitted to access the whitelisting endpoints for the requested mAccount.\n{\n \"durationMs\": 15,\n \"status\": \"Error\",\n \"statusDescription\": \"The request failed validation. See the errors collection for details.\",\n \"errors\": [\n {\n \"code\": \"InvalidAccountNumber\",\n \"field\": \"sourceAccount.accountNumber\",\n \"message\": \"The account number must be between 3 and 9 digits.\"\n }\n ]\n}" }, { "id": "lswCSNA0fvhuyGZSN0wpj", "language": "500", "code": "// 500 Internal Server Error. An unexpected error occurred while processing the request. The request was not completed and can be retried. Quote the statusDescription when contacting Monoova support.\n{\n \"durationMs\": 15,\n \"status\": \"Error\",\n \"statusDescription\": \"The request failed validation. See the errors collection for details.\",\n \"errors\": [\n {\n \"code\": \"InvalidAccountNumber\",\n \"field\": \"sourceAccount.accountNumber\",\n \"message\": \"The account number must be between 3 and 9 digits.\"\n }\n ]\n}" } ], "selectedLanguageId": "qmegrN808HrQi384QlFYE" } }, "children": [ { "text": "" } ] }