應用場景
使用者可於交易中進行記憶卡號功能,當使用者想要刪除信用卡資料時,特店 Server 必須先向綠界 Server 取得一組代碼(Token)。特店 Server 得到Token後,必須將Token傳給特店 Web 做產生刪除記憶卡號功能畫面。使用者就能在該畫面刪除已綁定的信用卡。
API介接網址
- 測試環境: https://ecpg-stage.ecpay.com.tw/Merchant/GetTokenbyUser
- 正式環境: https://ecpg.ecpay.com.tw/Merchant/GetTokenbyUser
HTTPS 傳輸協定
- Content Type:application/json
- HTTP Method:POST
特店Request參數說明 (Json格式)
MerchantID String(10)
特店編號 必填
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必須與PlatformID帶入相同值。
MerchantID String(10)
特店編號 必填
ConsumerInfo Object
消費者資訊 必填
當特店擁有自己的會員系統時,可將會員資料帶入
MerchantMemberID String(60)
消費者會員編號 必填
- 請帶入特店的會員編號
- 當 RememberCard 為 1 時,此欄位必填
Email String(30)
信用卡持卡人電子信箱
注意事項:檢核規則請參考正規表達式“^([a-zA-Z\d._%+-]+@[a-zA-Z\d.-]+\.[a-zA-Z]{2,6})*$”;
Phone String(60)
信用卡持卡人電話
可帶入國碼,但不可帶入+號。ex:886912345678
Name String(50)
信用卡持卡人姓名
- 該欄位可接受中文、英文與部分特殊符號
- 可支援的特殊符號為 : , . () / –
CountryCode String(3)
國別碼
- 持卡人帳單地址國別碼,請參考 ISO3166
- 臺灣請填寫 158
Address String(50)
地址
請帶入持卡人帳單地址
CustomField String(200)
自訂欄位
- 提供特店使用客制化欄位
- 請勿傳入超過長度 200 的內容,避免該欄位資訊被截斷
Data參數範例(Json格式)
{
"MerchantID": "3002607",
"ConsumerInfo": {
"MerchantMemberID": "test123456",
"Email": "customer@email.com",
"Phone": "0912345678",
"Name": "Test",
"CountryCode": "158"
}
}
綠界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)
特店編號
Token String(64)
代碼
代碼可使用的效期為 30 分鐘
TokenExpireDate String(20)
代碼到期時間
格式為 yyyy/MM/dd HH:mm:ss
Data參數範例(Json格式)
{
"RtnCode": 1,
"RtnMsg": "Success",
"PlatformID": "1234567890",
"MerchantID": "1234567890",
"Token": "m12dae4846446sq",
"TokenExpireDate": "2020/09/18 15:39:10"
}