FAIRSURE
PAYMENTGATEWAY
Implementation Documentation
INTERNAL CLASSIFICATION
Table of Contents
PROJECT DESCRIPTION.................................................................................................................................. 2
INTERFACES ................................................................................................................................................... 3
DEVELOPMENT FRAMEWORK....................................................................................................................... 4
INFRASTRUCTURAL REQUIREMENTS ............................................................................................................ 4
INTERNAL CLASSIFICATION
PROJECT DESCRIPTION
The fairsure payment gateway application is an aggregation of multiple outwards payment and inward
payment API service(enablers) into a single platform, to merchants in the public and private sector process
payments both inward and outward. The system shall make available to customers of on-boarded
merchants/businesses payment collection channels which includes; the bank transfer, card, USSD, NQR.
Payment inwards
Payment Option
n (New)
Payment Outwards
Admin (Single or bulk payment)
All users mgt
Onboarding/KYB
Merchant(s)
Price config. mgt
Merchant/Busines Users mgt
s mgt Reporting and
Merchant bill item analytics
setup Bill items setup
Reporting and Invoice and
analytics payment link
generation for
customers
NIBSS ISW CoralPay Other needed
enablers
(NIP/NQR/ebills) (Paydirect/Webpay) (USSD)
)
Application Overview
INTERNAL CLASSIFICATION
INTERFACES
S/N Module Deliverables Timeline
Remark
NIP integration or Any
Payment Outward service
Enablers Services NQR integration
1 (Third-party Ebills integration Web API
Services) Paydirect integration
Webpay integration
Coralpay USSD integration
User
creation/Signup/Register
Profile
Edit profile
Change password
Web API and front-
2 User management Reset password
end app
Enable/Disable
users(admin)
Delete user(admin)
Reset user password
(admin)
Merchant self onboarding
Merchant verification/KYC
Merchant authorization
(go-live)
Merchant/Business Web API and front-
3 Merchant
Management end app
blocking/unblocking
Settlement of inward
payment funds to
merchants
Creation of
Billing/Collection/Revenue
items as well as prices
4
Bill/Collection Items Edit bill item Web API and front-
Management Delete bill items end app
Invoice and payment link
generation for customers
Setting up debit accounts
Beneficiary management Web API and front-
5
Outwards Payment Single or bulk payment end app
(outward) to beneficiary(s)
INTERNAL CLASSIFICATION
Fees settings Web API and front-
6 Settings
Fee bearer settings end app
Web API and front-
7 Reporting
end app
DEVELOPMENT FRAMEWORK
S/N COMPONENT FRAMEWORK(LANGUAGE) OUTPUT USER INTERFACE
1 Backend Springboot(Java) API N/A
Web User
2 Frontend ReactJS or NextJs Web Application
Application
INFRASTRUCTURAL REQUIREMENTS
Application server
MySql Server
Access to all third-party requirements
INTERNAL CLASSIFICATION