Integration & Go-Live Guide
MILESTONE 1: SANDBOX INTEGRATION
In this phase, you will perform development and debugging in an isolated Sandbox environment. Whether you are using Cloud API or Semi-Integration, we provide specific tools to help you verify your logic without any financial risk.
1. Obtain Credentials & Setup
The preparation depends on your integration method:
1.1 For Cloud API Integrators:
System will send you 3 separate emails. Please check your inbox (including the spam folder) for the following:
Developer Account: Contains your unique Developer ID and Secret.
Test Merchant Token: The authentication token required for API calls.
Portal Credentials: Login details for the Test Merchant Portal to view sandbox transaction details.
🔗 Refernce: https://smartpossdk.gitbook.io/paywizard-open-api/cloud-api/integration-best-practices
1.2 For Semi-Integration Integrators:
Once you have set up your physical test environment, you can begin testing immediately.
* Optional Portal Access: If you wish to view real-time data for your test transactions, we can provision a Test Merchant Account for you upon request. This will allow you to log in to the dashboard and analyze your testing results.
2. Required Testing APP
To facilitate your testing, we provide two essential applications (pre-installed or pushed by TMS):
Paywizard Middleware This service acts as a bridge, receiving transaction requests from various protocols and routing them correctly.
Paywizard Test Payment App A simulator application that mimics the real payment flow. It processes transactions without charging real money, allowing you to test full payment lifecycles safely.
3. Comprehensive Test Case Validation
Before moving to the next phase, you must validate your integration against a complete set of test cases to ensure the robustness of your system:
Standard Transactions: Verify all transaction types required by your specific business logic (e.g., Sale, Void, Refund, Pre-auth).
Exception Scenarios: You must test common abnormal cases (e.g., Network Timeout, User Cancellation, Insufficient Funds, Card Decline) to ensure your application handles errors gracefully.
MILESTONE 2: PRE-PRODUCTION PILOT
Upon completing Sandbox verification, you will migrate to the Production Environment. In this phase, you will use real Production Parameters and the actual Processor Payment App to verify the system before deploying to live merchants.
1. Obtain Production Parameters
Paywizard will provision a new set of credentials specifically for the live environment. Please ensure you update your system with the following:
Production Developer Credentials: A new Developer ID and Secret specific to the production environment.
Production Portal Access: Access to the Production Merchant Portal for viewing live transaction data.
Production Merchant Parameters: Configuration data linked to the real Processor/Acquirer MID that you provided.
⚠️ Action Required: Update your Machine/Terminal Application or Server-side Application to use these new production endpoints and credentials.
2. Device & Application Reconfiguration
You must transition the physical WizarPOS terminal from "Debug Mode" to "Live Mode" by following these steps:
2.1 Reconfigure Middleware:
Update the Paywizard Middleware settings on the device to point to the Production Environment parameters.
2.2 Swap Payment Applications:
🛑 Uninstall: Remove the Paywizard Test Payment App (it is no longer used).
✅ Install: Install the specific Processor/Acquirer Payment App required for your region/bank.
2.3 Apply Varsheet Configuration:
Configure the newly installed Processor Payment App using the Production Varsheet provided by the acquirer/processor.
3. Production Verification Round
Before deploying to any real merchant store, you must perform a final "Pilot Test" using the production setup:
Full Regression Test: Repeat the full suite of test cases (all transaction types: Sale, Refund, Void, etc.) that you performed in the Sandbox.
Exception Handling: Re-verify common exception scenarios (e.g., user cancellation, card decline) to ensure the production app behaves as expected.
Critical: You may only proceed to Step 3 (Go Live) and deploy to real merchants after successfully passing this full round of production testing.
MILESTONE 3: GO LIVE!
Congratulations! Having successfully passed the production pilot test, you are now ready to deploy the fully configured solution to actual merchant locations.
1. Merchant Deployment
Deploy the system to your real merchants using the validated production configuration from Step 2.
Ensure the WizarPOS terminal and your application are retaining the correct Production MID and Varsheet parameters.
No further configuration changes should be made at this stage without prior testing.
2. Live Processing
You may now begin processing real transactions with actual customers.
Monitoring: We recommend closely monitoring the first batch of live transactions via the Production Portal to ensure stability.
Support: If any issues arise during the initial launch, please contact our support team immediately.
Launch Successful!
Your integration is now complete. We appreciate your partnership and cooperation throughout this process.
We wish you a prosperous business and great success!
Last updated