API Documentation

Integrate FamPay payment verification in minutes with our simple REST API

1

Generate QR Code

Create Payment Request

Generate a dynamic UPI QR code for receiving instant payments with automatic verification.

GET https://subdict.qzz.io/genqr?upi=YOURUPI&amount=AMOUNT&name=MERCHANTNAME

Request Parameters

Parameter Type Description
upi Required Your UPI ID (e.g., yourname@fam)
amount Required Payment amount in INR. Fixed amount - user cannot edit.
name Required Merchant / payee name displayed on the QR code

Response Format

{
  "status": "success",
  "data": {
    "qr_url": "https://subdict.qzz.io/qr/iybhathstalker@fam_5_DRX%20Net.png",
    "upi_id": "iybhathstalker@fam",
    "amount": "5",
    "name": "DRX Net",
    "created_at_ist": "16-05-2026 23:47:00"
  },
  "dev": "@subdict"
}

Pro Tip: QR codes are generated instantly and do not expire. No API key or order ID is required. Simply share the QR image URL or embed it directly in your application.

2

Verify Payment Status

Check Transaction Completion

Verify if payment has been successfully received by scanning your Gmail inbox for FamPay confirmation emails. Choose the correct parameter based on your payment source.

For Other App to FamPay Payments (UTR)

Use this when the payer sends money from Paytm, Google Pay, PhonePe, or any other UPI app to your FamPay UPI ID.

GET https://subdict.qzz.io/check?mail=YOUREMAIL@gmail&apppass=APPPASSWORD&utr=UTRNUMBER&amount=AMOUNT

The UTR (Unique Transaction Reference) is a 12-digit number found in the "You received" email from FamPay.

For FamPay-to-FamPay Payments (TXN ID)

Use this when the payer sends money from their FamPay account to your FamPay UPI ID. These payments do not have a UTR - only a FamPay Transaction ID.

GET https://subdict.qzz.io/check?mail=YOUREMAIL@gmail&apppass=APPPASSWORD&txnid=FAMPAYTXNID&amount=AMOUNT

The Transaction ID looks like FMPIB5255631361 and is found in the "You received" email from FamPay.

Request Parameters

Parameter Type Description
mail Required Your Gmail address without @gmail.com (e.g., yourname)
apppass Required Your Gmail App Password (not your regular password)
amount Required Expected payment amount in INR for validation
utr Conditional 12-digit UTR number (use for non-FamPay payments)
txnid Conditional FamPay Transaction ID like FMPIB... (use for FamPay-to-FamPay)

Important: You must use either utr OR txnid - not both. Use utr when the payment comes from external UPI apps (Paytm, GPay, etc.). Use txnid only for FamPay-to-FamPay transfers. Our system only scans emails that start with "You received" to ensure valid payment confirmations.

Response Examples

Payment Success

{
  "status": "success",
  "data": {
    "transaction_id": "FMPIB5255631361",
    "amount": 5,
    "utr": "301268197755",
    "sender_name": "Anuj Patel",
    "payment_time_ist": "16-05-2026 23:50:12",
    "verified": true
  },
  "dev": "@subdict"
}

Payment Not Found

{
  "status": "error",
  "message": "Transaction not found",
  "details": "No matching payment found in email inbox",
  "dev": "@subdict"
}

Amount Mismatch

{
  "status": "error",
  "message": "Amount mismatch",
  "details": "Expected amount does not match the transaction amount",
  "expected": 5,
  "found": 10,
  "dev": "@subdict"
}

Error Codes

Code Status Description
400 Bad Request Missing or invalid parameters
401 Unauthorized Invalid Gmail app password or authentication failed
403 Forbidden IMAP access disabled or account restricted
404 Not Found Payment not found in email inbox
409 Conflict Amount mismatch or duplicate transaction detected
429 Rate Limited Too many requests
500 Server Error Internal server error