python_flutterwave.charge package
Submodules
python_flutterwave.charge.bank module
- python_flutterwave.charge.bank.initiate_ach_bank_charge(amount: int, email: str, tx_ref: str, phone_number: str, currency: str) dict[source]
Collect ACH payments for USD and ZAR transactions
- Args:
tx_ref (int): Unique reference peculiar to the transaction.
amount (int): Amount to be charged for the transaction.
email (str): The customer’s email address.
phone_number (str): Phone number linked to the customer’s bank account or mobile money account
currency (str): Currency to charge in. Expected values are ZAR for ZA ACH and USD for US ACH.
- Returns:
dict: Response Details
- python_flutterwave.charge.bank.initiate_bank_charge(amount: int, email: str, tx_ref: str) dict[source]
Collect payments from your customers via bank transfers
- Args:
tx_ref (int): This is a unique reference peculiar to the transaction being carried out.
amount (int): This is the amount to be charged for the transaction.
email (str): The customer’s email address.
- Returns:
dict: Response Details
- python_flutterwave.charge.bank.initiate_nigeria_bank_charge(amount: int, email: str, tx_ref: str) dict[source]
Charge Nigerian bank accounts using Flutterwave
- Args:
tx_ref (int): This is a unique reference peculiar to the transaction being carried out.
amount (int): This is the amount to be charged for the transaction.
email (str): The customer’s email address.
- Returns:
dict: Response Details
- python_flutterwave.charge.bank.initiate_uk_eu_bank_charge(amount: int, email: str, tx_ref: str, phone_number: str, is_token_io: int) dict[source]
Charge Customers UK and EU bank accounts
- Args:
tx_ref (int): Unique reference peculiar to the transaction.
amount (int): Amount to be charged for the transaction.
email (str): The customer’s email address.
phone_number (str): Phone number linked to the customer’s bank account or mobile money account
is_token_io (int):
- Returns:
dict: Response Details
python_flutterwave.charge.card module
- python_flutterwave.charge.card.initiate_card_charge(amount: int, card_number: int, cvv: int, expiry_month: int, expiry_year: int, email: str, tx_ref: str) dict[source]
This is used to initiate card payments.
- Args:
tx_ref (int): This is a unique reference peculiar to the transaction being carried out.
amount (int): This is the amount to be charged for the transaction.
email (str): The customer’s email address.
card_number (int): The customer’s card.
cvv (int): Card CVV.
expiry_month (int): Card expiry month
expiry_year (int): Card expiry year
- Returns:
dict: Response Details
python_flutterwave.charge.mobile module
- python_flutterwave.charge.mobile.initiate_apple_pay_charge(tx_ref: str, amount: int, email: str, currency: str) dict[source]
Accept payments from your customers with Apple Pay
- Args:
tx_ref (int): Unique reference peculiar to the transaction.
amount (int): Amount to be charged for the transaction.
email (str): The customer’s email address.
currency (str): Currency to charge in.
- Returns:
dict: Response Details
- python_flutterwave.charge.mobile.initiate_enaira_charge(tx_ref: str, amount: int, email: str) dict[source]
Accept payment from eNaira wallets
- Args:
tx_ref (int): This is a unique reference peculiar to the transaction being carried out.
amount (int): This is the amount to be charged for the transaction.
email (str): The customer’s email address.
- Returns:
dict: Response Details
- python_flutterwave.charge.mobile.initiate_fawry_pay_charge(tx_ref: str, amount: int, email: str) dict[source]
Receive Fawry payments from customers in Egypt
- Args:
tx_ref (int): This is a unique reference peculiar to the transaction being carried out.
amount (int): This is the amount to be charged for the transaction.
email (str): The customer’s email address.
- Returns:
dict: Response Details
- python_flutterwave.charge.mobile.initiate_franco_mobile_charge(amount: int, email: str, tx_ref: str, phone_number: str, currency: str, franco_country_code: str) dict[source]
Collect mobile money payments from customers in Francophone countries
- Args:
tx_ref (int): Unique reference peculiar to the transaction.
amount (int): Amount to be charged for the transaction.
email (str): The customer’s email address.
phone_number (str): Phone number linked to the customer’s bank account or mobile money account
currency (str): Currency to charge in.
franco_country_code (str): Country code (BF, CI, CM, SN)
- Returns:
dict: Response Details
- python_flutterwave.charge.mobile.initiate_ghana_mobile_charge(amount: int, email: str, tx_ref: str, phone_number: str, network: str) dict[source]
Collect mobile money payments from customers in Ghana
- Args:
tx_ref (int): Unique reference peculiar to the transaction.
amount (int): Amount to be charged for the transaction.
email (str): The customer’s email address.
phone_number (str): Phone number linked to the customer’s bank account or mobile money account
network (str): Mobile money network provider (MTN, VODAFONE, TIGO)
- Returns:
dict: Response Details
- python_flutterwave.charge.mobile.initiate_google_pay_charge(tx_ref: str, amount: int, email: str, currency: str) dict[source]
Accept payments from your customers with Google Pay
- Args:
tx_ref (int): Unique reference peculiar to the transaction.
amount (int): Amount to be charged for the transaction.
email (str): The customer’s email address.
currency (str): Currency to charge in.
- Returns:
dict: Response Details
- python_flutterwave.charge.mobile.initiate_mpesa_charge(amount: int, email: str, tx_ref: str, phone_number: str) dict[source]
Collect Mpesa payments from customers in Kenya
- Args:
tx_ref (int): Unique reference peculiar to the transaction.
amount (int): Amount to be charged for the transaction.
email (str): The customer’s email address.
phone_number (str): Phone number linked to the customer’s bank account or mobile money account
- Returns:
dict: Response Details
- python_flutterwave.charge.mobile.initiate_paypal_charge(tx_ref: str, amount: int, email: str, currency: str) dict[source]
Collect payments from customers with PayPal
- Args:
tx_ref (int): Unique reference peculiar to the transaction.
amount (int): Amount to be charged for the transaction.
email (str): The customer’s email address.
currency (str): Currency to charge in.
- Returns:
dict: Response Details
- python_flutterwave.charge.mobile.initiate_rwanda_mobile_charge(amount: int, email: str, tx_ref: str, phone_number: str, order_id: str) dict[source]
Collect mobile money payments from customers in Rwanda
- Args:
tx_ref (int): Unique reference peculiar to the transaction.
amount (int): Amount to be charged for the transaction.
email (str): The customer’s email address.
phone_number (str): Phone number linked to the customer’s bank account or mobile money account
order_id (str): Unique ref for the mobilemoney transaction to be provided by the merchant
- Returns:
dict: Response Details
- python_flutterwave.charge.mobile.initiate_tanzania_mobile_charge(amount: int, email: str, tx_ref: str, phone_number: str) dict[source]
Collect mobile money payments from customers in Tanzania
- Args:
tx_ref (int): Unique reference peculiar to the transaction.
amount (int): Amount to be charged for the transaction.
email (str): The customer’s email address.
phone_number (str): Phone number linked to the customer’s bank account or mobile money account
- Returns:
dict: Response Details
- python_flutterwave.charge.mobile.initiate_uganda_mobile_charge(amount: int, email: str, tx_ref: str, phone_number: str) dict[source]
Collect mobile money payments from customers in Uganda
- Args:
tx_ref (int): Unique reference peculiar to the transaction.
amount (int): Amount to be charged for the transaction.
email (str): The customer’s email address.
phone_number (str): Phone number linked to the customer’s bank account or mobile money account
- Returns:
dict: Response Details
- python_flutterwave.charge.mobile.initiate_ussd_charge(tx_ref: str, account_bank: str, amount: int, email: str, phone_number: str) dict[source]
Collect USSD payments from customers in Nigeria
- Args:
tx_ref (int): Unique reference peculiar to the transaction.
amount (int): Amount to be charged for the transaction.
email (str): The customer’s email address.
account_bank (str): Bank numeric code. It can be gotten from the banks endpoint.
phone_number (str): Phone number linked to the customer’s bank account or mobile money account
- Returns:
dict: Response Details
- python_flutterwave.charge.mobile.initiate_zambia_mobile_charge(amount: int, email: str, tx_ref: str, phone_number: str) dict[source]
Collect mobile money payments from customers in Zambia
- Args:
tx_ref (int): Unique reference peculiar to the transaction.
amount (int): Amount to be charged for the transaction.
email (str): The customer’s email address.
phone_number (str): Phone number linked to the customer’s bank account or mobile money account
- Returns:
dict: Response Details
python_flutterwave.charge.validation module
- python_flutterwave.charge.validation.validate_charge(otp: str, flw_ref: str) dict[source]
Validate a charge
- Args:
flw_ref (str): Reference returned in the initiate charge call as data.flw_ref
otp (str): Random number of at least 6 characters sent to customers phone number.
- Returns:
dict: Response Details
Module contents
The charge APIs help you to collect payments using different payment methods.