Quick Start Guide with Maya Manager 1.0

This is your first step to being part of our inclusive digital financial economy. In this section, you will understand the prerequisites of integrating with Maya’s Online Payment solutions using Maya Manager 1.0.

ℹ️ Do you wish to switch to Maya Business Manager? Contact [email protected] or to your assigned Maya Relationship Manager.

1 Setup the Maya Manager 1.0

Reach out to your designated Maya Relationship Manager or [email protected] in order to acquire access to Maya Manager 1.0 in sandbox environment.

See also the video below to learn how to register and log in to the Maya Manager 1.0 (or the PayMaya Manager).

2 Learn the Environments

Maya offers its partners the ability to integrate with Maya solutions through the Sandbox and Production environments.

  • Sandbox - The Sandbox environment provides an instance for integrating Maya solutions and testing development builds, without the risk of impacting live transactions and real customers. During this testing phase, you may use our Sandbox Credentials and Cards .
  • Production - The Production environment represents the live setting where actual transactions will result in real charges. To conduct live transaction testing in the Production environment, you will need to use real cards and e-wallet accounts.

3 Generate your API Keys

At this point, you already have access to the Maya Manager 1.0.

Before you can proceed with accepting payments, you need to generate and set up your API keys. In technical terms, API keys serve the purpose of securely identifying and authenticating your transaction requests to Maya. The API keys you generate will then be used to establish payment integration on your platform, enabling you to accept online payments.

Access to Maya Manager 1.0

Access to the Maya Manager 1.0 is granted primarily to your nominated company representative. Should you need access to the Maya Manager 1.0, kindly direct your request to your nominated company representative, who will handle the provisioning of your access to the Maya Manager 1.0 and provide permission to generate your API keys.

Refer to the video below for the detailed instructions on managing User Access Management

The following steps narrate how to generate your API Keys:

🧠 Keep in mind

Things to note prior to generating your API Keys:

  • The environment you will be working on. As mentioned in 2 Learn the Environments , Maya has two (2) environments, Sandbox and Production. Each environment has a distinct Maya Manager 1.0 portal.
  • The Maya Solution you will be implementing. API Keys that will be generated are exclusive to the particular solution.

Step 1: Login to Maya Manager Sandbox .

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 unencrypted API keys will be shown on the screen. This is the only time that you can visibly see this; once you exit, only the masked values will be reflected.

Step 6: 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.

🔐Save your API key in a secured location

Misuse or mishandling of tokens or keys within the jurisdiction of the Partner, could entail risks and vulnerability of transactions.

⚠️ If your API keys are lost or breached, delete the old API keys and generate new ones in the same environment.

4 Authenticate with our APIs

For every Maya solution, there are multiple API endpoints that you as a Partner can utilize. To verify your identity as an authorized entity accessing Maya's endpoints, API Authentication must be performed during transaction requests.

Authentication is done via HTTP Basic Authentication. Review the API endpoint and check which type of API key is required, whether it is a Public (pk-....) or Secret (sk-....) API key.

To identify what type of API key is required for an endpoint, look for reminders or callouts that look like below:

⚠️ For Basic Authentication, use PUBLIC API KEY. Learn more →

⚠️ For Basic Authentication, use PRIVATE API KEY. Learn more →

The following steps narrate how to use your API Keys:

  1. Use the appropriate or required key as the Username, followed by a ':' (colon) and then the Password which should be left blank. If your API key is pk-Z0OSzLvIcOI2UIvDhdTGVVfRSSeiGStnceqwUE7n0Ah, the resulting string is:
  1. Apply Base64 encoding to the resulting string from Step 1. Using the sample value above, the Base64 encoded string will be:
  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 also: HTTP Basic Auth

5 Proceed to the Solutions Guide

Now that you have generated your API keys, proceed to the setup guides of your Online Payments . Select the Maya solution you have activated and read the guides. At this stage, you will be proceeding to your development and testing in the Sandbox Environment.

🧠 Keep in mind

The API Keys generated are exclusive to the particular Maya Online Payment solution for which they were activated.

To illustrate, an API key created for Maya Checkout cannot be repurposed for a Maya Card Payment Vault Endpoint. Each solution mandates the use of its own distinct API key.

6 Implement Webhooks to know payment statuses

⚠️ Do not use public API Keys when registering and testing your Sandbox webhooks.

After your customer performs a payment from your application or platform, that transaction is sent to Maya for processing. Maya uses webhooks to notify you of specific events that occur during the payment request. Payment events include successful payments, a customer decides not to authorize the payment, or when the payment fails.

ℹ️ Learn how to implement webhooks by following the steps provided in the Create and Configure your Webhook guide.

7 Go Live

Once you are done with your tests on the Sandbox Environment, it is time to move to Production.

  1. Submit an email to the Maya Fulfillment Team ([email protected]) and your Relationship Manager the following details:
    1. Merchant Name
    2. MID
    3. Screenshot of “200 OK” Webhook response, after registering your Webhooks.
    4. [For Maya Checkout or Maya Card Payment Vault] Screenshot of one (1) successful transaction per each scheme provider: Visa, MasterCard, and JCB using our List of mock test cards.
  2. Maya’s Fulfillment Team to send you your MID and Production Maya Manager 1.0 access.
  3. Set up your Maya Manager 1.0 Production account.
  4. Generate your Production keys. Refer to Generate your API Keys.
  5. Set up your Production Webhooks. See Webhooks for Payment Solutions for guidance.
  6. Be ready for your Post Production Testing. Once launched in production, prepare the following:
    • For initiating transactions: Download the Maya App (For Pay with Maya) and/or use real cards.
    • Production launch of your application/platform.

⚠️ 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.

ℹ️ Do you wish to switch to Maya Business Manager? Contact [email protected].