付款結果通知
應用場景 Ⅰ :
- Server 端方式(Server POST)(ReturnURL)
當消費者付款完成後,特店接受歐買尬金流的付款結果訊息,並回應接收訊息
Step1. 歐買尬金流:以ServerPost 方式傳送付款結果訊息至特店的Server網址[ReturnURL]
Step2. 特店:收到歐買尬金流的付款結果訊息,並判斷檢查碼是否相符
Step3. 特店:檢查碼相符後,回應1|OK
注意事項:
1.ATM、CVS、BarcodeATM 可透過廠商管理後台的『模擬付款』,來確認ReturnURL是否正確接收付款結果通知。
- Client 端方式(Client POST)(OrderResultURL)
當消費者付款完成後,歐買尬金流一次性反饋付款結果通知,並將頁面導至特店自製頁面
Step1. 歐買尬金流:傳送付款結果並將頁面導至特店的自製頁面網址(OrderResultURL)
Step2. 特店:收到歐買尬金流的付款結果訊息,並判斷檢查碼是否相符
注意事項:
1. 若要將付款結果頁顯示於特店自製頁面,請設定[OrderResultURL]。反之,未設定則會停留於歐買尬金流付款成功頁面。
2. 若[OrderResultURL]與[ClientBackURL]同時設定,將會以[OrderResultURL]為主。
3. 銀聯卡及非即時交易(ATM、CVS..等)不支援此參數。
4. 建議在測試階段時先不要設定此參數,可將畫面停留在歐買尬金流,看見歐買尬金流所提供的錯誤 訊息,便可有效除錯。
5. 若有設定此參數,請務必根據回傳的交易狀態來判斷顯示付款成功與否的頁面。
6. 因各家銀行授權時間不同,若因授權時間過久未收到反饋訊息,請使用查詢訂單API查詢後再顯示付款結果。
7. 若此參數設定網址未使用https時,部份瀏覽器可能會出現警告訊息提醒。
歐買尬金流回傳參數說明 Ⅰ :
介接路徑
- Content Type:text/html
- HTTP Method:POST
| 參數/型態 | 參數名稱 | 說明 |
|---|---|---|
| MerchantID String(10) | 特店編號 | |
| MerchantTradeNo String(20) | 特店交易編號 | 訂單產生時傳送給歐買尬金流的特店交易編號。英數字大小寫混合 |
| StoreID String(20) | 特店旗下店舖代號 | 提供特店填入分店代號使用,僅可用英數字大小寫混合。 |
| RtnCode Int | 交易狀態 | 若回傳值為 1 時,為付款成功 其餘代碼皆為交易異常,請至廠商管理後台確認後再出貨。 |
| RtnMsg String(200) | 交易訊息 | Server POST成功回傳:交易成功 Server POST補送通知回傳:paid Client POST成功回傳:Succeeded |
| TradeNo String(20) | 歐買尬金流的交易編號 | 請保存歐買尬金流的交易編號與特店交易編號 [MerchantTradeNo] 的關連。 |
| TradeAmt Int | 交易金額 | |
| PaymentDate String(20) | 付款時間 | 格式為yyyy/MM/dd HH:mm:ss |
| PaymentType String(20) | 特店選擇的付款方式 | 請參考回覆付款方式一覽表 |
| PaymentTypeChargeFee Int | 通路費 | |
| TradeDate String(20) | 訂單成立時間 | 格式為 yyyy/MM/dd HH:mm:ss |
| SimulatePaid Int | 是否為模擬付款 | 回傳值: 若為1時,代表此交易為模擬付款,請勿出貨。 若為0時,代表此交易非模擬付款。 注意事項: 特店可透過廠商後台網站來針對單筆訂單模擬歐買尬金流回傳付款通知,以方便介接API的測試。 |
| CustomField1 String(50) | 自訂名稱欄位 1 | 提供合作廠商使用記錄用客製化使用欄位 |
| CustomField2 String(50) | 自訂名稱欄位 2 | 提供合作廠商使用記錄用客製化使用欄位 |
| CustomField3 String(50) | 自訂名稱欄位 3 | 提供合作廠商使用記錄用客製化使用欄位 |
| CustomField4 String(50) | 自訂名稱欄位 4 | 提供合作廠商使用記錄用客製化使用欄位 |
| CheckMacValue String | 檢查碼 | 特店必須檢查檢查碼 [CheckMacValue] 來驗證,請參考附錄檢查碼機制 |
特店傳出參數說明:
| 參數 | 參數名稱 | 型態 | 說明 |
|---|---|---|---|
| String | 回傳值為純字串並無參數名稱 若回傳值第一碼值為 1時為成功,例: 1|OK。 若回傳值第一碼值為 0時為失敗,例: 0|ErrorMessage,ErrorMessage為 [錯誤代碼 - 錯誤訊息]。 此訊息僅代表特店回應是否已收到歐買尬金流回傳通知及所接收的資料是否正確,並不會影響訂單的狀態。 |
注意事項:
(1) 特店務必判斷檢查碼[CheckMacValue]是否正確,以及是否已經對該筆訂單的付款通知,做過相對應的處理,以免造成交易狀態無法同步的損失。
(2) 若未正確回應1|OK,系統會隔5~15分鐘後重發訊息給特店,當天重複發送四次。若特店正確回應 1|OK ,但歐買尬金流未收到,導致重複發送,請特店自行判斷是否已收到歐買尬金流回傳交易成功的訊息。
(3) 若特店持續收到歐買尬金流回傳付款資訊,此時請檢查是否未正確回應1|OK給歐買尬金流,常見錯誤回傳值為(“1|OK”、1|ok、_OK 、1\OK、空白 )。
(4) 若遇消費者已付款,但未收到歐買尬金流回傳付款完成資訊,此時請檢查接收回傳參數的伺服器是否服務正常,導致無法接收。
(5) 當模擬付款[SimulatePaid]的值為 1 時,表示此筆訂單資訊是由歐買尬金流廠商後台模擬付款按鈕所發送的回傳付款通知測試資訊,並非是由消費者實際真的付款,所以歐買尬金流也不會撥款給特店,請勿對該筆交易做出貨等動作,以避免損失。
(6) 特店務必判斷交易狀態[RtnCode]是否為 1 ,若非 1 時請勿對該筆交易做出貨動作,並取得交易訊息 [RtnMsg] 記錄失敗原因。
付款結果通知會以下表form-data格式參數直接回傳至頁面,並以「參數=值」表示
參數與參數之間以&隔開,例:
&CustomField1=&CustomField2=&CustomField3=&CustomField4=&MerchantID=2000132 &MerchantTradeNo=Test1510056539&PaymentDate=2017/11/02 16:22:18 &PaymentType=Credit_CreditCard&PaymentTypeChargeFee=1&RtnCode=1&RtnMsg=交易成功&SimulatePaid=0&StoreID=&TradeAmt=100&TradeDate=2017/11/07 20:08:59&TradeNo=17110720085960236789 &CheckMacValue= DB6960E7B3765C2ACDDF8437B9D92EA14823B1B5BA11069017777D79A99A9F1E
應用場景 Ⅱ :
- Server 端方式(Server POST)(ReturnURL)
當消費者付款完成後,特店接受歐買尬金流的付款結果訊息,並回應接收訊息
Step1. 歐買尬金流:以ServerPost 方式傳送付款結果訊息至特店的Server網址[ReturnURL]
Step2. 特店:收到歐買尬金流的付款結果訊息,並判斷檢查碼是否相符
Step3. 特店:檢查碼相符後,回應1|OK
注意事項:
1.ATM、CVS 可透過廠商管理後台的『模擬付款』,來確認ReturnURL是否正確接收付款結果通知。
- Client 端方式(Client POST)(OrderResultURL)
當訂單是使用信用卡定期定額的交易時,在每次授權成功後,歐買尬金流會傳送付款通知結果
Step1. 歐買尬金流:第二次授權是由歐買尬金流的排程進行授權,交易授權成功後以Server POST方式傳送付款通知至特店傳送的付款完成通知回傳網址[PeriodReturnURL]。
Step2. 特店:收到歐買尬金流的付款通知訊息後,需比對檢查碼是否相符。
注意事項:
第一次授權成功時,付款結果參數會回傳到付款完成通知回傳網址[ReturnURL],
第二次授權成功是由歐買尬金流的排程進行授權,所以從第二次開始的資料,都是回傳到所設定的付款完成通知回傳網址[PeriodReturnURL]。
歐買尬金流回傳參數說明 Ⅱ :
介接路徑
- Content Type:text/html
- HTTP Method:POST
| 參數/型態 | 參數名稱 | 說明 |
|---|---|---|
| MerchantID String(10) | 特店編號 | |
| MerchantTradeNo String(20) | 特店交易編號 | 訂單產生時傳送給歐買尬金流的特店交易編號。 |
| StoreID String(20) | 特店旗下店舖代號 | 提供特店填入分店代號使用,僅可用英數字大小寫混合。 |
| CustomField1 String(50) | 自訂名稱欄位 1 | 提供合作廠商使用記錄用客製化使用欄位 |
| CustomField2 String(50) | 自訂名稱欄位 2 | 提供合作廠商使用記錄用客製化使用欄位 |
| CustomField3 String(50) | 自訂名稱欄位 3 | 提供合作廠商使用記錄用客製化使用欄位 |
| CustomField4 String(50) | 自訂名稱欄位 4 | 提供合作廠商使用記錄用客製化使用欄位 |
| RtnCode Int | 交易狀態 | 1:授權成功,其餘為失敗 |
| RtnMsg String(200) | 交易訊息 | 交易訊息 |
| PeriodType String(1) | 週期種類 | 訂單建立時所設定的週期種類 |
| Frequency Int | 執行頻率 | 訂單建立時所設定的執行頻率 |
| ExecTimes Int | 執行次數 | 訂單建立時所設定的執行頻率 |
| Amount Int | 本次授權金額 | 此次所授權的金額 |
| Gwsr Int | 授權交易單號 | 此次所授權的交易單號 |
| ProcessDate String(20) | 處理時間 | 處理時間 ( yyyy/MM/dd HH:mm:ss ) |
| AuthCode String(6) | 授權碼 | 授權碼 |
| FirstAuthAmount Int | 初次授權金額 | 定期定額交易的第一筆授權金額。 |
| TotalSuccessTimes Int | 已執行成功次數 | 目前已成功授權的次數。 |
| SimulatePaid Int | 是否為模擬付款 | 回傳值: 若為 1 時,代表此交易為模擬付款 若為 0 時,代表此交易非模擬付款。 注意事項: 目前只有透過廠商後台的定期定額查詢功能,來發動的模擬付款通知,歐買尬金流才會傳送此參數,正常由定期定額排程所發送的付款通知,不會傳送此參數。當 SimulatePaid 的值為 1 時,RtnCode 也會是 1,表示此筆訂單是模擬付款,並非是由消費者實際真的付款,所以歐買尬金流也不會撥款給廠商,請勿對該筆交易做出貨等動作,以避免損失。 |
| CheckMacValue String | 檢查碼 | 特店必須檢查[CheckMacValue]來驗證,請參考附錄檢查碼機制。 |
注意事項:
(1) 特店務必判斷檢查碼[CheckMacValue]是否正確,以及是否已經對該筆訂單的付款通知,做過相對應的處理,以免造成交易狀態無法同步的損失。
(2) [PeriodReturnURL]每期僅會收到一次通知,如未收到通知,請利用信用卡定期定額訂單查詢取得實際授權結果。
(3) 若遇消費者已付款,但未收到歐買尬金流回傳付款完成資訊,此時請檢查接收回傳參數的伺服器是否服務正常,導致無法接收。
(4) 當模擬付款[SimulatePaid]的值為 1時,表示此筆訂單資訊是由歐買尬金流廠商後台模擬付款按鈕所發送的回傳付款通知測試資訊,並非是由消費者實際真的付款,所以歐買尬金流也不會撥款給特店,請勿對該筆交易做出貨等動作,以避免損失。
(5) 特店務必判斷交易狀態[RtnCode]是否為 1,若非 1 時請勿對該筆交易做出貨動作,並取得交易訊息 [RtnMsg] 記錄失敗原因。
付款結果通知會以下表form-data格式參數直接回傳至頁面,並以「參數=值」表示
參數與參數之間以&隔開,例:
Amount=100&AuthCode=123456&CustomField1=&CustomField2= &CustomField3= &CustomField4=&ExecTimes=99&FirstAuthAmount=100&Frequency=1&Gwsr=11119888&MerchantID=1000031&MerchantTradeNo=123135664132a318&PeriodType=M&ProcessDate=2022/01/01 08:00:10&RtnCode=1&RtnMsg=success&StoreID=&TotalSuccessTimes=2&CheckMacValue=4B0DD52A702111695C38E5769C0FB269E09A225FDDB88BF3633FD58901B51653
