Credit Card

This API enables third-party systems or apps to integrate cerdit card payment 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": {
            "creditCardMemberList": [
                {
                    "code": "BOK-77-APP-1",
                    "name": "Bank Of Kathmandu Credit Card - NPR"
                },
                {
                    "code": "CEN-29-APP-1",
                    "name": "Century Bank VISA Credit Card - NPR"
                },
                {
                    "code": "CEN-29-APP-2",
                    "name": "Century Bank VISA Credit Card - NPR (VISA GOLD)"
                },
                {
                    "code": "CTZ-68-APP-1",
                    "name": "Citizens Bank Visa Credit Card - NPR"
                },
                {
                    "code": "EBL-260-APP-1",
                    "name": "Everest Bank Visa Credit Card - NPR"
                },
                {
                    "code": "GIB-13-APP-1",
                    "name": "Global IME Visa Credit Card - NPR"
                },
                {
                    "code": "GIB-13-APP-2",
                    "name": "Global IME Visa Credit Card - NPR (VISA GOLD)"
                },
                {
                    "code": "LAX-13-APP-2",
                    "name": "Laxmi Visa Credit Card (New)- NPR"
                }
            ]
        }
    }
}

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": "1210",
    "description": "Credit Card",
    "currencyId": "1",
    "webRequest": true,
    "customValues": [
        {
            "internalName": "PAYMENTMETHOD",
            "fieldId": "15",
            "value": "Account"
        },
        {
            "fieldId": "35",
            "internalName": "SELECTBANK",
            "value": "{{senderBankCode}}"
        },
        {
            "fieldId": "14",
            "internalName": "ACCOUNTNUMBER",
            "value": "{{senderBankAccountNumber}}"
        },
        {
            "fieldId": "21",
            "internalName": "CUSTOMERID",
            "value": "{{customerId}}"
        },
        {
            "fieldId": "174",
            "internalName": "NAME",
            "value": "{{customerName}}"
        }
    ],
    "extraParam": {
        "code": "{{credCardBankCode}}",
        "bankName": "{{creditCardBankName}}",
        "serviceCharge": "10"
    }
}

Book Payment – Successful Response (Sample)

{
    "status": true,
    "sessionExpired": false,
    "payload": {
        "DoPaymentResult": {
            "wouldRequireAuthorization": false,
            "from": {
                "id": {{fromMemberId}},
                "name": "{{fromMemberName}}",
                "username": "{{fromMemberUsername}}",
                "mobileNo": "{{fromMemberPrincipal}}"
            },
            "finalAmount": 395.00,
            "formattedFinalAmount": "Rs. 395.00",
            "transferType": {
                "id": {{transferTypeId}},
                "name": "{{transferTypeName}}",
                "from": {
                    "id": 5,
                    "name": "Transaction 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}}"
                }
            ],
            "isOtpEnable": false,
            "showConsolidateAmount": false,
            "bookingId": 25
        }
    }
}

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": "1210",
    "description": "Credit Card",
    "traceNumber": "CEL-123456", //Use consistent transaction IDs like CELL-001 or PRV-001 per your company's standard. Trace Number must be unique. 
    "currencyId": "1",
    "webRequest": true,
    "bookingId": 25,
    "transactionPin": "XXXXXX",
    "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}}"
        },
        {
            "fieldId": "174",
            "internalName": "NAME",
            "value": "{{customerName}}"
        }
    ]
}

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	Type	Required	Description
code	String	Yes	Bank code that uniquely identifies the bank associated with the transaction.
bankName	String	Yes	Name of the bank to which the user’s credit card or account belongs.
customerId	Integer	Yes	Unique identifier assigned to the customer in the system.
name	String	Yes	Full name of the customer associated with the transaction.
serviceCharge	String	Yes	Service charge applied to the transaction.