Skip to content

Latest commit

 

History

History
204 lines (131 loc) · 5.4 KB

README.md

File metadata and controls

204 lines (131 loc) · 5.4 KB
Raw

PYTHON M-Pesa SDK

Total Downloads Latest Stable Version License

This is a library willing to help you to integrate the Vodacom M-Pesa operations to your application.


Features

Using this library, you can implement the following operations:

  • Receive money from a mobile account to a business account (C2B)
  • Send money from a business account to a mobile account (B2C)
  • Send money from a business account to another business account (B2B)
  • Revert any of the transactions above mentioned



Requirements



Installation


Using PIP

$ pip install paymentsds-mpesa

$ cd paymentsds-mpesa

$ pip install -r requirements.txt



Usage

Using this SDK is very simple and fast, let us see some examples:


C2B Transaction (Receive money from 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')

B2C Transaction (Sending money to 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')

B2B Transaction (Sending money to 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')

Transaction Reversal

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 scenario

Friends



Authors



Contributing

Thank you for considering contributing to this package. If you wish to do it, email us at developers@paymentsds.org and we will get back to you as soon as possible.



Security Vulnerabilities

If you discover a security vulnerability, please email us at developers@paymentsds.org and we will address the issue with the needed urgency.



License

Copyright 2022 © The PaymentsDS Team

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.