餘額查詢

BalanceQuery - 卡片餘額查詢

Request

Header

欄位	必填	型別	範例	說明
Method	YES	String(5)	31800	支付方式, 悠遊卡使用31800
ServiceType	YES	String	BalanceQuery	服務代碼
MchId	YES	String	Account0001	特店帳號
TradeKey	YES	String	sha256...hash	交易密碼(sha256編碼)
CreateTime	YES	String	20180101120000	建立日期, yyyyMMddHHmmss

Data

欄位	必填	型別	範例	說明
DeviceId	YES	String	01301234	終端機(讀卡機)編號
Retry	YES	String	0	重試次數, 請帶入0

Response

Header

欄位	型別	範例	說明
StatusCode	String(4)	0000	交易結果代碼
StatusDesc	String	交易成功	交易結果代碼說明
Method	String(5)	31800	支付方式, 悠遊卡使用31800
ServiceType	String	BalanceQuery	服務代碼
MchId	String	Account0001	特店帳號
ResponseTime	String	20180101120000	交易回應時間, yyyyMMddHHmmss

Data

欄位	型別	範例	說明
EZCardID	String	934528053	卡號
EZCardType	String	00
PersonalProfile	String	00
CardNumberForPrint	String	934528053
Balance	String	4000	餘額
TerminalTXNNumber	String	225417
HostSerialNumber	String	225417
ExpiryDate	String	20191230140820
CPUPurseVersion	String	00
BankCode	String	00
AreaCode	String	01
TXNResult	String	Success	交易結果
Retry	String	0
ErrorCode	String	000000	交易結果代碼
NewAESKey	String	f49f778a27...bbe6
EZCardPurseID	String	0000000000000000

API Example

Request

{
  "Header": {
    "Method": "31800",
    "ServiceType": "BalanceQuery",
    "MchId": "myMchId",
    "TradeKey": "9af15b336e6a9619928537df30b2e6a2376569fcf9d7e773eccede65606529a0",
    "CreateTime": "20180715104430"
  },
  "Data": "{\"DeviceId\":\"01304187\",\"Retry\":\"0\"}"
}

Response

{
  "Header": {
    "StatusCode": "0000",
    "StatusDesc": "STATUS_SUCCESS",
    "Method": "31800",
    "ServiceType": "BalanceQuery",
    "MchId": "myMchId",
    "ResponseTime": "20180715104434"
  },
  "Data": {
    "EZCardID": "1917740208",
    "EZCardType": "08",
    "PersonalProfile": "00",
    "CardNumberForPrint": "1917740208",
    "Balance": "482",
    "TerminalTXNNumber": "104432",
    "HostSerialNumber": "104432",
    "ExpiryDate": "20250810000000",
    "CPUPurseVersion": "00",
    "BankCode": "32",
    "AreaCode": "01",
    "TXNResult": "Success",
    "Retry": "0",
    "ErrorCode": "000000",
    "NewAESKey": "a3900d6a3e5c02f26bcb1eee506752fb",
    "EZCardPurseID": "0000000000000000"
  }
}