DenmarkDenmarkUkraineAfrica Mon - Fri 09:00-17:00 +45-7022-3969 Mon - Fri 10:00-18:00 +380-951780154 Mon - Fri 10:00-18:00 +234 (0) 8083354094
info@bancore.com
Number #1
In African Payments
Industry Standard
PCI Level 1
Trusted By
Top 10 remittance companies
Login

Consumer Services

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

Customer Registration

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

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

   Operation successful

60

INVALID_CARD

Invalid card number.  Account  doesn’t exist
For registration, returns if account already exists 

95

INVALID_MERCHANT_ACCOUNT

Invalid merchant, merchant don’t exist

100

GENERAL_ERROR

Unknown error. Please try again later

200

USER_IP_TRIES_EXCEEDED

Customer has exceeded failed attempts and has been blocked

202

UNEXPECTED_MERCHANT_IP

Merchant IP is unknown

Customer Log in

Method URL

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

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

client_id

Unique client identifier provided by client

Required

phone

User phone number in international format starting with country code

Required

password

SHA-256 (pin code value entered on client side)

Required

enckey

SHA256(merchant_id + client_id + phone + password + merchantPrivateKey)

Required 

Response Parameters

Parameter

Description

Type

result

Response  code  in  case  of  successful  transaction  will be

APPROVED = “30”

required

token

Access token value

optional

needChangePassword

true or false

If true request customer to set permanent pin.

optional

Sample:

request:

https://kegow.bancore.com/getit/api/mobile/authorize.do?merchant_id=83&client_id=1234567890&password=03ac674216f3e15c761ee1a5e255f067953623c8b388b4459e13f978d7c846f4&phone=2347083692514&encKey=a61814bd2526ddae860077832da2d75c4b369e79442bd1b61dbd2822309f9302

response:

result=30&token=nMQVcZ0&needChangePassword=false

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

  Operation successful

95

INVALID_MERCHANT_ACCOUNT

Invalid merchant, merchant don’t exist

101

MOBILE_NUMBER_ERROR 

  Mobile number is wrong

102

BLOCKED_MOBILE_NUMBER

  Mobile number is blocked

103

PIN_ERROR

  PIN code is wrong

Token Renew

Method URL

https://kegow.bancore.com/getit/api/mobile/updateToken/call.do

Request Parameters

Parameter

Description

Type

merchantID

Merchant account id. Provided by Bancore.

Required

client_id

Unique client identifier provided by client

Required

phone

Customer phone number

Required

token

Token generated previously

Required

enckey

SHA-256(merchant_id+access_token+phone+client_id+merchantPrivateKey)

Required 

Response Parameters

Parameter

Description

Type

result

Response  code  in  case  of  successful  transaction  will be

APPROVED = “30”

required

errorMessage

Error description

optional

token

Renewed access token

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

 

Set Pin Code

Method URL

https://kegow.bancore.com/getit/api/mobile/pin/set.do

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

pin

Customer pin code

Required

newPin

New pin code

Required

access_token

Token generated previously

Required

enckey

SHA-256(merchant_id+access_token+pin+newPin+merchantPrivateKey)

Required 

Response Parameters

Parameter

Description

Type

result

Response  code  in  case  of  successful  transaction  will be

APPROVED = “30”

required

errorMessage

Error description

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

101

MOBILE_NUMBER_ERROR 

  Mobile number is wrong

103

PIN_ERROR

  PIN code is wrong

415

WRONG_TOKEN

 Token value is wrong

Get Personal Information

Method URL

https://kegow.bancore.com/getit/api/mobile/profile/get.do

Request Parameters

Parameter

Description

Type

access_token

Unique token generated

Required

merchant_id

Merchant account id. Provided by Bancore.

Required

encKey

