應用場景
注意事項：
- 超商繳費條碼(BARCODE)因超商端作業時間關係會於消費者付款完成兩天後回傳。
- ATM、CVS、BARCODE可透過廠商管理後台的『模擬付款』，來確認ReturnURL是否正確接收付款結果通知。
- 付款結果通知常見付款狀態未更新原因說明。
- 1|OK僅是廠商回應綠界是否收到通知，並不會改變付款狀態。
HTTPS 傳輸協定
- Accept ：text/html
- Content Type：application/json
- HTTP Method：POST
綠界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)
特店編號
SimulatePaid Int
是否為模擬付款
當交易為模擬付款時，才會回傳此欄位。回傳值為:
- 1 : 代表此交易為模擬付款，並非是由消費者實際真的付款。所以綠界也不會撥款給特店，請勿對該筆交易做出貨等動作，以避免損失。
注意事項：
- 特店可透過廠商後台來針對單筆訂單模擬綠界回傳付款通知，以方便介接API
- 此功能僅只是用於測試ReturnURL是否能成功接收，不會改變付款狀態
- 只有透過廠商後台的定期定額查詢功能發動的模擬付款通知，綠界才會傳送此參數，正常由定期定額排程所發送的付款通知，不會傳送此參數
OrderInfo Object
訂單資訊
MerchantTradeNo String(20)
特店交易編號
TradeNo String(20)
綠界交易編號
請保存綠界的交易編號與特店交易編號MerchantTradeNo的關聯。
TradeAmt Int
交易金額
TradeDate String(20)
訂單成立時間
格式為 yyyy/MM/dd HH:mm:ss
PaymentType String(20)
付款方式
- Credit: 信用卡一次付清、分期付款
- ApplePay
- UnionPay: 銀聯卡
- FlexibleInstallment: 圓夢彈性分期
- CVS: 超商代碼
- BARCODE: 超商條碼
- ATM
PaymentDate String(20)
付款時間
格式為 yyyy/MM/dd HH:mm:ss
ChargeFee Number
手續費
TradeStatus String(8)
交易狀態
- 0 :代表交易訂單成立未付款
- 1 : 代表交易訂單成立已付款
CardInfo Object
信用卡授權資訊
付款方式為信用卡或銀聯卡時，回傳CardInfo
AuthCode String(6)
銀行授權碼
Gwsr Int
授權交易單號
ProcessDate String(20)
交易時間
格式為yyyy/MM/dd HH:mm:ss
Amount Int
金額
Stage Int
分期期數
Stast Int
首期金額
Staed Int
各期金額
Eci Int
3D(VBV) 回傳值
Eci=5,6,2,1 代表該筆交易為3D交易，且付款方式為銀聯卡時不回傳
Card6No String(6)
信用卡卡號前六碼
付款方式為銀聯卡時不回傳
Card4No String(4)
信用卡卡號末四碼
付款方式為銀聯卡時不回傳
RedDan Int
紅利扣點
使用信用卡紅利時回傳
RedOkAmt Int
實際扣款金額
使用信用卡紅利時回傳
RedYet Int
紅利剩餘點數
使用信用卡紅利時回傳
RedDeAmt Int
紅利折抵金額
使用信用卡紅利時回傳
PeriodType String(1)
週期種類
定期定額時回傳，訂單建立時所設定的週期種類
Frequency Int
執行頻率
定期定額時回傳，訂單建立時所設定的執行頻率
ExecTimes Int
執行次數
定期定額時回傳，訂單建立時所設定的執行次數
PeriodAmount Int
訂單建立時的每次要授權金額
定期定額時回傳
TotalSuccessTimes Int
目前已成功授權的次數
定期定額時回傳，目前已成功授權的次數
TotalSuccessAmount Int
目前已成功授權的金額合計
定期定額時回傳
IssuingBank String(30)
銀行名稱
IssuingBankCode String(10)
銀行代碼
CVSInfo Object
超商代碼資訊
付款方式為CVS時，回傳CVSInfo
PayFrom String(10)
繳費超商
- family：全家
- hilife：萊爾富
- okmart：OK 超商
- ibon：7-11
PaymentNo String(14)
繳費代碼
PaymentURL String(100)
繳費連結
PayStoreID String(15)
繳費超商門市代碼
依超商傳回門市代碼 範例:166843
PayStoreName String(30)
繳費超商門市名稱
依超商傳回門市名稱 範例:板橋德民店
BarcodeInfo Object
超商條碼資訊
付款方式為Barcode時，回傳BarcodeInfo
PayFrom String(10)
繳費超商
- family：全家
- hilife：萊爾富
- okmart：OK 超商
- ibon：7-11
ATMInfo Object
ATM資訊
付款方式為ATM時，回傳ATMInfo
ATMAccBank String(3)
付款人銀行代碼
若該銀行未提供，則回傳空白
ATMAccNo String(5)
付款人銀行帳號後五碼
若該銀行未提供，則回傳空白
CustomField String(200)
自訂欄位
提供特店使用客制化欄位
Data參數範例(Json格式)
{
"RtnCode": 1,
"RtnMsg": "Success",
"MerchantID": "3002607",
"OrderInfo": {
"MerchantTradeNo": "20180914001",
"TradeNo": "1809261503338172",
"TradeDate" :"2018/09/26 14:59:54"
},
"CardInfo": {
"Gwsr": 10735183,
"ProcessDate": "2018/09/26 14:59:54",
"AuthCode": "777777",
"Amount": 100,
"Eci": 2,
"Card4No": "2222",
"Card6No": "491122",
"RedDan": 0,
"RedOkAmt": 0,
"RedYet": 0
}
}
注意事項：
- 若未正確回應1|OK，系統會隔5~15分鐘後重發訊息給特店，當天重複發送四次。
- 若特店持續收到綠界回傳付款資訊，此時請檢查是否未正確回應1|OK給綠界，常見錯誤回傳值為(“1|OK”、1|ok、_OK 、1\OK、空白 )。
- 若遇消費者已付款，但未收到綠界回傳付款完成資訊，此時請檢查接收回傳參數的伺服器是否服務正常，導致無法接收。請參考：無法收到綠界回傳的付款結果通知
- 當模擬付款SimulatePaid的值為1時，表示此筆訂單資訊是由綠界廠商後台模擬付款按鈕所發送的回傳付款通知測試資訊，並非是由消費者實際真的付款，所以綠界也不會撥款給特店，請勿對該筆交易做出貨等動作，以避免損失。
- 特店務必判斷交易狀態RtnCode是否為1，若非1時請勿對該筆交易做出貨動作，並取得交易訊息RtnMsg記錄失敗原因。