Value added services

Well documented APIs to offer consumer product
Supports products like:
Insurance (Auto, health, life);
Airtime;
Fashion;
Bill payment;
Travel

Get Mobile Operators List

Method URL

https://kegow.bancore.com/getit/api/mobile/airtime/operators.do

Request Parameters

Parameter	Description	Type
merchantID	Merchant account id. Provided by Bancore.	Required
access_token	Unique token generated	Required

Response Parameters

Parameter	Description	Type
Parameter	Description	Type
result	Success or fail result code	Required
errorMessage	Error description	Optional
operators	List of mobile phone operators is returned e.g. (MTN-MTN; ETST-9Mobile; AIRT-AirTel; GLO-GLO; VISAF-Visafone Nigeria; MLINK-MultiLinks; MTNHYNET-MTN Hynet; MTNBBSERV-MTN Blackberry; MTNDSERV-MTN Data; MTNPOSP-MTN Postpaid; ETSTDATA-9Mobile Data; AIRTDATA-Airtel Data; GLODATA-Globacom Data; LCC-LCC Toll)	Optional

Return Codes

Code	Value	Description
0	MISSING_PARAMETER	Required parameter(s) was not found or wrong name
10	REJECT_ENCKEY_MISMATCH	Encryption key is invalid
30	SUCCESS	Successful operation
95	INVALID_MERCHANT_ACCOUNT	Invalid merchant, merchant don’t exist
100	GENERAL_ERROR	Unknown error. Please try again later

Airtime Purchase

Purchase airtime recharge for user phone number. Funds will be loaded to the user’s phone account. Use the Method URL below.

Method URL

https://kegow.bancore.com/getit/api/merchant/merchantairtime.do

Request Parameters

Parameter	Description	Type
Parameter	Description	Type
merchantID	Merchant account ID of the client	required
operator	Mobile phone operator name (MTN-MTN;ETST-Etisalat;VISAF-VISAF;AIRT-AirTel;MLINK-MLINK;GLO-GLO)	required for Nigerian numbers optional for international numbers
destinationNumber	Mobile phone number of recipient of airtime in international format (234xxxxxxxxxx)	required
amount	Amount in smallest monetary unit for Nigerian numbers (10*100 = 1000) Amount whole number for international numbers (10)	required
currency	For Nigerian numbers: Currency code (e.g NGN) For international numbers: Currency code (e.g XOF) of the destination phone number	required
orderId	Unique identifier of the transaction	required
encKey	For Nigerian numbers: SHA-256(merchantID + destinationNumber + amount + orderID +operator+merchantPrivateKey) For international numbers: SHA-256(merchantID + destinationNumber + amount + orderID +merchantPrivateKey)	required

Response Parameters

Parameter	Description	Type
Parameter	Description	Type
result	Response code in case of successful transaction will be APPROVED = “30”	required
errorMessage	Description of error returned	optional
transactionId	Transaction ID of the operation	optional

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/merchantairtime.do?merchantID=72&operator=ETST&destinationNumber=2347062206892&amount=1500&orderId=1569319479476¤cy=NGN&encKey=f1646bc7fcf7df3a268ccd3ff931491c2fda4f313a1121fd3d9f658026eaeea4

response:

result=30&transactionId=2593

request:

https://kegow.bancore.com/getit/api/merchant/merchantairtime.do?merchantID=76&destinationNumber=380951780154&amount=10&orderId=158815480096266241¤cy=UAH&encKey=dc783acf44b455a68baf30d622a71c22178c9f80683debbd1dd9fa7eeacaf4d9

response:

result=30&transactionId=67309

Payment with Voucher

This method is used to process Payment with Voucher. Use the Method URL below.

Method URL

https://kegow.bancore.com/getit/api/vouchercardpurchase.do

Request Parameters

Parameter	Description	Type
account_id	Unique identifier of merchant account in the system	Required
cardnumber	19 digits voucher number	Required
currency	Currency code (e.g NGN)	Required
amount	Amount in smallest monetary unit	Required
order_id	Customer unique identifier of the transaction	Optional
encKey	Encryption key. SHA-256(account_id+ cardnumber+ amount+ currency+ private_key)	Required

Response Parameters

Parameter	Description	Type
result	Success or fail result code	Required
transact	Transaction id	Optional
checkSUM	Encryption key. SHA-256(result + transact+merchantPrivateKey)	Optional

