Biller
Get Biller List
This API provides the biller list for Utility Bill payment
URL
[GET] http://127.0.0.1:8282/api/v1/private/wallet/utility/billers
Sample Response
{
"code": 200,
"messages": [
"Biller List"
],
"data": {
"types": [
{
"visibility": true,
"is_active": true,
"title": "Electricity",
"icon": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller-type/ic_pay_bill_electricity.png",
"billers": [
{
"biller_id": "b025",
"title": "Dhaka Electric Supply Company (DESCO postpaid)",
"logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller/desco.png",
"params": [
{
"field_type": "alphanumeric",
"label": "Bill No",
"key": "bll_no",
"value": "",
"placeholder": "Bill No",
"input": true,
"type": "alphanumeric",
"required": true,
"is_read_only": false,
"visibility": "show",
"options": []
}
],
"hidden_fields": [
{
"key": "biller_id",
"value": "b025"
},
{
"key": "bll_typ",
"value": "NM"
},
{
"key": "mode",
"value": "SAPI"
}
]
}
]
},
{
"visibility": true,
"is_active": true,
"title": "Water",
"icon": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller-type/ic_pay_bill_water.png",
"billers": [
{
"biller_id": "b099",
"title": "Dhaka WASA",
"logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller/dwasa.png",
"params": [
{
"field_type": "alphanumeric",
"label": "Bill No",
"key": "bil_no",
"value": "",
"placeholder": "Bill No",
"input": true,
"type": "alphanumeric",
"required": true,
"is_read_only": false,
"visibility": "show",
"options": []
}
],
"hidden_fields": [
{
"key": "biller_id",
"value": "b099"
},
{
"key": "bll_typ",
"value": "NM"
},
{
"key": "mode",
"value": "SAPI"
}
]
}
]
},
{
"visibility": true,
"is_active": true,
"title": "Gas",
"icon": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller-type/ic_pay_bill_gas.png",
"billers": [
{
"biller_id": "b430",
"title": "Jalalabad Gas Transmission Limited",
"logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller/jalalabad.png",
"params": [
{
"field_type": "alphanumeric",
"label": "Account No",
"key": "bllr_accno",
"value": "",
"placeholder": "Account No",
"input": true,
"type": "alphanumeric",
"required": true,
"is_read_only": false,
"visibility": "show",
"options": []
},
{
"field_type": "mobile_no",
"label": "Mobile No",
"key": "bill_mobno",
"value": "",
"placeholder": "Mobile NO",
"input": true,
"type": "numeric",
"required": true,
"is_read_only": false,
"visibility": "show",
"options": []
}
],
"hidden_fields": [
{
"key": "biller_id",
"value": "b430"
},
{
"key": "bll_typ",
"value": "NM"
},
{
"key": "mode",
"value": "SAPI"
}
]
},
{
"biller_id": "b451",
"title": "Bakhrabad Gas",
"logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller/bakhrabad.png",
"params": [
{
"field_type": "alphanumeric",
"label": "Account No",
"key": "bllr_accno",
"value": "",
"placeholder": "Account No",
"input": true,
"type": "alphanumeric",
"required": true,
"is_read_only": false,
"visibility": "show",
"options": []
},
{
"field_type": "mobile_no",
"label": "Mobile No",
"key": "bill_mobno",
"value": "",
"placeholder": "Mobile NO",
"input": true,
"type": "numeric",
"required": true,
"is_read_only": false,
"visibility": "show",
"options": []
},
{
"field_type": "select",
"label": "Bill Type",
"key": "bll_typ",
"value": "",
"placeholder": "",
"input": true,
"type": "select",
"required": true,
"is_read_only": false,
"visibility": "show",
"options": [
{
"option_display_value": "Meter",
"option_value": "M"
},
{
"option_display_value": "Non Meter",
"option_value": "NM"
}
]
}
],
"hidden_fields": [
{
"key": "biller_id",
"value": "b451"
},
{
"key": "bll_typ",
"value": "NM"
},
{
"key": "mode",
"value": "SAPI"
}
]
}
]
},
{
"visibility": true,
"is_active": true,
"title": "Internet",
"icon": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller-type/ic_pay_bill_internet.png",
"billers": [
{
"biller_id": "b091",
"title": "Bangladesh Telecommunications Company Limited",
"logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller/btcl.png",
"params": [
{
"field_type": "alphanumeric",
"label": "Bill No",
"key": "bll_no",
"value": "",
"placeholder": "Bill No",
"input": true,
"type": "alphanumeric",
"required": true,
"is_read_only": false,
"visibility": "show",
"options": []
}
],
"hidden_fields": [
{
"key": "biller_id",
"value": "b091"
},
{
"key": "bll_typ",
"value": "NM"
},
{
"key": "mode",
"value": "SAPI"
}
]
}
]
},
{
"visibility": true,
"is_active": false,
"title": "DTH",
"icon": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller-type/ic_pay_bill_dth.png",
"billers": []
},
{
"visibility": true,
"is_active": false,
"title": "Education",
"icon": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller-type/ic_pay_bill_education.png",
"billers": []
},
{
"visibility": true,
"is_active": true,
"title": "Other",
"icon": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller-type/ic_pay_bill_other.png",
"billers": [
{
"biller_id": "b566",
"title": "Land Tax",
"logo": "https://ekpay.gov.bd/assets/billers/land-tax.png",
"params": [
{
"field_type": "alphanumeric",
"label": "Payment Token",
"key": "bllr_accno",
"value": "",
"placeholder": "Payment Token",
"input": true,
"type": "alphanumeric",
"required": true,
"is_read_only": false,
"visibility": "show",
"options": []
}
],
"hidden_fields": [
{
"key": "biller_id",
"value": "b566"
},
{
"key": "bll_typ",
"value": "NM"
},
{
"key": "mode",
"value": "SAPI"
}
]
}
]
}
]
}
}
Sample Response Format
| Parameter |
Type |
Description |
Always Present |
code |
Int |
HTTP code (e.g., 200) |
Yes |
messages |
Array |
List of result messages |
Yes |
data.types |
Array |
List of biller types |
Yes |
data.types[].visibility |
Boolean |
Indicates if the biller type is visible |
Yes |
data.types[].is_active |
Boolean |
Indicates if the biller type is active |
Yes |
data.types[].title |
String |
Title of the biller type |
Yes |
data.types[].icon |
String |
URL to the icon of the biller type |
Yes |
data.types[].billers |
Array |
List of billers under this type |
Yes |
data.types[].billers[].biller_id |
String |
Unique identifier for the biller |
Yes |
data.types[].billers[].title |
String |
Title of the biller |
Yes |
data.types[].billers[].logo |
String |
URL to the logo of the biller |
Yes |
data.types[].billers[].params |
Array |
List of parameters required for the biller |
Yes |
data.types[].billers[].params[].field_type |
String |
Type of field (e.g., alphanumeric, mobile_no, select) |
Yes |
data.types[].billers[].params[].label |
String |
Label for the input field |
Yes |
data.types[].billers[].params[].key |
String |
Key for the input field |
Yes |
data.types[].billers[].params[].value |
String |
Default value for the input field |
No |
data.types[].billers[].params[].placeholder |
String |
Placeholder text for the input field |
Yes |
data.types[].billers[].params[].input |
Boolean |
Indicates if the input field is editable |
Yes |
data.types[].billers[].params[].type |
String |
Type of input (e.g., alphanumeric, numeric, select) |
Yes |
data.types[].billers[].params[].required |
Boolean |
Indicates if the input field is required |
Yes |
data.types[].billers[].params[].is_read_only |
Boolean |
Indicates if the input field is read-only |
Yes |
data.types[].billers[].params[].visibility |
String |
Visibility status of the input field (e.g., show) |
Yes |
data.types[].billers[].params[].options |
Array |
List of options for fields with select input type |
No |
data.types[].billers[].hidden_fields |
Array |
List of hidden fields |
Yes |
data.types[].billers[].hidden_fields[].key |
String |
Key of the hidden field |
Yes |
data.types[].billers[].hidden_fields[].value |
String |
Value of the hidden field |
Yes |
Bill Payment
Get Summary
This API provides the summary information of bill pay
URL
[GET] http://127.0.0.1:8282/api/v1/private/wallet/utility-bill-pay/summary
Sample Response
{
"code": 200,
"messages": [],
"data": {
"summary": {
"request_id": "2bf1c1ae-db3e-4e8b-8945-2754f48bad0d",
"biller": {
"title": "Electricity Bill Payment",
"logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller/desco.png"
},
"amount": "৳100.00",
"charge": "+ ৳5.00",
"total_payable": "$105.00",
"has_beneficiary": true
}
}
}
{
"code": 422,
"messages": [
"Bill not found."
],
"data": null
}
Sample Response Format
| Parameter |
Type |
Description |
Always Present |
code |
Int |
HTTP code (e.g., 200) |
Yes |
messages |
Array |
Result messages |
Yes |
data.summary |
Object |
Transaction summary |
Yes |
data.summary.request_id |
String |
Request ID |
Yes |
data.summary.biller |
Object |
Biller information |
Yes |
data.summary.biller.title |
String |
Title of the biller (e.g., Electricity Bill Payment) |
Yes |
data.summary.biller.logo |
String |
URL to the logo of the biller |
Yes |
data.summary.amount |
String |
Transaction amount |
Yes |
data.summary.charge |
String |
Transaction charge |
Yes |
data.summary.total_payable |
String |
Total amount payable (including charge) |
Yes |
data.summary.has_beneficiary |
Bool |
Whether the transaction has a beneficiary or not |
Yes |
Execute request
This API Performs execution of utility bill payment
URL
[POST] http://127.0.0.1:8282/api/v1/private/wallet/utility-bill-pay/execute
Sample request
{
"request_id" : "2bf1c1ae-db3e-4e8b-8945-2754f48bad0d",
"pin": 1235
}
Sample Request Format
| Parameter |
Type |
Description |
Always Present |
request_id |
string |
mobile number |
Yes |
pin |
Number |
pin |
Yes |
Sample Response
{
"summary": {
"biller": {
"title": "Electricity Bill Payment",
"logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller/desco.png"
},
"total_payable": "৳105.00"
}
}
{
"code": 422,
"messages": [
"The selected request id is invalid."
],
"data": null,
"error_title": null
}
{
"code": 422,
"messages": [
"Sorry! PIN does not match."
],
"data": null,
"error_title": "E_PIN_ERROR"
}
{
"code": 422,
"messages": [
"The selected request id is invalid."
],
"data": null,
"error_title": null
}
Sample Response Format
| Parameter |
Type |
Description |
Always Present |
code |
Int |
HTTP code (e.g., 200) |
Yes |
messages |
Array |
Result messages |
Yes |
data.summary |
Object |
Transaction summary |
Yes |
data.summary.biller |
Object |
Biller details |
Yes |
data.summary.biller.title |
String |
Title of the biller |
Yes |
data.summary.biller.logo |
String |
URL to the biller logo |
Yes |
data.summary.total_payable |
String |
Total amount payable (including charge) |
Yes |
Histories
This API provides bill pay history data for utility bill pay
URL
[POST] http://127.0.0.1:8282/api/v1/private/wallet/utility-bill-pay/histories
Sample Response
{
"code": 200,
"messages": [
"Your Money Request has been accepted."
],
"data": {
"order_id": "2bf1c1ae-db3e-4e8b-8945-2754f48bad0d",
"title": "Electricity Bill Payment",
"logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller/desco.png",
"amount": "৳100.00",
"trx_id": "2bf1c1ae-db3e-4e8b-8945-2754f48bad0d",
"created_at": "20/02/2025 03:45 PM",
"details": {
"bill_information": "Electricity bill payment for January 2025",
"payment_information": "Payment made through online bank transfer",
"payment_received": "৳100.00"
}
}
}
{
"code": 422,
"messages": [
"The selected request id is invalid."
],
"data": null,
"error_title": null
}
{
"code": 404,
"messages": [
"Sorry! Something went wrong. Please try again later."
],
"data": null
}
Sample Response Format
| Parameter |
Type |
Description |
Always Present |
code |
Int |
HTTP code (e.g., 200) |
Yes |
messages |
Array |
Result messages |
Yes |
data.order_id |
String |
Unique identifier for the order |
Yes |
data.title |
String |
Title of the transaction (e.g., Electricity Bill Payment) |
Yes |
data.logo |
String |
URL to the biller's logo |
Yes |
data.amount |
String |
Transaction amount |
Yes |
data.trx_id |
String |
Unique identifier for the transaction |
Yes |
data.created_at |
String |
Date and time the transaction was created |
Yes |
data.details.bill_information |
String |
Bill information (e.g., description of the bill) |
Yes |
data.details.payment_information |
String |
Payment information (e.g., method used for payment) |
Yes |
data.details.payment_received |
String |
Amount received for the payment |
Yes |
Beneficiaries
This API provides Beneficiary list for pay bill
URL
[GET] http://127.0.0.1:8282/api/v1/private/wallet/utility-bill-pay/beneficiaries
Sample Response
{
"code": 200,
"messages": [],
"data": {
"beneficiaries": [
{
"user_id": 25,
"biller_logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller/desco.png",
"display_title": "Electricity Bill Payment",
"display_ac_no": "1234567890",
"bllr_id": "BLLR123",
"srvc_id": "SRVC987",
"inpt_pref": "preference_value_1"
},
{
"user_id": 25,
"biller_logo": "https://deshipay.s3.ap-southeast-1.amazonaws.com/ekshop-biller/desco.png",
"display_title": "Water Bill Payment",
"display_ac_no": "9876543210",
"bllr_id": "BLLR124",
"srvc_id": "SRVC988",
"inpt_pref": "preference_value_2"
}
]
}
}
Sample Response Format
| Parameter |
Type |
Description |
Always Present |
code |
Int |
HTTP code (e.g., 200) |
Yes |
messages |
Array |
Result messages |
Yes |
data.beneficiaries |
Array |
List of beneficiaries |
Yes |
data.beneficiaries.user_id |
Int |
User ID of the beneficiary |
Yes |
data.beneficiaries.biller_logo |
String |
URL of the biller logo |
Yes |
data.beneficiaries.display_title |
String |
Title displayed for the biller |
Yes |
data.beneficiaries.display_ac_no |
String |
Account number displayed for the beneficiary |
Yes |
data.beneficiaries.bllr_id |
String |
Biller's unique ID |
Yes |
data.beneficiaries.srvc_id |
String |
Service ID related to the biller |
Yes |
data.beneficiaries.inpt_pref |
String |
Input preferences related to the biller |
Yes |