Current position: document > > flow card expiration date

Functional description

Query the expiration date of the traffic card (the interface is related to the contract between the merchant and our company, so please notify us before using this interface)

URL

/v1/cardExpireDate

Request method

GET POST

Request parameters

Parameter fields Field type Is it necessary Parameter description
agentid string Yes Merchant ID
cardNum string Yes Card number, support 20 bit ICCID/11 bit or 13 bit cell phone number
ti string Yes Time Stamp UTC/GMT+08:00,Example:2016-09-23 17:33:50 is 1474623230
format string No json or xml,default is json

Invocation direction

Third party application server, HTT. server

Request examples

http://api.ht-telecom.com/v1/cardExpireDate?agentid=**&cardNum=**&format=json&ti=**&sign=**

Return to the example, JSON format

/**Successful return to an exampl**/
{
    "code": 0,
    "msg": "Error code description",
    "data":
        {
            "msisdn": "***",
            "expireDate":"**", // yyyy-mm-dd Formatted string
            "activateTime": "**", // yyyy-mm-dd Formatted string
            "startDate": "**",  // yyyy-mm-dd Formatted string
        }
}

/**Failure to return to the sample**/
{
    "code": -1,
    "msg": "Error code description",
    "data": ""
}

Return field description

Parameter fields Field type Is it necessary Parameter description
code int_32 Yes Error code, 0 for success, others fail
msg string Yes Error code description
data JSON Object Yes Returned data
--msisdn string Yes GSM SIM Card
--expireDate string Yes Expiration date of traffic card
--activateTime string Yes Traffic card date
--startDate string Yes Flow card activation set menu opening date