API Reference

Overview

Zai is a powerful payments engine custom-built for marketplaces. Removing compliance, fraud, risk, staffing, and operational headaches; Zai helps online platforms focus on what matters most to their business.

Zai supports international payments and multiple transaction types in a wide range of currencies.

Marketplaces can offer their buyers/payers the ability to pay using:

  • Real time payments (Australian NPP / OSKO)
  • Credit & Debit Cards
  • ACH Direct Debit
  • BPAY
  • Wire Transfer

Sellers/payees can receive their funds by using:

  • Real time payments (Australian NPP / OSKO)
  • ACH Direct Credit
  • BPAY

Zai provides you with an API to easily and quickly start taking payments on your marketplace.

Zai's API environments

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://secure.api.promisepay.com

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

Specifications

This section contains the API specification in JSON and Swagger formats.

These specifications can be used to auto-generate SDKs.