API Documentation

Welcome to the FamAPI developer documentation. Seamlessly integrate automated UPI payments using your personal FamPay account. Our REST API allows you to programmatically generate QR codes and verify payments in real-time without business KYC.

Base URL: https://fam.aryanispe.in

Authentication

Pass your secret API key as a query parameter for GET requests, or in the request body for POST requests. You can find your API key in the Dashboard.

// Example Payload inclusion

{ "api_key": "FAM_XYZ123" }

// Example Query inclusion

?api_key=FAM_XYZ123

GET

/api/qr

Generates a UPI payment QR code and initiates a new pending order.

Query Parameters

Parameter	Type	Description
api_key	string	Your secret API key. REQUIRED
amount	string / float	Amount to be collected (e.g. 10 or 500.50). REQUIRED
upi	string	The receiver UPI ID. REQUIRED

Response

{
    "status": "success",
    "data": {
        "order_id": "FAM1720709040001",
        "qr_url": "https://api.qrserver.com/v1/...",
        "upi_id": "merchant@fampay",
        "amount": "10"
    }
}

GET

/api/verify_order

Poll this endpoint to check the real-time payment status. It triggers IMAP reading on our end to find matching incoming transaction emails.

Query Parameters

Parameter	Type	Description
api_key	string	Your secret API key. REQUIRED
order_id	string	The order_id returned from `/api/qr`. REQUIRED

Response (Pending)

{
    "status": "pending",
    "message": "Payment not received yet. Keep polling."
}

Response (Success)

{
    "status": "success",
    "data": {
        "order_id": "FAM1720709040001",
        "transaction_id": "FMPIB6133656758",
        "amount": "10.00",
        "sender_name": "AG FF"
    }
}