應用場景
特店Server需將從特店Web取得到的BindCardPayToken，送至綠界Server建立綁定信用卡交易。
注意事項：此 API 需與銀行連線，如遇銀行連線不穩定時可能導致回應時間增加。特店如需設定 API 連線逾時的時間，建議至少 30 秒以上。
API介接網址
- 測試環境: https://ecpg-stage.ecpay.com.tw/Merchant/CreateBindCard
- 正式環境: https://ecpg.ecpay.com.tw/Merchant/CreateBindCard
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)
特店編號 必填
BindCardPayToken String(64)
綁定信用卡代碼 必填
MerchantMemberID String(60)
特店會員編號 必填
Data參數範例(Json格式)
{
"MerchantID": "3002607",
"BindCardPayToken": "enter your token",
"MerchantMemberID": "test123456789"
}
綠界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格式) :3D驗證時
需進行3D驗證時，回傳以下參數:
RtnCode Int
交易狀態
1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。
注意事項：如收到以下代碼，建議廠商與消費者確認信用卡狀態:
- RtnCode = 10100252，代表此信用卡的餘額不足。
- RtnCode = 10100255，代表此信用卡為掛失卡。
RtnMsg String(200)
回應訊息
PlatformID String(10)
平台商編號
MerchantID String(10)
特店編號
OrderInfo Object
訂單資訊
MerchantTradeNo String(20)
特店交易編號
ThreeDInfo JSON
3D驗證資訊
ThreeDURL String(200)
3D驗證網址
注意事項：3D驗證連結，請勿使用 iframe 方式開啟
Data參數範例(Json格式)：
{
"RtnCode": 1,
"RtnMsg": "Success",
"PlatformID": "1234567890",
"MerchantID": "1234567890",
"OrderInfo": {
"MerchantTradeNo": "test123466"
},
"ThreeDInfo": {
"ThreeDURL": "https://3durl.com.tw"
}
}
Data參數說明(Json格式): 不走3D驗證時
RtnCode Int
交易狀態
1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。
注意事項：如收到以下代碼，建議廠商與消費者確認信用卡狀態:
- RtnCode = 10100252，代表此信用卡的餘額不足。
- RtnCode = 10100255，代表此信用卡為掛失卡。
RtnMsg String(200)
回應訊息
PlatformID String(10)
平台商編號
MerchantID String(10)
特店編號
MerchantMemberID String(30)
特店會員編號
BindCardID String(64)
綁定信用卡代碼
如收到的內容為null或空字串時，代表該筆訂單內容的綁卡資料已不存在或失效，並不影響交易授權的結果。
IsSameCard Bool
此信用卡是否已重覆綁定
true:是，false:否。同個廠商會員是否，是否綁定相同的信用卡
OrderInfo Object
綁卡訂單資訊
MerchantTradeNo String(20)
特店交易編號
TradeNo String(20)
綠界交易編號
請保存綠界的交易編號與特店交易編號MerchantTradeNo的關聯。
TradeAmt Int
交易金額
TradeDate String(20)
訂單成立時間
格式為 yyyy/MM/dd HH:mm:ss
PaymentType String(20)
付款方式
- Credit: 信用卡
PaymentDate String(20)
付款時間
格式為 yyyy/MM/dd HH:mm:ss
ChargeFee Number
手續費
TradeStatus String(8)
交易狀態
- 0 :代表交易訂單成立未付款
- 1 : 代表交易訂單成立已付款
CardInfo JSON
信用卡授權資訊
AuthCode String(6)
銀行授權碼
Gwsr Int
銀行授權碼
ProcessDate String(20)
交易時間
格式為yyyy/MM/dd HH:mm:ss。
Amount Int
金額
Eci Int
3D(VBV) 回傳值
Eci=5,6,2,1 代表該筆交易為3D交易。
Card6No String(6)
信用卡卡號前六碼
Card4No String(4)
信用卡卡號末四碼
CardValidYY String(2)
信用卡有效年
格式為YY。
CardValidMM String(2)
信用卡有效月
格式為MM。
Stage Int
分期期數
有分期付款時回傳
Stast Int
首期金額
有分期付款時回傳
Staed Int
各期金額
有分期付款時回傳
CustomField String(200)
自訂欄位
提供特店使用客制化欄位
Data參數範例(Json格式)
{
"RtnCode": 1,
"RtnMsg": "Success",
"PlatformID": "1234567890",
"MerchantID": "1234567890",
"MerchantMemberID": "abcdefg",
"BindCardID": "a123dfgh",
"CardInfo": {
"Card6No": "123456",
"Card4No": "1234",
"CardValidYY": "25",
"CardValidMM": "12",
"AuthCode": "654123",
"Gwsr": 125,
"ProcessDate": "2022/09/18 15:39:10",
"Amount": 2
"Eci": 1,
},
"OrderInfo": {
"MerchantTradeNo": "test123466",
"TradeNo": "123456789",
"PaymentDate": "2022/09/18 15:39:10",
"TradeAmt": 2,
"PaymentType": "Credit",
"TradeDate": "2022/09/18 15:39:10",
"ChargeFee": 0,
"TradeStatus": "1",
}
}