Metadata-Version: 2.1
Name: brij-fintech
Version: 0.0.4
Summary: A library for brij fintech
Home-page: https://github.com/brianmuigai/brij
Author: Brian Muigai
Author-email: brianmuigai1@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# brij
A client api for brij fintech

## installation
```pip install brij-fintech==0.0.4```

## getting started
in order to use brij services,you'll need to follow these simple steps
- create an account with them
- create a service/application under your brij account dashboard
- note down your app ID and appKey

## Integration

***Direct Payment:***
sending direct payment from your customer to your brij account using M-Pesa
```
from brij.mpesa import MpesaService

to_acc = MpesaService(app_id='YOUR-BRIJ-APP-ID', app_key='YOUR-BRIJ-APP-KEY')
response = to_acc.mpesa_to_acc(amount, sender, MPESA-NUMBER, 'short description')
if r:
    print(r.json())
else:
    print('error')
```
- the description text must not exceed 16 chars
- MPESA-NUMBER is the number making the transaction. the supported format starts is 254712345678
- 
***Escrow:***
sending escrow payment between your customers with your account acting as an escrow account, using M-pesa
```
from mpesa import MpesaService

service = MpesaService(app_id='YOUR-BRIJ-APP-ID', app_key='YOUR-BRIJ-APP-KEY')
r = service.mpesa_to_escrow(amount, 'sender email or phone', 'recepient email or phone', MPESA-NUMBER, 'short deacription')
print(r.json())
```
- the MPESA-NUMBER is the number making the transaction. the supported format is 254712345678
- short description must not exceed 16 chars
- sender email or phone are required in order to reach both parties with updates on the transaction



