post
https://{URL}/v1/open-api/products/inquiry
The Inquiry Prepaid endpoint allows to retrieve detailed information about prepaid products. This inquiry is optional; customer can proceed directly to the "buy product" process without performing the inquiry. The inquiry is available only for the following providers: PLN, OVO, Gopay, DANA, and Maxim.
A. Request Header
| Field | Format | Mandatory | Length | Example |
|---|---|---|---|---|
| content-type | string | Y | application/json | |
| Open-Api-Timestamp | yyyy-mm-dd'T'hh:mm:ss+07:00 | Y | 2024-02-07T10:28:35.000+07:0 | |
| Open-Api-Signature | Digital Signature | Y | 88 | vNMoAmiDRV+paVyD5FaidgI5kRy2p Co8oEoQN/GBpIPuO3eicY63b7xY0W DffScvkOZsZ1442ewabI7Wzd22pw== |
B. Request Body
| Field | Type | Description | Required | Example |
|---|---|---|---|---|
| msidn | string | The telephone number of client | true | "01105691111" |
| amount | string | The buy price from the partner to Klikoo. The amount will deduct the partner’s balance on Klikoo when the transaction status is success | true | "20500" |
| product_code | string | Unique identifier for the product | true | "PLN20" |
| selling_price | string | The selling price of the product from the partner. This value is required to calculate the margin value to be shown on the dashboard. It can be set as same as amount if you wouldn’t like to show the margin on the dashboard | true | "21000" |
| value | string | Similar to msidn, representing a value associated with a mobile device or user | true | "01105691111" |
| partner_reference_id | string | The unique reference identifier provided by the partner or service invoking the transaction, recommended value is UUID v4 | true | "42323-42234-44226-96273" |
C. Sample Request
{
"msidn": "01105691111",
"amount": "20500",
"product_code": "PLN20",
"selling_price": "21000",
"value": "01105691111",
"partner_reference_id": "42323-42234-44226-96273"
}
{
"msidn": "01105691111",
"amount": "73500",
"product_code": "OVO10",
"selling_price": "73500",
"value": "0817345544",
"partner_reference_id": "21312315433453533"
}
{
"msidn": "01105691111",
"amount": "73500",
"product_code": "GOPAY10",
"selling_price": "73500",
"value": "0817345544",
"partner_reference_id": "21312315433453533"
}
{
"msidn": "01105691111",
"amount": "73500",
"product_code": "DN1",
"selling_price": "73500",
"value": "0817345544",
"partner_reference_id": "21312315433453533"
}
{
"msidn": "01105691111",
"amount": "10000",
"product_code": "DNOPEN",
"selling_price": "10000",
"value": "0817345544",
"partner_reference_id": "21312315433453533"
}
{
"msidn": "01105691111",
"amount": "73500",
"product_code": "MAX5000",
"selling_price": "73500",
"value": "01105691111",
"partner_reference_id": "{{$guid}}"
}
D. Response Body
| Field | Type | Description | Example |
|---|---|---|---|
| response_code | string | Contains the OpenAPI response code | “200022000” |
| response_message | string | Contains the value of OpenAPI response message | “Sukses” |
| data | object | An object or object array containing additional information about the postpaid inquiry | |
product_name | string | The value of product’s name | “PLN 20.000” |
amount | int | TThe buy price from the partner to Klikoo. The amount will deduct the partner’s balance on Klikoo when the transaction status is success | 20500 |
total | int | The total amount of the transaction | 20546 |
product_code | string | An identifier for the inquiry or request | “PLN20” |
customer_number | string | The customer number associated with the transaction or inquiry | “01105691111” |
customer_name | string | Name of the customer involved in the transaction | “BAHARRUDIN1” |
power_capacity | string | The power capacity or size of the product | “R1/2200VA” |
E. Sample Response
{
"response_code": "200022000",
"response_message": "Sukses",
"data": {
"product_name": "PLN 20.000",
"amount": 20500,
"total": 20546,
"product_code": "PLN20",
"customer_number": "01105691111",
"customer_name": "BAHARRUDIN1",
"power_capacity": "R1/2200VA"
}
}
{
"response_code": "503029998",
"response_message": "CUSTID not recognized. Biller throws exception. Err:5110",
"data": {
"customer_number": "01105601111"
}
}
Try It Here (Form)
To try the following endpoint, enter the example request data you want to use in the following form