E-Nkap v1.0.0 Quickstart Guide

CONTENTS
ABOUT E-NKAP 2
OVERVIEW 2
FEATURES 2
REQUIREMENTS FOR INTEGRATION 2
GETTING STARTED 2
REGISTER FOR AN ACCOUNT IN THE MERCHANT PORTAL 2
ACTIVATE YOUR API ACCOUNT 3
SUBSCRIPTION TO E-NKAP PAYMENT API 4
GENERATE TOKEN 4
API SPECIFICATIONS 6
OVERVIEW OF IMPORTANT ENDPOINTS 6
TEST API USING API CLIENT 6
PAYMENT TRANSACTION WORKFLOW 7
PAYMENT TRANSACTION WORKFLOW 9

PAYMENT FLOW WHEN SMOBILPAY IS SELECTED 10
PAYMENT FLOW WHEN MTN MOBILE MONEY IS SELECTED 10
PAYMENT FLOW WHEN EXPRESS UNION MOBILE IS SELECTED 10
PAYMENT FLOW WHEN ORANGE MONEY IS SELECTED 11
CALLBACKS 11
TRANSACTIONS 12

Copyright maviance © 2019 Page 1 of 14 e-nkap – QuickStart Guide

1. ABOUT E-NKAP
e-nkap is a payment platform that enables Cameroonians to buy and sell on the Internet using all existing
local payment methods.
We enable digital organisations to accept cash payments, MTN Mobile Money, Orange Money or payments
by cards.
In Cameroon, most payments happen with cash or mobile phones, not credit cards. That means if you’re an
online merchant, PayPal isn’t going to be enough–you’re going to need something that’s specific to the
market.
e-nkap offers a simple unique API to enable local businesses to go participate in the huge digital economy
by transforming their service offerings into the world of e-commerce sites. Meet your customers where
they spend more and more time – online!

Features
● A single contract for multiple payment methods. In Cameroon we currently support
○ Smobilpay
○ MTN Mobile Money
○ Express Union Mobile
○ Orange Money
● Instant notifications for transactions

● Save and easy way to receive money for your services
● All transactions in one place
● Fast and simple payout
2. REQUIREMENTS FOR INTEGRATION

Getting started with E-nkap is easy. After these 3 steps you are ready to trigger your first API call:
1. Register at our merchant portal and get your merchant account approved
2. Subscribe to the payment API in our API store
3. Generate an access token


3. GETTING STARTED
3.1. REGISTER FOR AN ACCOUNT IN THE MERCHANT PORTAL
First, you need to create an account in our merchant portal to get started.
The merchant portal will be your central hub allowing you to view your commercial data as well as your
transactions.
Your account will be reviewed and activated in no time by maviance team.
Please contact us in case of delays or issues.
Create an account at: https://merchant.enkap.cm/merchant


3.2. ACTIVATE YOUR API ACCOUNT

Once your account is activated, you can login in to 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 our API Manager is sent to your provided email.
Note: Please only click once and wait for a few seconds, for the activation to be processed by our subsystems.
3.3. SETTING UP CALLBACK AND NOTIFICATION URLS
Also now have to configure the Return URL and instant notification url.
● Return URL: This URL is required and used to redirect back the customer to your shop after the
payment has been ordered by the customer. E-nkap will append your reference id in the path of the
URL with the form: https://myshop.com/callback/{yourReferenceId}?status={STATUS}, where


yourReferenceId is generated by your system and was provided in the initial order placement
request. The status gives you the current payment status.
● Instant notification URL: The URL used by E-nkap to instantly notify you about the status of the
payment. E-nkap would append your reference Id (generated by your system and provided in the
initial order placement request) as path variable and send a PUT with the status of the payment in
the body as {"status":"[txStatus]"}, where [txStatus] is the payment status. Example: your
notification URL is https://www.myshop.com.com/callback, E-nkap invokes PUT with URL:
https://www.myshop.com.com/callback/{your_reference_Id} and body ({"status":"[txStatus]"})
3.4. SUBSCRIPTION TO E-NKAP PAYMENT API
As your application integration links are now setup, the next step involves the subscription of your API
account to the E-nkap API in our API Manager.
On the merchant portal, follow the link to access the Api Manager in order to subscribe to the API.


