Skip to content

DanNduati/Ussd_mobile_payments

Repository files navigation

USSD STK-Push pipeline

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.

Description

Implemention of a ussd -> stk-push mobile payment pipeline with Fastapi, AT-USSD and M-Pesa Express API

Demo

Prerequisites

Running locally

clone the repository and navigate to the project directory

git clone [email protected]:DanNduati/ussd-stkpush.git
cd ussd-stkpush/

Create a python virtual environment activate it

python3 -m venv venv
source venv/bin/activate

Install Project dependencies

pip install -r requirements.txt

Create a .env file similar to .env.example.

Run uvicorn server

uvicorn app.main:app --reload

Run ngrok tunneling script

cd scripts
./start_ngrok.sh

This should print out your tunnel address and also populate it into your .env file

$ ./start_ngrok.sh 
Extracting ngrok public url ...
NGROK_PUBLIC_URL => [ https://d8eb-197-232-61-213.ngrok.io ]

Outcome

Registered User Unregistered user
WIP
WIP
WIP
WIP

Inspiration

NYEWASCO ussd water bill enquiry and payment

Technologies Used

License

license