This operation is used to register a new cardholder. Use the Method URL below.
https://kegow.bancore.com/getit/api/merchant/registration.do
|
Parameter |
Description |
Type |
|---|---|---|
|
merchantID |
Merchant account ID |
Required |
|
phone |
Mobile number in international format |
Required |
|
name |
User name |
Required |
|
address |
User address |
Required |
|
city |
User city |
Required |
|
country |
User country in ISO code format (ex. Nigeria – NG) |
Required |
|
zip |
Zip Code |
Required |
|
region |
Region code in ISO format (LA for Lagos) |
Optional |
|
customerID |
National ID |
Optional |
|
ip |
User IP address |
Optional |
|
|
User email |
Optional |
|
encKey |
SHA-256(merchantID + phone + merchantPrivateKey) |
Required |
|
Parameter |
Description |
Type |
|---|---|---|
|
result |
Response code in case of successful transaction will be APPROVED = “30” |
result |
|
phone |
User phone number |
phone |
|
encKey |
SHA-256(merchantID + phone + result + merchantPrivateKey) |
encKey |
|
errorText |
If we have some errors, add supported text. |
errorText |
https://kegow.bancore.com/getit/api/merchant/registration.do?merchantID=76&phone=2348049714879&name=Max+Andros&address=Cronenberg+321&city=Abuja&country=NG&zip=00176®ion=LA&customerID=1999755079&ip=198.31.5.81&email=test@test,com&birthDate=2000-08-28&encKey=4dd9a00401fd7b850d02e3ced85509f4e9f2bd9dcfe1a5ce9d47131cb36639b
result=30&phone=2348049714879&encKey=30305088E682D2EC11BE4FC5715BC09C5F3BD50C95EBEDE2547F77BA6EA7C606&errorText=null
This operation retrieves cardholder registration data. Use the Method URL below.
https://kegow.bancore.com/getit/api/merchant/account.do
|
Parameter |
Description |
Type |
|---|---|---|
|
merchantID |
Merchant account ID |
Required |
|
phone |
Mobile number in international format |
Required |
|
encKey |
SHA-256(phone + merchantID + merchantPrivateKey) |
Required |
|
Parameter |
Description |
Type |
|---|---|---|
|
result |
Response code in case of successful transaction will be APPROVED = “30” |
required |
|
firstName |
Сustomer first name stored in account |
optional |
|
lastName |
Customer last name stored in account |
optional |
|
dateOfBirth |
User date of birth in format year-month-date |
optional |
|
state |
User registered state in ISO format |
optional |
|
address |
User registered address |
optional |
|
city |
User registered City |
optional |
|
zip |
User registered zip code |
optional |
|
remitterId |
User ID registered with the account |
optional |
|
pinExist |
True – permanent pin code set up for the account False – Go through OTP |
optional |
|
checkSum |
SHA-256(phone + merchantID + firstName + merchantPrivateKey) |
optional |
https://kegow.bancore.com/getit/api/merchant/account.do?merchantID=72&phone=2348094194738&encKey=3b66f9492d62a3000cf131a13df8441337056b163e2c707931af79ecdefe11a
result=30&firstName=Airiel&lastName=Corund&dateOfBirth=2000-08-28&state=LA&address=Cronenberg321&city=Abuja&zip=00176&remitterId=1999755079&checkSUM=D4EDC61F1D4A376F579FCB80E667B1B660B18B00764ECA6806D8EADDC71622CF&cards=11984931&pinExist=false
This operation allows checking the current card balance of the cardholder. Use the Method URL below.
https://kegow.kegow.com/getit/api/merchant/balance.do
|
Parameter |
Description |
Type |
|---|---|---|
|
cardID |
Provided card reference/id |
Required |
|
merchantID |
Provided merchant account id |
Required |
|
encKey |
Encryption key. SHA-256(cardID + merchantID + merchantPrivateKey) |
Required |
|
Parameter |
Description |
Type |
|---|---|---|
|
result |
Success or fail result code |
Required |
|
amount |
Card available balance |
Required |
|
cardName |
Card holder name |
Required |
|
currency |
Card currency |
Required |
|
checkSUM |
Encryption key. SHA-256(cardID + merchantID + amount + currency + merchantPrivateKey) |
Required |
https://kegow.bancore.com/getit/api/merchant/balance.do?cardID=4860095&merchantID=72&encKey=b0714fc99dbaa713c079729024d38d3c00243925e10fb8aede6818ee6837221
result=30&amount=1698.7¤cy=XOF&cardName=Airiel Corund&checkSUM=1E8B5182961500B7AB6403B6BF66E4F0FBDC7BB5ABCE35C4380CF88BEC162F99
This operation is used to get transaction history activity for a given cardholder over a period of time. Use the Method URL below.
https://kegow.bancore.com/getit/api/merchant/ministatement.do
|
Parameter |
Description |
Type |
|---|---|---|
|
cardID |
Provided card reference/id |
Required |
|
merchantID |
Provided merchant account id |
Required |
|
encKey |
Encryption key. SHA-256(cardID + merchantID + merchantPrivateKey) |
Required |
Response content type: application/xml
0
0001
01/01/2013
01/06/2013
accountId is required parameter
encKey is required parameter
cardId is required parameter
30
0001
01/01/2013
01/06/2013
2013-05-29T00:00:00+03:00
Transfer of USD10.00 to ‘Virtual card in USD for ID: 96805’ Virtual Card
TransactionEntryId:(13ef00e831e0248)
-10.00
66.35
2013-05-29T00:00:00+03:00
Transfer of USD10.00 to ‘Virtual card in USD for ID: 96805’ Virtual Card
TransactionEntryId:(13ef00d8fab0f48)
-10.00
76.35
2013-05-23T00:00:00+03:00
Transfer of USD13.65 to ‘Virtual card in USD for ID: 96805’ Virtual Card
TransactionEntryId:(13ed0f019960b48)
-13.65
86.35
2013-05-23T00:00:00+03:00
Transfer of USD100.00 from ‘bancore.USD’ Funding Account
TransactionEntryId:(13ed0eebab00248)
100.00
100.00
This operation is used to update Personal Information of the cardholder. Use the Method URL below.
https://kegow.bancore.com/getit/api/merchant/profile/update.do
|
Parameter |
Description |
Type |
|---|---|---|
|
merchantID |
Merchant account id. Provided by Bancore. |
Required |
|
phone |
Mobile number in international format |
Required |
|
address |
Customer’s address |
Required |
|
country |
Customer’s country |
Required |
|
|
Customer’s email address |
Required |
|
firstName |
Customer’s first name |
Required |
|
lastName |
Customer’s last name |
Required |
|
zip |
Zip code |
Required |
|
city |
Customer’s city |
Required |
|
dateOfBirth |
Customer’s date of birth |
Required |
|
subscribed |
Customer’s subscription |
Optional |
|
address2 |
Customer’s address 2 |
Optional |
|
fullAddress |
Customer’s full address |
Optional |
|
cityDistrict |
Customer’s city district |
Optional |
|
stateCountyRegion |
Customer’s region code |
Optional |
|
encKey |
SHA-256(merchantID+phone+email+dateOfBirth+merchantPrivateKey) |
Required |
|
Parameter |
Description |
Type |
|---|---|---|
|
result |
Success or failure result code |
Required |
https://kegow.bancore.com/getit/api/merchant/profile/update.do?merchantID=50&phone=2348096989068&address=Maple+street+29-2&country=NG&email=test@test.com&firstName=Ayn&lastName=Vorky&zip=100001&city=Lagos&dateOfBirth=2000-08-08&subscribed=true&address2=Maple+street+27-2&fullAddress=Maple+street+23+Lagos+100001&cityDistrict=test&stateCountyRegion=LA&encKey=d1eb48c64a55ccd08a86b53752660ee69b8593ba5a59c30d53d01ee2f90950
result=30
This operation is used to send a request to Withdraw Funds from the card. Use the Method URL below.
https://kegow.bancore.com/getit/api/merchant/withdraw.do
|
Parameter |
Description |
Type |
|---|---|---|
|
cardID |
Provided card reference/id |
Required |
|
merchantID |
Provided merchant id |
Required |
|
currency |
Currency code (e.g USD) |
Required |
|
amount |
Amount in smallest monetary unit |
Required |
|
orderID |
Customer unique identifier of the transaction |
Required |
|
encKey |
Encryption key. SHA-256(cardID + amount + currency + orderID + merchantID + merchantPrivateKey) |
Required |
|
Parameter |
Description |
Type |
|---|---|---|
|
result |
Success or fail result code |
Required |
|
transactID |
Transaction id |
Optional |
|
orderID |
Customer unique identifier of the transaction |
Optional |
|
checkSUM |
Encryption key. SHA-256(amount + transactID + merchantPrivateKey) |
Optional |
https://kegow.bancore.com/getit/api/merchant/withdraw.do?cardID=4856967&merchantID=341¤cy=XOF&amount=1100&orderID=1612264148991&encKey=a1f9ef2f206b709bb7d5b569b4d2955f6f2af315812f2ddb40da18908e9426
result=30&transactID=71686&checkSUM=2D453BE4AD4070529A51BBFF133813D7BD262F911205BC52A0E768709FBF7670&orderID=1612264148991
This operation is used to send a request to Deposit Funds to the existing card (Card Load for Existing Users with CardID). Use the Method URL below.
https://kegow.bancore.com/getit/api/merchant/deposit.do
|
Parameter |
Description |
Type |
|---|---|---|
|
cardID |
Provided card reference/id |
Required |
|
merchantID |
Provided merchant id |
Required |
|
currency |
Currency code (e.g USD) |
Required |
|
amount |
Amount in smallest monetary unit |
Required |
|
orderID |
Customer unique identifier of the transaction |
Required |
|
encKey |
Encryption key. SHA-256(cardID + amount + currency + orderID + merchantID + merchantPrivateKey) |
Required |
|
Parameter |
Description |
Type |
|---|---|---|
|
result |
Success or fail result code |
Required |
|
transactID |
Transaction id |
Optional |
|
orderID |
Customer unique identifier of the transaction |
Optional |
|
checkSUM |
Encryption key. SHA-256(amount + transactID + merchantPrivateKey) |
Optional |
https://kegow.bancore.com/getit/api/merchant/deposit.do?cardID=4857751&merchantID=72¤cy=XOF&amount=150000&orderID=1612266441118&encKey=a18ae4861c445491c643f2832b6c8e189660079ca1e3d17ea977c243444f79
result=30&transactID=71698&checkSUM=5111486137B63B5285486844B7CA658CF4FF0BFE830484C4F400A77D957EA26C&orderID=1612266441118
This operation is used to send a request to Deposit Funds (Card Load for Newly Registered Users without Card). Use the Method URL below.
https://kegow.bancore.com/getit/api/merchant/bankTopup.do
|
Parameter |
Description |
Type |
|---|---|---|
|
accountID |
Provided user id. Unique 19 digits code or mobile number in international format with country code |
Required |
|
merchantID |
Provided merchant id |
Required |
|
currency |
Currency code (e.g VND) |
Required |
|
amount |
Amount in smallest monetary unit |
Required |
|
orderID |
Customer unique identifier of the transaction |
Optional |
|
encKey |
Encryption key. SHA-256(accountID + amount + currency + merchantID + merchantPrivateKey) |
Required |
|
Parameter |
Description |
Type |
|---|---|---|
|
result |
Success or fail result code |
Required |
|
transactID |
Transaction id |
Optional |
|
cardID |
Сard reference returned in case if deposit is made to accounts that were registered but card was not issued for them. |
Optional |
|
orderID |
Customer unique identifier of the transaction |
Optional |
|
checkSUM |
Encryption key. SHA-256(amount + transactID + merchantPrivateKey) |
Optional |
https://kegow.bancore.com/getit/api/merchant/bankTopup.do?accountID=2348098855313&merchantID=72¤cy=XOF&amount=112000&orderID=1612189492732&encKey=103a243c059d172051d1333278597a950f49708713c88a06653749a3fc36f
result=30&transactID=71635&checkSUM=20BF7627F327714F5F12712FF401C3FA3F194A275F58EA1B5DBE8939344FA0D8&cardID=4860380&orderID=1612189492732
This operation allows getting the Card ID of the cardholder. Use the Method URL below.
https://kegow.bancore.com/getit/api/merchant/card.do
|
Parameter |
Description |
Type |
|---|---|---|
|
accountID |
Provided user id. Unique 19 digits code or mobile number in international format with country code |
Required |
|
merchantID |
Provided merchant id |
Required |
|
encKey |
Encryption key. SHA- 256 (accountID + merchantID + merchantPrivateKey) |
Required |
|
Parameter |
Description |
Type |
|---|---|---|
|
result |
Success or fail result code |
Required |
|
cardID |
Default Card reference |
Required |
|
checkSUM |
Encryption key. SHA – 256 (accountID + cardID + merchantPrivateKey) |
Optional |
https://kegow.bancore.com/getit/api/merchant/card.do?accountID=2348096989068&merchantID=341&encKey=f68242311323512b3a5cf388693354a01c932c97bee1e3f9f819fb0b3fbe44
result=30&cardID=4855676&checkSUM=249BE088E6003E3B752B30FB9A1462D8D7EBCD5908651E9359915E572E829989
This operation allows getting the Card Image. Use the Method URL below.
https://kegow.bancore.com/getit/api/merchant/card/image.do
|
Parameter |
Description |
Type |
|---|---|---|
|
merchantID |
Merchant account id. Provided by Bancore. |
Required |
|
phone |
Mobile number in international format |
Required |
|
card_id |
Unique identifier of the card |
Required |
|
encKey |
Encryption key. SHA-256(merchantID+phone+card_id+merchantPrivateKey) |
Required |
/WEB-INF/pages/card/image/cardImage.jsp
https://kegow.bancore.com/getit/api/merchant/card/image.do?merchantID=76&phone=2348098855313&card_id=4860381&encKey=2c872a73dd62095c188cda0c600b0cc8a943bb2863034974b870360c069984
This operation is used to Get and Check Transaction Status. Use the Method URL below.
https://kegow.bancore.com/getit/api/merchant/txstatus.do
|
Parameter |
Description |
Type |
|---|---|---|
|
merchantID |
Merchant account ID |
Required |
|
encKey |
SHA-256(orderID+merchantID+privateKey) |
Required |
|
orderID |
Customer unique identifier of the transaction |
Required |
|
Parameter |
Description |
Type |
|---|---|---|
|
result |
Response code |
required |
|
orderID |
Customer unique identifier of the transaction |
optional |
|
transactStatus |
COMPLETED for successful operations CANCELLED for failed operations |
optional |
|
checkSum |
SHA-256(orderID, transactionStatus, privateKey) |
optional |
https://kegow.bancore.com/getit/api/merchant/txstatus.do?merchantID=72&orderID=1610548998576&encKey=060f8c6b82a64f558d26a6f1b59228966bde17d2b3ac5c799cb5d2602d8556
result=30&transactStatus=CANCELED&checkSUM=0B9626C636011DEA7872CBE848F50164730C1054E70D979F18A1BAE6BBDB6A99&orderID=1610548998576
This operation is used to Add Plastic Card to the cardholder’s account. Use the Method URL below.
https://kegow.bancore.com/getit/api/merchant/addplastic.do
|
Parameter |
Description |
Type |
|---|---|---|
|
merchantID |
Merchant account ID |
Required |
|
accountID |
Mobile number in international format with country code |
Required |
|
cardID |
GTP customer ID |
Required |
|
digits |
Four last digits of the card |
Required |
|
encKey |
SHA-256(accountID+cardID+digits+merchantID+privateKey) |
Required |
|
Parameter |
Description |
Type |
|---|---|---|
|
result |
Response code |
Required |
https://kegow.bancore.com/getit/api/merchant/addplastic.do?merchantID=72&accountID=2348092685963&cardID=2253781&digits=3853&encKey=985091f1b7834e477e2bf05381cc459f27f980bce3fad8038b400276cf953bd
result=30&checkSUM=9112E7AAADCC1164B73F199F95E29A558F425BD05F256AD1256D1330ED9A7FA9
https://kegow.bancore.com/getit/api/mobile/freezeThaw.do
|
Parameter |
Description |
Type |
|---|---|---|
|
merchantID |
Merchant account ID |
Required |
|
encKey |
SHA-256(orderID+merchantID+privateKey) |
Required |
|
orderID |
Customer unique identifier of the transaction |
Required |
|
Parameter |
Description |
Type |
|---|---|---|
|
result |
Success or failure result code |
Required |
|
errorMessage |
Error description |
Required |
https://kegow.bancore.com/getit/api/mobile/freezeThaw.do?merchant_id=83&card_id=4737684&status=FREEZE&access_token=nMQVcZ0&encKey=a4d5b48822324db7045e101f8d29be3d53078c17e4cebe4c542a70815845ff2e
result=30
|
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 |
|
415 |
WRONG_TOKEN |
Token is wrong |
Possible Return Codes are digit numerical values sent as a part of the response from the server. Status codes give an idea of whether the request to the server has been successful or not.
Find in the table below the return codes and their respective descriptions:
|
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 |
|
40 |
SUCCCESS. IN PROGRESS |
Successful operation. Transaction in progress. |
|
60 |
INVALID_CARD |
Invalid card number.Accountdoesn’t exist |
|
61 |
CARD_BLOCKED |
Blocked card |
|
90 |
INVALID_ORDER_ID |
OrderID must be unique |
|
95 |
INVALID_MERCHANT_ACCOUNT |
Invalid merchant, merchant don’t exist |
|
96 |
INVALID_AMOUNT |
Invalid amount for the operation |
|
97 |
AMOUNT_TOO_BIG |
Amount is too big to be accepted by the destination phone number |
|
98 |
TRANSFER_LIMIT |
Transfer limit is reached |
|
100 |
GENERAL_ERROR |
Unknown error. Please try again later |
|
102 |
BLOCKED_MOBILE_NUMBER |
Mobile number is blocked |
|
103 |
PIN_ERROR |
PIN code is wrong |
|
111 |
RECORD_NOT_FOUND |
The requested record is not found |
|
113 |
CARDID_TOKEN_WRONG |
Card id differs from account represented by token |
|
116 |
KYC_PAYMENT_LIMIT |
Payment limit is exceeded for KYC level |
|
200 |
USER_IP_TRIES_EXCEEDED |
Customer has exceeded failed attempts and has been blocked |
|
202 |
UNEXPECTED_MERCHANT_IP |
Merchant IP is unknown |
|
203 |
INACTIVE_MERCHANT_ACCOUNT |
The merchant account is not active |
|
300 |
FEE_NOT_FOUND |
Fee value not available |
|
400 |
APPLICATION_UPDATE |
The application is not available |
|
412 |
AMOUNT_ERROR |
Amount is wrong |
|
415 |
WRONG_TOKEN |
Token value is wrong |
|
420 |
WRONG_BANK_ACCOUNT |
The submitted bank account information is incorrect |