1. Click on the “API Manager” ( or navigate directly to https://store.enkap.cm/store )

2. Sign in by providing the username and password sent to you via email after activating the API
account in step 3.2
3. Select e-nkap payment api in the list
4. In the e-nkap payment api page, click on the Subscribe button on the right hand side
3.5. GENERATE TOKEN
Now all that is left is to generate your Access tokens.

Select the E-nkap API application in the API Manager, click on “Generate keys”
You will now 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 needs to be provided as a Bearer Token in the Authorization header of all requests to the
E-nkap API in order to authenticate you.
4. API SPECIFICATIONS
To ease implementation the full API description is available as a swagger document, which is included in
your welcome package.
4.1. API PAYMENT URL

E-nkap base payment API URL: https://api.enkap.cm/payment/v1
4.2. OVERVIEW OF IMPORTANT ENDPOINTS
Endpoints Purpose
/token Generate an access token


POST /api/order Create a new order transaction for payment.
DELETE /api/order/{txid} Cancel the order with id txid
GET /api/order/{txid} Returns the status and details of order with id txid
GET /api/order/{txid}/status Returns the payment status of order with id txid
4.3. TESTING OUR API USING AN API CLIENT
There are multiple ways to integrate our API. We however recommend that you have a first look at the API
using a preview tool importing the swagger file.
The easiest way to do that is the use of the following tool, which will allow you to view the API, run API
requests and even to generate fully working client code in your required language:
https://editor.swagger.io/#
1. In the swagger editor, Click on File → Import Url

2. Paste our E-nkap API specifications
3. View and execute the the endpoints/requests
4. Select Generate client and select the desired language to generate a fully working client for
integration into your application
5. PAYMENT TRANSACTION WORKFLOW

The following diagram depicts the sequence of calls and processes involved in the payment transaction
flow


After successful integration to your website, the following workflow occurs for a payment transaction
1. A Customer creates an order in your online shop and clicks on checkout.

Your application needs to send a request to the POST /api/order endpoint to create the order in
E-nkap. E-nkap shall return a response which include a redirect URL to our payment page, to which
you need to forward your customer.
2. The customer will now choose the payment option that is best for him and submit the request. The
individual flows for each provider are listed below.


3. Based on the selected payment service provider, a confirmation request for a second factor may be
necessary to confirm the transaction from customer side (e.g. MTN cashout confirmation via SMS
or USSD).
4. Your customer will now be redirected to the Return URL you have configured in the merchant
portal
5. At this stage, the transaction is in the status IN_PROGRESS. The instant notification URL you have
configured in the merchant portal will be used to update the status of the transaction when it
changes.
6. Once the payment has been processed, the status of the transaction will be changed to COMPLETED
(or FAILED in case of an error). The status of the order can at anytime be obtained by calling the
endpoint GET /api/order/{txid}/status


6. SUPPORTED PAYMENT PROVIDERS

Currently e-nkap supports the following payment options.
Please note that we will continuously add new providers.
1. Smobilpay
2. MTN Mobile Money
3. Express Union Mobile
4. Orange Money
6.1. PAYMENT FLOW WHEN SMOBILPAY IS SELECTED
When order has been created and has the status CREATED, when the customer selects Smobilpay as method of payment;
1. Customer enters name, phone number, email, confirms terms and conditions and clicks on submit;
2. The status of the transaction changes to IN_PROGRESS
3. Customer receives order number for the order by email or SMS.
4. The customer is redirected to the callback URL set in the merchant’s API configuration settings.
5. Customer goes to a nearby Smobilpay agent with the order number and pays for the order
6. When payment is successful or unsuccessful, customer is notified by email and status of the transaction changes
from IN_PROGRESS to COMPLETED or FAILED respectively.
7. Customer received a notification email with the appropriate status.
6.2. PAYMENT FLOW WHEN MTN MOBILE MONEY IS SELECTED
When order has been created and has the status CREATED and the customer selects MTN Mobile Money as the method of
payment;
1. Customer enters name, mobile money number, email, confirms terms and conditions and clicks on submit;
2. The status of the transaction changes to IN_PROGRESS.
3. Customer receives a USSD approval request from MTN to approve the payment of the order.
4. Customer approves the payment request by entering his secret code and submitting.
5. The customer’s account is debited by the order amount.
6. If the transaction is successful, the status of the transaction changes PENDING to CONFIRMED else FAILED.
7. Customer is notified by MTN if transaction is successful


6.3. PAYMENT FLOW WHEN EXPRESS UNION MOBILE IS SELECTED
When order has been created and has the status CREATED and the customer selects Express Union Mobile Money as the
method of payment;
1. Customer enters name, EU mobile number, email, confirms terms and conditions and clicks on submit;
3. Customer receives an SMS notification to approve the payment of the order on the EU mobile app.
4. Customer approves the payment request by entering his secret code and submitting.
5. The customer’s account is debited by the order amount.
6. If the transaction is successful, the status of the transaction changes PENDING to CONFIRMED else FAILED.
7. Customer is notified by Express Union if transaction is successful
6.4. PAYMENT FLOW WHEN ORANGE MONEY IS SELECTED
When order has been created and has the status CREATED and the customer selects Orange Money as the method of
payment;
1. Customer requests an OTP (One Time Password) from Orange

2. Customer enters name, Orange money number, OTP, email, confirms terms and conditions and clicks on submit;
4. E-nkap processes the transaction and changes the status to CONFIRMED or FAILED
5. Customer is notified by Orange if transaction is successful
TRANSACTIONS
You can view a list of your transactions at the Transaction history section of MY ACCOUNT in the Merchant Portal



E-Nkap v1.0.0 Quickstart Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

E-Nkap v1.0.0 Quickstart Guide

Uploaded by

Copyright:

Available Formats

PAYMENT TRANSACTION WORKFLOW 9

● A single contract for multiple payment methods. In Cameroon we currently support

● Instant notifications for transactions

2. REQUIREMENTS FOR INTEGRATION

Create an account​ at: ​ ​https://merchant.enkap.cm/merchant

3.2. ACTIVATE YOUR API ACCOUNT

3.3. SETTING UP CALLBACK AND NOTIFICATION URLS

3.4. SUBSCRIPTION TO E-NKAP PAYMENT API

1. Click on the “API Manager” ( or navigate directly to ​https://store.enkap.cm/store​ )

3.5. GENERATE TOKEN

Now all that is left is to generate your Access tokens.

Token generation URL: ​https://api.enkap.cm/token

4.1. API PAYMENT URL

4.2. OVERVIEW OF IMPORTANT ENDPOINTS

/token Generate an access token

POST /api/order Create a new ​order ​transaction for payment.

DELETE /api/order/{txid} Cancel the ​order ​with id ​txid

GET /api/order/{txid}/status Returns the ​payment ​status of ​order ​with id ​txid

4.3. TESTING OUR API USING AN API CLIENT

1. In the swagger editor, Click on File → Import Url

5. PAYMENT TRANSACTION WORKFLOW

1. A Customer creates an order in your online shop and clicks on checkout.

6. SUPPORTED PAYMENT PROVIDERS

6.1. PAYMENT FLOW WHEN SMOBILPAY IS SELECTED

7. Customer received a notification email with the appropriate status.

6.2. PAYMENT FLOW WHEN MTN MOBILE MONEY IS SELECTED

7. Customer is notified by MTN if transaction is successful

6.3. PAYMENT FLOW WHEN EXPRESS UNION MOBILE IS SELECTED

6.4. PAYMENT FLOW WHEN ORANGE MONEY IS SELECTED

1. Customer requests an OTP (One Time Password) from Orange

You might also like

Create an account at: https://merchant.enkap.cm/merchant

1. Click on the “API Manager” ( or navigate directly to https://store.enkap.cm/store )

Token generation URL: https://api.enkap.cm/token

POST /api/order Create a new order transaction for payment.

DELETE /api/order/{txid} Cancel the order with id txid

GET /api/order/{txid}/status Returns the payment status of order with id txid