Sample:

request:

https://kegow.bancore.com/getit/api/vouchercardpurchase.do?account_id=72&cardnumber=6395536056449808776¤cy=XOF&amount=5000&order_id=1585578673735&enckey=c8d6f4bfe52782ed57a16f112cec0386f0a4aa22976d0d8d2dec64158a9777

response:

result=30&transact=64496&checksum=AC65C97B308636A067F7DB769A5C8D87B002F888151DC365562AA910E3786452

Cardless ATM Withdrawal

Method URL

https://kegow.bancore.com/getit/api/mobile/atm/withdraw.do

Request Parameters

Parameter	Description	Type
merchant_id	Merchant account id. Provided by Bancore.	Required
access_token	Unique token generated	Required
phone	Recipient’s phone number	Required
amount	Amount in smallest monetary units	Required
currency	Currency of the operation	Required
sourceCard	Id of the source card	Required
orderID	Unique identifier of the operation	Required
encKey	Encryption key SHA-256(merchant_id+ phone+ amount+ currency+ merchantPrivateKey)	Required

Response Parameters

Parameter	Description	Type
result	Success or failure result code	Required
code	Withdrawal code	Required
pin	Pin code to confirm the withdrawal	Required
error	Error code	Required
checkSum	Checksum	Optional

Return Codes

Code	Value	Description
0	MISSING_PARAMETER	Required parameter(s) was not found or wrong name
10	REJECT_ENCKEY_MISMATCH	Encryption key is invalid
20	INSUFFICIENT_FUNDS	Not enough funds for requested operation
30	SUCCCESS	Successful Payment
60	INVALID_CARD	Invalid card number. Account doesn’t exist For registration, returns if account already exists
90	INVALID_ORDERID	OrderID must be unique
95	INVALID_MERCHANT_ACCOUNT	Invalid merchant, merchant don’t exist
98	TRANSFER_LIMIT	Transfer limit
100	GENERAL_ERROR	Unknown error. Please try again later
102	BLOCKED_MOBILE_NUMBER	Mobile number is blocked
116	KYC_PAYMENT_LIMIT	Payment limit is exceeded for KYC level
302	POSSIBLE_FRAUD	Suspicious Activity
415	WRONG_TOKEN	Token value is wrong

Send SMS

This method is used for SMS send out. Use the Method URL below.

Method URL

https://kegow.bancore.com/getit/api/merchant/sms.do

Request Parameters

Parameter	Description	Type
phone	Recipient phone number	Required
merchantID	Provided merchant account id	Required
text	Text of the SMS	Required
from	Sender name	Required
encKey	Encryption key. SHA-256(merchantID + phone + text + merchantPrivateKey)	Required

Response Parameters

Parameter	Description	Type
result	Success or fail result code	Required

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/sms.do?merchantID=72&phone=96170909700&text=test+txt&from=Monnyme&encKey=3e5266857d2faa97a228de1e94ffe1845925302b2158f5792fa226af85ef04

response:

result=30

Bill Payment

Bill Payment. Get Category.

Method URL

https://kegow.bancore.com/getit/api/mobile/quickteller/getCategories.do

Request Parameters

Parameter	Description	Type
merchant_id	Merchant account id. Provided by Bancore.	Required
access_token	Unique token generated	Required
encKey	Encryption key SHA-256(merchant_id+ access_token+ merchantPrivateKey)	Required

Response Parameters

Parameter	Description	Type
result	Success or failure result code	Required
categories	json with list of categories will be returned	Required

Bill Payment. Get Billers.

Method URL

https://kegow.bancore.com/getit/api/mobile/quickteller/getBillers.do

Request Parameters

Parameter	Description	Type
merchant_id	Merchant account id. Provided by Bancore.	Required
access_token	Unique token generated	Required
category_id	ID of the category selected by user in the first step of Bill Payment process	Required
encKey	Encryption key SHA-256(merchant_id+ access_token+ category_id+ merchantPrivateKey)	Required

Response Parameters

Parameter	Description	Type
result	Success or failure result code	Required
billers	json with list of billers for specified category will be returned	Required

Bill Payment. Get Product.

Method URL

https://kegow.bancore.com/getit/api/mobile/quickteller/getProducts.do

Request Parameters

