Get Account Status By BankAccount

GET

https://api.mpay.com.au/receivables/v1/statusByBankAccount/{bankAccountNumber}

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.

bankAccountNumberstringRequired. The account number of the virtual account whose status you want to retrieve. Must belong to the parent mAccount you are authenticated as.

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

200successful validation

400Bad Request — the request was malformed or contained invalid parameters.

401Unauthorized — authentication failed, or the API key was missing or invalid.

500Internal Server Error — an unexpected error occurred while processing the request.

curl --request GET \
     --url 'https://api.mpay.com.au/receivables/v1/statusByBankAccount/{bankAccountNumber}?bsb=012-345' \
     --header 'accept: application/json'