Environments

There are two environments available throughout the integration process: Pre-live (sandbox) and Live (production). Security for Zai is a high priority and as such, data is not shared between environments. Instead, there is a separate endpoint for each environment.

📘

Coming soon

Credit card and direct debit transactions within the UK are not yet available.

Pre-live

The Pre-live, sandbox environment is where you'll initially integrate with Zai. This environment should be used to finalise your workflow, test your integration, and make sure no test data is shared with the production environment.

There are some significant features of our Pre-live environment:

• All money is virtual. No real money will be charged or sent.
• Test data can be used.
• Direct Debits / ACH payments are processed automatically every three minutes.
• Credit Card transactions can be processed instantly, using test card data.
• Payouts will reach the "batched" state, but not the "successful" state.
• Data is not shared with the Live environment.
• Configurations won't carry across to production, as Pre-live data is completely independent.
• There are no payment method restrictions; however, certain payment methods may not be configured on your platform. Contact Support if unsure about your configuration. By default, these methods are disabled:
  • Credit card payin (by seller role)
  • Direct debit payin

For your testing purposes, we limit API calls in Pre-live to 60 minutes.

Pre-live API endpoint

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

Pre-live Dashboard

To manage your Pre-live platform, go to https://dashboard.hellozai.com/, and select Pre-live.

Live

The Live, production environment is where you'll initially integrate with Zai. This environment will be used once your testing is complete and you are ready to use Zai with real money.

There are some things you need to be aware of when using Live:

• All money is real. Money will be charged and sent.
• Only real information on accounts and users will be processed.
• A more restrictive ruleset applies with available payment methods. Contact us if a payment method needs to be enabled or disabled.
• Configurations and data set up in the Pre-live environment will not apply and will need to be reconfigured.

Live API endpoint

To access the Live, production environment, use the following endpoint:
https://secure.api.promisepay.com

Live Dashboard

To manage your Live, production platform, go to https://dashboard.hellozai.com/, and select Live.