Parameter	Description	Type
merchant_id	Merchant account id. Provided by Bancore.	Required
access_token	Unique token generated	Required
biller_id	ID of the biller selected by user in the second step of Bill Payment process	Required
encKey	Encryption key SHA-256(merchant_id+ access_token+ category_id+ merchantPrivateKey)	Required

Response Parameters

Parameter	Description	Type
result	Success or failure result code	Required
products	json with list of products for specified biller will be returned	Required

Bill Payment. Pay Bill.

Method URL

https://kegow.bancore.com/getit/api/mobile/quickteller/pay.do

Request Parameters

Parameter	Description	Type
merchant_id	Merchant account id. Provided by Bancore.	Required
access_token	Unique token generated	Required
product_id	Payment code returned under getProducts.do for the product that you need	Required
customer_id	Customer details for the selected product	Required
card_id	ID of the card to be used for payment	Required
amount	Amount to be paid in smallest monetary units	Required
currency	Currency	Required
encKey	Encryption key SHA-256(merchant_id+ access_token+amount+ customer_id+card_id+ merchantPrivateKey)	Required

Response Parameters

Parameter	Description	Type
result	Success or failure result code	Required
responseCode	Response code from the Bill Payment provider	Required
transactionId	Unique identifier of the transaction	Required
transactionDate	Date of the transaction	Required

Possible Return Codes

Code	Value	Description
0	MISSING_PARAMETER	Required parameter(s) was not found or wrong name
10	REJECT_ENCKEY_MISMATCH	Encryption key is invalid
20	INSUFFICIENT_FUNDS	Not enough funds for requested operation
30	SUCCCESS	Successful Payment
60	INVALID_CARD	Invalid card number. Account doesn’t exist For registration, returns if account already exists
61	CARD_BLOCKED	Card blocked
90	INVALID_ORDERID	OrderID must be unique
95	INVALID_MERCHANT_ACCOUNT	Invalid merchant, merchant don’t exist
100	GENERAL_ERROR	Unknown error. Please try again later
101	MOBILE_NUMBER_ERROR	Mobile number is wrong
102	BLOCKED_MOBILE_NUMBER	Mobile number is blocked
103	PIN_ERROR	PIN code is wrong
113	CARDID_TOKEN_WRONG	Card id differs from account represented by token
116	KYC_PAYMENT_LIMIT	Payment limit is exceeded for KYC level
150	VIRTUALCARD_LIMIT_EXCEEDED	Virtual cards limit is excceeded
151	PLASTICCARD_LIMIT_EXCEEDED	Plastic cards limit is excceeded
200	USER_IP_TRIES_EXCEEDED	Customer has exceeded failed attempts and has been blocked
202	UNEXPECTED_MERCHANT_IP	Merchant IP is unknown
203	DEACTIVE_MERCHANT_ACCOUNT	The merchant account is not active
300	FEE_NOT_FOUND	Fee value not available
400	APPLICATION_UPDATE	The application is not available
415	WRONG_TOKEN	Token value is wrong
420	BANK_TRANSFER_FAILED	Transfer to bank failed

International mobile data

Possible Return Codes

Code	Value	Description
0	MISSING_PARAMETER	Required parameter(s) was not found or wrong name
10	REJECT_ENCKEY_MISMATCH	Encryption key is invalid
20	INSUFFICIENT_FUNDS	Not enough funds for requested operation
30	SUCCCESS	Successful Payment
60	INVALID_CARD	Invalid card number. Account doesn’t exist For registration, returns if account already exists
61	CARD_BLOCKED	Card blocked
90	INVALID_ORDERID	OrderID must be unique
95	INVALID_MERCHANT_ACCOUNT	Invalid merchant, merchant don’t exist
100	GENERAL_ERROR	Unknown error. Please try again later
101	MOBILE_NUMBER_ERROR	Mobile number is wrong
102	BLOCKED_MOBILE_NUMBER	Mobile number is blocked
103	PIN_ERROR	PIN code is wrong
113	CARDID_TOKEN_WRONG	Card id differs from account represented by token
116	KYC_PAYMENT_LIMIT	Payment limit is exceeded for KYC level
150	VIRTUALCARD_LIMIT_EXCEEDED	Virtual cards limit is excceeded
151	PLASTICCARD_LIMIT_EXCEEDED	Plastic cards limit is excceeded
200	USER_IP_TRIES_EXCEEDED	Customer has exceeded failed attempts and has been blocked
202	UNEXPECTED_MERCHANT_IP	Merchant IP is unknown
203	DEACTIVE_MERCHANT_ACCOUNT	The merchant account is not active
300	FEE_NOT_FOUND	Fee value not available
400	APPLICATION_UPDATE	The application is not available
415	WRONG_TOKEN	Token value is wrong
420	BANK_TRANSFER_FAILED	Transfer to bank failed

