Quick Start

This is your first step to be part of our inclusive digital financial economy. As a developer, you are powering your platforms and establishments with Maya Business.

But before you can go production with your desired tools and services, you must first do the following.

Learn our Environments

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 Merchant Services team. Only then the production credentials will be provided.

Production is for production payments. Testing in this environment will incur real charges.

🚧

️ ️New Production URL Hostname and Migration Guide for Online Payments

In line with rebranding of Maya, starting July 12, 2022, the new Production URL hostname for Maya Payment Gateway will be https://pg.maya.ph. It is recommended that you update your application configuration to the new URL before the end of 2022.

Additionally, the returned web URLs for Maya hosted payment web pages for Online Payments such as Checkout and Pay with Maya will be https://payments.maya.ph.

For more details, you may see the changelog page.

Environment

Old API URL Hostname

New API URL Hostname

Old Returned Web URL Hostname

New Returned Web URL Hostname

Production

https://pg.paymaya.com

https://pg.maya.ph

https://payments.paymaya.com

https://payments.maya.ph

Sandbox

https://pg-sandbox.paymaya.com

No change. Still use the existing URL:
https://pg-sandbox.paymaya.com

https://payments-web-sandbox.paymaya.com

No change. Still use the existing URL:
https://payments-web-sandbox.paymaya.com

EnvironmentMaya Business Manager
Sandboxhttps://manager-sandbox.paymaya.com
Livehttps://manager.paymaya.com

📘

Want to try it out first?

You can also try out our sandbox environment without creating an account by using our publicly available Sandbox Credentials and Cards

Obtain an API Key

Both sandbox and production 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.

Once logged in, go to the menu on the left side of the screen and look for  API Keys.

On the main navigation, select the name of the Merchant that you registered earlier. Then generate the API key by clicking Generate API Key.

You’ll be redirected to another screen where you will create keys for both Public and Secret policies.

After clicking Create, 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.

You can start the development after the API key in the sandbox environment is generated. Check our API documentation on how you can authenticate your application and start using our APIs.

Authenticating with our API

Authentication is done via HTTP Basic Authentication. Depending on the API endpoint, the public or secret key must be provided as the username and the password left as blank.

Steps are as follows:

  1. Combine Username and Password (left blank) separated by ‘:’ (colon). If your API key is “pk-Z0OSzLvIcOI2UIvDhdTGVVfRSSeiGStnceqwUE7n0Ah”, the resulting string is:
pk-Z0OSzLvIcOI2UIvDhdTGVVfRSSeiGStnceqwUE7n0Ah:
  1. Apply Base64 encoding to the resulting string from Step 1. Using the resulting string from Step 1, the Base64 encoded string will be:
cGstWjBPU3pMdkljT0kyVUl2RGhkVEdWVmZSU1NlaUdTdG5jZXF3VUU3bjBBaDo=
  1. Indicate the authorization method i.e. “Basic” followed by a space then the Base64 encoded string in Step 2. An example is shown below.
Authorization: Basic cGstWjBPU3pMdkljT0kyVUl2RGhkVEdWVmZSU1NlaUdTdG5jZXF3VUU3bjBBaDo=

(see HTTP Basic Auth)

Go to Production

Production deployment will happen once your team is finished with development and quality checks using your own sandbox credentials. You can then contact your assigned account manager to activate your production manager portal and generate your production API keys.

Final Requirements

In order to gain approval for production manager portal, integration will need to be validated by the Maya Fulfillment Online Team.

For Checkout/website integration, you will need to do the following test transactions in Sandbox below or follow the email sent by the Maya Fulfillment Online Team.

  1. Generate your API Keys via Maya Business Manager Sandbox. Please note that the keys will be exposed only once. Please copy them immediately and save them securely. Once you exit, only the masked values will be reflected.

  2. Register your Webhooks via Maya Business Manager. To proceed, check for a “200 OK” response by going to the Settings tab.

  3. For Checkout: After integration, complete test transactions for Visa, Mastercard, and JCB using our List of mock test cards. Use test cards tagged as “Success” under the Payment column. To proceed, you need 1 successful transaction per test card.

🚧

Production Testing

It is highly recommended to do a production test using your production API keys. This ensures your application has switched from sandbox to production.

Do note that testing in the production environment will incur real charges.


Did this page help you?