0% found this document useful (0 votes)
31 views

KCB FT Api Specification Document

Uploaded by

zackmzito254
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
31 views

KCB FT Api Specification Document

Uploaded by

zackmzito254
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 5

KCB FUNDS TRANSFER API SPECIFICATION DOCUMENT

Version 1.3

Introduction
This document seeks to describe the specifica4ons to integrate to the FT API. The API supports Internal
Funds Transfer, Transfer to other banks via Pesalink, RTGS, EFT and to mobile wallets.

Requirements
- A KCB Bank account number
- Indemnity form (Template to be shared by KCB Bank)
- Customer LeLer

Request speci5ication
Descrip)on Value
Method POST
Content Type applica4on/json
Request Type ASYNC

Request Parameter De5initions


Field Descrip)on Sample
beneficiaryDetails KCB Account Name JOHN DOE
companyCode KE0010001
creditAccountNumber Account to be credited 123456789
currency KES
debitAccountNumber KCB Account to be debited 987654321
debitAmount Amount to be debited from debit account and 100
credited to credit account number
paymentDetails A brief descrip4on of the payment reason School fee payment
transac)onReference A unique transac4on code used to track the request FTAPI7883TCP
lifecycle. This is generated by the 3rd party calling the
service and must be unique per transac4on
transac)onType A short code to determine type of transac4on, that IF
is, KCB Internal Funds Transfer, EFT, RTGS, Mobile etc.
See Appendix 1 for all transac4on type codes
beneficiaryBankCode Bank code to determine beneficiary’s bank. See 01
appendix 2 for all bank codes

KCB FT API SPECIFICATION DOCUMENT Page 1 of 5


Sample Request

{
"beneficiaryDetails": "JOHN DOE",
"companyCode": "KE0010001",
"creditAccountNumber": "909099090",
"currency": "KES",
"debitAccountNumber": "37890012",
"debitAmount": 10,
"paymentDetails": "fee payment",
"transactionReference": "MHSGS7883",
"transactionType": "AC",
"beneficiaryBankCode": "19"
}

Possible Responses

Response Descrip(on
{ Unauthorized request. Ensure to
"fault": {
"code": 900902, use consumer key and consumer
"message": "Missing Credentials", secret issued on the onboarding
"description": "Missing Credentials. Make sure your process
API request provides required credentials"
}
}
{ Successful call. Your request is
“statusCode”: “0”,
“statusMessage”: “Success”, being processed. You will receive
“statusDescription”: “Request received for processing”, the outcome on the Callback URL
“merchantID”: “263eb626-3fe7-4662-813e-f6f2962219e1”, specified during onboarding
“retrievalRefNumber”: “PCI663RSS”
}
{ Request failed due to either daily
"statusCode": "1",
"statusMessage": "Error", limit or transacCon limit as
"statusDescription": "Validation failed: Transaction specified on FT portal.
failed due to limit rule",
"merchantID": null,
"retrievalRefNumber": "GB99JBOD"
}

{ Request failed due to either a


“statusCode”: “1”,
“statusMessage”: “Error”, missing field or an invalid value on
“statusDescription”: “Validation failed: Invalid crucia l the request body.
param”,
“merchantID”: null,
“retrievalRefNumber”: “AGP46IB”
}
{ Request failed because of duplicate
"statusCode": "1",
"statusMessage": "Error", transacConReference. Ensure you
"statusDescription": "Validation failed: Retrieval RefN pass a unique one per request.
umber already exist", "merchantID": null,
"retrievalRefNumber": "CSS472TCP"
}

KCB FT API SPECIFICATION DOCUMENT Page 2 of 5


Noti5ication
Acer processing of the request, a no4fica4on will be sent to the callback URL provided. Partner should
expect a POST request with payload as follows.

Noti5ication Parameter De5inition


Field Descrip)on Sample

CReference Core banking system transac4on Id. Available FT22017MHXT2


for successful transac4ons only
transac)onDate 2022-07-
06T11:08:40.019Z

transac)onStatus Outcome of the request SUCCESS/FAILED

transac)onMessage Descrip4on of the outcome of the transac4on Processed Successfully

beneficiaryAccountNumber KCB Account to credited 1226938922

amount 100

transac)onReference Unique transac4on Id supplied by partner CSS472TCP


when ini4a4ng request

merchantId Unique transac4on Id received from KCB on 1d2b13f8-ea62-465c-


request received acknowledgment twre-hasdsdvdhg

beneficiaryName Name of the credited party JOHN DOE

debitAccountNumber Debited account number 1226938933

Sample Noti5ication Payload

{
"ftReference": "FT22060GXZGY",
"transactionDate": "2022-07-06T11:08:40.019Z",
"amount": "100",
"transactionStatus": "SUCCESS",
"transactionMessage": "Processed Successfully",
"beneficiaryAccountNumber": "1226938922",
"beneficiaryName": "JOHN DOE",
"transactionReference": "CSS472TCP",
"merchantId": "1d2b13f8-ea62-465c-9fda-e18353579880",
"debitAccountNumber": "1279258233"
}

KCB FT API SPECIFICATION DOCUMENT Page 3 of 5


Appendix
1. Transaction Type References
Code Type

IF Internal KCB Funds transfer

RT RTGS

PL PESALINK

EF EFT

MO MOBILE MONEY

2. Bank Codes
BANK NAME PARTICIPANT IDENTIFICATION CODE ON THE NEW IPS (PIC)
KCB 01
Stanchart 02
ABSA 03
Bank of India 05
Bank of Baroda 06
NCBA 07
Prime Bank 10
Coop Bank 11
NBK 12
M-Oriental 14
CiE Bank 16
Habib Bank AG Zurich 17
Middle East Bank 18
Bank of Africa 19
Consolidated 23
Credit Bank 25
Access Bank 26
Stanbic Bank 31
ABC Bank 35

KCB FT API SPECIFICATION DOCUMENT Page 4 of 5


Eco Bank 43
SPIRE Bank 49
Paramount 50
Kingdom Bank 51
Gt Bank 53
Victoria Bank 54
Guardian Bank 55
I&M Bank 57
Development Bank 59
SBM 60
Housing finance 61
DTB 63
Mayfair Bank 65
Sidian Bank 66
Equity Bank 68
Family Bank 70
Gulf African Bank 72
First Community Bank 74
DIB Bank 75
UBA 76
KWFT 78
Faulu Bank 79
Post Bank 99
MPESA MPESA

For any queries or support, please reach out to [email protected]

KCB FT API SPECIFICATION DOCUMENT Page 5 of 5

You might also like