Government Prize Initiative

This API enables third-party systems or apps to integrate Government Prize Initiative services into their systems via CellPay.

Prize winner lookup

Endpoint:

{base-url}/api/v1/ird/lottery/prize-winners

Method: POST

Request Headers:

The following HTTP headers are required when calling the API:

Content-Type: application/json
Cellpay-Access-Token: {{accessToken}}

Prize winner lookup – Request Example

{
    "fromDate": "2026-08-07",
    "toDate": "2026-08-12"
}

Prize winner lookup – Successful Response (Sample)

{
    "status": true,
    "sessionExpired": false,
    "payload": {
        "irdLotteryResponse": [
            {
                "issuerIdentifier": "{{issuerIdentifier}}",
                "issuerName": "{{issuerName}}",
                "networkIdentifier": "{{networkIdentifier}}",
                "networkName": "Cellcom Pvt. Ltd.",
                "acquirerIdentifier": "{{acquirerIdentifier}}",
                "additionalInfo": "{{additionalInfo}}",
                "payerMobile": "{{payerMobile}}",
                "transactionDate": "2026-08-10",
                "couponCode": "{{couponCode}}",
                "dayCode": "{{dayCode}}",
                "prizeFiscalYearCode": "2083-84",
                "couponGeneratedAt": "2026-08-10 02:29:54.0",
                "officialPrizeCouponId": "{{officialPrizeCouponId}}",
                "drawId": "{{drawId}}",
                "categoryTitleEn": "{{categoryTitleEn}}",
                "categoryTitleNe": "{{categoryTitleNe}}",
                "titleEn": "{{titleEn}}",
                "titleNe": "{{titleNe}}",
                "eligibleFrom": "2026-08-10",
                "eligibleTo": "2026-08-10",
                "publishedAt": "2026-08-10 02:29:54.0",
                "winnerRank": 1,
                "transactionId": "{{transactionId}}"
            }
        ]
    }
} 

Prize Coupon Lookup

Endpoint:

{base-url}/api/v1/ird/lottery/prize-coupon-lookup

Method: POST

Request Headers:

The following headers are required when calling the API:

Content-Type: application/json
Cellpay-Access-Token: {{accessToken}}

Prize coupon lookup – Request Example

{
    "fromDate": "2026-08-07",
    "toDate": "2026-08-13",
    "payerMobileNumber": "{{payerMobileNumber}}",
    "couponStatus": "ASSIGNED" // ASSIGNED, NOT_ASSIGNED,
    // "couponStatus": null
}

tip

• If couponStatus is null, the response includes both ASSIGNED and NOT_ASSIGNED coupons and payers.
• If couponStatus = ASSIGNED: the payer is eligible for the prize.
• If couponStatus = NOT_ASSIGNED: the payer is not eligible for the prize.

Note: payerMobileNumber is compulsory for the lookup request.

Prize coupon lookup – Successful Response (Sample)

{
    "status": true,
    "sessionExpired": false,
    "payload": {
        "irdLotteryResponse": [
            {
                "issuerIdentifier": "{{issuerIdentifier}}",
                "issuerName": "{{issuerName}}",
                "networkIdentifier": "{{networkIdentifier}}",
                "networkName": "FONEPAY",
                "acquirerIdentifier": "{{acquirerIdentifier}}",
                "additionalInfo": "{{additionalInfo}}",
                "psoTransactionId": "{{psoTransactionId}}",
                "payerMobile": "{{payerMobile}}",
                "transactionDate": "2026-08-13",
                "status": "ASSIGNED",
                "hasPrizeCoupon": true,
                "couponCode": "{{couponCode}}",
                "dayCode": "{{dayCode}}",
                "prizeFiscalYearCode": "2083-84",
                "couponGeneratedAt": "2026-08-13T05:52:00.410258+05:45",
                "officialPrizeCouponId": "{{officialPrizeCouponId}}"
            }
        ]
    }
}

Service Parameters

Parameter Name	Type	Required	Description
Content-Type	string	Yes	Must be application/json.
Cellpay-Access-Token	string	Yes	Access token for authenticating API calls. Do not hard-code; examples redact this value.
fromDate	string (YYYY-MM-DD)	Yes	Start date for the lookup range.
toDate	string (YYYY-MM-DD)	Yes	End date for the lookup range.
payerMobileNumber	string	Yes (prize-coupon-lookup)	Payer's mobile number; compulsory for coupon lookup requests. Examples use placeholders like {{payerMobileNumber}}.
couponStatus	enum (ASSIGNED, NOT_ASSIGNED, NULL)	No	Filter by coupon assignment state. ASSIGNED = eligible, NOT_ASSIGNED = not eligible, NULL = return all.
irdLotteryResponse	array	-	Response array of prize/coupon objects.
issuerIdentifier	string	-	Issuer identifier (placeholder: {{issuerIdentifier}}).
couponCode	string	-	Coupon code (placeholder: {{couponCode}}).
payerMobile	string	-	Payer mobile number (placeholder: {{payerMobile}}).
transactionId	string	-	Transaction identifier (placeholder: {{transactionId}}).
winnerRank	integer	-	Winner ranking for the coupon (1 = first prize, etc.).

Redaction note: Examples in this document use placeholders (e.g. {payerMobile}, {couponCode}, {accessToken}) instead of sensitive headers (Authorization, Cookie) and personal data. Replace placeholders with real values only in a secure environment or via server-side configuration.