Encryption key. SHA-256(merchant_id+ access_token+ merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

 result

Success or failure result code

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

Retrun 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

102

BLOCKED_MOBILE_NUMBER

  Mobile number is blocked

415

WRONG_TOKEN

  Token value is wrong

Update Personal Information

Method URL

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

Request Parameters

Parameter

Description

Type

access_token

Unique token generated

Required

merchant_id

Merchant account id. Provided by Bancore.

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

Required

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(encKey= SHA-256(merchant_id+access_token+ email+ dateOfBirth+ merchantPrivateKey))

Required

Response Parameters

Parameter

Description

Type

 result

Success or failure result code

Required

Retrun 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

102

BLOCKED_MOBILE_NUMBER

  Mobile number is blocked

415

WRONG_TOKEN

  Token value is wrong

Remind Pin

Method URL

https://kegow.bancore.com/getit/api/mobile/pin/restore.do

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

phone

Customer phone number

Required

encKey

Encryption key. SHA-256(merchant_id+phone+merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or failure result code

Required

Sample:

request:

https://kegow.bancore.com/getit/api/mobile/pin/restore.do?phone=2347083698527&merchant_id=87&encKey=0b40482ef928ae3fdffae0eaa94be10aef95139e5ee13f436d3d5397b39180c9

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

100

GENERAL_ERROR

Unknown error. Please try again later

101

MOBILE_NUMBER_ERROR 

  Mobile number is wrong

Redeem Vouchers

Method URL

https://kegow.bancore.com/getit/api/mobile/topup/voucher.do

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

voucher

19 digits number

Required

encKey

Encryption key SHA-256(merchantID + access_token+ vocuher + merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or failure result code

Required

transactID

Transaction id

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 

          96

                               INVALID_AMOUNT

  Invalid amount for the operation

100

GENERAL_ERROR

Unknown error. Please try again later

102

BLOCKED_MOBILE_NUMBER

  Mobile number is blocked

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

415

WRONG_TOKEN

   Token value is wrong

Get Cards List

Method URL

https://kegow.bancore.com/getit/api/mobile/cards/call.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 fail result code

Required

errorMessage

Error description

Optional

cardsList

json format: id,amount,currency,cardNumber, type, defaultCard

Optional

Sample:

response:

result=30&cardsList=[{“”id””:4737684,””amount””:””172272.64″”,””currency””:””XOF””,””cardNumber””:”” 1841″”,””type””:””VIRTUAL””},{“”id””:4738372,””amount””:””324.92″”,””currency””:””XOF””,””cardNumber””:”” 5842″”,””type””:””VIRTUAL””}]

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

102

BLOCKED_MOBILE_NUMBER 

  Mobile number is blocked

View Card Details

Method URL

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

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

card_id

Unique identifier of the card returned in card list

Required

cardNumberPart

false – returns masked PAN, CVV, exp date

true – returns remaining digits of masked PAN

Required

encKey

Encryption key. SHA-256(merchant_id+card_id+access_token+merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or fail result code

Required

errorMessage

Error description

Required

availableBalance

balance available on the card

Required

currency

currency of the card

Required

cardHolderName

cardholder name

Required

cvv

secret code of the card

Required

cardNumber

masked PAN

Required

expiryDateMonth

month of expiry date

Required

expiryDateYear

year of expiry date

Required

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

102

BLOCKED_MOBILE_NUMBER 

  Mobile number is blocked

415

WRONG_TOKEN

Token is wrong

List of Transaction

Method URL

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

Request Parameters

Parameter

Description

Type

access_token

Unique token generated

Required

merchant_id

Merchant account id. Provided by Bancore.

Required

card_id

Card identifier returned in card list request

Required

from_date

Start date for transactions to be extracted

Optional

to_date

End date for transactions to be extracted

Optional

encKey

Encryption key. SHA-256(merchant_id+access_token+card_id+merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

transactions

list of transactions in JSON

Required

total

total amount of operations

Required

result

 Success or fail result code

 Required

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 

60

INVALID_CARD

  Invalid card number.  Account  doesn’t exist
  For registration, returns if account already exists

95

INVALID_MERCHANT_ACCOUNT

Invalid merchant, merchant don’t exist

100

GENERAL_ERROR

Unknown error. Please try again later

102

BLOCKED_MOBILE_NUMBER 

  Mobile number is blocked

415

WRONG_TOKEN

  Token is wrong

Card to Card Transfer (Own cards)

Method URL

https://kegow.bancore.com/getit/api/mobile/transfer/owncard.do

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

amount

Amount to be transferred in smallest monetary units (amount*100)

Required

currency

Card currency

Required

sourceCard

Source card id

Required

destinationCard

Destination card id

Required

encKey

Encryption key. SHA- 256 (merchantID + access_token + amount + sourceCard + destinationCard + merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or failure result code

Required

transactionID

Unique identifier of the transaction

Required

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 

          96

                               INVALID_AMOUNT

  Invalid amount for the operation

97

 AMOUNT_TOO_BIG

  Amount is too big to be accepted by the destination phone number

100

GENERAL_ERROR

Unknown error. Please try again later

102

BLOCKED_MOBILE_NUMBER

  Mobile number is blocked

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

400

APPLICATION_UPDATE

The application is not available

415

WRONG_TOKEN

   Token value is wrong

Transfer to a Mobile Phone Number

Method URL

https://kegow.bancore.com/getit/api/mobile/transfer/othercard.do

Request Parameters

Parameter

Description

Type

merchantID

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

amount

Amount to be transferred in smallest monetary units (amount*100)

Required

currency

Card currency

Required

sourceCard

Source card id

Required

destinationPhone

Destination phone number in international format (country code followed by phone number e.g.
45246070605)

Required

encKey

Encryption key. SHA- 256 (merchantID + access_token + amount + sourceCard + destinationPhone +
merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or failure result code

Required

transactionID

Unique identifier of the transaction

Required

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

 96

   INVALID_AMOUNT

  Invalid amount for the operation

97

 AMOUNT_TOO_BIG

Amount is too big to be accepted by the destination phone number

100

GENERAL_ERROR

Unknown error. Please try again later

102

BLOCKED_MOBILE_NUMBER

  Mobile number is blocked

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

400

APPLICATION_UPDATE

The application is not available

415

WRONG_TOKEN

   Token value is wrong

Get Fee for Operation

Method URL

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

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

amount

Amount of the operation

Required

access_token

Unique token generated

Required

currency

Currency of the operation

Required

type

Type of the operation:

TRANSFER_VIRTUAL_TO_VIRTUAL, TRANSFER_VIRTUAL_TO_PLASTIC, TRANSFER_PLASTIC_TO_VIRTUAL – card to card transfer

TRANSFER_VIRTUAL_TO_VIRTUAL_OTHER_ACCOUNT, TRANSFER_VIRTUAL_TO_PLASTIC_OTHER_ACCOUNT, TRANSFER_PLASTIC_TO_VIRTUAL_OTHER_ACCOUNT, TRANSFER_PLASTIC_TO_PLASTIC_OTHER_ACCOUNT – transfer to a mobile phone number

TOPUP_VIRTUAL_BY_VIRTUAL, TOPUP_PLASTIC_BY_VIRTUAL, TOPUP_VIRTUAL_BY_VIRTUAL_NEW (used when card list was returned empty) – voucher redemption

QUICK_TELLER_BILL_PAYMENT_BY_PLASTIC
QUICK_TELLER_BILL_PAYMENT_BY_VIRTUAL – bill payment operations through Quick Teller
BILL_PAYMENT_BY_PLASTIC_TO_VIRTUAL – request money and invoce operations
BILL_PAYMENT_BY_VIRTUAL_TO_VIRTUAL

Required

encKey

Encryption key. SHA-256 (merchantID + access_token + amount + type + merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

totalAmount

total amount of operation

 Required

feeAmount

fee for operation

 Required

result

Success or failure result code

 Required

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

96

 INVALID_AMOUNT

  Invalid amount for the operation

100

GENERAL_ERROR

Unknown error. Please try again later

102

BLOCKED_MOBILE_NUMBER 

  Mobile number is blocked

300

FEE_NOT_FOUND

   Fee value not available

415

WRONG_TOKEN

  Token is wrong

Airtime Top up.

Purchase airtime recharge for user phone number. Funds will be loaded to user phone account.

Method URL

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

Request Parameters

Parameter

Description

Type

merchantID

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

 operator

Mobile phone operator name (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)

Required

destinationNumber

Mobile phone number of recipient of airtime in international format (234xxxxxxxxxx)

Required

cardId

Card identifier returned in card list request

Required

amount

Amount in smallest monetary unit

Required

currency

Currency code (e.g NGN)

Required

orderId

Unique identifier of the transaction 

Required

encKey

SHA-256(merchantID + destinationNumber + amount + orderID + cardId + access_token + 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

transactionId

Transaction ID of the operation

Required

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 

60

INVALID_CARD

   Invalid card number.  Account  doesn’t exist
   For registration, returns if account already
exists

90

INVALID_ORDER_ID

OrderID must be unique

95

INVALID_MERCHANT_ACCOUNT

Invalid merchant, merchant don’t exist

100

GENERAL_ERROR

Unknown error. Please try again later

415

WRONG_TOKEN

  Token is wrong

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

Verify Bank Account

Method URL

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

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

bankAccountNumber

Bank account number

Required

bankCode

6 digits code of the bank returned in List of Banks method

Required

encKey

SHA-256(merchant_id + access_token + bankCode + bankAccountNumber + merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or fail result code

Required

accountIdentificationName

Account Information

Required

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

96

 INVALID_AMOUNT

  Invalid amount for the operation

100

GENERAL_ERROR

Unknown error. Please try again later

102

BLOCKED_MOBILE_NUMBER 

  Mobile number is blocked

300

FEE_NOT_FOUND

  Fee value not available

412

AMOUNT_ERROR

  Amount is wrong

415

WRONG_TOKEN

  Token is wrong

Transfer to Bank

Method URL

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

Request Parameters

Parameter

Description

Type

merchantID

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

sourceCard

Card identifier returned in card list request

Required

amount

Amount in smallest monetary unit

Required

currency

Currency code (e.g NGN)

Required

bankAccountNumber

Bank account number

Required

bankSortCode

6 digits code of the bank returned in List of Banks method

Required

orderID

Unique identifier of the transaction 

Required

encKey

SHA-256(merchant_id + access_token + orderID + amount + currency + bankAccountNumber+ bankSortCode +
merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or fail result code

Required

errorMessage

Error description

Optional

transactionId

Transaction ID of the operation

Required

Return Codes

Code

Value

Description

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

96

 INVALID_AMOUNT

  Invalid amount for the operation

100

GENERAL_ERROR

Unknown error. Please try again later

102

BLOCKED_MOBILE_NUMBER 

  Mobile number is blocked

300

FEE_NOT_FOUND

  Fee value not available

 412

AMOUNT_ERROR

  Amount is wrong

415

WRONG_TOKEN

  Token is wrong

Get List of Banks

Method URL

https://kegow.bancore.com/getit/api/mobile/bank/accounts.do

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

bankCode

Always set to 1

 

encKey

SHA-256(merchant_id + access_token + bankCode + merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or fail result code

Required

bank codes

list of bank codes in json

Required

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

Issue Gift Card

Method URL

https://kegow.bancore.com/getit/api/mobile/giftcard/create.do

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

amount

Amount in smallest monetary unit

Required

currency

Currency code (e.g NGN)

Required

sourceCard

Card identifier returned in card list request

Required

destinationPhone

Mobile phone number of recipient of gift card in international format (234xxxxxxxxxx)

Required

deliveryDate

Date when gift card should be delivered

Required

email

Email address of the recipient of gift card

Required

firstName

First name of the recipient of gift card

Required

lastName

Last name of the recipient of gift card

Required

description

Description text that will be sent to the recipient

Required

encKey

Encryption key SHA-256(merchantID + access_token + amount + sourceCard + destinationPhone + merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or failure result code

Required

transactID

Transaction id

Optional

 

Request Money/Invoice

Request Money/Invoice. Create Request/Invoice

Method URL

https://kegow.bacore.com/getit/api/mobile/bill/create.do

Request Parameters

Parameter

Description

Type

requestMoney

ture/false

Use “true” if money request is sent

Use “false” for invoice to be created

Required

merchant_id

Merchant account id. Provided by Bancore.

Required

descriptions

Purpose of payment

Required

amount

Amount in smallest monetary unit

Required

currency

Currency code (e.g NGN)

Required

receiverPhone

Mobile phone number of recipient of the request in international format (234xxxxxxxxxx)

Required

access_token

Unique token generated

Required

encKey

Encryption key SHA-256(merchant_id+ access_token+ receiverPhone+ currency+ mechantPrivateKey)

Required

receiverAddress

Address of the recipient

Optional

referenceText

Unique text created by user

Optional

referenceNumber

Unique number assigned by user

Optional

senderAddress

Address of the sender

Optional

senderAddress2

Address of the sender

Optional

senderCompanyName

Company name for the invoice

Optional

senderContactPerson

Contact person for the invoice

Optional

senderPostalCode

Postal code for the invoice

Optional

senderCountryCode

Country code for the invoice

Optional

receiverName

Name of the recipient

Optional

VATNumber

VAT Number of the company

Optional

VATPercent

VAT value in percentage

Optional

VATEnabled

true/false

Optional

sendSMS

true/false for SMS notification to be seent to a recipient. The SMS sending has a cost and user’s account will be chanrged

Optional

Response Parameters

Parameter

Description

Type

result

Success or failure result code

Required

errorText

Error text

Required

billId

ID of the request/invoice

Required

Request Money/Invoice. Pay Request/Invoice

Method URL

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

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

billId

Id of the request/invoice to be paid

Required

cardId

Id of the card to be used for payment

Required

requestMoney

ture/false

Use “true” if money request is sent

Use “false” for invoice to be created

Required

encKey

Encryption key SHA-256(merchant_id +access_token+ billId+ cardId+ merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or failure result code

Required

errorText

Error description

Required

billId

ID of the request/invoice

Required

Request Money/Invoice. Get list of Requests/Invoices

Method URL

https://kegow.bancore.com/getit/api/mobile/bill/list.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+ billId+ cardId+ merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or failure result code

Required

errorText

Error description

Optional

bills

Bill paid

Optional

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

Card Load.

Method URL

https://kegow.bancore.com/getit/api/mobile/creditcard/redirect.do

Request Parameters

Parameter

Description

Type

merchantID

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

orderID

Unique identifier of the transaction 

Required

cardID

ID of the card to be used for payment

Required

amount

Amount to be paid in smallest monetary units

Required

currency

Currency

Required

URL

Redirect URL where user will be redirected after successful or failed payment

Required

encKey

Encryption key SHA-256(merchantID+access_token+orderID+ amount+ currency+ url+
cardID+merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

responseCode

In case of failure response code with error code will be returned

Required

In case of success redirect to payment gateway will be performed. Redirect will be
performed on Bancore side and needs to be reflected in secure iframe.
In case of successful or
failed load redirect from payment gateway will be performed to redirect URL provided in the request.

Set Default Card

Method URL

https://kegow.bancore.com/getit/api/mobile/cards/setdefault.do

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

card_id

ID of the card to be used for payment

Required

encKey

Encryption key SHA-256(merchant_id +card_id+ access_token+ merchantPrivateKey)

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/cards/setdefault.do?merchant_id=83&card_id=4738372&access_token=nMQVcZ0&encKey=5e36215a4ec37fe20b6c805628c97bf6aadf77aa9bbd73adaa4d037b1983cf1b

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

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

Send Message.

Method URL

https://kegow.bancore.com/getit/api/mobile/messages/create.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

name

Name of the recipient

Required

subject

Subject of the the message to be sent

Required

text

Body of the message

Required

sendSms

True or false. Notify user with SMS. There is a charge applied for SMS notification.

Required

encKey

Encryption key SHA-256(merchant_id+ phone+subject+ access_token+ merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or failure result code

Required

Sample:

request:

https://kegow.bancore.com/getit/api/mobile/messages/create.do?merchant_id=83&access_token=nMQVcZ0&name=Olga&phone=2347083692513&subject=Test&text=Test&sendSms=false&encKey=9e516185a116d5f6557655153d27a60385788f7165319e5c4e8db52544e4b8ef

response:

result=30

Get List of Messages.

Method URL

https://kegow.bancore.com/getit/api/mobile/messages/list.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

messages

List of messages received by user in JSON

Required

errorMessage

Error description

Required

Sample:

request:

https://kegow.bancore.com/getit/api/mobile/messages/list.do?merchant_id=83&access_token=I3UhohZ&encKey=4ae6071daaf319187dd6e46a8b4ef1843ea3dfd3538e9cd20758648daa2ab133

response:

result=30&messages=[{“id”:4743352,”message”:”Tes message”,”subject”:”Hello”,”date”:”Aug 9, 2017 2:49:05 PM”,”type”:”PERSONAL”,”status”:”UNREAD”,”direction”:”INCOME”,”sender”:”2348096871651″,”recipient”:”2347056346804″,”thread”:1941,”main”:false,”spam”:false,”visible”:true}]

Verify Mobile Number

Method URL

https://kegow.bancore.com/getit/api/mobile/checkCustomer.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

encKey

Encryption key SHA-256(merchant_id+phone+merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or failure result code

Required

firstName

First name of the user

Required

lastName

Last name of the user

Required

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

Get Account KYC Level

Method URL

https://kegow.bancore.com/getit/api/merchant/kyc.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

KYC Level

Account KYC Level.
Possible values:

0,1,2 – Bronze
3 – Silver

For checkSUM:

0 – NON_KYC

1 – LIMITED_KYC

2 – BASIC_KYC

3 – FULL_KYC

Required

checkSUM

Encryption key. SHA- 256(accountID + kyc + merchantPrivateKey)

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 

61

CARD_BLOCKED

Card blocked

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

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

400

APPLICATION_UPDATE

The application is not available

Re-send OTP to the user

Method URL

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

Request Parameters

Parameter

Description

Type

merchantID

Merchant account id. Provided by Bancore.

Required

phone

User phone number in international format starting with country code

Required

encKey

SHA256(merchantID + phone + merchantPrivateKey)

Required 

Response Parameters

Parameter

Description

Type

result

Response  code  in  case  of  successful  transaction  will be

APPROVED = “30”

required

errorMessage

Error message returned in case of an error

optional

Sample:

request:

https://kegow.bancore.com/getit/api/mobile/otp.do?merchantID=87&phone=2347083692514&encKey=07f70c9f256c2c7522ff2faa05b2587eb3ce40c400cfd196e51febde0f47e8df

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

101

MOBILE_NUMBER_ERROR

   Mobile number is wrong

Terms and Conditions Tracking

Method URL

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

Request Parameters

Parameter

Description

Type

Parameter

Description

Type

 

merchant_id

 

Merchant account id. Provided by Bancore.

 

Required

access_token

Unique token generated

Required

encKey

SHA256(merchantID + merchantPrivateKey)

Required 

Response Parameters

Parameter

Description

Type

result

Response  code  in  case  of  successful  transaction  will be

APPROVED = “30”

required

tocAccepted

Identifies if user has accepted Terms and Conditions

required

tocAcceptedDate

  Date when Terms and Conditions were accepted by user

required

Sample:

request:

https://kegow.bancore.com/getit/api/mobile/checkToc.do?merchant_id=87&access_token=epFOCrv&encKey=801430fceba831612be198e4270b1de18bf9d70e186573c561bddf610683afad

response:

result=30&tocAccepted=true&tocAcceptedDate=null

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

Get List of Services per Country

Method URL

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

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

country

Service available in the specific Country. 

Required

encKey

Encryption key. SHA-256(merchant_id+merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or failure result code

Required

services

List of services for the specified country

id – id number of the service
type – directory where service is stored
visible – true or false for hidden service
visibleForCountries – list of countries where service is available
accessForCountries – list of countries where service is open
name – name of the service (please see appendix for detailed list)
url, sortNumber, template, roles – internal system info
kyc – minimum level of KYC needed to use the service

Required

Sample:

request:

https://kegow.bancore.com/getit/api/mobile/withdrawservice.do?access_token=epFOCrv&merchant_id=87&country=Nigeria&encKey=801430fceba831612be198e4270b1de18bf9d70e186573c561bddf610683afad

response:

result=30&services=[{“id”:4739865,”type”:”B2C_SERVICES”,”visible”:true,”visibleForCountries”:[{“country”:”ng”}],”accessForCountries”:[{“country”:”ng”}],”name”:”b2c.customer.console.buttons.giro”,”url”:”/b2c/quickteller/bill/call.do“,”sortNumber”:0,”template”:”u003ca hrefu003du0027{uri}u0027 classu003du0027{class}u0027u003eu003cspan classu003d”icon-menu icon-basket”u003eu003c/spanu003e{name}u003c/au003e”,”roles”:”/b2c/quickteller/bill/call”,”kyc”:”NON_KYC”},{“id”:4739866,”type”:”B2C_SERVICES”,”visible”:true,”visibleForCountries”:[{“country”:”ng”}],”accessForCountries”:[{“country”:”ng”}],”name”:”b2c.giftCard.call”,”url”:”/b2c/giftCard/call.do”,”sortNumber”:0,”template”:”u003ca hrefu003du0027{uri}u0027 classu003du0027{class}u0027u003eu003cspan classu003d”icon-menu icon-bill-forward”u003eu003c/spanu003e{name}u003c/au003e”,”kyc”:”NON_KYC”},{“id”:4710393,”type”:”B2C_SERVICES”,”visible”:true,”visibleForCountries”:[{“country”:”ng”}],”accessForCountries”:[{“country”:”ng”}],”name”:”b2c.withdrawRequest.title”,”url”:”/b2c/withdraw/request/call.do”,”sortNumber”:2,”template”:”u003ca hrefu003du0027{uri}u0027 classu003du0027{class}u0027u003eu003cspan classu003d”icon-menu icon-atm”u003eu003c/spanu003e{name}u003c/au003e”,”roles”:”/b2c/withdraw/request/call”,”kyc”:”NON_KYC”},{“id”:3756411,”type”:”B2C_S]

Return Codes

Parameter

Description

Type

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

101

MOBILE_NUMBER_ERROR

  Mobile number is wrong

Get Card Image

Method URL

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

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

card_id

Unique identifier of the card

Required

encKey

Encryption key. SHA-256(merchant_id+ card_id+ access_token+ merchantPrivateKey)

Required

Response Parameters

Jsp file for customize:

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

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

102

BLOCKED_MOBILE_NUMBER

  Mobile number is blocked

Issue a Card.

Method URL

https://kegow.bancore.com/getit/api/mobile/cards/order.do

Request Parameters

Parameter

Description

Type

merchant_id

Merchant account id. Provided by Bancore.

Required

access_token

Unique token generated

Required

sourceCard

ID of the card to be used for payment

Required

amount

Amount to be paid in smallest monetary units

Required

currency

Currency of the card

Required

type

VIRTUAL or PLASTIC

 

encKey

Encryption key SHA-256(merchant_id+access_token+amount+ sourceCard+merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or failure

Required

transactionID

Identifier of the transaction

Required

Return Codes

Parameter

Description

Type

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

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

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

400

APPLICATION_UPDATE

The application is not available

415

WRONG_TOKEN

   Token value is wrong

Remaining Load Limit

Method URL

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

Request Parameters

Parameter

Description

Type

merchant_id

Provided merchant id

Required

access_token

Unique identifier of the card

Required

encKey

Encryption key. SHA-256(merchant_id+merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success or fail result code

Required

rest

Remaining amount in smallest monetary units

Required

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/calculatelimit.do?access_token=AsDVgky&merchant_id=83&encKey=14a2f2c366aba54fb9b70d597c22aa412ec7b3d3c22b579ff248b781ea70bb63

response:

result=30&rest=2610

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 

100

GENERAL_ERROR

  Unknown error. Please try again later

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