API Reference USSD

USSD Solutions

This document provides an overview of the USSD web service available on the Creditswitch Platform , which enables business partners to display their USSD menus seamlessly.

For technical assistance with the CSW API šŸ› ļø, please contact us at techsupport@creditswitch.com āœ‰ļø to ensure a swift response and dedicated support.

Integration

This section outlines the recommended integration flow , designed to minimize the risk of transaction disputesļø and boost customer confidence in the system .

To ensure secure data transfer šŸ” between the Creditswitch server and the clientā€™s server, a secured connection is required. This can be achieved using a VPN šŸŒ, HTTPS šŸ”’, or other trusted security protocols.

External USSD Application Service
GET

This service allows clients to display their preferred USSD menu šŸ“±. Creditswitch appends the userā€™s request parameters and forwards them to the specified endpoint . A JSON response is expected for each request.

Service Information

To be provided by the client
GET
Parameter Name Type M/O Description
msisdn Numeric M Customerā€™s 13 digit phone number e.g. 2347055699312
input String M For first dial, this fields comes with the short (without #) e.g *444 subsequently, with the userā€™s input e.g. 1
sessionid String M This displays a unique numeric ID for each request
network String M It identifies the network providersā€™ which includes MTN, Glo, Airtel or 9Mobile
action String M This could either be begin, request, or end beginā€“ means a new request request ā€“ means session should be continued end ā€“ means session should be ended
allinput String M For first dial, this fields comes with the short (without #) e.g .*444 subsequently, the concatenation of the initial input and other user input e.g.*444*1
Parameter Name Type M/O Description
message String M String of message (140 characters) to be displayed to the user
action String M This could either be request or end request ā€“ means session should be continued end ā€“ means session should be ended 

http://CLIENT_FULL_BASEURL?msisdn=23478599658965&input=*444&sessionid=123555522&net work=MTN&action=begin&allinput=*444*1
                            
{"message": "Welcome to Creditswitch\n\n1.Airtime/Data\n2.Airtime Swap\n3.Fund Wallet\n4.Balance
\n5.Transactions\n6.Change PIN",  "action":"request" }
USSD Push Notification Application Service
GET

This API explains how a third party can initiate a USSD push šŸ“± to a subscriberā€™s mobile number directly from the Creditswitch Platform šŸ’³.

Service Information

http://BASEURL:PORT
GET
Parameter Name Type M/O Description
msisdn Numeric M 13 digit Phone number of the subscriber that will receive the push
network String M Mobile network of the subscriber
username String M The username that was assigned to the third-party user during integration
password String M The Password that was assigned to the third-party user during integration
msg String M A 130-character text that will be display to subscribers
msg_type String M This could either be begin, continue, or end beginā€“ means apass as instruction to create new session. continue-will allow subscriber response back. End ā€“ means terminate the sessiong
sessionid String O set this to empty string when msg_type is begin, for continue and end request you should return back the generated sessionid
Parameter Name Type M/O Description
msisdn String M msisdn provided in the payload
sessionid String M Session Id for the request
network String M Network of the msisdn provided
input String M user input (it could be empty if it does not require input from the user) 

                                    "http://BASEURL:PORT/ussd_push?msg= welcome to Creditswitch
Pro\n\n1.Win 10,000 airtime\n2.Refer a friend&msisdn=23480000000&username=xyz&password=xzy&msg_type=continue&network=MTN&sessionid=111192029228292"
                            
{"msisdn":" 23480000000","sessionid":"111192029228292","network":"MTN","input":"1"}