Khanepani

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

Get Possible Values

Endpoint:

{base-url}/payments/possibleValues/{transferTypeId}

Method: GET

Request Headers:

The following HTTP headers are required when calling the API:

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

Get Possible Values – Response Example

{
    "status": true,
    "sessionExpired": false,
    "payload": {
        "possibleValues": {
            "offices": [
                {
                    "officeName": "ITAHARI",
                    "officeCode": "H20:1:2"
                },
                {
                    "officeName": "BIRATNAGAR",
                    "officeCode": "NK:38:Biratnagar"
                },
                {
                    "officeName": "POKHARA",
                    "officeCode": "NK:37:Pokhara"
                },
                {
                    "officeName": "BHARATPUR WATER SUPPLY MANAGEMENT BOARD",
                    "officeCode": "WK:35:eSewa_bharatpur"
                },
                {
                    "officeName": "BIRAT WATER SUPPLY AND SANITATION USER COMITTEE\",\n    \"ADDRESS\": \"BIRATNAGAR-3,MORANG",
                    "officeCode": "WK:32:eSewa_mangadh"
                },
                {
                    "officeName": "INDRAPUR SMALL TOWN WATER SUPPLY AND SANITATION USER COMMITTEE",
                    "officeCode": "WK:33:eSewa_indrapur"
                },
                {
                    "officeName": "KAWASOTI KHANEPANI",
                    "officeCode": "WK:44:KAWASHOTI"
                },
                {
                    "officeName": "KAWASOTI WATER SUPPLY",
                    "officeCode": "WK:34:eSewa_kawasoti"
                },
                {
                    "officeName": "LEKHNATH SMALL TOWN WATER SUPPLY & SANITATION USER COMMITTEE",
                    "officeCode": "WK:30:WATERMARK"
                },
                {
                    "officeName": "PRAGATINAGAR WATER SUPPLY & SANITATION CONSUMERS ASSOCIATION(PWSSCA)",
                    "officeCode": "WK:31:khanepani_nawal"
                },
                {
                    "officeName": "SURKHET VALLEY WATER SUPPLY USERS ORGANIZATION",
                    "officeCode": "WK:36:eSewa_surkhet"
                }
            ]
        }
    }
}

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": "1",
    "description": "Khane Pani",
    "currencyId": "1",
    "webRequest": true,
    "customValues": [
        {
            "internalName": "PAYMENTMETHOD",
            "fieldId": "15",
            "value": "Account"
        },
        {
            "fieldId": "35",
            "internalName": "SELECTBANK",
            "value": "{{senderBankCode}}"
        },
        {
            "fieldId": "14",
            "internalName": "ACCOUNTNUMBER",
            "value": "{{senderBankAccountNumber}}"
        }
        {
            "internalName": "OFFICE_CODE",
            "fieldId": "36",
            "value": "itahari"
        },
        {
            "internalName": "SERVICE_CHARGE",
            "fieldId": "181",
            "value": "1"
        },
        {
            "internalName": "CUSTOMERID",
            "fieldId": "21",
            "value": "{{customerId}}"
        }
    ]
}

Book Payment – Successful Response (Sample)

{
    "status": true,
    "sessionExpired": false,
    "payload": {
        "DoPaymentResult": {
            "wouldRequireAuthorization": false,
            "from": {
                "id": {{fromMemberId}},
                "name": "{{fromMemberName}}",
                "username": "{{fromMemberUsername}}",
                "mobileNo": "{{fromMemberPrinicipal}}",
                "premiumMember": false
            },
            "finalAmount": 1.00,
            "formattedFinalAmount": "Rs. 1.00",
            "transferType": {
                "id": {{transferTypeId}},
                "name": "{{transferTypeName}}",
                "title": "{{transferTypeTitle}}",
                "from": {
                    "id": 5,
                    "name": "Account",
                    "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": "Account"
                },
                {
                    "fieldId": "35",
                    "internalName": "SELECTBANK",
                    "value": "{{senderBankCode}}"
                },
                {
                    "fieldId": "14",
                    "internalName": "ACCOUNTNUMBER",
                    "value": "{{senderBankAccountNumber}}"
                },
                {
                    "internalName": "OFFICE_CODE",
                    "fieldId": 36,
                    "value": "itahari"
                },
                {
                    "internalName": "SERVICE_CHARGE",
                    "fieldId": 181,
                    "value": "1"
                },
                {
                    "internalName": "CUSTOMERID",
                    "fieldId": 21,
                    "value": "{{customerId}}"
                }
            ],
            "isOtpEnable": false,
            "showConsolidateAmount": false,
            "bookingId": 1142
        }
    }
}

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": "{{transferTypeId}}",
    "amount": "1",
    "description": "Khane Pani",
    "currencyId": "1",
    "webRequest": true,
    "bookingId": 1142,
    "transactionPin": "xxxxxx",
    "customValues": [
        {
            "internalName": "PAYMENTMETHOD",
            "fieldId": "15",
            "value": "Account"
        },
        {
            "fieldId": "35",
            "internalName": "SELECTBANK",
            "value": "{{senderBankCode}}"
        },
        {
            "fieldId": "14",
            "internalName": "ACCOUNTNUMBER",
            "value": "{{senderBankAccountNumber}}"
        },
        {
            "internalName": "OFFICE_CODE",
            "fieldId": "36",
            "value": "itahari"
        },
        {
            "internalName": "SERVICE_CHARGE",
            "fieldId": "181",
            "value": "1"
        },
        {
            "internalName": "CUSTOMERID",
            "fieldId": "21",
            "value": "1"
        }
    ]
}

Confirm Payment – Successful Response (Sample)

{
    "status": true,
    "sessionExpired": false,
    "payload": {
        "ConfirmPaymentResult": {
            "id": 350251,
            "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
OFFICE_CODE	String	Yes	Office code of the Khanepani office.
SERVICE_CHARGE	String	Yes	Service charge applicable for the Khanepani payment.
CUSTOMERID	Integer	Yes	Unique customer ID provided by the Khanepani office.
AMOUNT	String	Yes	Total amount to be paid.