International mobile data. Get Countries.

Method URL

https://kegow.bancore.com/getit/api/merchant/airtime/transferto/countries.do

Request Parameters

Parameter	Description	Type
merchantID	Merchant account id. Provided by Bancore.	Required
orderID	Unique identifier of the transaction	Required
encKey	Encryption key SHA-256(merchantID + OrderID + merchantPrivateKey)	Required

Response Parameters

Parameter	Description	Type
result	Success or failure result code	Required
countries	list of countries will be returned	Required
countryIDs	list of countries ID will be returned	Required

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/airtime/transferto/countries.do?merchantID=72&orderID=1620386773452&encKey=62354cb3c4b2b2a4d119b347c427a1ac8a445f266f0b098533e1966c1f7a15fc

response:

result=30&countries=Afghanistan,Albania,Anguilla,Antigua and Barbuda,Argentina,Armenia,Aruba,Bangladesh,Barbados,Benin,Bolivia,Brazil,British Virgin Islands,Burkina Faso,Burundi,Cambodia,Cameroon,Cayman Islands,Central African Republic,Chile,China,Colombia,Costa Rica,Cyprus,Dominica,Dominican Republic,DR Congo,Ecuador,Egypt,El Salvador,Eswatini,Fiji,France,Gambia,Ghana,Grenada,Guatemala,Guinea,Guinea-Bissau,Guyana,Haiti,Honduras,India,Indonesia,Iraq,Ivory Coast,Jamaica,Jordan,Kazakhstan,Kenya,Kosovo,Kuwait,Laos,Liberia,Madagascar,Malaysia,Mali,Mexico,Moldova,Morocco,Mozambique,Nepal,Nicaragua,Niger,Nigeria,Pakistan,Palestine,Panama,Papua New Guinea,Paraguay,Peru,Philippines,Poland,Puerto Rico,Republic of the Congo,Romania,Russia,Rwanda,Saint Kitts and Nevis,Samoa,Senegal,Sierra Leone,Singapore,Sint Maarten,Somalia,South Africa,Spain,Sri Lanka,Tanzania,Thailand,Togo,Tonga,Trinidad and Tobago,Tunisia,Turkey,Turks and Caicos Islands,Uganda,Ukraine,United States,Uruguay,Vanuatu,Vietnam,Yemen,Zambia,Zimbabwe&countryIDs=661,662,916,668,669,670,671,678,679,683,686,691,692,697,698,699,700,704,705,707,708,710,715,718,724,725,712,727,729,730,876,737,740,745,748,753,756,757,758,760,761,762,766,767,769,773,774,776,778,779,919,782,785,789,797,799,801,808,810,813,814,819,824,825,826,832,834,836,837,838,839,840,841,842,913,847,848,849,918,855,859,862,863,941,867,868,870,871,882,884,886,888,889,891,892,894,900,901,899,904,906,908,911,914,915

International mobile data. Get Operators.

Method URL

https://kegow.bancore.com/getit/api/merchant/airtime/transferto/operators.do

Request Parameters

Parameter	Description	Type
merchantID	Merchant account id. Provided by Bancore.	Required
countryID	ID of the country selected by user in the first step	Required
orderID	Unique identifier of the transaction	Required
encKey	Encryption key SHA-256 (merchantID + countryID + orderID + merchantPrivateKey)	Required

Response Parameters

Parameter	Description	Type
result	Success or failure result code	Required
operators	list of operators for specified country will be returned	Required
operatorIDs	list of operators ID for specified country will be returned	Required

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/airtime/transferto/operators.do?merchantID=72&countryID=901&orderID=1620386906138&encKey=d73befc32cd49af66c0621b24e2407b622b4fe0afd58fd099ff210930709e33a

response:

result=30&operators=Intertelecom Ukraine,Kyivstar Ukraine,Lifecell Ukraine,Vodafone Ukraine&operatorIDs=1799,322,43,1423

