How to Integrate

1 Obtain your API Keys

The Payments Processing Platform APIs uses API keys to authenticate requests. API keys carry many privileges, your grant or permission to access and integrate with Maya’s endpoints.

Authenticating with our API

Authentication is done via HTTP Basic Authentication. Depending on the API endpoint, the public (pk-....) or secret (sk-....) 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:

2. Apply Base64 encoding to the resulting string from Step 1. Using the resulting string from Step 1, the Base64 encoded string will be:

cGstWjBPU3pMdkljT0kyVUl2RGhkVEdWVmZSU1NlaUdTdG5jZXF3VUU3bjBBaDo=

3. 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=

2 Create Straight Payment

POST /p3/pay

Use this endpoint and provide basic payment details when performing a straight payment.

• A successful straight payment request will generate a paymentTransactionReferenceNo.
• Successful straight payment will be processed for clearing and settlement on the next cut-off schedule.

Funding instrument must be set to indicate the type of source of funds or where payment will be charged. Payments Processing Platform currently supports fundingInstrument: CARD

When card is used, you need to indicate the account type and card type where the transaction should be charged.

For E-commerce

"threeDSecure": 
{
      "verificationToken": "jqEmJkhI2+SDCAAAAAAJBwAAAAA=",
      "eci": "05",
      "enrolled": "Y",
      "authenticationStatus": "Y"
}

For Card-present

Initiator and Intent

You can indicate the initiator and the intent of the transaction in the Straight Payment requests. The value in these fields may be used by Issuers when determining the approval status of an authorization transaction.

INITIATOR (transaction.initiator)

INTENT (transaction.intent)

Reference Numbers

The following reference numbers can be set to provide additional tagging for each transaction during reconciliation processes:

Conditional Void and Refund

Void Transaction

POST /p3/void

Use this endpoint to void a successful transaction providing the paymentTransactionReferenceNo generated during creation of straight payment.

Refund Transaction

POST /p3/refund

Use this endpoint to refund straight payment

Clients can perform either full or partial refunds.

Full Refunds

• You just need to provide the transactionReferenceNo of the transaction to refund the full amount.

Partial Refunds

• You need to provide transactionReferenceNo and the amount to be refunded. You may continue to send partial refund requests until the entire amount for the transaction has been refunded.

3 Test your Work