Government Payment

This API enables third-party systems or apps to integrate government payment services into their systems via CellPay.

Book Payment

Endpoint:

{base-url}/payments/systemPayment

Method: POST

Request Headers:

The following HTTP headers are required when calling the API:

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

Book Payment – Request Example

{
    "transferTypeId": "{{transferTypeId}}",
    "amount": "1659",
    "description": "",
    "currencyId": "1",
    "webRequest": true,
    "customValues": [
        {
            "fieldId": "21",
            "internalName": "CUSTOMERID",
            "value": "{{customerId}}"
        },
        {
            "fieldId": "15",
            "internalName": "PAYMENTMETHOD",
            "value": "Mobile Wallet"
        }
    ],
    "isOtpEnable": null,
    "otp": null
}

Book Payment – Successful Response (Sample)

{
    "status": true,
    "sessionExpired": false,
    "payload": {
        "DoPaymentResult": {
            "wouldRequireAuthorization": false,
            "from": {
                "id": {{fromMemberid}},
                "name": "{{fromMemberName}}",
                "username": "{{fromMemberUsername}}",
                "mobileNo": "{{fromMemberPrincipal}}",
                "premiumMember": false
            },
            "finalAmount": 1659.00,
            "formattedFinalAmount": "NPR 165,980.00",
            "fees": [
                {
                    "type": "FEE",
                    "name": "Fee on Government(10001 - above)",
                    "amount": 20.00,
                    "formattedAmount": "NPR 20.00",
                    "description": "Applied Fee"
                }
            ],
            "transferType": {
                "id": {{transferTypeId}},
                "name": "{{transferTypeName}}",
                "title": "{{transferTypeTitle}}",
                "from": {
                    "id": 14,
                    "name": "Mobile Wallet",
                    "currency": {
                        "id": 1,
                        "symbol": "रु",
                        "name": "Nepalese Rupee"
                    }
                },
                "to": {
                    "id": 6,
                    "name": "Cellcom Float Account",
                    "currency": {
                        "id": 1,
                        "symbol": "रु",
                        "name": "Nepalese Rupee"
                    }
                }
            },
            "customValues": [
                {
                    "internalName": "CUSTOMERID",
                    "fieldId": 21,
                    "value": "{{customerId}}"
                },
                {
                    "internalName": "PAYMENTMETHOD",
                    "fieldId": 15,
                    "value": "Mobile Wallet"
                }
            ],
            "isOtpEnable": false,
            "advanceValues": {
                "creditorName": "{{creditorName}}",
                "particulars": "{{particular}}",
                "remarks": "{{remarks}}",
                "referenceId": "{{referenceId}}"
            },
            "showConsolidateAmount": false
        }
    }
}

Confirm Payment

Endpoint:

{base-url}/payments/confirmSystemPayment

Method: POST

Request Headers:

The following headers are required when calling the API:

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

Confirm Payment – Request Example

{
    "transferTypeId": "459",
    "amount": "1659",
    "description": "vat 1 qua",
    "currencyId": "1",
  "traceNumber": "CEL-123456" //Use consistent transaction IDs like CELL-001 or PRV-001 per your company's standard. Trace Number must be unique.
    "webRequest": true,
    "customValues": [
        {
            "fieldId": "21",
            "internalName": "CUSTOMERID",
            "value": "{{customerId}}"
        },
        {
            "fieldId": "15",
            "internalName": "PAYMENTMETHOD",
            "value": "Mobile Wallet"
        }
    ],
    "isOtpEnable": null,
    "otp": "",
    "transactionPin": "XXXXXX",
    "extraParam": {
        "referenceId": "{{referenceId}}"
    }
}

Confirm Payment – Successful Response (Sample)

{
    "status": true,
    "sessionExpired": false,
    "payload": {
        "ConfirmPaymentResult": {
            "id": 138065,
            "pending": false,
     "traceNumber": "CEL-123456" //Use consistent transaction IDs like CELL-001 or PRV-001 per your company's standard. Trace Number must be unique.
        }
    }
}

Service Parameters

Parameter Name	Parameter Type	Required	Description
CUSTOMERID	Integer	Yes	EBP number of the customer
Amount	String	Yes	Amount to be paid