Appearance
JomPAY Billers
Retrieve the JomPAY biller list. Use this endpoint for JomPAY biller selection.
API Endpoint
http
GET https://api.iimmpact.com/v1/jompay/billersRequest Headers
| Header | Description | Required |
|---|---|---|
Authorization | Bearer token | Yes, unless using API key auth |
X-Api-Key | Your API key | Yes, unless using bearer token auth |
X-Timestamp | Unix timestamp in seconds for API key auth | Required for API key auth |
X-Nonce | Unique request identifier for API key auth | Required for API key auth |
X-Signature | HMAC-SHA256 signature (v1=...) for API key auth | Required for API key auth |
See Authentication and API Key Authentication for details.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | number | No | Page number. Defaults to 1. Must be used with limit. |
limit | number | No | Number of billers per page. If omitted, returns the full list. |
biller_code | string | No | Filter to a specific JomPAY biller code. |
suggested_category | string | No | Filter by suggested biller category. |
Examples
Paginated list
http
GET https://api.iimmpact.com/v1/jompay/billers?page=1&limit=2json
{
"message": "success",
"data": [
{
"biller_code": "818625",
"display_name": "TADIKA DIDIKAN SOLEH PLT.",
"denomination": null,
"face_value": null,
"validity": null,
"description": null,
"account_number": null,
"additional_description": [],
"min": "1.00",
"max": "30000.00",
"suggested_category": "Education"
},
{
"biller_code": "779264",
"display_name": "RIM PRO AUTOMOTIVE.",
"denomination": null,
"face_value": null,
"validity": null,
"description": null,
"account_number": null,
"additional_description": [],
"min": "1.00",
"max": "30000.00",
"suggested_category": null
}
],
"links": {
"first": "/v1/jompay/billers?page=1&limit=2",
"last": "/v1/jompay/billers?page=10133&limit=2",
"prev": null,
"next": "/v1/jompay/billers?page=2&limit=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 10133,
"path": "/v1/jompay/billers",
"per_page": 2,
"to": 2,
"total": 20266
}
}Filter by biller code
http
GET https://api.iimmpact.com/v1/jompay/billers?biller_code=818625json
{
"message": "success",
"data": [
{
"biller_code": "818625",
"display_name": "TADIKA DIDIKAN SOLEH PLT.",
"denomination": null,
"face_value": null,
"validity": null,
"description": null,
"account_number": null,
"additional_description": [],
"min": "1.00",
"max": "30000.00",
"suggested_category": "Education"
}
],
"links": {
"first": "/v1/jompay/billers?biller_code=818625&page=1&limit=1",
"last": "/v1/jompay/billers?biller_code=818625&page=1&limit=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "/v1/jompay/billers",
"per_page": 1,
"to": 1,
"total": 1
}
}Filter by suggested category
http
GET https://api.iimmpact.com/v1/jompay/billers?suggested_category=Education&page=1&limit=2json
{
"message": "success",
"data": [
{
"biller_code": "818625",
"display_name": "TADIKA DIDIKAN SOLEH PLT.",
"denomination": null,
"face_value": null,
"validity": null,
"description": null,
"account_number": null,
"additional_description": [],
"min": "1.00",
"max": "30000.00",
"suggested_category": "Education"
},
{
"biller_code": "123456",
"display_name": "KOLEJ UNIVERSITI EXAMPLE",
"denomination": null,
"face_value": null,
"validity": null,
"description": null,
"account_number": null,
"additional_description": [],
"min": "1.00",
"max": "30000.00",
"suggested_category": "Education"
}
],
"links": {
"first": "/v1/jompay/billers?suggested_category=Education&page=1&limit=2",
"last": "/v1/jompay/billers?suggested_category=Education&page=50&limit=2",
"prev": null,
"next": "/v1/jompay/billers?suggested_category=Education&page=2&limit=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 50,
"path": "/v1/jompay/billers",
"per_page": 2,
"to": 2,
"total": 100
}
}Response 200
| Field | Type | Description |
|---|---|---|
message | string | Response status message. |
data | array | JomPAY billers. |
data[].biller_code | string | JomPAY biller code. Pass this to Make Payment via extras.biller_code. |
data[].display_name | string | Biller name. |
data[].denomination | number | Always null for JomPAY billers. |
data[].face_value | number | Always null for JomPAY billers. |
data[].validity | string | Always null for JomPAY billers. |
data[].description | string | Optional biller description. |
data[].account_number | string | Always null for JomPAY billers. |
data[].additional_description | array | Additional biller description lines. |
data[].min | string | Minimum payment amount for this biller. |
data[].max | string | Maximum payment amount for this biller. |
data[].suggested_category | string | Suggested biller category, or null if no category is mapped. |
links | object | Pagination links using /v1/jompay/billers. |
meta | object | Pagination metadata. |
Suggested categories
suggested_category is not provided by PayNet. It is an IIMMPACT-maintained suggestion and may contain errors or differ from how a biller is officially classified.
Notes
- This endpoint is dedicated to JomPAY. Do not pass
product_code. - If a biller does not have a mapped category,
suggested_categoryis returned asnull. - Treat
suggested_categoryas advisory only. It is not an official PayNet category.
