A Safaricom's DarajaAPI package for Flask Applications.
Project description
Flask-Mpesa
Flask-Mpesa provides a simple intergration for flask Applications with Mpesa Daraja API.
Installation
Use the package manager pip to install flask-mpesa.
pip install Flask-Mpesa
Usage
from flask import Flask
from flask_mpesa import MpesaAPI
app=Flask(__name__)
mpesaapi=MpesaAPI(app)
if you are using blueprints
from flask_mpesa import MpesaAPI
mpesaapi=MpesaAPI()
mpesaapi.init_app(app)
Be sure to set the following variables in the app.config
app.config["API_ENVIRONMENT"] = "sandbox" #sandbox or live
app.config["APP_KEY"] = "..." # App_key from developers portal
app.config["APP_SECRET"] = "..." #App_Secret from developers portal
B2C Api
This returns a json response to your result_url.
@app.route('/transact/b2c',methods=['GET'])
def b2c_transact():
data={"initiator_name": "[InitiatorName]",
"security_credential": "[SecurityCredential]",#from developers portal
"amount": "1000",
"command_id":"[command_id]",
"party_a": "[PartyA]",
"party_b": "[PartyB]",
"remarks": "[Remarks]",
"queue_timeout_url": "YOUR_URL" ,
"result_url": "YOUR_URL",
"occassion": "[Occassion]"
}
mpesaapi.B2C.transact(**data) # ** unpacks the dictionary
B2B Api
This returns a json response to your result_url.
@app.route('/transact/b2b')
def b2b_transact():
data={"initiator": "[Initiator]",
"security_credential": "[SecurityCredential]",#from developers portal
"amount": "1000",
"command_id":"[command_id]",
"sender_identifier_type":"[SenderIdentifierType]",
"receiver_identifier_type":"[ReceiverIdentifierType]",
"party_a": "[PartyA]",
"party_b": "[PartyB]",
"remarks": "[Remarks]",
"queue_timeout_url": "YOUR_URL" ,
"result_url": "YOUR_URL",
"account_reference": "[AccountReference]"
}
mpesaapi.B2B.transact(**data) # ** unpacks the dictionary
C2B api
@app.route('/transact/c2b')
def c2b_transact():
reg_data={"shortcode": "600364",
"response_type": "Completed",
"confirmation_url": "https://50213252.ngrok.io/confirmation",
"validation_url": "https://50213252.ngrok.io/validation"
}
v=mpesaapi.C2B.register(**reg_data) # ** unpacks the dictionary
##use v to capture the response
#This method allows you to test a mock payment and see the result so it can be avoided in production mode.
test_data={"shortcode": "600364",
"command_id": "CustomerPayBillOnline",
"amount": "100",
"msisdn": "254708374149",
"bill_ref_number": "account"
}
new_v = mpesaapi.C2B.simulate(**test_data) # ** unpacks the dictionary
#use new_v to capture the response
return render_template('home.html')
@app.route('/confirmation',methods=["POST"])
def c2b_confirmation():
#save the data
request_data = request.data
#Perform your processing here e.g. print it out...
print(request_data)
MpesaExpress api
@app.route('/transact/c2b')
def c2b_transact():
data = {
"business_shortcode": "[BusinessShortcode]", #from developers portal
"passcode": "[Passcode]",#from developers portal
"amount": "[Amount]", # choose amount preferrably KSH 1
"phone_number":"[PhoneNumber]", #phone number to be prompted to pay
"reference_code": "[Reference Code]",#Code to inform the user of services he/she is paying for.
"callback_url": "[YOUR_URL]", # cllback url should be exposes. for testing putposes you can route on host 0.0.0.0 and set the callback url to be https://youripaddress:yourport/endpoint
"description": "[Description]" #a description of the transaction its optional
}
resp = mpesaapi.MpesaExpress.stk_push(**data) # ** unpacks the dictionary
##use resp to capture the response
return render_template('home.html')
@app.route('/callback-url',methods=["POST"])
def callback_url():
#get json data set to this route
json_data = request.get_json()
#get result code and probably check for transaction success or failure
result_code=json_data["Body"]["stkCallback"]["ResultCode"]
message={
"ResultCode":0,
"ResultDesc":"success",
"ThirdPartyTransID":"h234k2h4krhk2"
}
#if result code is 0 you can proceed and save the data else if its any other number you can track the transaction
return jsonify(message),200
Balance api
balance=mpesaapi.Balance
Reversal api
reversal=mpesaapi.Reversal
TransactionStatus api
transaction_status=mpesaapi.TransactionStatus
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Tests and Examples
Examples are comming soon!.
License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Flask-Mpesa-1.2.5.tar.gz
(8.8 kB
view hashes)