Scribd
Upload
31 views

I&M Collections Integration API Document

This document outlines the technical integration process for corporate ERPs with bank collections, detailing transaction flows originating from various bank channels. It specifies the service parameters for verification and transaction requests and responses, all formatted in JSON. The document serves as a guide for corporates to align their ERPs with the bank's collection processes.

Uploaded by

James Maina
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
31 views

I&M Collections Integration API Document

This document outlines the technical integration process for corporate ERPs with bank collections, detailing transaction flows originating from various bank channels. It specifies the service parameters for verification and transaction requests and responses, all formatted in JSON. The document serves as a guide for corporates to align their ERPs with the bank's collection processes.

Uploaded by

James Maina
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/ 6

Corporate ERP Integration

Technical ERP Integration for Collections

pg. 1
Contents
About this document .............................................................................................................................. 3
Architecture ............................................................................................................................................ 3
Transaction flow.................................................................................................................................. 3
Service parameters. ................................................................................................................................ 4
Verification request. ........................................................................................................................... 4
Verification response. ......................................................................................................................... 4
Transaction request. ........................................................................................................................... 5
Transaction response. ......................................................................................................................... 5

pg. 2
About this document
This document gives information to corporates on how the bank will be sending collections and
expecting response so that they conform their ERPs as described in the subsequent chapters of this
document.

Architecture

Transaction flow
- Transactions will be originating from bank channels which include; Branch, RTGS,
MPESA and Pesalink.
- Business connect will query the core banking system for collections that have
occurred on various collection accounts configured for business connect transactions.
- Through the Corporate ERP integrator microservice (connector), collections will be
sent to the corporate’s ERP.

pg. 3
Service parameters.
All requests will be sent as a json string that will consist of parameters as described on the following
tables and sample json strings. Corresponding responses should also be in json format.

Verification request.
The table below shows the request body which the bank will be sending to a corporate’s ERP for
customer verification.

Field name Description


customerid Customer unique identification ID on Corporate
ERP
apiusername Corporate’s API username
apipassword Corporate’s API password

"customerid": "363736",

"apiusername": "username",

"apipassword": "XXXXXX"

Verification response.
The bank will be expecting a json string response consisting of parameters as shown on the following
table and sample json string.

Field name Mandatory Description


resultCode Yes Result code 0 for success while 1
for failure
resultDesc Yes Description/Narration from API
balance No Customer balance
customerName Yes Customer name
customerID Yes Customer Id

"resultCode": 0,

"resultDesc": "Customer Found",

"balance": 0,

"customertName": "John Doe",

"customerID": "363736",

pg. 4
}

Transaction request.
The following table shows the request body which the bank will be sending to a corporate’s ERP

Field name Description


customerid Customer identification ID on corporate’s ERP
transactionref Unique reference from core banking
amount Amount collected
transactiondate Time
description Payment description
paymentmode Bank channel
accountnumber Account number on ERP identifying the service
(not mandatory)
apiusername Corporate’s API username
apipassword Corporate’s API password
{

" customerid ": "363736",

" transactionref ": "s3993883",

" amount ": "1000",

"paymentmode": "TELLER",

" transactiondate ": "2020-06-18T15:43:52+03:00",

“accountnumber”:”930393039”

" description": "Payment narration",

"apiusername": "username",

"apipassword": "XXXXXX",

Transaction response.
The bank expects a json string response as described on the following tables and sample json strings

Successful transactions

Field name Mandatory Description


resultCode Yes Result code 0
resultDesc Yes Description/Narration from API
erpRefId Yes Unique erp reference id

pg. 5
"resultCode": 0,

"resultDesc": "Successful",

"erpRefId": "XXX902029"

Failed transactions or transactions with exceptions.

Field name Mandatory Description


resultCode Yes Result code 1 for failure
resultDesc Yes Description/Narration from API

"resultCode": 1,

"resultDesc": " Authentication Failed!", // "Duplicate Transaction" // "Customer Not Found"

pg. 6

You might also like