POST | Inquiry | Tokopedia Seller API

Inquiry

The purpose of this payload is for Tokopedia to get the bills information from a partner that can be delivered to the Tokopedia user. Tokopedia users will input their client number/MSISDN (mandatory) and additional parameters (not mandatory). Partner will provide the response to Tokopedia, and Tokopedia will show the result on the check out page.

After the Tokopedia user is done making payment on the payment channel, Tokopedia will hit Inquiry again for the Re-Inquiry flow. The purpose for this flow is to make sure the amount paid by users and bill details are still the same with partner response after payment timestamp. If the Re-Inquiry results are not matched, we will directly fail and refund the transaction to users without hitting payment payload to partner.

Request

Key	Value	Required	Description
ref_id	string	yes	Unique reference identifier from Tokopedia
client_number	string	based on payment type	Client bill identifier / MSISDN number Mandatory for postpaid product Not mandatory for prepaid product
category	string	yes	Product category identifier provided by Tokopedia
rsid	string	no	Tokopedia channel identifier (default will be filled with TOKOPEDIA)
product_code	string	yes	Code of product given by Partner
timestamp	string	yes	In Jakarta Time GMT+7, Format: YYYY-MM-DD hh:mm:ss
additional_parameter	array	no	List of additional parameters needed

Unencrypted & Unsigned (Plain Payload) Example

{
  "client_number": "1234567890",
  "product_code": "product5627",
  "category": "listrik",
  "RSID": "listrikMainApp01",
  "timestamp": "2021-12-12 12:12:12",
  "additional_parameter": [
    {
      "name": "room",
      "value": "studio"
    },
    {
      "name": "month",
      "value": "5"
    }
  ]
}

Tokopedia UI Example during Inquiry

inquiry

Response

Key	Value	Required	Description
partner_inquiry_id	string	yes	Unique inquiry ID from partne
client_number	string	yes	Client bill identifier / MSISDN
product_code	string	yes	Code of product given by Partner
response_code	string	yes	Response code as specified (see Response Codes)
message	string	yes	Additional informational or error message
due_date	string	no	Due date for given bill in Indonesia date, format: YYYY-MM-DD
bill_generation_date	string	no	Bill generation date for given bill in Indonesia date, format: YYYY-MM-DD
is_open_amount	bool	no	Defines if the bill can be paid with open amount method that depends on user input
admin_fee	number	no	Partner admin fee that already included on total_amount
total_amount	number	yes	Total bill amount or product price including partner admin_fee
timestamp	string	yes	In Jakarta Time GMT+7, Format: YYYY-MM-DD hh:mm:ss
bill_details	array	no	Details of a given bill For specific product categories, please refer to section Mandatory Response
additional_details	array of bill_details with label	no	Additional details of a given bill that will be shown to the user with a collapsed initial state. This usually is not important yet needs to be displayed to the user. For specific product categories, please refer to section Mandatory Response.

Information details will be used on the checkout page to show the user their bill information

Decrypted & Verified (Plain Payload) Success Example

{
  "partner_inquiry_id": "1234567890",
  "client_number": "1234567890",
  "product_code": "product5627",
  "response_code": "00",
  "message": "Success",
  "due_date": "2021-12-21",
  "bill_generation_date": "2021-12-01",
  "is_open_amount": false,
  "admin_fee": 5000,
  "total_amount": 1505000,
  "timestamp": "2021-12-12 12:12:12",
  "bill_details": [
    {
      "name": "Nama Perusahaan",
      "value": "Company Lorem",
      "is_pii": false,
      "is_show": true
    },
    {
      "name": "Nama Customer",
      "value": "John Doe",
      "is_pii": true,
      "is_show": true
    },
    {
      "name": "Alamat",
      "value": "Jalan Melati",
      "is_pii": true,
      "is_show": true
    }
  ],
  "additional_details": [
    {
      "label": "Pemakaian",
      "details": [
        {
          "name": "Meter awal",
          "value": "120 m2",
          "is_pii": false,
          "is_show": true
        },
        {
          "name": "Meter akhir",
          "value": "150 m2",
          "is_pii": false,
          "is_show": true
        }
      ]
    }
  ]
}

Decrypted & Verified (Plain Payload) Failed Example

{
  "client_number": "1234567890",
  "product_code": "product5627",
  "response_code": "11",
  "message": "Bill not available",
  "timestamp": "2021-12-12 12:12:12"
}

Checkout Page

checkout

Inquiry​

Inquiry