Get started

The K-Pay API provides programmatic access to allow you to pay and get paid by your customers using MoMo by MTN, Aitel Money, Visa, Mastercard, SMartcash, SPENN etc

To use this API, you need credentials and API key. Please contact us at www.kpay.africa to get your access.

API Endpoint :
https://pay.esicia.com/

Supported Payment methods

We are ISO/IEC 27001:2013 and PCI-DSS Certified

Headers

Payment request

To initiate a payment you need to make a POST call to the following request in Json

# Here is a curl example
curl \
-X POST https://pay.esicia.com/ \
-H 'secret_key=your_api_key' \
-d '{
"action":"pay",
"msisdn":"0783300000", 
"details":"order",
 "refid":"15947234071471114", 
"amount":4200,"currency":"RWF",
 "email":"user@user.rw", 
"cname":"CUSTOMER NAME", 
"cnumber":"123456789", 
"pmethod":"momo", 
"retailerid":"02",
 "returl":"https://iduka.rw/api/call",
 "redirecturl":"https://www.iduka.rw"}'
                

Success result example :

{
"reply":"PENDING",
"url":"https://pay.esicia.com/checkout/A12343983489",
"success":1,
"authkey":"m43snbf9oivnmersqh6mn1lbh5",
"tid":"E6974831594723691",
"refid":"15947234071471114",
"retcode":0
}
                

Parameters

Failed example :

{
"reply":"TARGET_AUTHORIZATION_ERROR",
"url":" ",
"success":0,
"authkey":"m43snbf9oivnmersqh6mn1lbh5",
"tid":"E6974831594723691",
"refid":"15947234071471114",
"retcode"::606
}
                

Payment status inquiry

To check a payment status, you need to make a POST call to the following request in Json

# Here is a curl example
curl \
-X POST https://pay.esicia.com/ \
-H 'secret_key=your_api_key' \
-d '{ 
"action":"checkstatus",
"refid":"15947234071471114"
}'
                

Success result example :

{
"tid":"A441489693051",
"refid":"1489693046",
"momtransactionid":"616730887",
"statusid":"01",
"statusdesc":"Successfully processed transaction."

}

                

Parameters

Failed example :

{
"tid":"E6974831594723691",
"refid":"15947234071471114",
"momtransactionid":"12943154",
"statusdesc":"TARGET_AUTHORIZATION_ERROR",
"statusmsg":"Not enough funds",
"statusid":"02"

}
                

Payment callback response

K-Pay will send to your system a response as soon as it gets its completion status this is send to returl parameter

# Here is a curl example
curl \
-X POST ####returl#### \

-d '{
"tid":"A441489693051",
"refid":"1489693046",
"momtransactionid":"616730887",
“payaccount”:”0783300000”,
"statusid":"01",
"statusdesc":"Successfully processed transaction."

}
'
                

Expected response :

{
"tid":"A441489693051",
"refid":"1489693046",
"reply":"OK"
}


                

Parameters

Available Payment methods

Supported Payment methods in K-Pay

Test Cards

Some test cards you can use on Visa / MasterCard payment methods
CVV: use 3 digits example 123
Expiration date: use any date in the future

Transaction limits

The transaction limits are set based on transaction payment method

Return codes

The K-Pay API has various response codes (retcode):