List Whitelist Source Accounts

GET

https://api.mpay.com.au/receivables/v1/whitelisting/list/{automatcherBankAccountNumber}

This endpoint will list all whitelisted source account details linked to the queried Automatcher account number.

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

bsbstringOptional 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.

200200 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.

400400 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.

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

500500 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.

curl --request GET \
     --url 'https://api.mpay.com.au/receivables/v1/whitelisting/list/{automatcherBankAccountNumber}?bsb=123-456' \
     --header 'accept: application/json'