Register PayID

POST

https://api.mpay.com.au/receivables/v1/payid/registerPayId

This endpoint allows the registration of a PayID against an account number. We recommend leaving 10 seconds before registering a PayID on a new account to ensure the account has been enabled for NPP.

The domains that can be used to register a PayID are restricted. Custom domains are supported but must first be approved — please contact us for configuration. The default domain is monoova.me; if the PayID field is left blank we will generate a check-digited PayID on the Monoova domain.

acceptstringGenerated from available response content types

bodyobjectRequest body used to register a PayID against an account number.

200Successful validation. The PayID was registered.

400Bad Request — the request could not be processed because one or more fields failed validation, or the PayID or account details supplied are not valid.

401Unauthorized — the API key supplied in the basic authentication header is missing, invalid, or not permitted to access this resource.

500Internal Server Error — an unexpected error occurred while processing the request. Retry the request; if the error persists, contact Monoova support and quote the statusDescription.

curl --request POST \
     --url https://api.mpay.com.au/receivables/v1/payid/registerPayId \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data-raw '{
     "payId": "[email protected]",
     "bankAccountNumber": "410000123",
     "bsb": "123-456",
     "payIdName": "Jane Doe Pty Ltd"
     }'