Scribd
Upload
12 views

Bill Validation Api Specification Document

Uploaded by

xilam23436
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
12 views

Bill Validation Api Specification Document

Uploaded by

xilam23436
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

BILL VALIDATION API INTERFACE SPECIFICATION DOCUMENT

Version 1.0
Introduction
This Interface specification document describes the integration points between a third-
party system and the KCB API Gateway for the External Bill validation API. The API
facilitates the validation of external bill.

Prerequisites
Register on the API gateway accessible on https://sandbox.buni.kcbgroup.com/devportal/apis

The API can be accessed through the API category VendingServices. For more information
or clarification, kindly send an email to [email protected]

REQUEST

Transport Protocol HTTPS

Message Format JSON

Interaction Type Synchronous

HTTP Verb POST

Authorization OAuth2

Request Message
REQUEST PAYLOAD

Name Type Presence Description

requestId String(20) Mandatory Unique Identifier of the request.

customerReference String(30) Mandatory This unique identifier of the customer.

organizationReference String(30) Mandatory Unique biller code that identifies the biller.

Sample Request Message


{
"requestId": "UGC002001",
"customerReference": "1020220001046912",
"organizationReference": "572572"
}
Response Message.
Response after successful query processing.
RESPONSE PAYLOAD

Name Type Presence Description

statusCode Number(30) Mandatory Unique code that indicates whether the request
successfully processed or not
statusMessage String (30) Mandatory Provides additional information about the
status of the transaction.
transactionID String (30) Mandatory Unique identifier of the request.

customerName String (30) Mandatory Full name of the customer.

amount String (30) Mandatory Transacted amount.

billType String (10) Optional Represents the type of bill either FIXED or
PARTIAL
currency String (30) Mandatory Represents the currency used in the transaction
i.e., KES
creditAccountIdentifier String (30) Optional CreditAccountIdentifier

Sample Response Message

{
"billAmount": "999,999.00",
"creditAccountIdentifier": null,
"billType": null,
"currency": "KES",
"CustomerName": "John Doe,P051440161S,1020220001046912",
"transactionID": "UGC002001",
"statusMessage": "REQUESTED/CONSULTED E SLIP NUMBER (PRN) EXISTS IN THE SYSTEM",
"statusCode": "0"
}

Page 1 of 2
KCB BANK GROUP- INTERFACE SPECIFIATION DOCUMENT

You might also like