A wrapper library for the Daraja Mpesa API
Project description
MPESA CONNECT
A wrapper library for the Daraja Mpesa API
Features
- Authorization
- Mpesa Express
- STK Push
- Query
- Customer To Business (C2B)
- Register URL
- Simulate
- Business To Customer (B2C)
- Account Balance
- Transaction Status
Installation
$ pip install mpesa-connect
Usage
NOTE: Before you start, make sure to go through the official Daraja Mpesa API documentation
Create an app instance.
from mpesa_connect import App
# Sandbox
app = App.create_sandbox(consumer_key=..., consumer_secret=...)
# Production
app = App.create_production(consumer_key=..., consumer_secret=...)
Generate an authorization token.
from mpesa_connect import Authorization
auth = Authorization(app)
result = auth.generate_token()
access_token = result.access_token
You can attach this token to the service instance or include it as an argument to the api methods calls
Mpesa Express
STK Push
from mpesa_connect import STKPush
stk = STKPush(app, access_token=access_token)
result = stk.process_request(
business_short_code=...,
phone_number=...,
amount=...,
call_back_url=...,
account_reference=...,
transaction_desc=...,
password=...,
timestamp=...,
# access_token=access_token
)
Query
result = stk.query(
business_short_code=...,
checkout_request_id=...,
password=...,
)
You can use the generate_password
helper to create a password
from mpesa_connect.utils import generate_password
password = generate_password(
business_short_code=....,
pass_key=...,
timestamp=...,
)
Alternatively, you can include the pass_key
argument in place of password
to auto generate the password
Customer To Business (C2B) API
Register URL
from mpesa_connect import C2B
from mpesa_connect.enums import ResponseType, TransactionType
c2b = C2B(app, access_token=access_token)
result = c2b.register_url(
short_code=...,
validation_url=...,
confirmation_url=...,
response_type=ResponseType.COMPLETED,
)
Simulate
result = c2b.simulate(
short_code=...,
command_id=TransactionType.CUSTOMER_PAY_BILL_ONLINE,
amount=...,
msisdn=...,
bill_ref_number=...,
)
Business To Customer (B2C) API
from mpesa_connect import B2C
from mpesa_connect.enums import TransactionType
b2c = B2C(app, access_token=access_token)
result = b2c.payment_request(
initiator_name=...,
security_credential=...,
amount=...,
command_id=TransactionType.BUSINESS_PAYMENT,
party_a=...,
party_b=...,
queue_time_out_url=...,
result_url=...,
remarks=...,
occassion=...,
)
Account Balance API
from mpesa_connect import AccountBalance
from mpesa_connect.enums import TransactionType, IdentifierType
ab = AccountBalance(app, access_token=access_token)
result = ab.query(
initiator=...,
security_credential=...,
command_id=TransactionType.ACCOUNT_BALANCE,
identifier_type=IdentifierType.ORGANIZATION_SHORT_CODE,
party_a=...,
queue_time_out_url=...,
result_url=...,
remarks=...,
)
Transaction Status API
from mpesa_connect import TransactionStatus
from mpesa_connect.enums import TransactionType, IdentifierType
ts = TransactionStatus(app, access_token=access_token)
result = ts.query(
initiator=...,
security_credential=...,
transaction_id=...,
command_id=TransactionType.TRANSACTION_STATUS_QUERY,
identifier_type=IdentifierType.ORGANIZATION_SHORT_CODE,
party_a=...,
queue_time_out_url=...,
result_url=...,
remarks=...,
occassion=...,
)
All API methods return a result object with a response
property which is a requests.Response
object, plus various properties corresponding to the json body of the response
Running Tests
Install dependencies
$ poetry install
Create .env
file from .env.example then edit it to add your app credentials and test parameters
$ cp .env.example .env
Run tests
$ poetry run pytest
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mpesa_connect-0.1.4.tar.gz
.
File metadata
- Download URL: mpesa_connect-0.1.4.tar.gz
- Upload date:
- Size: 10.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.5.1 CPython/3.11.4 Linux/5.19.0-46-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6108e280d1cb3de17c7c7dd953191b5c16cbcfa2ae3b424f4a227f9f61f195fc |
|
MD5 | 3e52cb94ca315348ad5e97c6f774de2b |
|
BLAKE2b-256 | e0c65f295200a5f68b941a388d063cecdddb6253bad22ca36fbee22bb3d429f2 |
Provenance
File details
Details for the file mpesa_connect-0.1.4-py3-none-any.whl
.
File metadata
- Download URL: mpesa_connect-0.1.4-py3-none-any.whl
- Upload date:
- Size: 12.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.5.1 CPython/3.11.4 Linux/5.19.0-46-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab4942004a0cfa7eca9dd8e79b771cfd1d2b55a8a7cc902afe1e715dde6d5553 |
|
MD5 | 7d7094e92029fa33b1c3e1bedcd4fdab |
|
BLAKE2b-256 | 4baf248102b967c19e7bfa9d02de7bd8bb68d2f792bcfa5bd2d7be2a018fba76 |