Validate Account Details via NPP

POST

https://api.mpay.com.au/verify/v1/aba/nppvalidate

Validates a bank account or PayID via the NPP rail and returns the registered account owner name together with the fees that apply to the request.

acceptstringGenerated from available response content types

bodyobjectRequest payload used to validate a bank account or PayID via the NPP rail.

200Success. The account details were validated successfully.

400<p>Bad Request. The request could not be processed because one or more fields are missing, malformed, or failed validation. Check <code>statusDescription</code> for the specific field or rule that failed.</p>

401<p>Unauthorized. The API key was missing, malformed, or is not valid for this environment. Pass your API key as the basic authentication username with no password.</p>

500Internal Server Error. An unexpected error occurred while processing the request. The request was not completed and can be safely retried.

curl --request POST \
     --url https://api.mpay.com.au/verify/v1/aba/nppvalidate \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data-raw '{
     "creditMethod": "NppCreditBankAccount",
     "bsb": "032-001",
     "bankAccountNumber": "123456789",
     "accountName": "Acme Pty Ltd",
     "payId": "[email protected]",
     "payIdType": "Email",
     "remitter": "ACME PTY LTD",
     "lodgementReference": "ACCT VERIFY 4821",
     "verificationIdentifier": "SUPPLIER-ONBOARD-4821"
     }'