Bill Query & Payment Confirmation API

Endpoints for Education, ISP and Insurance bill query and payment confirmation — JSON over HTTPS.

Authentication

Headers required
Header KeyValue / Notes
API-KEYProvided by SSLCOMMERZ (required)
AuthorizationBearer <token> (optional if API-KEY used)
Content-Typeapplication/json

1. Bill Query

POST /api/v1/bill/query

Request Body (common)

FieldTypeRequiredDescription
service_typestringyesOne of education, isp, insurance
amountnumberoptionalIf known. Query allowed without it.
mobile_nostringrequired for education & ispMSISDN (e.g. 017XXXXXXXX)
dobstring (YYYY-MM-DD)optionalStudent date of birth (education only)
bill_monthstring (YYYY-MM)optionalBilling month if applicable

Service-specific fields

  • Education: reference_id or student_id (string)
  • ISP: customer_no (string)
  • Insurance: proposal_number (string)
Sample Request — Education
{
  "service_type": "education",
  "reference_id": "STU123456",
  "bill_month": "2025-09",
  "mobile_no": "01712345678",
  "dob": "2008-10-02"
}
Sample Response — Education
{
  "status": "success",
  "message": "Bill Found",
  "data": {
    "student_name": "Rahim Uddin",
    "reference_id": "STU123456",
    "bill_month": "2025-09",
    "amount_due": 5000,
    "due_date": "2025-10-15"
  }
}
Sample Request — ISP
{
  "service_type": "isp",
  "customer_no": "CUST89011",
  "mobile_no": "01898765432"
}
Sample Response — ISP
{
  "status": "success",
  "message": "Bill Found",
  "data": {
    "customer_name": "XYZ Internet Client",
    "package": "50 Mbps",
    "amount_due": 1500,
    "billing_cycle": "2025-10"
  }
}
Sample Request — Insurance
{
  "service_type": "insurance",
  "proposal_number": "PROP112233",
  "amount": 7000
}
Sample Response — Insurance
{
  "status": "success",
  "message": "Premium Due",
  "data": {
    "policy_holder": "Abdul Karim",
    "amount_due": 7000,
    "due_date": "2025-11-30"
  }
}

2. Payment Confirmation

POST /api/v1/bill/payment/confirm

Request Body

{
  "transaction_id": "TXN548257",
  "service_type": "education",
  "reference_id": "STU123456",
  "amount": 5000,
  "mobile_no": "01712345678"
}
Sample Response — Confirm
{
  "status": "success",
  "message": "Payment Confirmed",
  "confirmation_id": "CONF987654321",
  "details": {
    "service_type": "education",
    "amount": 5000
  }
}

Error Responses & Status Codes

{
  "status": "failed",
  "error_code": "BILL_NOT_FOUND",
  "message": "No bill available for provided information"
}

Status Codes:
200 - Success
400 - Invalid Request
404 - Bill Not Found
500 - Internal Server Error

Notes & Recommendations