Merge pull request #7 from WilliamOtieno/v1.0.0

V1.0.0

.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v2

README.md

@@ -1,135 +1 @@
-# 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](/CONTRIBUTING.md).
-
-
-## Installation
-
-- ``pip install python-flutterwave``
-
-## Usage
-
-- Create an account in Flutterwave [here](https://dashboard.flutterwave.com/signup?referrals=RV1284343) 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
-
-```python
-uri = payment.initiate_payment(tx_ref="qwerty", amount=100, redirect_url='your_callback_url',
-                               payment_options='mpesa', customer_email='[email protected]',
-                               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` and `tx_ref`. If your url is `https://example.com/callback`
-then it may be `http://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.
-
-> There is no need to save the transaction_id as it is also possible to use tx_ref to get the payment details!
-> Check here - https://developer.flutterwave.com/reference/endpoints/transactions/
-
-
-- To check the transaction details e.g. successful or not, grab the transaction_id from the previous step. 
-```python
-details = payment.get_payment_details(transaction_id)
-# or
-deailts = payment.get_payment_details_via_tx_ref(tx_ref)
-
-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.
-```python
-mpesa_trans_details = payment.trigger_mpesa_payment(tx_ref="qwertyuio", amount=100, currency='KES', 
-                                                    email='[email protected]', 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 uses `NGN`
-  - Only a number of banks support `USSD` so you have to refer to the docs to check your bank and its corresponding `account_bank` code.
-```
-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
-```
-
-
-```python
-details = payment.initiate_ussd_payment(tx_ref="123erd", amount=100, email='[email protected]',
-                                        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...
-```python
-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.
-```python
-details = payment.verify_card_details(card_bin=553188)
-print(details)
-```
-
-[![Sponsor Python Flutterwave](https://cdn.buymeacoffee.com/buttons/default-red.png)](https://dashboard.flutterwave.com/donate/zvapzky1ozls)
+```New docs under development```

python_flutterwave/charge/__init__.py

@@ -0,0 +1,5 @@
+from .bank import *
+from .card import *
+from .mobile import *
+from .validation import *
+

python_flutterwave/charge/bank.py

@@ -0,0 +1,133 @@
+import os
+import requests
+import json
+
+from python_flutterwave.decorators import handle_api_exceptions
+
+
+token = os.environ.get("SECRET_KEY")
+base_url = "https://api.flutterwave.com/v3/charges"
+
+
+@handle_api_exceptions
+def initiate_bank_charge(
+    amount: int,
+    email: str,
+    tx_ref: str,
+) -> dict:
+    """
+    Collect payments from your customers via bank transfers
+    :param tx_ref: str
+    :param amount: int
+    :param email: str
+    :return: dict
+    """
+
+    params = {"type": "bank_transfer"}
+    payload = json.dumps(
+        {
+            "tx_ref": f"{tx_ref}",
+            "amount": f"{amount}",
+            "email": f"{email}",
+        }
+    )
+    headers = {"Authorization": f"Bearer {token}", "Content-Type": "application/json"}
+
+    response = requests.post(url=base_url, headers=headers, data=payload, params=params)
+
+    return dict(response.json())
+
+
+@handle_api_exceptions
+def initiate_nigeria_bank_charge(
+    amount: int,
+    email: str,
+    tx_ref: str,
+) -> dict:
+    """
+    Charge Nigerian bank accounts using Flutterwave
+    :param tx_ref: str
+    :param amount: int
+    :param email: str
+    :return: dict
+    """
+
+    params = {"type": "mono"}
+    payload = json.dumps(
+        {
+            "tx_ref": f"{tx_ref}",
+            "amount": f"{amount}",
+            "email": f"{email}",
+        }
+    )
+    headers = {"Authorization": f"Bearer {token}", "Content-Type": "application/json"}
+
+    response = requests.post(url=base_url, headers=headers, data=payload, params=params)
+
+    return dict(response.json())
+
+
+@handle_api_exceptions
+def initiate_uk_eu_bank_charge(
+    amount: int, email: str, tx_ref: str, phone_number: str, is_token_io: int
+) -> dict:
+    """
+    Charge Customers UK and EU bank accounts
+    :param tx_ref: str
+    :param amount: int
+    :param email: str
+    :param phone_number: str
+    :param is_token_io: int
+    :return: dict
+    """
+
+    params = {"type": "account-ach-uk"}
+    payload = json.dumps(
+        {
+            "tx_ref": f"{tx_ref}",
+            "amount": f"{amount}",
+            "email": f"{email}",
+            "phone_number": f"{phone_number}",
+            "is_token_io": is_token_io,
+        }
+    )
+    headers = {"Authorization": f"Bearer {token}", "Content-Type": "application/json"}
+
+    response = requests.post(url=base_url, headers=headers, data=payload, params=params)
+
+    return dict(response.json())
+
+
+@handle_api_exceptions
+def initiate_ach_bank_charge(
+    amount: int,
+    email: str,
+    tx_ref: str,
+    phone_number: str,
+    currency: str,
+) -> dict:
+    """
+    Collect ACH payments for USD and ZAR transactions
+    :param tx_ref: str
+    :param amount: int
+    :param email: str
+    :param phone_number: str
+    :param currency: str
+    :return: dict
+    """
+
+    params = {"type": "account-ach-uk"}
+    payload = json.dumps(
+        {
+            "tx_ref": f"{tx_ref}",
+            "amount": f"{amount}",
+            "currency": f"{currency}",
+            "email": f"{email}",
+            "phone_number": f"{phone_number}",
+        }
+    )
+    headers = {"Authorization": f"Bearer {token}", "Content-Type": "application/json"}
+
+    response = requests.post(url=base_url, headers=headers, data=payload, params=params)
+
+    return dict(response.json())

python_flutterwave/charge/card.py

@@ -0,0 +1,50 @@
+import os
+import requests
+import json
+
+from python_flutterwave.decorators import handle_api_exceptions
+
+
+token = os.environ.get("SECRET_KEY")
+base_url = "https://api.flutterwave.com/v3/charges"
+
+
+@handle_api_exceptions
+def initiate_card_charge(
+    amount: int,
+    card_number: int,
+    cvv: int,
+    expiry_month: int,
+    expiry_year: int,
+    email: str,
+    tx_ref: str,
+) -> dict:
+    """
+    This is used to initiate card payments.
+    :param tx_ref: str
+    :param amount: int
+    :param card_number: int
+    :param cvv: int
+    :param expiry_month: int
+    :param expiry_year: int
+    :param email: str
+    :return: dict
+    """
+
+    params = {"type": "card"}
+    payload = json.dumps(
+        {
+            "tx_ref": f"{tx_ref}",
+            "amount": f"{amount}",
+            "card_number": f"{card_number}",
+            "cvv": f"{cvv}",
+            "expirty_month": f"{expiry_month}",
+            "expirty_year": f"{expiry_year}",
+            "email": f"{email}",
+        }
+    )
+    headers = {"Authorization": f"Bearer {token}", "Content-Type": "application/json"}
+
+    response = requests.post(url=base_url, headers=headers, data=payload, params=params)
+
+    return dict(response.json())