Query Product List

Request Url

sandbox：https://api.sandbox.hitpoints.com/v1/items

production：https://api.hitpoints.com/v1/items

Request Method

​ GET

Request Parameters

Parameters	Required	Type	Description
currency	Optional	string(3)	Query the product list of the specified currency, if unspecified, the product list of all currencies will be returned by default
random_key	Yes	string(16)	randomly set the value with random string

Request Success Response

{
      "data": {
          "pin-value-fixed": [
              {
                  "product_id": 4,
                  "product_name": "Happy Card",
                  "category_name": "20 Yuan",
                  "category_code": "happy-card-a",
                  "region": "BC",
                  "currency": "CNY",
                  "par_value": "20.00",
                  "discount_rate": "25.00%",
                  "max_fetch_quantity": 5
              },
              {
                  "product_id": 2,
                  "product_name": "Happy Card",
                  "category_name": "10 Yuan",
                  "category_code": "happy-card-a",
                  "region": "BC",
                  "currency": "CNY",
                  "par_value": "10.00",
                  "discount_rate": "25.00%",
                  "max_fetch_quantity": 10
              }
          ],
          "another-pin-group": [
              {
                  "product_id": 3,
                  "product_name": "UnfixedPinCategory",
                  "category_name": "charge card",
                  "category_code": "unfixed-pin-category",
                  "region": "CN",
                  "currency": "CNY",
                  "par_value": "0.00",
                  "discount_rate": "0.00%",
                  "max_fetch_quantity": 50
              }
          ]
      },
      "code": 200,
      "message": "ok",
      "success": true
  }

Response Fields Description

Field	Description
code	The response code describe the request is success or not, code = 200 means success
message	The description message to the code
success	Describe the code with bool, when code = 200 , it's true, otherwise it's false

These fields below will response when code=200

Fields	Description
data	the product list, group by category
pin-value-fixed	the category key name，all products under the key have a fixed par value

Description:

Fields	Description
product_id	the product ID
product_name	the product name
category_name	the product category name
category_code	the product category code
region	the available region(country) code
par_value	the face value of the product
currency	the product currency
discount_rate	the reseller discount(%)，the real unit price = par_value * (1 - discount_rate%)
max_fetch_quantity	the maximum number of fetching card in single order

Response Headers：

Fields	Description
Sign	The signature from HitPoints server
Date-GMT	The Time String for HitPoints calculate response signature

Notice: if request failed，that the code!=200, or this is no data field in response body，there will be no Sign field in response header

Fail response example：

{
      "code": 400100,
      "message": "bad request parameter, parameter validate fail",
      "success": false
 }