Stock Broker

This API enables third-party systems or apps to integrate stock broker 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": {
            "stockBrokerList": [
                {
                    "brokerId": 34,
                    "brokerName": "Vision Securities Pvt. Limited",
                    "memberId": "611"
                },
                {
                    "brokerId": 49,
                    "brokerName": "Online Securities Pvt.Ltd",
                    "memberId": "611"
                },
                {
                    "brokerId": 58,
                    "brokerName": "Naasa Securities Company Ltd",
                    "memberId": "611"
                }
            ]
        }
    }
}

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}",
    "toMemberPrincipal": "{{toMemberPrincipal}}",
    "amount": "1",
    "description": "Stock Broker Payment",
    "currencyId": "1",
    "webRequest": true,
    "customValues": [
        {
            "internalName": "PAYMENTMETHOD",
            "fieldId": 15,
            "value": "Account"
        },
        {
            "internalName": "SELECTBANK",
            "fieldId": 35,
            "value": "{{senderBankCode}}"
        },
        {
            "internalName": "ACCOUNTNUMBER",
            "fieldId": 14,
            "value": "{{senderBankAccountNumber}}"
        },
        {
            "fieldId": "21",
            "internalName": "CUSTOMERID",
            "value": "{{customerId}}"
        },
        {
            "fieldId": "33",
            "internalName": "MOBILENUMBER",
            "value": "18930349400"
        },
        {
            "fieldId": "174",
            "internalName": "NAME",
            "value": "test name"
        }
    ]
}

Book Payment – Successful Response (Sample)

{
    "status": true,
    "sessionExpired": false,
    "payload": {
        "DoPaymentResult": {
            "wouldRequireAuthorization": false,
            "from": {
                "id": {{fromMemberId}},
                "name": "{{fromMemberName}}",
                "username": "{{fromMemberUsername}}",
                "mobileNo": "{{fromMemberPrincipal}}"
            },
            "finalAmount": 615.00,
            "formattedFinalAmount": "Rs. 615.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": "BUS_ID",
                    "fieldId": 198,
                    "value": "NDU3MDE1OjQzMzU4NDM6MA=="
                },
                {
                    "internalName": "TICKET_ID",
                    "fieldId": 199,
                    "value": "656232-B"
                },
                {
                    "internalName": "FROM_TO",
                    "fieldId": 201,
                    "value": "KATHMANDU-POKHARA"
                },
                {
                    "internalName": "PAYMENTMETHOD",
                    "fieldId": 15,
                    "value": "Account"
                },
                {
                    "fieldId": "35",
                    "internalName": "SELECTBANK",
                    "value": "{{senderBankCode}}"
                },
                {
                    "fieldId": "14",
                    "internalName": "ACCOUNTNUMBER",
                    "value": "{{senderBankAccountNumber}}"
                }
            ],
            "isOtpEnable": false,
            "showConsolidateAmount": false,
            "bookingId": 22
        }
    }
}

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": "615",
    "description": "ok",
    "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": 22,
    "transactionPin": "XXXXXX",
    "customValues": [
        {
            "internalName": "BUS_ID",
            "fieldId": "198",
            "value": "NDU3MDE1OjQzMzU4NDM6MA=="
        },
        {
            "internalName": "TICKET_ID",
            "fieldId": "199",
            "value": "656232-B"
        },
        {
            "internalName": "FROM_TO",
            "fieldId": "201",
            "value": "KATHMANDU-POKHARA"
        },
        {
            "fieldId": "15",
            "internalName": "PAYMENTMETHOD",
            "value": "Account"
        },
        {
            "fieldId": "35",
            "internalName": "SELECTBANK",
            "value": "{{senderBankCode}}"
        },
        {
            "fieldId": "14",
            "internalName": "ACCOUNTNUMBER",
            "value": "{{senderBankAccountNumber}}"
        }
    ]
}

Confirm Payment – Successful Response (Sample)

{
    "status": true,
    "sessionExpired": false,
    "payload": {
        "ConfirmPaymentResult": {
            "id": 137916,
            "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
brokerId	Integer	Yes	Unique identifier assigned to the broker.
brokerName	String	Yes	Registered name of the broker.
memberId	Integer	Yes	Unique identity number of the member registered with CellPay.
name	String	Yes	Full name of the customer associated with the transaction.
customerId	Integer	Yes	Unique identifier assigned to the customer in the system.
mobileNumber	String	Yes	Customer’s registered mobile number.