---
title: Create Whitelist Source Account
slug: api/create-whitelist-source-account
docTags:
createdAt: 2025-06-10T23:35:03.459Z
---
{
"id": "_XHKgjWXmVCBo6nCpS8Fc",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "https://api.mpay.com.au/receivables/v1/whitelisting/create",
"servers": [
{
"url": "https://api.mpay.com.au/receivables/v1/whitelisting/create",
"description": "Production URL"
},
{
"url": "https://api.m-pay.com.au/receivables/v1/whitelisting/create",
"description": "Sandbox URL"
}
],
"name": "Create Whitelist Source Account",
"description": "Use this API to create a new whitelist entry for an automatcher account. Multiple source bank account numbers or bank account names can be whitelisted against each Automatcher number. The system will automatically return payments if the payment details do not match one of the entries.\nMake sure to set the account status to 'Enabled' to accept payments for the set of rules defined, the status can always be updated if the rule no longer applies using the update endpoint.
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "required",
"name": "body",
"type": "object",
"description": "",
"customType": "cruWhiteListSourceAccountCreatedBody_V1",
"schema": [
{
"name": "automatcherBankAccountNumber",
"kind": "optional",
"type": "string",
"description": "Valid receivables bank account number belonging to the Sign-in mAccount.",
"example": ""
},
{
"name": "sourceAccount",
"kind": "optional",
"type": "object",
"description": "This is the sourceAccount.",
"modelRef": "#/components/schemas/cruWhiteListSourceAccountsClass",
"customType": "cruWhiteListSourceAccountsClass",
"schema": [
{
"name": "accountStatus",
"kind": "optional",
"type": "string",
"description": "Account status; either Enabled or Disabled.",
"example": ""
},
{
"name": "accountName",
"kind": "optional",
"type": "string",
"description": "Account name.",
"example": ""
},
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "id",
"example": 0
},
{
"name": "accountNumber",
"kind": "optional",
"type": "string",
"description": "3 to 9 digit bank account number.",
"example": ""
},
{
"name": "bsbNumber",
"kind": "optional",
"type": "string",
"description": "6 digits with a '-'. At least one of BSB/AccountNumber or AccountName is required.",
"example": ""
}
]
},
{
"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": ""
}
],
"modelRef": "#/components/schemas/cruWhiteListSourceAccountCreatedBody_V1",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "basicAuth",
"name": "basicAuth",
"kind": "optional",
"type": "http",
"scheme": "basic"
}
]
},
"responses": [
{
"statusCode": "200",
"description": "successful validation",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "cruWhiteListSourceAccountResponse_V1",
"schema": [
{
"name": "automatcherBankAccountNumber",
"kind": "optional",
"type": "string",
"description": "Valid receivables bank account number belonging to the Sign-in mAccount.",
"example": ""
},
{
"name": "durationMs",
"kind": "optional",
"type": "integer",
"description": "20",
"example": 0
},
{
"name": "statusDescription",
"kind": "optional",
"type": "string",
"description": "Operation completed successfully",
"example": ""
},
{
"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": ""
},
{
"name": "sourceAccount",
"kind": "optional",
"type": "array",
"description": "This is the sourceAccount.",
"modelRef": "#/components/schemas/cruWhiteListSourceAccountsClass",
"customType": "cruWhiteListSourceAccountsClass[]",
"schema": [
{
"name": "accountStatus",
"kind": "optional",
"type": "string",
"description": "Account status; either Enabled or Disabled.",
"example": ""
},
{
"name": "accountName",
"kind": "optional",
"type": "string",
"description": "Account name.",
"example": ""
},
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "id",
"example": 0
},
{
"name": "accountNumber",
"kind": "optional",
"type": "string",
"description": "3 to 9 digit bank account number.",
"example": ""
},
{
"name": "bsbNumber",
"kind": "optional",
"type": "string",
"description": "6 digits with a '-'. At least one of BSB/AccountNumber or AccountName is required.",
"example": ""
}
]
},
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "Ok",
"example": ""
}
],
"modelRef": "#/components/schemas/cruWhiteListSourceAccountResponse_V1",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "FPkjt52TXkZbj82AWcjDn",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n --url https://api.mpay.com.au/receivables/v1/whitelisting/create \\\n --header 'accept: application/json'"
},
{
"id": "2p87y-RSkZpcSszkr1855",
"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: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.mpay.com.au/receivables/v1/whitelisting/create\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "Wp9ehiZ7EvP4bTRx1Mibm",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/receivables/v1/whitelisting/create\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "-_Duf3w9NIHz7iJ95OKPa",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/receivables/v1/whitelisting/create\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "FPkjt52TXkZbj82AWcjDn"
},
"results": {
"languages": [
{
"id": "eKxUva3Q20SNvAZw13lf3",
"language": "200",
"code": "// successful validation\n{\n \"automatcherBankAccountNumber\": \"\",\n \"durationMs\": \"\",\n \"statusDescription\": \"\",\n \"automatcherBsb\": \"\",\n \"sourceAccount\": [\n {\n \"accountStatus\": \"\",\n \"accountName\": \"\",\n \"id\": \"\",\n \"accountNumber\": \"\",\n \"bsbNumber\": \"\"\n }\n ],\n \"status\": \"\"\n}"
}
],
"selectedLanguageId": "eKxUva3Q20SNvAZw13lf3"
}
},
"children": [
{
"id": "Ut27hrYzbh5SQLF-tC5yw",
"type": "paragraph",
"children": [
{
"text": "Use this API to create a new whitelist entry for an automatcher account. Multiple source bank account numbers or bank account names can be whitelisted against each Automatcher number. The system will automatically return payments if the payment details do not match one of the entries.\nMake sure to set the account status to 'Enabled' to accept payments for the set of rules defined, the status can always be updated if the rule no longer applies using the update endpoint."
}
]
}
]
}