Magento 2
Learn about using plugins to power up your Magento website
Maya Magento Plugin only supports straight payments. Alternatively, you can explore Shopify
and WooCommerce
1 Request Access to Maya Business Manager
Contact your assigned Relationship Manager to gain access to your Maya Manager Sandbox account.
Keep in mind
Maya Business Manager has two environments: Sandbox and Production.
- Sandbox is used for development, testing, and integration. Once the integration is completed in this environment, it will be verified by our Operations team. Only then the production credentials will be provided.
- Production is for live payments. Testing in this environment will incur real charges.
Both environments have the ability to generate API keys. Once your account is onboarded to a sandbox account, you need to log in to the manager account of your respective environment.
2 Generating API Keys
Generate your API keys by following the steps below:
Step 1: Login to Maya Manager Sandbox and generate your API Key.
Step 2: Go to the menu on the left side of the screen and look for API Keys.
Step 3: On the main navigation, select the name of the Merchant that you registered earlier. Then generate the API key by clicking Generate API Key.
Step 4: After being redirected to another screen, create keys for both Public and Secret policies.
Step 5: Click Create then your API key will be shown to you.
The same flow will be used when generating keys on to your Production environment.
Save your API key in a secured location
The full API key will only be shown once. It is important that you store it in a secure location. If you lost your API key, try generating it again using the environment you are working on.
3 Install and configure Maya Business Plugin in Magento 2
Must-have requirements before proceeding:
- A Maya Business Merchant Manager account
- A working Magento instance with shell/terminal access
- Technical know-how to navigate and execute commands in the terminal
3.1 Installing Maya Business Plugin
- Purchase Maya Business Plugin from Magento Marketplace. It is free.
- Users should install it according to the official extensions installation instructions page: Magento Extension Installation Guide.
3.2 Configuring Maya Business Plugin to accept payments
- Click Stores on the left-hand navigation and choose Configuration under Settings.
- On the Stores Configuration screen, click the Sales dropdown navigation menu on the left side of the main panel. Under it, click on the Payment Methods submenu. This will bring you to the Payment Methods screen where you can configure the Maya Business Plugin.
- On the Payment Methods screen, just click on the corresponding Configure button with the Maya Business Plugin.
- On the Maya Business Plugin Configuration section, under the Basic Settings section, you can configure the following fields:
- Mode - This is the mode of the plugin. You can set this dropdown field to either Test or Live mode.
- Public API Key - This is where your public API key from your Maya Business Merchant Manager dashboard will go. Depending on your Mode, you’ll either need to generate test or live keys in your manager dashboard. The value from your manager dashboard that goes in this field is normally prefixed with the characters ‘pk-’.
- Secret API Key - This is the same as your public API key, except this one is prefixed with the characters ‘sk-’.
- Under the Card Payments section, you can configure the following fields:
- Enabled - This determines whether or not the Maya payment method will show up in the Checkout page.
- Title - This is what the label of your Maya payment method in the checkout page is.
- For Webhook Settings section, no change needed. The URL configured in the Base URL field below will be automatically passed to Maya Manager once you click Save Config.
- Click Save Config when you have finished your configuration.
To ensure that the configuration was a success, login to your Maya Manager 1.0. Go to Webhooks, and select the Magento merchant.
You should find the Webhook URLs from your Magento plugin (based on the Base URL configured) successfully saved on Maya Manager 1.0.
3.3 [Recommended] Sandbox Mode Testing
At this point, you should have done the following:
- Generated Sandbox API Keys.
- You should have added products in your Magento store.
Currently, only the Production environment is accessible through the Maya Business Manager. If you require Sandbox Access via the Maya Manager 1.0, please reach out to [email protected].
Stay tuned for more features to be released within the portal.
- Go to the Maya Business Magento Plugin configuration section, under the Basic Settings section.
- Set Mode to Test.
- Paste your public (
pk-...) and secret (sk-...) keys generated from Maya Manager 1.0 Sandbox. Make sure that there are no extra whitespaces.
- Click Save Config.
To ensure that the configuration was a success, login to your Maya Manager 1.0 Sandbox
You should find the Webhook URLs from your Magento plugin (based on the Base URL configured) successfully saved on Maya Manager 1.0.
At this stage, you should now have a working checkout button that redirects your customer to Maya Checkout.
- Click the checkout button.
- You are redirected to Maya Checkout Page.
Sample Maya Checkout page
- Before your customer will input their payment details, their order will be marked as Pending Payment on your Magento Orders Dashboard.
- Once the payment is successful, go to your Magento Orders Dashboard. The order should now have the status Processing.
Keep in mind
During your tests on the Sandbox
3.4 Go Live
Once you are done with your tests on the Sandbox Environment, it is time to move to Production.
At this point, you should have done the following:
- Generated Production API Keys.
- You should have added products in your Magento store.
- Go to the Maya Business Magento Plugin configuration section, under the Basic Settings section.
- Set Mode to Live.
- Paste your public (
pk-...) and secret (sk-...) keys generated from Maya Manager 1.0 Production.. Make sure that there are no extra whitespaces.
- Click Save Config.
To ensure that the configuration was a success, login to your Maya Manager 1.0 Production
You should find the Webhook URLs from your Magento plugin (based on the Base URL configured) successfully saved on Maya Manager 1.0.
3.5 Live Testing
At this stage, when you checkout products from your store and proceed to payment, you should now be redirected to a live Maya Checkout page.
- Click the checkout button.
- You are redirected to Maya Checkout Page.
Sample Maya Checkout page
- Before your customer will input their payment details, their order will be marked as Pending Payment on your Magento Orders Dashboard.
- Once the payment is successful, go to your Magento Orders Dashboard. The order should now have the status Processing.
Keep in mind
If you wish to test live transactions in Production, you will need to use real cards and e-wallet accounts. Transactions performed will incur real charges.
Advanced Use Cases
Setup of Order Confirmation Email Notification
Email notification upon order confirmation is a Magento default behavior. To change that behavior:
- Under Miscellaneous Settings, configure the field Send order confirmation email before payment resolution to:
- Yes - If you want the order confirmation email to be sent before payment is made (regardless if payment resolution is successful or failure).
- No - If you want the order confirmation email not to be sent before payment is successful. For failed payments, no email will be sent.
Troubleshooting
For troubleshooting tips and guides, please refer to Magento Troubleshooting Guide
Updated over 1 year ago