應用場景
提供特店使用CVS繳費代碼查詢取得各超商的三段式條碼。
注意事項：
- 若訂單已付款成功或已過期時，查詢三段式條碼會失敗。
- 超商代碼查詢超商三段式條碼，每次有效時間為10分鐘。
API介接網址
- 測試環境: https://ecpayment-stage.ecpay.com.tw/1.0.0/Cashier/QueryCVSBarcode
- 正式環境: https://ecpayment.ecpay.com.tw/1.0.0/Cashier/QueryCVSBarcode
HTTPS 傳輸協定
- Content Type：application/json
- HTTP Method：POST
特店Request參數說明 (Json格式)
MerchantID String(20)
特店編號 必填
RqHeader Object
傳輸資料 必填
Timestamp Number
傳輸時間 必填
請將傳輸時間轉換為時間戳(GMT+8)，綠界會利用此參數將當下的時間轉為 Unix TimeStamp 來驗證此次介接的時間區間。
注意事項：
- 驗證時間區間為 10 分鐘內有效，若超過此驗證時間則此次訂單將無法建立，產生時間戳請參考相關資料。
- 合作特店須進行主機「時間校正」，避免主機產生時差，導致API無法正常運作。
Data String
加密資料 必填
此參數為加密過的 JSON 格式資料，加密方式請參考說明。
特店Request參數範例 (Json格式)
{
"MerchantID": "3002607",
"RqHeader": {
"Timestamp": 1234567890
},
"Data": "enter your data"
}
Data參數說明(Json格式)
注意事項：請在加密前對參數值進行 URLEncode
PlatformID String(10)
特約合作平台商代號
- 為專案合作的平台商使用
- 一般特店或平台商本身介接，則參數請帶空值
- 專案合作平台商的特店使用時，參數請帶平台
商所綁的特店編號 MerchantID
MerchantID String(10)
特店編號 必填
PaymentNo String(20)
繳費代碼 必填
CVSType String(10)
繳費超商 必填
- Family :全家
- Hilife : 萊爾富
- iBon: 7-11
Data參數範例(Json格式)
{
"MerchantID": "3002607",
"PaymentNo": "123486456",
"CVSType" : "iBon"
}
綠界Response參數說明 (Json格式)
MerchantID String(10)
特店編號
RpHeader Object
回傳資料
Timestamp Number
回傳時間
時間戳 Unix timestamp
TransCode Int
回傳代碼
1 代表 API 傳輸資料 (MerchantID, RqHeader, Data) 接收成功，實際的API執行結果狀態請參考 RtnCode 參數
TransMsg String(200)
回傳訊息
Data String
加密資料
此參數為加密過的 JSON 格式資料
綠界Response參數範例 (Json格式)
{
"MerchantID": "3002607",
"RpHeader": {
"Timestamp": 1234564848
},
"TransCode": 1,
"TransMsg": "Success",
"Data": "…"
}
Data參數說明(Json格式)
RtnCode Int
交易狀態
1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。
RtnMsg String(200)
回應訊息
PlatformID String(10)
平台商編號
MerchantID String(10)
特店編號
CVSInfo Object
超商代碼資訊
ExpireDate String(20)
繳費期限
格式為yyyy/MM/dd HH:mm:ss
Barcode1 String(20)
條碼第一段號碼
Barcode2 String(20)
條碼第二段號碼
Barcode3 String(20)
條碼第三段號碼
Data參數範例(Json格式)
{
"RtnCode": 1,
"RtnMsg": "Success",
"MerchantID": "3002607",
"CVSInfo": {
"ExpireDate":"2020/12/31 15:12:20",
"Barcode1":"123456789",
"Barcode2":"1234567890123456",
"Barcode3":"123456789012345"
}
}