https://github.com/rogendo/django-daraja-2.0

https://github.com/rogendo/django-daraja-2.0

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/rogendo/django-daraja-2.0
• Owner: Rogendo
• License: mit
• Created: 2023-11-02T10:03:12.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-02T10:03:33.000Z (about 1 year ago)
• Last Synced: 2024-04-27T00:28:23.265Z (7 months ago)
• Language: Python
• Size: 104 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![Daraja logo](logo.png "Daraja logo")

# django-daraja

This is a django library based on the Safaricom MPESA daraja API. This is a django library based on the Safaricom MPESA daraja API. Use it for a simplified experience, spend less time setting up...

[![Build Status](https://circleci.com/gh/martinmogusu/django-daraja.svg?style=shield)](https://circleci.com/gh/martinmogusu/django-daraja)

[![Documentation Status](https://readthedocs.org/projects/django-daraja/badge/?version=latest)](https://django-daraja.readthedocs.io/en/latest/?badge=latest)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![PyPI version](https://badge.fury.io/py/django-daraja.svg)](https://badge.fury.io/py/django-daraja)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-daraja.svg)

Read the full documentation at https://django-daraja.readthedocs.io

MPESA Daraja API documentation can be found at https://developer.safaricom.co.ke

## Installation

To install the package, run

```

$ pip install django_daraja

```

## Examples

### STK Push

An example, to send an STK push prompt to customer phone, then display response message

```python

    from django_daraja.mpesa.core import MpesaClient

    def index(request):

        cl = MpesaClient()

        phone_number = '0700111222'

        amount = 1

        account_reference = 'reference'

        transaction_desc = 'Description'

        callback_url = 'https://api.darajambili.com/express-payment'

        response = cl.stk_push(phone_number, amount, account_reference, transaction_desc, callback_url)

        return HttpResponse(response)

```

On your browser, you will receive a message `Success. Request accepted for processing` on success of the STK push, and on the phone number specified you will receive an MPESA PIN prompt. Once the transaction is complete, you will receive a notification on the callback URL you provided. If you used the exact callback URL in the example above (i.e. https://api.darajambili.com/express-payment), you can head over to https://darajambili.com to view the notification received

### B2C Payment

An example, to perform a BusinessPayment B2C (Business to Customer) transaction

```python

    from django_daraja.mpesa.core import MpesaClient

    def index(request):

        cl = MpesaClient()

        phone_number = '0700111222'

        amount = 1

        transaction_desc = 'Business Payment Description'

        occassion = 'Test business payment occassion'

        callback_url = 'https://api.darajambili.com/b2c/result'

        response = cl.business_payment(phone_number, amount, transaction_desc, callback_url, occassion)

        return HttpResponse(response)

```

On your browser, you will receive a message `Accept the service request successfully.` on success of the transaction. Once the transaction is complete, you will receive a notification on the callback URL you provided. If you used the exact callback URL in the example above (i.e. https://api.darajambili.com/b2c/result), you can head over to https://darajambili.com to view the notification received

The full documentation of all supported API's can be found at https://django-daraja.readthedocs.io