Appearance
Payment Gateways
Base URL:
https://your-domain.com
Payment gateway integration endpoints for processing online payments.
Bkash
Bkash payment gateway endpoints. These endpoints are called by the Bkash payment gateway system and do not require standard authentication.
Query Bill
Query subscriber bill information for Bkash payment processing.
| Property | Value |
|---|---|
| Endpoint | Query Bill |
| Method | POST |
| URL | /api/queryBill |
| Authentication | Bkash Gateway Auth |
Request Headers:
| Header | Value | Required |
|---|---|---|
Content-Type | application/json | Yes |
Accept | application/json | Yes |
Request Body:
json
{
"billerId": "your-biller-id",
"billNo": "subscriber-username"
}| Parameter | Type | Required | Description |
|---|---|---|---|
billerId | string | Yes | Bkash assigned biller ID |
billNo | string | Yes | Subscriber username or ID |
Success Response (200 OK):
json
{
"billerId": "your-biller-id",
"billNo": "subscriber001",
"billAmount": 1000,
"billDueDate": "2024-01-31",
"customerName": "John Doe",
"customerMobile": "01712345678",
"status": "success"
}Error Response (Bill Not Found):
json
{
"status": "error",
"message": "Bill not found"
}Pay Bill
Process bill payment from Bkash.
| Property | Value |
|---|---|
| Endpoint | Pay Bill |
| Method | POST |
| URL | /api/payBill |
| Authentication | Bkash Gateway Auth |
Request Headers:
| Header | Value | Required |
|---|---|---|
Content-Type | application/json | Yes |
Accept | application/json | Yes |
Request Body:
json
{
"billerId": "your-biller-id",
"billNo": "subscriber-username",
"transactionId": "TRX123456789",
"amount": 1000,
"payerMobile": "01712345678"
}| Parameter | Type | Required | Description |
|---|---|---|---|
billerId | string | Yes | Bkash assigned biller ID |
billNo | string | Yes | Subscriber username or ID |
transactionId | string | Yes | Bkash transaction ID |
amount | decimal | Yes | Payment amount |
payerMobile | string | Yes | Payer's mobile number |
Success Response (200 OK):
json
{
"status": "success",
"message": "Payment successful",
"transactionId": "TRX123456789",
"billNo": "subscriber001",
"amount": 1000,
"paymentDate": "2024-01-15 10:30:00"
}Error Response (Payment Failed):
json
{
"status": "error",
"message": "Payment failed: Invalid amount"
}Search Transaction
Search for a specific transaction by transaction ID.
| Property | Value |
|---|---|
| Endpoint | Search Transaction |
| Method | POST |
| URL | /api/searchTransaction |
| Authentication | Bkash Gateway Auth |
Request Headers:
| Header | Value | Required |
|---|---|---|
Content-Type | application/json | Yes |
Accept | application/json | Yes |
Request Body:
json
{
"billerId": "your-biller-id",
"transactionId": "TRX123456789"
}| Parameter | Type | Required | Description |
|---|---|---|---|
billerId | string | Yes | Bkash assigned biller ID |
transactionId | string | Yes | Bkash transaction ID |
Success Response (200 OK):
json
{
"status": "success",
"transactionId": "TRX123456789",
"billNo": "subscriber001",
"amount": 1000,
"payerMobile": "01712345678",
"paymentDate": "2024-01-15 10:30:00",
"transactionStatus": "completed"
}Error Response (Transaction Not Found):
json
{
"status": "error",
"message": "Transaction not found"
}