Query Card Status

Request Url

​ sandbox：https://api.sandbox.hitpoints.com/v1/pin/query

​ production：https://api.hitpoints.com/v1/pin/query

Request Method

​ GET

Request Parameters

Parameters	Required	Type	Description
pin_sn	Yes	string(16)	HitPoints Card Serial Number (SN, not secret)
random_key	Yes	string(16)	randomly set the value with random string

Request success response

 {
      "data": {
          "pin_sn": "W000000011U00001",
          "pin_key": "8Q57B8221QN7900R",
          "category_name": "Happy Card",
          "product_name": "10 Yuan",
          "product_id": 2,
          "currency": "CNY",
          "amount": "10.00",
          "cost_price": "0.00",
          "status": "verified",
          "create_time": 1562034955,
          "expire_time": 1624291200
      },
      "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	response data
pin_sn	the product serial number
pin_key	the product secret
category_name	the product category name
product_name	the product name
product_id	the product Id
amount	the product face value
currency	the product currency
cost_price	the cost price for reseller
status	product status：active = can be used, inactive = cannot be used, verified = already used, void = is scrapped, expired = is expired
create_time	the product create time
expire_time	the product expire time

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
  }