Skip to main content

FamGateway Python SDK ⚡

PyPI version Python versions License: MIT Govt MSME Registered

The official Python client library for FamGateway — 100% Free, Zero-Fee Peer-to-Peer UPI Payment Gateway for Indian Developers and Businesses.


✨ Features

  • Instant Dynamic UPI QR Codes — Get direct QR image URLs (qr_url) to send directly in Telegram Bots or apps.
  • 📲 Deep UPI Intent Linksupi://pay?... URLs for 1-tap payments in PhonePe, Google Pay, and Paytm.
  • 🤖 Telegram Bot Friendly — Send QR codes directly to users inside Telegram chats without external browser redirects.
  • 🛡️ Zero Transaction Fees — 100% peer-to-peer settlement directly into your FamPay / UPI ID.
  • 🔔 Instant Webhooks & Polling — Automated payment reconciliation via webhooks and status API.

📦 Installation

pip install famgateway

🚀 Quickstart (3 Lines of Code)

from famgateway import FamGateway

# 1. Initialize client with your API Key
fg = FamGateway(api_key="your_famgateway_api_key")

# 2. Create a dynamic UPI payment order
order = fg.create_order(
    amount=100.0,
    customer_name="Aryan Gupta",
    customer_phone="9876543210"
)

print("Order ID:", order.order_id)
print("Payable Amount: ₹", order.payable_amount)
print("QR Code Image URL:", order.qr_url)
print("Deep UPI Intent:", order.upi_intent)
print("Hosted Checkout URL:", order.checkout_url)

# 3. Check order payment status
status = fg.get_status(order.order_id)
if status.is_paid:
    print(f"Payment Captured! UTR: {status.utr}")

🤖 Telegram Bot Integration Example

Use famgateway to collect payments directly inside Telegram without any website redirect!

import telebot
from telebot.types import InlineKeyboardMarkup, InlineKeyboardButton
from famgateway import FamGateway

bot = telebot.TeleBot("YOUR_TELEGRAM_BOT_TOKEN")
fg = FamGateway(api_key="YOUR_FAMGATEWAY_API_KEY")

@bot.message_handler(commands=['buy'])
def handle_buy(message):
    # 1. Create UPI payment order for ₹50
    order = fg.create_order(
        amount=50.0,
        customer_name=f"{message.from_user.first_name} ({message.from_user.id})"
    )

    # 2. Create inline pay button
    markup = InlineKeyboardMarkup()
    markup.row(
        InlineKeyboardButton("📲 Pay via UPI App", url=order.upi_intent),
        InlineKeyboardButton("🔄 Check Status", callback_data=f"check_{order.order_id}")
    )

    # 3. Send QR image directly in chat!
    bot.send_photo(
        chat_id=message.chat.id,
        photo=order.qr_url,
        caption=f"⚡ *Scan to Pay ₹{order.payable_amount}*\n\nOrder ID: `{order.order_id}`",
        parse_mode="Markdown",
        reply_markup=markup
    )

@bot.callback_query_handler(func=lambda call: call.data.startswith("check_"))
def handle_status(call):
    order_id = call.data.split("_")[1]
    status = fg.get_status(order_id)

    if status.is_paid:
        bot.answer_callback_query(call.id, "✅ Payment Verified!", show_alert=True)
        bot.send_message(call.message.chat.id, f"🎉 Payment received! UTR: `{status.utr}`")
    else:
        bot.answer_callback_query(call.id, "⏳ Payment pending. Please complete the UPI payment.", show_alert=True)

bot.infinity_polling()

📚 API Reference

FamGateway(api_key, base_url="https://famgateway.in", timeout=15)

Initializes the FamGateway client.

fg.create_order(amount, customer_name=None, customer_email=None, customer_phone=None, redirect_url=None, webhook_url=None)

Creates a new payment order and generates dynamic UPI QR details.

Returns OrderResponse object:

  • order.order_id (str): Unique order reference (e.g. fg_J2KVI0O8)
  • order.amount (float): Base order amount
  • order.payable_amount (float): Reconciled payable amount
  • order.qr_url (str): Direct URL of the QR code image
  • order.upi_intent (str): Deep link (upi://pay?...) for opening UPI apps
  • order.checkout_url (str): Hosted web checkout URL
  • order.upi_id (str): Receiver UPI ID

fg.get_status(order_id)

Checks payment status for an order.

Returns OrderStatus object:

  • status.status (str): 'success', 'pending', or 'expired'
  • status.is_paid (bool): True if payment captured successfully
  • status.is_pending (bool): True if awaiting customer payment
  • status.utr (str|None): Bank 12-digit UTR / RRN reference
  • status.transaction_id (str|None): FamPay transaction reference ID
  • status.sender_name (str|None): Name of payer

🏢 About & Legal

FamGateway is a developer-focused payment orchestration platform operated by ARYANISPE.

📄 License

MIT License. Free for commercial and private use.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

famgateway-1.0.0.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

famgateway-1.0.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file famgateway-1.0.0.tar.gz.

File metadata

  • Download URL: famgateway-1.0.0.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.9

File hashes

Hashes for famgateway-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e879ff4689f1e53ff35db7182f760bed157de5d92849a85858efa22408cdc93f
MD5 761512f57ab3081f2205007681d84141
BLAKE2b-256 cfaa8bda2d1a30eab33db188d0b2232e4300433138848990f2713a7470fafa8c

See more details on using hashes here.

File details

Details for the file famgateway-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: famgateway-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.9

File hashes

Hashes for famgateway-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b4a39813b889864e15f11a4186d53a641bdd88376875386dc56be3d8672efb0b
MD5 c89d66b7e1ed3b8a7166dd9e0f65f2d5
BLAKE2b-256 d8dd6b53fd550119a8524b794bc6a9179f4876419ebff068895afc796ee2e5e6

See more details on using hashes here.

Release history Release notifications | RSS feed

1.0.2

2 files

1.0.1

2 files

This release

1.0.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page