Prepaid Card

Launch a Prepaid Card Payment solution with our award-winning card issuing Platform
Issue prepaid cards instantly to your customers
Mastercard, VISA, UnionPay and Verve supported

Customer Registration

This operation is used to register a new cardholder. Use the Method URL below.

Method URL

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

Request Parameters

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
email	User email	Optional
encKey	SHA-256(merchantID + phone + merchantPrivateKey)	Required

Response Parameters

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

Sample:

request:

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

response:

result=30&phone=2348049714879&encKey=30305088E682D2EC11BE4FC5715BC09C5F3BD50C95EBEDE2547F77BA6EA7C606&errorText=null

Display account data

This operation retrieves cardholder registration data. Use the Method URL below.

Method URL

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

Request Parameters

Parameter	Description	Type
merchantID	Merchant account ID	Required
phone	Mobile number in international format	Required
encKey	SHA-256(phone + merchantID + merchantPrivateKey)	Required

Response Parameters

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

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/account.do?merchantID=72&phone=2348094194738&encKey=3b66f9492d62a3000cf131a13df8441337056b163e2c707931af79ecdefe11a

response:

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

Display Card Balance

This operation allows checking the current card balance of the cardholder. Use the Method URL below.

Method URL

https://kegow.kegow.com/getit/api/merchant/balance.do

Request Parameters

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 Parameters

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

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/balance.do?cardID=4860095&merchantID=72&encKey=b0714fc99dbaa713c079729024d38d3c00243925e10fb8aede6818ee6837221

response:

result=30&amount=1698.7¤cy=XOF&cardName=Airiel Corund&checkSUM=1E8B5182961500B7AB6403B6BF66E4F0FBDC7BB5ABCE35C4380CF88BEC162F99

Mini Statement

Method URL

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

Request Parameters

Parameter	Description	Type
merchantID	Merchant account ID (will be provided by Retailer)	Required
cardID	Customer card id	Required
startDate	Start period date in format dd/MM/yyyy	Required
endDate	End period date in format dd/MM/yyyy	Required
encKey	SHA-256(merchantId + cardId + startDate + endDate + merchantPrivateKey)	Required

Response Parameters

Response content type: application/xml

Examples:

Request:

https://kegow.bancore.com/getit/api/merchant/ministatement.do?merchantID=341&cardID=4861361&startDate=01/03/2021&endDate=30/03/2021&encKey=69e98f31a5b94fd74998c4926dd0b80b13f85f5b755e5a93553941abcc6baa82

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:ministatement xmlns:ns2="com.bancore.api.merchant">
    <result>30</result>
    <cardID>4861361</cardID>
    <startDate>01/03/2021</startDate>
    <endDate>30/03/2021</endDate>
    <transactions>
        <date>2021-03-25T12:34:18+01:00</date>
        <description>Mini Statement</description>
        <transactionReference>654122020</transactionReference>
        <fundsCredited>-2</fundsCredited>
        <fundsDebited>-2</fundsDebited>
        <cardBalance>111.60</cardBalance>
        <merchantName></merchantName>
        <merchantId></merchantId>
        <mccCode></mccCode>
        <merchantCity></merchantCity>
    </transactions>
    <transactions>
        <date>2021-03-24T16:13:36+01:00</date>
        <description>Funds Transfer External Account to Card</description>
        <transactionReference>653789293</transactionReference>
        <fundsCredited>58.80</fundsCredited>
        <fundsDebited>58.80</fundsDebited>
        <cardBalance>113.60</cardBalance>
        <merchantName></merchantName>
        <merchantId></merchantId>
        <mccCode></mccCode>
        <merchantCity></merchantCity>
    </transactions>
    <transactions>
        <date>2021-03-24T16:06:34+01:00</date>
        <description>Mini Statement</description>
        <transactionReference>653787641</transactionReference>
        <fundsCredited>-2</fundsCredited>
        <fundsDebited>-2</fundsDebited>
        <cardBalance>54.80</cardBalance>
        <merchantName></merchantName>
        <merchantId></merchantId>
        <mccCode></mccCode>
        <merchantCity></merchantCity>
    </transactions>
    <transactions>
        <date>2021-03-24T15:58:36+01:00</date>
        <description>Mini Statement</description>
        <transactionReference>653783911</transactionReference>
        <fundsCredited>-2</fundsCredited>
        <fundsDebited>-2</fundsDebited>
        <cardBalance>56.80</cardBalance>
        <merchantName></merchantName>
        <merchantId></merchantId>
        <mccCode></mccCode>
        <merchantCity></merchantCity>
    </transactions>
    <transactions>
        <date>2021-03-24T14:42:29+01:00</date>
        <description>Funds Transfer External Account to Card</description>
        <transactionReference>653762914</transactionReference>
        <fundsCredited>58.80</fundsCredited>
        <fundsDebited>58.80</fundsDebited>
        <cardBalance>58.80</cardBalance>
        <merchantName></merchantName>
        <merchantId></merchantId>
        <mccCode></mccCode>
        <merchantCity></merchantCity>
    </transactions>
</ns2:ministatement>

Update Personal Information

This operation is used to update Personal Information of the cardholder. Use the Method URL below.

Method URL

https://kegow.bancore.com/getit/api/merchant/profile/update.do

