Overview
This guide walks you through the full integration journey for Maya Checkout, from onboarding and setup in Maya Manager 1.0, to generating API keys, testing in Sandbox, and finally going live in Production.
Before you begin, make sure you have read About Maya Checkout to understand its requirements, supported integration methods, and key concepts.
By the end of this guide, you will know the tools, credentials, and configurations required before writing any code.
Getting Started
Step 1: Define your setup
- Choose your integration method: API or SDK
- Select the payment methods you want to support: Cards, QRPh, Maya Wallet, or other channels
- Specify additional features you want enabled, such as:
- Authorize (Hold) & Capture transactions
- Fraud Protection
- Payment Facilitator processing
Step 2: Sign up for Maya Manager 1.0
Maya Checkout requires an account in Maya Manager 1.0 (also known as PayMaya Manager).
2.1. Request for a Maya Manager 1.0 account
Refer to this video: How to set up a Maya Manager 1.0 account
-
New partners: Email [email protected] to request access.
-
Existing partners: Contact your assigned Maya Relationship Manager.
2.2. Provide the preferred setup
2.3. Approval & Account Activation
Once verified, your business account will be activated, and you’ll gain access to the dashboard:
-
Sandbox: https://manager-sandbox.paymaya.com
-
Production: https://manager.paymaya.com
Configure Access
Access is first granted to your company’s nominated representative. If you need access (e.g, generate API keys), request it from your company representative.
Step 3: Generate Your Sandbox API Keys
API keys are required to authenticate your application with Maya Checkout.
Steps to generate your API keys in the Maya Manager 1.0:
3.1. Log in to Maya Manager 1.0 Sandbox
3.2. In the sidebar, look for API Keys
3.3. Select the merchant account created earlier
3.4. Click Generate API Key
3.5. Create keys
After being redirected to another screen, create keys for both Public
and Secret
policies.
3.6. Click Create
3.7. Copy your API keys
The public and secret keys will be displayed once. Store them securely in an encrypted vault.
Copy and store the generated public and secret API keys in a secure and encrypted location. Do not store your keys anywhere that unauthorized personnel can access. Once you exit the screen, only masked values will be visible.
Step 4: Configure & Implement
4.1. Now that you have your account and API keys, check How API Authentication Works in Maya Checkout
4.2. Proceed to the implementation guides that match your integration type:
- Accept One-time Payment using Maya Checkout
- Authorize (Hold) and Capture Payments in Maya Checkout
- Accept Payments as a Payment Facilitator in Maya Checkout
Step 5: Apply Best Practices
Before going live, ensure your system handles all key payment states and scenarios:
- Understanding Payment Statuses in Maya Checkout
- Configuring Your Webhook for Maya Checkout
- Managing Voids and Refunds in Maya Checkout
- If Fraud Protect is enabled, review the Implementing Fraud Protection in Maya Checkout
- Understanding Errors in Maya Checkout
Step 6: Test Your Integration
Your technical team is responsible for developing, debugging, and testing your sandbox. Review the Testing and Validating Your Maya Checkout Integration guide.
Step 7: Submit Testing Results
Once testing is complete, send results and sign off:
Recipients:
- Maya Fulfillment Team: [email protected]
- Your Maya Relationship Manager
Include:
- Merchant Name
- Merchant ID (MID)
- Screenshot of
200 OK
Webhook response - Screenshot of one successful transaction per card scheme: Visa, MasterCard, JCB (using test cards)
Step 8: Go Live
When ready, coordinate with your Maya Relationship Manager and complete the Go Live Checklists.
Before Going to Production
- Complete your Sandbox testing and submit your signoff
- Obtain Maya’s Acceptance testing approval
- Review your API error handling procedures
- Send your formal request and coordinate the Go-live date.
- Prepare your production environment.
- Apply the production values to your application. This includes:
- Setting up your production Maya Manager 1.0 account
- Generating your production API keys
- Updating the credentials, endpoints, webhooks, and URLs to align with your production values
After Going Live in Production
- Conduct your pilot testing in production (using real cards and wallets; charges will apply).
- Submit your final signoff.
- Prepare for your public launch.
Do not raise production concerns in ASKAMAYADEV. For production support, email [email protected].
Estimated Activities and Timelines
Considering internal complexities like engineering resources, system integrations, and team coordination, the integration with Maya can take anywhere from weeks to up to months.
PHASE | ESTIMATES | TASKS |
---|---|---|
Merchant Account creation and Sandbox onboarding | ~1 week | Creation of your merchant account begins upon submission of complete documentary requirements. Sandbox access is provided during this phase. |
Build | 2-4 weeks | Build your application and integration. This may vary depending on your development timelines. |
Test | 2-3 business days | Complete your end-to-end testing in Sandbox and provide your sign-off to Maya. This may vary depending on your testing activities and timelines. |
Transition to Production | 1-2 weeks | This is based on Maya's estimated timeline, which will only begin once you have completed all sandbox requirements. Access to Production is given during this phase. |
Go Live | 2-3 business days | You may do pilot testing in Production or proceed to launch. Please share your public launch date with your Maya Relationship Manager. |
FAQs
Q: Do I need Sandbox to integrate?
A: Yes, integration starts in the Sandbox for testing before going live to Production.
Q: Where can I find my API keys after initial setup?
A: Only masked values are available later. Always save your keys securely when first generated.
Next Steps
You have now set up Maya Checkout in Production following the integration guides and best practices.
- For merchant account-related requests (e.g., feature enablement), reach out to your Maya Relationship Manager.
- If you run into issues in Production, check the Understanding Errors in Maya Checkout for proper handling.