CG Net
This API enables third-party systems or apps to integrate services into their systems via CellPay.
Get Possible Values
Endpoint:
{{base-url}}/payments/possibleValues/{{transferTypeId}}
Method: POST
Request Headers:
The following HTTP headers are required when calling the API:
--header 'Content-Type: application/json' \
--header 'Cellpay-Access-Token: {{accessToken}}' \
Get Possible Values – Request Example
{
"customerId": "{{customerId}}"
}
Get Possible Values – Response Example
{
"status": true,
"sessionExpired": false,
"payload": {
"possibleValues": {
"cgCustomerDetailsPojo": {
"customerType": "PGCustomerDetail1",
"status": "Active",
"expiryDate": "2026-12-29 23:59:59",
"returnCode": 0,
"returnMessage": "Success",
"name": "Test",
"userId": "{{customerId}}",
"address": "Lalitpur ",
"state": "Nepal",
"nation": "Nepal",
"mobileNumber": "{{mobileNumber}}",
"email": "{{email}}",
"currentPlanName": "CGNet_101Mbps_12_Internet_Only",
"outstandingAmount": 0
},
"planLists": [
{
"amount": 17000.17,
"description": "CGNet_150Mbps_24M_Internet_Only",
"planName": "CGNet_150Mbps_24M_Internet_Only",
"primarySpeed": "150.00 Mbps",
"volumeQuota": "1536000 MB",
"validity": "2 Year"
},
{
"amount": 14999.73,
"description": "CGNet_101Mbps_24M_Internet_Only",
"planName": "CGNet_101Mbps_24M_Internet_Only",
"primarySpeed": "101.00 Mbps",
"volumeQuota": "1228800 MB",
"validity": "2 Year"
},
{
"amount": 9000.0,
"description": "CGNet_101Mbps_12_Internet_Only",
"planName": "CGNet_101Mbps_12_Internet_Only",
"primarySpeed": "101.00 Mbps",
"volumeQuota": "1228800 MB",
"validity": "1 Year"
}
],
"planType": "PlaListResponse",
"returnCode": 0,
"returnMessage": "Success",
"toMemberPrincipal": "0000000001"
}
}
}
Book Payment
Endpoint:
{{base-url}}/payments/memberPayment
Method: POST
Request Headers:
The following HTTP headers are required when calling the API:
--header 'Content-Type: application/json' \
--header 'Cellpay-Access-Token: {{accessToken}}' \
Book Payment – Request Example
{
"transferTypeId": "{{transferTypeId}}",
"amount": "9000",
"description": "Self Transfer Large Merchant",
"currencyId": "1",
"webRequest": "true",
"toMemberPrincipal": "0000000001",
"customValues": [
{
"fieldId": "15",
"internalName": "PAYMENTMETHOD",
"value": "Account"
},
{
"fieldId": "35",
"internalName": "SELECTBANK",
"value": "{{senderBankCode}}"
},
{
"fieldId": "14",
"internalName": "ACCOUNTNUMBER",
"value": "{{senderBankAccountNumber}}"
},
{
"fieldId": "21",
"internalName": "CUSTOMERID",
"value": "{{customerId}}"
}
],
"extraParam": {
"renewType": "Renew",
"planName": "CGNet_101Mbps_12_Internet_Only",
"planAmount": "9000"
},
"isOtpEnable": false
}
Book Payment – Successful Response (Sample)
{
"status": true,
"sessionExpired": false,
"payload": {
"DoPaymentResult": {
"wouldRequireAuthorization": false,
"from": {
"id": 69067,
"name": "{{memberName}}",
"username": "{{memberUserame}}",
"mobileNo": "{{membermobileNo}}",
"premiumMember": false
},
"to": {
"id": 350270,
"name": "CG PVT LTD",
"username": "cgnet",
"mobileNo": "0000000001",
"premiumMember": false
},
"finalAmount": 9000.00,
"formattedFinalAmount": "Rs. 9,000.00",
"transferType": {
"id": 603,
"name": "CG Internet Payment",
"title": "CG Internet Payment",
"from": {
"id": 5,
"name": "Transaction Account",
"currency": {
"id": 1,
"symbol": "रु",
"name": "Nepalese Rupee"
}
},
"to": {
"id": 14,
"name": "Mobile Wallet",
"currency": {
"id": 1,
"symbol": "रु",
"name": "Nepalese Rupee"
}
}
},
"customValues": [
{
"internalName": "PAYMENTMETHOD",
"fieldId": 15,
"value": "Account"
},
{
"internalName": "SELECTBANK",
"fieldId": 35,
"value": "{{senderBankCode}}"
},
{
"internalName": "ACCOUNTNUMBER",
"fieldId": 14,
"value": "{{senderBankAccountNumber}}"
},
{
"internalName": "CUSTOMERID",
"fieldId": 21,
"value": "{{customerId}}"
}
],
"isOtpEnable": false,
"showConsolidateAmount": false,
"extraParam": {
"eventId": 0,
"subEventId": 0,
"disableOtp": false,
"renewType": "Renew",
"planName": "CGNet_101Mbps_12_Internet_Only",
"planAmount": "9000",
"renewOption": false
},
"bookingId": 5183
}
}
}
Confirm Payment
Endpoint:
{base-url}/payments/confirmMemberPayment
Method: POST
Request Headers:
The following headers are required when calling the API:
--header 'Content-Type: application/json' \
--header 'Cellpay-Access-Token: {{accessToken}}' \
Confirm Payment – Request Example
{
"transferTypeId": "{{transferTypeId}}",
"amount": "9000",
"description": "Self Transfer Large Merchant",
"currencyId": "1",
"bookingId": 122,
"webRequest": "true",
"transactionPin": "{{transactionPin}}",
"customValues": [
{
"fieldId": "15",
"internalName": "PAYMENTMETHOD",
"value": "Account"
},
{
"fieldId": "35",
"internalName": "SELECTBANK",
"value": "{{senderBankCode}}"
},
{
"fieldId": "14",
"internalName": "ACCOUNTNUMBER",
"value": "{{senderBankAccountNumber}}"
}
],
"extraParam": {
"username": "{{username}}",
"renewType": "Renew",
"planName": "CGNet_101Mbps_12_Internet_Only",
"planAmount": "9000"
},
"isOtpEnable": false
}
Confirm Payment – Successful Response (Sample)
{
"status": true,
"sessionExpired": false,
"payload": {
"ConfirmPaymentResult": {
"id": 174639,
"pending": false
}
}
}
Service Parameters
This section defines the key parameters required for processing utility service payments via the CellPay API. These parameters may vary depending on the selected transferTypeId and the specific service provider configuration.
All service-specific inputs are passed through the customValues and extraParam objects in the request payload.
Core Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| transferTypeId | String | Yes | Unique identifier of the service being consumed |
| amount | String/Decimal | Yes | Transaction amount to be paid |
| currencyId | String | Yes | Currency identifier (e.g., 1 for NPR) |
| description | String | Yes | Description of the transaction |
| bookingId | Integer | Yes (Confirm only) | Unique ID generated during Book Payment step |
| transactionPin | String | Conditional | Required if OTP is disabled |
| isOtpEnable | Boolean | Yes | Determines whether OTP-based authorization is enabled |
Custom Values (Service-Specific Inputs)
The customValues array is used to pass dynamic parameters required by different service providers. Each object contains:
| Field | Type | Description |
|---|---|---|
| fieldId | String | Unique identifier of the field configured in CellPay system |
| internalName | String | Logical name of the parameter |
| value | String | Value provided by the API consumer |
Commonly Used Custom Parameters
| Internal Name | Description | Example |
|---|---|---|
| CUSTOMERID | Unique customer identifier in provider system | CUST12345 |
| ACCOUNTNUMBER | Bank account number (for account-based payments) | 001234567890 |
| SELECTBANK | Bank identifier/code | NABIL |
| PAYMENTMETHOD | Payment source type | Wallet / Account |
Extra Parameters
The extraParam object is used to pass additional service-level metadata required for transaction processing.
| Parameter | Type | Required | Description |
|---|---|---|---|
| planName | String | Conditional | Selected service plan name |
| planAmount | String | Conditional | Amount associated with the selected plan |
| renewType | String | Conditional | Defines renewal behavior (e.g., Renew, New) |
| username | String | Conditional | Username for authentication in confirm step (if required) |