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

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 (max length 50)

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 (for Nigerian mob. numbers)

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 (limitation on the duration of the requested period – 1 month)

Required

endDate

End period date in format dd/MM/yyyy (limitation on the duration of the requested period – 1 month)

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:
Fail:

<ns2:ministatement>
<result>0</result>
<cardID>0001</cardID>
<startDate>01/01/2013</startDate>
<endDate>01/06/2013</endDate>
<errorMessage>accountId is required parameter</errorMessage>
<errorMessage>encKey is required parameter</errorMessage>
<errorMessage>cardId is required parameter</errorMessage>
</ns2:ministatement>

Success:

<ns2:ministatement>
<result>30</result> <cardID>0001</cardID>
<startDate>01/01/2013</startDate>
<endDate>01/06/2013</endDate>
<transactions>
<date>2013-05-29T00:00:00+03:00</date>
<description>Transfer of USD10.00 to 'Virtual card in USD for
ID: 96805' Virtual Card</description>
<transactionReference>TransactionEntryId:
(13ef00e831e0248)</transactionReference>
<fundsCredited/>
<fundsDebited>-10.00</fundsDebited>
<cardBalance>66.35</cardBalance>
</transactions>
<transactions>
<date>2013-05-29T00:00:00+03:00</date>
<description>Transfer of USD10.00 to 'Virtual card in USD
for ID: 96805' Virtual Card</description>
<transactionReference>TransactionEntryId:
(13ef00d8fab0f48)</transactionReference>
<fundsCredited/>
<fundsDebited>-10.00</fundsDebited>
<cardBalance>76.35</cardBalance>
</transactions>
<transactions>
<date>2013-05-23T00:00:00+03:00</date>
<description>Transfer of USD13.65 to 'Virtual card in USD for
ID: 96805' Virtual Card</description>
<transactionReference>TransactionEntryId:
(13ed0f019960b48)</transactionReference>
<fundsCredited/>
<fundsDebited>-13.65</fundsDebited>
<cardBalance>86.35</cardBalance>
</transactions>
<transactions>
<date>2013-05-23T00:00:00+03:00</date>
<description>Transfer of USD100.00
from 'bancore.USD' Funding Account</description>
<transactionReference>TransactionEntryId:
(13ed0eebab00248)</transactionReference>
<fundsCredited>100.00</fundsCredited>
<fundsDebited/>
<cardBalance>100.00</cardBalance>
</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

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(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 + orderIDmerchantID + 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

Method URL

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

CEncryption key. SHA-256(accountID + 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 + cardID+merchantPrivateKey)

Optional

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/issuecard.do?accountID=2348096326998&merchantID=341¤cy=XOF&amount=100000&orderID=1612283107905&encKey=23fdb0796ea9e4086665bc8aadbff0f3a291c5c96855289e3b4a857acb94f9

response:

result=30&cardID=4860408&transactionID=71728&checkSUM=BCC00875A3AEC0511690C699B6A23A7A42CEA8C6607A5668402820CA368FA714&orderID=1612283107905

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

View Card Info

Method URL

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

Request Parameters

Parameter

Description

Type

merchantID

Merchant account ID

Required

cardId

Provided card id

Required

cardNumberPart

false – returns masked PAN, CVV, exp date

true – returns remaining digits of masked PAN

Optional

encKey

SHA-256(merchantID + cardId + merchantPrivateKey)

Required 

Response Parameters

Parameter

Description

Type

result

Response  code  in  case  of success will be “30”

required

availableBalance

Available card balance

optional

currency

Currency code (e.g USD)

optional

cardHolderName

Cardholder name

optional

cvv

3 digits security code printed on the back of the card

optional

cardNumber

masked PAN

optional

state

Active/null(not active)

optional

expiryDateMonth

2 digits of the month card is valid to

optional

expiryDateYear

4 digits of the year card is valid to

optional

Sample(1):

request:

https://kegow.bancore.com/getit/api/merchant/card/get.do?merchantID=341&cardId=4855676&cardNumberPart=false&encKey=b09fae9c202b38225bb7359df8b50228cfb1d1e72157ae3fa1a4ab913b7e8388

response:

result=30&availableBalance=4569.69¤cy=XOF&cardHolderName=Andre Tan&cvv=123&cardNumber=XXXX3737&state=ACTIVE&expiryDateMonth=9&expiryDateYear=2022

Sample(2):

request:

https://kegow.bancore.com/getit/api/merchant/card/get.do?merchantID=72&cardId=4860380&cardNumberPart=true&encKey=9d8a2430db7cb7358377059f68a5492f0ee574efd9debf940c9e416aa6cf6baa

response:

result=30&availableBalance=null¤cy=null&cardHolderName=null&cvv=null&cardNumber=990099059245XXXX&state=null&expiryDateMonth=null&expiryDateYear=null

Sample(3):

request:

https://kegow.bancore.com/getit/api/merchant/card/get.do?merchantID=76&cardId=4860381&cardNumberPart=&encKey=8ece47d73a2f025ea7023e1c3e28995ea0ff7402216216cf8473aaf552642089

response:

result=30&availableBalance=1560.2¤cy=XOF&cardHolderName=Cora Hay&cvv=672&cardNumber=XXXX6887&state=ACTIVE&expiryDateMonth=2&expiryDateYear=2024

Plastic Card Issuance - Registration Request

Method URL

https://kegow.bancore.com/getit/api/merchant/issuecard/plastic.do

Request Parameters

Parameter

Description

Type

merchantID

Provided merchant account id

Required

customerID

Processor card reference printed on the card

Opt

preferredName

Preferred name of cardholder

Required

IDType

1: Passport, 2:National ID, 3:Driver’s License, 4:Other

Required

IDValue

Value corresponding to the IDType

Required

mobilePhoneNumber

Phone number in international format starting with country code 234xxxxxxxxx

Required

currency

Preferred name of cardholder

Required

preferredName

Currency code (e.g USD)

Required

encKey

Encryption key. SHA-256(merchantID + mobilePhoneNumber + preferredName + currency + merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success (30) or fail result code

Required

cardID

The Card ID in Bancore system

Required

Sample(without customerID (Processor card reference printed on the card)):

request:

https://kegow.bancore.com/getit/api/merchant/issuecard/plastic.do?merchantID=76&preferredName=MALIA+TATE&IDType=1&IDValue=ACF569654&mobilePhoneNumber=2348049858671¤cy=XOF&encKey=5b290262830d4759ac5bc328c236a0a1489be9d3112ecaec99da9d7c8e0b318

response:

result=30&cardID=4862208

Sample(with customerID (Processor card reference printed on the card)):

request:

https://kegow.bancore.com/getit/api/merchant/issuecard/plastic.do?merchantID=72&customerID=10444837&preferredName=ANNA+POMODORO&IDType=1&IDValue=ACF569654&mobilePhoneNumber=2348045497112¤cy=XOF&encKey=8d69b2ee0273e03012279d6bfeae60015297b265430dd42234817020e02243f

response:

result=30&cardID=4862206

Plastic Card Pin Code Reset

Method URL

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

Request Parameters

Parameter

Description

Type

merchantID

Provided merchant account id

Required

cardID

The Card ID in Bancore system

Required

pin

New pin code

Required

encKey

Encryption key. SHA-256( merchantID + cardID + pin + merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success (30) or fail result code

Required

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/card/changePIN2.do?merchantID=72&cardID=4862203&pin=5566&encKey=29c239f4ba56a1aa6ecd2b70f1792248b3591f8a147127e62991f3b700bbad6

response:

result=30

Plastic Card Pin Code Change

Method URL

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

Request Parameters

Parameter

Description

Type

merchantID

Provided merchant account id

Required

cardID

The Card ID in Bancore system

Required

encKey

Encryption key. SHA-256( merchantID + cardID + merchantPrivateKey)

Required

Response Parameters

Parameter

Description

Type

result

Success (30) or fail result code

Required

Sample:

request:

https://kegow.bancore.com/getit/api/merchant/card/changePIN.do?merchantID=72&cardID=4862203&encKey=cecacb7e746dc2ad179b1b9b8fcda93801dd521cca8af529fd44b60ba944350

response:

result=30

POS Webhook documentation

POS Webhook documentation

Webhook send by the POS Platform

General

Webhooks allow external services to be notified when an operation is completed.

The URL that receives the Webhook data have to be configured and must use HTTPS.

Data is transmitted in JSON format

Transaction

From your side you need to prepare a URL where requests from Bancore with information on transactions will be sent in JSON format.

 

Field

Type

Description

requestId

int

Unique identifier for the request.
Min Length 1.
Max Length 15.

customerId

int

Unique identifier of customer.
Min Length 5.
Max Length 10.

transactionId

int

Unique identifier of transaction.
Min Length 10.
Max Length 15.

lastFourDigits

string

Last four digits of the customer account.
Min Length 4.
Max Length 4.

transactionDate

string

Transaction Date. 
Formated as dd-MMM-yyyy.
Min Length 11.
Max Length 11.

transactionTime

string

Transaction Time. 
Formated as hh:mm (24 hour format).
Min Length 5.
Max Length 5.

transactionName

string

Transaction name.
POS, ATM, Transfer, Received.
Min Length 3.
Max Length 8.

creditOrDebit

string

C for Credit, D for Debit.
Min Length 1.
Max Length 1.

currencyCode

string

Three character currency
code of the account.
Min Length 3.
Max Length 3.

baseAmount

number

Amount in the card currency
that was authorized or cleared.
The sign
will be negative for debit, and
positive for credit.
Min Length 1.
Max Length 15.

totalAmount

number

Summation of baseAmount and
feeAmount in the card currency
that was
authorized
or cleared.
Min Length 1.
Max Length 15.

runningBalance

number

The current balance
of the account in the currency
of the account.
Min Length 1.
Max Length 15.

fees

number

Fee amount in the card
currency that was authorized
or cleared.
Min Length 1.
Max Length 15.

  reference

string

Reference information
regarding the transaction.
Min Length 1.
Max Length 150.

  firstName

string

Customer First Name.
Min Length 1.
Max Length 80.

  lastName

string

Customer Last Name.
Min Length 1.
Max Length 50.

  merchantCity

string

Merchant City.
Min Length 0.
Max Length 13.

  merchantTerminal

string

Merchant Terminal Id.
Min Length 0.
Max Length 8.

  merchantCountry

string

A two character code identifying
the country of the acquiring
institution
for the merchant or ATM.
Min Length 0.
Max Length 2

  denialReason

string

If a transaction was denied,
this contains a brief
description of
the denial reason.
Min Length 1.
Max Length 40

{
  “requestId”: 11223344556699,
  “customerId”: 479045,
  “transactionId”: 1234567890,
  “lastFourDigits”: “1234”,
  “transactionDate”: “01-APR-2021”,
  “transactionTime”: “04:51”,
  “transactionName”: “POS”,
  “creditOrDebit”: “C”,
  “currencyCode”: “XOF”,
  “baseAmount”: 12,
  “fees”: 1,
  “reference”: “Here is the reference
information”,
  “firstName”: “Larry”,
  “lastName”: “Sands”,
  “merchantCity”: “New York
City”,
“merchantTerminal”: “DFVC97PR”,
  “merchantCountry”: “US”,
  “denialReason”: “Velocity
Limit
Exceeded”,
  “totalAmount”: 13,
  “runningBalance”: 123
}

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