Query PIN Status

Introduction

Merchant can query HitPoints Pin status through Pin serial number(Not card secret)

API 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
ping_sn	是	string(16)	serial number HitPoints card
random_key	是	string(16)	randomly set the value with random string

Response Example

  {
      "data": {
          "pin_sn": "W000000011U00001",
          "category_name": "Happy Card",
          "product_name": "10 Yuan",
          "currency": "CNY",
          "amount": "10.00",
          "status": "verified",
          "create_time": 1562034955,
          "expire_time": 1624291200,
          "verify_time": 1563939943,
          "is_settled": 1
      },
      "code": 200,
      "message": "ok",
      "success": true
  }

Response Field 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 response data set
pin_sn	the card serial number of HitPoints (Not card secret)
product_name	pin product name
category_name	Pin category name
amount	card face value
currency	card currency
status	verified,active,expired,inactive
create_time	create time of the card
expire_time	expire time of the card
verify_time	payment time of the card
is_settled	the payment amount is payed to merchant：1=unpaid，2=paid

Response Header：

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
  }