For archived content, access the previous documentation here or the previous API reference here.

Get Product List

Prev Next
Get
/bill-payments/v1/product

Gets a list of available products with optional filtering capabilities

Security
HTTP
Type Basic
Query parameters
id
string

Filter by specific product ID

ExamplePLN_PREPAID_50K
biller
string

Filter by biller name

ExamplePLN
category
string

Filter by product category

Valid values[ "ELECTRICITY" ]
ExampleELECTRICITY
country
string

Filter by country code (e.g. ID)

ExampleID
availability_status
string

Filter by product availability status

Valid values[ "AVAILABLE", "TEMPORARILY_UNAVAILABLE", "DISCONTINUED" ]
ExampleAVAILABLE
requires_inquiry
boolean

Filter products that require inquiry step

Exampletrue
limit
integer

Number of records to be fetched per page

Default50
Example50
cursor
string

Cursor value for paginating the result

Exampledummy-cursor-value-001==
Responses
200

Successful response

plnPrepaid

PLN Prepaid 50K Example

{
  "limit": 50,
  "cursor": "dummy-cursor-value-001==",
  "data": [
    {
      "type": "product",
      "id": "PLN_PREPAID_50K",
      "properties": {
        "product_name": "PLN Prepaid 50K",
        "category": "ELECTRICITY",
        "biller": "PLN",
        "country": "ID",
        "currency": "IDR",
        "requires_inquiry": false,
        "availability_status": "AVAILABLE",
        "admin_amount": 3200,
        "base_amount": 50000,
        "total_amount": 53200,
        "revenue_share_amount": 1000,
        "locale": {
          "en": "PLN Prepaid 50.000",
          "id": "PLN Prabayar 50.000"
        }
      }
    }
  ]
}
Expand All
object
data
Array of object (BillPaymentProduct)

Array of product objects

object
type
string

Type of object, always "product"

Valid values[ "product" ]
id
string

Unique product identifier

properties
object
product_name
string

Display name of the product

category
string

Product category

Valid values[ "ELECTRICITY" ]
biller
string

Name of the biller/provider

country
string

Country code in ISO 3166-1 alpha-2 format

currency
string

Currency code in ISO 4217 format

requires_inquiry
boolean

Whether product requires inquiry before purchase

availability_status
string

Product availability status

Valid values[ "AVAILABLE", "TEMPORARILY_UNAVAILABLE", "DISCONTINUED" ]
admin_amount
number

Administrative fee amount

base_amount
number

Base product amount (0 for postpaid products)

total_amount
number

Total amount including admin fee

revenue_share_amount
number

Merchant revenue share amount

locale
object

Localized product names

en
string

Product name in English

id
string

Product name in Indonesian

next_cursor
string

Cursor value for next page. Empty if the last page reached

limit
integer

Number of records per page

400

Inputs are failing validation. The errors field contains details about which fields are violating validation.

object
error_code
string
Valid values[ "API_VALIDATION_ERROR", "FEATURE_NOT_AVAILABLE" ]
message
string
errors
Array
OneOf
string
string
object
object
401

API key in use does not have necessary permissions to perform the request. Please assign proper permissions for the key.

object
error_code
string
Valid values[ "RATE_LIMIT_EXCEEDED" ]
message
string
errors
Array
OneOf
string
string
object
object
500

Internal Server Error

object
error_code
string
Valid values[ "API_VALIDATION_ERROR", "FEATURE_NOT_AVAILABLE" ]
message
string
errors
Array
OneOf
string
string
object
object