Ncell Top-Up

This API enables third-party systems or apps to integrate Ncell Top-up services into their systems via CellPay.

Book Payment

Endpoint:

{base-url}/payments/systemPayment

Method: POST

Request Headers:

The following headers are required when calling the API:

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

Book Payment – Request Example

{
    "transferTypeId": "{transferTypeId}",
    "amount": "50",
    "description": "ncell topup",
    "currencyId": "1",
    "webRequest": true,
    "customValues": [
        {
            "fieldId": "15",
            "internalName": "PAYMENTMETHOD",
            "value": "Mobile Wallet"
        },
        {
            "fieldId": "16",
            "internalName": "MOBILENUMBER",
            "value": "{{rechargeNumber}}"
        }
    ]
}

Book Payment – Successful Response (Sample)

{
    "status": true,
    "sessionExpired": false,
    "payload": {
        "DoPaymentResult": {
            "wouldRequireAuthorization": false,
            "from": {
                "id": "{{memberId}}",
                "name": "{{memberName}}",
                "username": "{{memberUsername}}",
                "mobileNo": "{{memberMobileNumber}}",
                "premiumMember": false
            },
            "finalAmount": 50.00,
            "formattedFinalAmount": "Rs. 50.00",
            "fees": [
                {
                    "type": "COMMISSION",
                    "name": "Cashback on ncell test",
                    "amount": 0.75,
                    "formattedAmount": "Rs. 0.75",
                    "description": "Cashback on ncell test"
                }
            ],
            "transferType": {
                "id": 238,
                "name": "Merchant Wallet NCELL Prepaid",
                "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": "PAYMENTMETHOD",
                    "fieldId": 15,
                    "value": "Mobile Wallet"
                },
                {
                    "internalName": "MOBILENUMBER",
                    "fieldId": 16,
                    "value": "{{rechargeNumber}}"
                }
            ],
            "isOtpEnable": false,
            "showConsolidateAmount": false,
            "bookingId": 128
        }
    }
}

Confirm Payment

Endpoint:

{base-url}/payments/confirmSystemPayment

Method: POST

Request Headers:

The following HTTP headers are required when calling the API:

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

Confirm Payment – Request Example

{
    "transferTypeId": "{transferTypeId}",
    "amount": "50",
    "description": "ncell topup",
    "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,
    "transactionPin": "XXXXXX",
    "bookingId": 128,
    "customValues": [
        {
            "fieldId": "15",
            "internalName": "PAYMENTMETHOD",
            "value": "Mobile Wallet"
        },
        {
            "fieldId": "16",
            "internalName": "MOBILENUMBER",
            "value": "{{rechargeNumber}}"
        }
    ]
}

Confirm Payment – Successful Response (Sample)

{
    "status": true,
    "sessionExpired": false,
    "payload": {
        "ConfirmPaymentResult": {
            "id": 169564,
            "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	Type	Required	Description
transferTypeId	Integer	Yes	Same Transfer Type ID used in Book Payment
amount	String	Yes	Recharge amount
description	String	No	Transaction description
currencyId	Integer	Yes	Defines the payment source: 1 = Account/Wallet, 2 = Loyalty
webRequest	Boolean	Yes	true for web, false for mobile
traceNumber	String	Yes	Must be unique
bookingId	Integer	Yes	Booking ID from Book Payment
transactionPin	String	Yes	User’s CellPay transaction PIN
customValues	Array	Conditional	Required if service mandates additional input