M-Pesa SDK for Python
M-Pesa SDK for Python is an unofficial library aiming to help develbusinesses integrating every M-Pesa operations to their Python applications.
Contents
- Features
- Usage
- Prerequisites
- Installation
- Configuration
- Related Projects
- Contributing
- Changelog
- Authors
- Credits
- License
Features
- Receive money from a mobile account to a business account
- Send money from a business account to a mobile account
- Send money from a business account to a another business account
- Revert a transaction
- Query the status of a transaction
Usage
Quickstart
Receive Money from a Mobile Account
from paymentsds.mpesa import Client
client = Client(
api_key='<REPLACE>', # API Key
public_key='<REPLACE>', # Public Key
service_provider_code='<REPLACE>' # input_ServiceProviderCode
)
try:
payment_data = {
'from': '841234567', # input_CustomerMSISDN
'reference': '11114', # input_ThirdPartyReference
'transaction': 'T12344CC', # input_TransactionReference
'amount': '10' # input_Amount
}
result = client.receive(payment_data)
except:
print('Operation failed')Send Money to a Mobile Account
from paymentsds.mpesa import Client
client = Client(
api_key='<REPLACE>', # API Key
public_key='<REPLACE>', # Public Key
service_provider_code='<REPLACE>' # input_ServiceProviderCode
)
try:
payment_data = {
'to': '841234567', # input_CustomerMSISDN
'reference': '11114', # input_ThirdPartyReference
'transaction': 'T12344CC', # input_TransactionReference
'amount': '10' # input_Amount
}
result = client.send(payment_data)
except:
print('Operation failed')Send Money to a Business Account
from paymentsds.mpesa import Client
client = Client(
api_key='<REPLACE>', # API Key
public_key='<REPLACE>', # Public Key
service_provider_code='<REPLACE>' # input_ServiceProviderCode
)
try:
payment_data = {
'to': '979797', # input_ReceiverPartyCode
'reference': '11114', # input_ThirdPartyReference
'transaction': 'T12344CC', # input_TransactionReference
'amount': '10' # input_Amount
}
result = client.send(payment_data)
except:
print('Operation failed')Revert a Transaction
from paymentsds.mpesa import Client
client = Client(
api_key='<REPLACE>', # API Key
public_key='<REPLACE>', # Public Key
service_provider_code='<REPLACE>', # input_ServiceProviderCode
initiatorIdentifier='<REPLACE>', # input_InitiatorIdentifier,
securityIdentifier='<REPLACE>' # input_SecurityCredential
)
try:
reversion_data = {
'reference': '11114', # input_ThirdPartyReference
'transaction': 'T12344CC', # input_TransactionReference
'amount': '10' # input_ReversalAmount
}
result = client.revert(reversion_data)
except:
# Handle success scenarioQuery the Status of a Transaction
Examples
Prerequisites
Installation
Using pip
$ pip install paymentsds-mpesapaymentsds-mpesa
$ pip install -r requirements.txtInstallation Scenario 2
Installation Scenario 3
Configuration
Configuration Scenario 1
Configuration Scenario 2
Configuration Scenario 3
Related Projects
Dependencies
Production Dependencies
Development Dependencies
Friends
Alternatives
Inspiration
- rosariopfernandes/mpesa-node-api
- karson/mpesa-php-sdk
- codeonweekends/mpesa-php-sdk
- abdulmueid/mpesa-php-api
- realdm/mpesasdk
Contributing
Changelog
Authors
Credits
License
Copyright 2020 AnĂsio Mandlate, Edson Michaque, Elton Laice and NĂ©lio Macombo
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