International mobile data. Get Products.

Method URL

https://kegow.bancore.com/getit/api/merchant/airtime/transferto/products.do

Request Parameters

Parameter	Description	Type
merchantID	Merchant account id. Provided by Bancore.	Required
operatorID	ID of the operator selected by user	Required
orderID	Unique identifier of the transaction	Required
encKey	Encryption key SHA-256(merchantID + operatorID + orderID + merchantPrivateKey)	Required

Response Parameters

Parameter	Description	Type
result	Success or failure result code	Required
products	list of products for specified biller will be returned	Required
wholesalePrices	list of wholesale prices	Required
retailPrices	list of retail prices	Required

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/airtime/transferto/products.do?merchantID=72&operatorID=322&orderID=1620387034696&encKey=5ebbf19cf9cadb48f88756ac030a40fd0a2d79c831b5d97aaedf5216fac41ea7

response:

result=30&products=5,10,15,20,25,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100,125,150,200,250,300,400,500,600,700,800,900,1000,1100,1200&wholesalePrices=0.23,0.43,0.64,0.84,1.05,1.25,1.46,1.66,1.87,2.07,2.28,2.48,2.69,2.89,3.10,3.30,3.52,3.72,3.93,4.13,5.15,6.18,8.24,10.28,12.34,16.45,20.55,24.66,28.76,32.87,36.98,41.08,45.19,49.29&retailPrices=0.30,0.60,0.80,1.10,1.40,1.60,1.90,2.10,2.40,2.60,2.90,3.10,3.40,3.70,3.90,4.20,4.40,4.70,5.00,5.20,6.50,7.80,10.30,12.90,15.50,20.60,25.70,30.90,36.00,41.10,46.30,51.40,56.50,61.70

International mobile data. Merchant Data Purchase

Method URL

https://kegow.bancore.com/getit/api/merchant/merchantairtime.do

Request Parameters

Parameter	Description	Type
merchantID	Merchant account ID of the client	Required
operator	ID of the operator selected by user	Required
destinationNumber	Mobile phone number of recipient of airtime in international format	Required
amount	Amount in smallest monetary unit	Required
currency	For international numbers: Currency code (e.g XOF) of the destination phone number	Required
orderID	Unique identifier of the transaction	Required
encKey	SHA-256(merchantID + destinationNumber + amount + orderID +merchantPrivateKey)	Required

Response Parameters

Parameter	Description	Type
result	Response code in case of successful transaction will be APPROVED = “30”	Required
errorMessage	Description of error returned	Optional
wholesalePrices	Transaction ID of the operation	Optional

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/merchantairtime.do?merchantID=76&destinationNumber=380963956548&amount=500&orderId=1620389894151¤cy=UAH&operator=322&encKey=f3da5febdb69dd5a6f4ab8d3ae4b15bfd741a856cc1a4e984045f607c08fbb27

response:

result=30&transactionId=72900

NOTES: The API method doesn’t work for Nigerian phone numbers, only international.

Consumer Services

Value added services

Get Mobile Operators List

Method URL

Request Parameters

Response Parameters

Return Codes

Airtime Purchase

Method URL

Request Parameters

Response Parameters

Sample:

Payment with Voucher

Method URL

Request Parameters

Response Parameters

Sample:

Cardless ATM Withdrawal

Method URL

Request Parameters

Response Parameters

Return Codes

Send SMS

Method URL

Request Parameters

Response Parameters

Sample:

Bill Payment

Bill Payment. Get Category.

Method URL

Request Parameters

Response Parameters

Bill Payment. Get Billers.

Method URL

Request Parameters

Response Parameters

Bill Payment. Get Product.

Method URL

Request Parameters

Response Parameters

Bill Payment. Pay Bill.

Method URL

Request Parameters

Response Parameters

Possible Return Codes

International mobile data

Possible Return Codes

International mobile data. Get Countries.

Method URL

Request Parameters

Response Parameters

Sample:

International mobile data. Get Operators.

Method URL

Request Parameters

Response Parameters

Sample:

International mobile data. Get Products.

Method URL

Request Parameters

Response Parameters

Sample:

International mobile data. Merchant Data Purchase

Method URL

Request Parameters

Response Parameters

Sample:

API Specification

Need Help ?