Register for an account in the merchant portal.

You need to create an account to get started.
Your account will be reviewed and activated in no time by maviance team.
Create an account at https://merchant.enkap.cm/merchant/#/login

Activate your API account.

  • Once your account is activated, you can log in into the portal and Activate your API account by clicking the button Activate API Account in API SETTINGS tab.
  • By doing so, an email with the login credentials to the API manager is sent to your email.
  • Also, you have to configure the callback URLs and notification URL. E-nkap uses the callback URL to redirect the customer after completing his transaction. At this stage, the transaction is in the "PENDING" status: The notification URL is used to update the status of the transaction when it changes.


Setting up the merchant email notifications.

As a merchant, you can configure e-nkap to send email notifications to your email address for successful transactions. To set-up your email and activate the feature, follow the steps below:

  1. Log in to the merchant portal with your merchant credentials.
  2. Go to edit profile.
  3. On the SUPPORT INFORMATION section, enter the notification email address and select 'Yes' for support email-enabled.
  4. Click save.

Accessing e-nkap payment API.

On the merchant portal, you have a link to access to the API manager in order to subscribe to the API.

  1. Click on the "API manager" link.
  2. Sign in by providing username and password sent by email after activating the API account.


To access the e-nkap payment API, there are two steps involved.

  1. Create an application in the API manager (or use the default one).
  2. Subscribe to the ENKAP PAYMENT API on the application.

Creating an Application.

  1. On the application page, click 'ADD APPLICATION'.
  2. Enter the application 'name' and 'description' and click 'ADD' to save it.

Subscribing to the API.

You can subscribe to the e-nkap API on the application you created or on the default application.

  1. On the APIs page, click on the e-nkap payment API.
  2. Select the 'Application' you want to use from the application drop-down list.
  3. Click subscribe to the API.

.

Generate Token

Select the ENKAP API application in the API Manager, click on generate keys.

After clicking on the generate keys button, you will see your Customer Key and Customer Secret. These two keys can be used to generate your basic token used for access token generation.
Token generation URL: https://api.enkap.cm/token
This access token of type Bearer is to be included in all the request to the ENKAP API


Request

curl -k -d "grant_type=client_credentials" \-H "Authorization: Basic Base64(consumer-key:consumer-secret)" \ https://api.enkap.cm/token


Response

{ "access_token": "abackd-fd2231" "scope": "scope" "token_type": "Bearer" "expires_in": 3600}

Important API Endpoints


Endpoints

Purpose

POST /api/order

Create a new order transaction for payment.

DELETE /api/order/{txid}

Cancel the order with id txid.

GET /api/order?orderMerchantId={orderMerchantId}
GET /api/order?txid={txid}

Returns the details of the order with the merchant external id or the e-nkap internal id respectively.

GET /api/order/status?orderMerchantId={orderMerchantId}
GET /api/order/status?orderTransactionId={orderTransactionId}

Returns the payment status of the order with the merchant external id or the e-nkap internal id respectively.