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

Create Inquiry

  • Updated on Aug 8, 2025
  • Published on Aug 8, 2025
Prev Next
Post
/bill-payments/v1/inquiry

Facilitates pre-payment verification for products requiring upfront bill checks, such as PLN electricity services. The response includes comprehensive bill information and the total amount due.

Security
HTTP
Type Basic
Body parameters
plnPrepaid

PLN Prepaid Inquiry

{
  "product_id": "PLN_PREPAID_50K",
  "customer_number": "12345678910"
}
plnPostpaid

PLN Postpaid Inquiry

{
  "product_id": "PLN_POSTPAID",
  "customer_number": "22345678910"
}
Expand All
object
product_id
string Required

Product identifier

customer_number
string Required

Customer's account/service number

additional_properties
object

Additional parameters required for specific products

Responses
200

Successful inquiry response

plnPrepaid

PLN Prepaid Inquiry Response

{
  "data": {
    "business_id": "5f27a14a9bf05c73dd040bc8",
    "type": "inquiry",
    "id": "inq-98765",
    "properties": {
      "product_id": "PLN_PREPAID_50K",
      "admin_amount": 3200,
      "base_amount": 50000,
      "total_amount": 53200,
      "revenue_share_amount": 500,
      "currency": "IDR",
      "customer_number": "12345678910",
      "customer_details": [
        {
          "key": "Nama Pelanggan",
          "value": "John Doe"
        },
        {
          "key": "Nomor Pelanggan",
          "value": "12345678910"
        }
      ],
      "product_details": [
        {
          "key": "Tarif/Daya",
          "value": "R2/000003500"
        },
        {
          "key": "Denom",
          "value": "100.000"
        }
      ],
      "bill_details": [
        {
          "key": "Admin",
          "value": "3200"
        }
      ]
    }
  }
}
Expand All
object
data
object
business_id
string

Xendit's Business ID

type
string

Type of response, always "inquiry"

Valid values[ "inquiry" ]
id
string

Unique inquiry identifier

properties
object
product_id
string

Product identifier

admin_amount
number

Administrative fee amount

base_amount
number

Base product amount

total_amount
number

Total amount including admin fee

revenue_share_amount
number

Partner revenue share amount

currency
string

Currency of the product

customer_number
string

Customer's account/service number

customer_details
Array of object (BillPaymentDetailKeyValue)

Array of customer information key-value pairs

object
key
string

Name of the detail field

value
string

Value of the detail field

product_details
Array of object (BillPaymentDetailKeyValue)

Array of product information key-value pairs

object
key
string

Name of the detail field

value
string

Value of the detail field

bill_details
Array of object (BillPaymentDetailKeyValue)

Array of billing information key-value pairs

object
key
string

Name of the detail field

value
string

Value of the detail field

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
404

The provided id does not exist. Please review the id and try again

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

Conflict

object
error_code
string
Valid values[ "DUPLICATE_ERROR", "IDEMPOTENCY_ERROR" ]
message
string
errors
Array
OneOf
string
string
object
object
502

Bad Gateway - Biller error

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

Service Unavailable - Biller maintenance

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

Gateway Timeout - Biller timeout

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