Integration Best Practices

Welcome to the Wizarpos PayWizard Cloud API! To ensure a smooth and secure integration process, please follow these best practices when connecting your services to our platform.

1. Getting Started: Developer Account Application

Before you begin the integration process, the first step is to apply for a developer account. Please contact our support team to submit your application.

2. Sandbox Environment for Development and Testing

Once your developer account application is approved, we will provide you with credentials for our sandbox environment. This includes:

  • A Sandbox Developer Account: This account gives you access to the testing environment.

  • Test Merchant Parameters: A set of test credentials and configurations for a sample merchant.

  • API Token: A unique token specifically for your sandbox account and test merchant.

Use these credentials to develop and test your integration thoroughly. The sandbox environment is designed to mimic the functionality of the production environment without affecting live data.

3. Integrating with the API

During the integration phase, please use the provided sandbox developer account and test merchant parameters. This will allow you to test all API endpoints and webhooks to ensure your application is working correctly before going live.

4. Transitioning to the Production Environment

After you have successfully completed your integration and testing in the sandbox, you will be ready to move to the production environment. For this step, you will need to:

  • Request Production Credentials: Contact us to receive your production developer account and production merchant parameters.

  • Replace Sandbox Credentials: It is crucial to replace all sandbox credentials in your application with the new production credentials. This includes the developer account details, merchant parameters, and the API token.

Important Note on API Tokens:

Please be aware that each merchant has its own unique API token. The token you use in the sandbox environment is for testing purposes only and will not work in the production environment. Similarly, each of your live merchants in the production environment will have a distinct token that must be used for all API requests associated with that merchant.

By following these best practices, you can ensure a successful and secure integration with our Cloud API. If you have any questions, please refer to our API documentation or contact our developer support team.

Last updated