Member Payment Endpoints
The following endpoints are used for Member Payment transactions:
Book Payment Endpoint:
{base-url}/payments/memberPayment
Confirm Payment Endpoint:
{base-url}/payments/confirmMemberPayment
Both endpoints use the POST method and require authenticated access.
Member Book Payment Request
The Member Book Payment request is used to validate the transaction details before execution. During this step, the sender provides recipient identification details along with the transaction amount.
Key characteristics:
- Requires recipient identification (toMemberPrincipal or toMemberId)
- Validates recipient availability and transaction parameters
- Generates a Booking ID
- No funds are deducted at this stage
The Booking ID returned from this request must be used in the Confirm Payment step.
Sample Request Example
{
"transferTypeId": "{transferTypeId}",
"toMemberPrincipal": "{{toMemberPrincipal}}",
"amount": "1",
"description": "test",
"currencyId": "1",
"webRequest": "true",
"traceNumber": "CELL-001",
"customValues": [
{
"internalName": "PAYMENTMETHOD",
"fieldId": "15",
"value": "Mobile Wallet"
}
],
"extraParam": {
},
"isOtpEnable": false
}
Member Confirm Payment Request
The Member Confirm Payment request is used to finalize the transaction. The sender submits the Booking ID along with authorization details such as the transaction PIN.
Upon successful validation:
- Funds are transferred to the recipient member’s wallet or linked bank account
- The sender’s wallet balance is debited in real time
- A final transaction response is returned
Sample Request Example
{
"transferTypeId": "{transferTypeId}",
"toMemberPrincipal": "{{toMemberPrincipal}}",
"amount": "1",
"description": "test",
"currencyId": "1",
"webRequest": "true",
"traceNumber": "CELL-001",
"bookingId": 1,
"transactionPin": "12345678",
"customValues": [
{
"internalName": "PAYMENTMETHOD",
"fieldId": "15",
"value": "Mobile Wallet"
}
]
}
Service Parameters
| Parameter Name | Parameter Type | Description |
|---|---|---|
| transferTypeId | Integer | Unique identifier for the payment type or service |
| amount | String | Amount to be paid (in NPR) |
| toMemberPrincipal | String | Member account within cellpay |
| description | String | Payment description |
| currencyId | Integer | 1 = Account/Wallet, 2 = Loyalty |
| webRequest | Boolean | true for web-based requests, false for mobile |
| traceNumber | String | Unique transaction reference (e.g., CELL-001). Use a different traceNumber for each request and transaction |
| transactionPin | String | 8-digit PIN, same as user login PIN |
| bookingId | Integer | ID returned from Book Payment request; required for Confirm Payment |
| internalName | String | Input field name (e.g., PAYMENTMETHOD, SELECTBANK) |
| fieldId | Integer | System-defined ID for the custom field |
| value | String | Value provided by the user for the specific field |