Overview

📘

Australia only

These virtual account and PayID API reference docs are for platforms operating in Australia.

This section covers all the APIs that relate to virtual accounts and PayIDs.

As a prerequisite to using these APIs, please make sure you have:

  • implemented and migrated over to our OAuth authentication framework.
  • implemented and migrated over to our webhook APIs.

See our documentation guides for more details on using virtual accounts and PayIDs.

These APIs have the same method of authentication. Both your Live (production) and Pre-live (sandbox) platforms can be managed by accessing the Zai Dashboard at https://dashboard.hellozai.com/.
For more details, see our Environments guide.

🚧

Please note

When you go to the Zai Dashboard, you'll need to select either Live or Pre-live. The Live environment is for production use only. Use Pre-live to test your integration.

API endpoints

To access the Live (production) environment, use the following endpoint:
https://au-0000.api.assemblypay.com

To access the Pre-live (sandbox) environment, use the following endpoint:
https://sandbox.au-0000.api.assemblypay.com

Specifications

This section contains the Virtual Accounts specifications in JSON and YAML formats.