Request Parameters

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
email	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

Response Parameters

Parameter	Description	Type
result	Success or failure result code	Required

Sample:

request:

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

response:

result=30

Withdraw Funds

This operation is used to send a request to Withdraw Funds from the card. Use the Method URL below.

Method URL

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

Request Parameters

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

Response Parameters

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

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/withdraw.do?cardID=4856967&merchantID=341¤cy=XOF&amount=1100&orderID=1612264148991&encKey=a1f9ef2f206b709bb7d5b569b4d2955f6f2af315812f2ddb40da18908e9426

response:

result=30&transactID=71686&checkSUM=2D453BE4AD4070529A51BBFF133813D7BD262F911205BC52A0E768709FBF7670&orderID=1612264148991

Deposit Funds (Card Load for Existing Users with CardID)

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.

Method URL

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

Request Parameters

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

Response Parameters

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

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/deposit.do?cardID=4857751&merchantID=72¤cy=XOF&amount=150000&orderID=1612266441118&encKey=a18ae4861c445491c643f2832b6c8e189660079ca1e3d17ea977c243444f79

response:

result=30&transactID=71698&checkSUM=5111486137B63B5285486844B7CA658CF4FF0BFE830484C4F400A77D957EA26C&orderID=1612266441118

Deposit Funds (Card Load for Newly Registered Users without Card)

This operation is used to send a request to Deposit Funds (Card Load for Newly Registered Users without Card). Use the Method URL below.

Method URL

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

Request Parameters

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

Response Parameters

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

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/bankTopup.do?accountID=2348098855313&merchantID=72¤cy=XOF&amount=112000&orderID=1612189492732&encKey=103a243c059d172051d1333278597a950f49708713c88a06653749a3fc36f

response:

result=30&transactID=71635&checkSUM=20BF7627F327714F5F12712FF401C3FA3F194A275F58EA1B5DBE8939344FA0D8&cardID=4860380&orderID=1612189492732

Get Card ID

This operation allows getting the Card ID of the cardholder. Use the Method URL below.

Method URL

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

Request Parameters

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

Response Parameters

Parameter	Description	Type
result	Success or fail result code	Required
cardID	Default Card reference	Required
checkSUM	Encryption key. SHA – 256 (accountID + cardID + merchantPrivateKey)	Optional

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/card.do?accountID=2348096989068&merchantID=341&encKey=f68242311323512b3a5cf388693354a01c932c97bee1e3f9f819fb0b3fbe44

response:

result=30&cardID=4855676&checkSUM=249BE088E6003E3B752B30FB9A1462D8D7EBCD5908651E9359915E572E829989

Get Card Image

This operation allows getting the Card Image. Use the Method URL below.

Method URL

https://kegow.bancore.com/getit/api/merchant/card/image.do

Request Parameters

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

Response Parameters

Jsp file for customize:

/WEB-INF/pages/card/image/cardImage.jsp

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/card/image.do?merchantID=76&phone=2348098855313&card_id=4860381&encKey=2c872a73dd62095c188cda0c600b0cc8a943bb2863034974b870360c069984

response:

Issue Additional Prepaid Virtual Card

This operation is used to Get and Check Transaction Status. Use the Method URL below.

Method URL

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

Request Parameters

Parameter	Description	Type
merchantID	Merchant account ID	Required
encKey	SHA-256(orderID+merchantID+privateKey)	Required
orderID	Customer unique identifier of the transaction	Required

Response Parameters

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

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/txstatus.do?merchantID=72&orderID=1610548998576&encKey=060f8c6b82a64f558d26a6f1b59228966bde17d2b3ac5c799cb5d2602d8556

response:

result=30&transactStatus=CANCELED&checkSUM=0B9626C636011DEA7872CBE848F50164730C1054E70D979F18A1BAE6BBDB6A99&orderID=1610548998576

Add Plastic Card API

This operation is used to Add Plastic Card to the cardholder’s account. Use the Method URL below.

Method URL

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

Request Parameters

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

Response Parameters

Parameter	Description	Type
result	Response code	Required

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/addplastic.do?merchantID=72&accountID=2348092685963&cardID=2253781&digits=3853&encKey=985091f1b7834e477e2bf05381cc459f27f980bce3fad8038b400276cf953bd

response:

result=30&checkSUM=9112E7AAADCC1164B73F199F95E29A558F425BD05F256AD1256D1330ED9A7FA9

Freeze/Activate Card

Method URL

https://kegow.bancore.com/getit/api/mobile/freezeThaw.do

Request Parameters

Parameter	Description	Type
merchantID	Merchant account ID	Required
encKey	SHA-256(orderID+merchantID+privateKey)	Required
orderID	Customer unique identifier of the transaction	Required

Response Parameters

Parameter	Description	Type
result	Success or failure result code	Required
errorMessage	Error description	Required

Sample:

request:

https://kegow.bancore.com/getit/api/mobile/freezeThaw.do?merchant_id=83&card_id=4737684&status=FREEZE&access_token=nMQVcZ0&encKey=a4d5b48822324db7045e101f8d29be3d53078c17e4cebe4c542a70815845ff2e

response:

result=30

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
415	WRONG_TOKEN	Token is wrong

Possible Return Codes

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 For registration, returns if account already exists
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

Introduction

P2P Transfer