Python Wrapper for interacting with the Flutterwave Payments API
Project description
Python Flutterwave
Description
Python Wrapper for interacting with the Flutterwave API
Contribution
- Before making any further steps (for interested contributors), please refer to the CONTRIBUTING GUIDE.
Installation
pip install python-flutterwave
Usage
- Create an account in Flutterwave here and obtain your
Secret Key
only.
from python_flutterwave import payment
payment.token = 'YOUR_SECRET_KEY'
Here are all the possible values for payment options available on Flutterwave:
0: "account"
1: "card"
2: "banktransfer"
3: "mpesa"
4: "mobilemoneyrwanda"
5: "mobilemoneyzambia"
6: "qr"
7: "mobilemoneyuganda"
8: "ussd"
9: "credit"
10: "barter"
11: "mobilemoneyghana"
12: "payattitude"
13: "mobilemoneyfranco"
14: "paga"
15: "1voucher"
16: "mobilemoneytanzania"
- To trigger a standard payment that returns a redirect uri
uri = payment.initiate_payment(tx_ref="qwerty", amount=100, redirect_url='your_callback_url',
payment_options='mpesa', customer_email='example@email.com',
customer_phone_number='0123456789', currency='KES', customer_name='John Doe',
title='Demo Payment', description='Just pay me...')
print(uri)
-
Redirect the user to that uri where he/she will make the payment.
-
After payment is made, the user will be redirected to the
redirect_url
you declared but Flutterwave will append some info regarding the payment i.e.transaction_id
andtx_ref
. If your url ishttps://example.com/callback
then it may behttp://example.com/callback/?status=successful&tx_ref=qwerty&transaction_id=2784792
-
You should save the transaction_id to your DB as it will be used to query the transaction details.
-
To check the transaction details e.g. successful or not, grab the transaction_id from the previous step.
details = payment.get_payment_details(transaction_id)
print(details)
- To trigger an automatic MPESA charge on your customer through STK push, first configure your Webhook url in the dashboard, it may be a simple server; Flutterwave will post some data regarding your transaction status in that url. This method call will return a Python dict object. You can decide what to do thereon.
mpesa_trans_details = payment.trigger_mpesa_payment(tx_ref="qwertyuio", amount=100, currency='KES',
email='johndoe@gmail.com', phone_number='1234567890',
full_name='John Doe')
print(mpesa_trans_details)
-
To initiate a USSD payment to your customer, configure your webhook url in the dashboard where Flutterwave will post data regarding the transaction. This method call will return a Python Dict object from which you can extract the USSD code to show your customer for payment completion. For other banks, you may also need to extract the
payment_code
from the result.- By default,
NGN
is the only supported currency for USSD payments so this method automatically usesNGN
- Only a number of banks support
USSD
so you have to refer to the docs to check your bank and its correspondingaccount_bank
code.
- By default,
At the moment, banks available for USSD payments (and their numeric codes) are:
Access Bank -- 044
Ecobank -- 050
Fidelity Bank -- 070
First Bank of Nigeria -- 011
First City Monument Bank (FCMB) -- 214
GTBank -- 058
Heritage Bank -- 030
Keystone Bank -- 082
Stanbic IBTC Bank -- 221
Sterling Bank -- 232
Union Bank -- 032
United Bank for Africa -- 033
Unity Bank -- 215
VFD Microfinance Bank -- 090110
Wema Bank -- 035
Zenith Bank -- 057
details = payment.initiate_ussd_payment(tx_ref="123erd", amount=100, email='johndoe@gmail.com',
phone_number='789456123', full_name='John Doe', account_bank='057')
print(details)
- For bank transactions, it is important to first verify the details given to you by the customer before granting incentives according to the specifications of your application.
- To verify bank details call the function below that returns a Python dictionary with the data...
details = payment.verify_bank_account_details(account_number= "0690000032", account_bank= "044")
print(details)
- For card transactions, it is advisable to ascertain the customer's card details before granting incentives according to the specifications of your application.
- This function call takes the
card_bin
(usually the first 4-6 digits in debit/credit cards) and returns info regarding the card. A Python dict object is returned, thence use it according to your needs.
details = payment.verify_card_details(card_bin=553188)
print(details)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for python-flutterwave-0.8.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ff1296482f0d1e4ee9c479ad85a43d84b6ffc92d5ae381caa8ded0c23655db1 |
|
MD5 | 3df27d34174891d04f8331a7c874a5db |
|
BLAKE2b-256 | 01701365f4ca65c84441f24e556673f95a5602c9998adc05a589953c5686435a |
Hashes for python_flutterwave-0.8.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 77cb3c16aee65f3f9760f5beb447edff70e2c722800eb0cf37a8c4f7df272b65 |
|
MD5 | 13f320052d9c73e071a24e01a596bcba |
|
BLAKE2b-256 | cad2d6509cae0fb8ad234b7f7800c7d8fb76e30ccf1e808fff78a5fcc3fc2a94 |