付款結果通知
應用場景Ⅰ
- Server 端方式(Server POST)(ReturnURL)
當消費者付款完成後,廠商接受歐買尬金流的付款結果訊息,並回應接收訊息
Step1. 歐買尬金流:以 ServerPost 方式傳送付款結果訊息至廠商的 Server 網址[ReturnURL]
Step2. 廠商:收到歐買尬金流的付款結果訊息,回應 1|OK
注意事項:
- ATM、CVS 可透過廠商管理後台的『模擬付款』,來確認 ReturnURL 是否正確接收付款結果通知。
- 1|OK 僅是廠商回應歐買尬金流是否收到通知,並不會改變付款狀態。
歐買尬金流回傳參數說明
• Accept:text/html
• Content Type:application/json
• HTTP Method:POST
| 參數 / 型態 | 參數名稱 | 說明 |
|---|---|---|
| MerchantID String(10) | 特店編號 | |
| RqHeader JSON | 傳輸資料 | |
| Timestamp Number | 傳輸時間 | 時間戳 Unix timestamp |
| TransCode Int | 回傳代碼 | 1 代表傳輸資料(MerchantID,RqHeader,Data)接收成功,其餘均為失敗 |
| TransMsg String(200) | 回傳訊息 | 回傳訊息 |
| Data String | 加密資料 | 加密過 JSON 格式的資料。加密方法說明 |
範例
json
{
"RtnCode": 1,
"RtnMsg": "Success",
"MerchantID": "1000031",
"OrderInfo":
{
"MerchantTradeNo": "test123466"
},
"ThreeDInfo":
{
"ThreeDURL": "https://3durl.com.tw"
}
}Data參數說明
| 參數 / 型態 | 參數名稱 | 說明 |
|---|---|---|
| RtnCode Int | 交易狀態 | 1 代表 API 執行成功,其餘代碼均為失敗。失敗代碼請參考交易訊息代碼表 |
| RtnMsg String(200) | 回應訊息 | |
| 以下為 RtnCode 為 1 時才會回傳 | ||
| PlatformID String(10) | 平台商編號 | 特約合作平台商特店編號。 |
| MerchantID String(10) | 特店編號 | |
| SimulatePaid Int | 是否為模擬付款 | 當交易為模擬付款時,才會回傳此欄位回傳值。1:代表此交易為模擬付款,RtnCode 也為 1。並非是由消費者實際真的付款,所以歐買尬金流也不會撥款給廠商,請勿對該筆交易做出貨等動作,以避免損失。 ※ 注意事項: ● 特店可透過廠商後台來針對單筆訂單模擬歐買尬金流回傳付款通知,以方便介接 API。 ● 此功能僅只是用於測試 ReturnURL 是否能成功接收,不會改變付款狀態。 ● 只有透過廠商後台的定期定額查詢功能發動的模擬付款通知,歐買尬金流才會傳送此參數,正常由定期定額排程所發送的付款通知,不會傳送此參數。 |
| OrderInfo JSON Object | 訂單資訊 | |
| MerchantTradeNo String(20) | 特店交易編號 | |
| TradeNo String(20) | 歐買尬金流的交易編號 | 請保存歐買尬金流交易編號與特店交易編號 [MerchantTradeNo] 的關聯。 |
| PaymentDate String(20) | 付款時間 | 格式為 yyyy/MM/dd HH:mm:ss |
| TradeAmt Int | 交易金額 | |
| PaymentType String(20) | 特店選擇的付款方式 | |
| TradeDate String(20) | 訂單成立時間 | yyyy/MM/dd HH:mm:ss |
| ChargeFee Number | 手續費 | |
| TradeStatus String(8) | 交易狀態 | 若為 0 時,代表交易訂單成立未付款 |
| 付款方式為 CVS 時,回傳 CVSInfo | ||
| CVSInfo JSON Object | CVS 資訊 | |
| PayFrom String(10) | 繳費超商 | family:全家 ibon:7-11 |
| PaymentNo String(14) | 繳費代碼 | |
| PaymentURL String(100) | 繳費連結 | |
| StoreID String(20) | 超商代碼繳款的店舖代號 | 020328 |
| StoreName String(20) | 超商代碼繳款的店舖名稱 | 台中公民店 |
| 付款方式為 ATM 時,回傳 ATMInfo | ||
| ATMInfo JSON Object | ATM 資訊 | |
| ATMAccBank String(3) | 付款人銀行代碼 | |
| ATMAccNo String(5) | 付款人銀行帳號後五碼 | |
| 付款方式為信用卡或銀聯卡時,回傳 CardInfo | ||
| CardInfo JSON Object | 授權資訊 | |
| 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 | 紅利扣點 | 使用信用卡紅利時回傳 |
| RedDeAmt Int | 紅利折抵金額 | 使用信用卡紅利時回傳 |
| RedOkAmt Int | 實際扣款金額 | 使用信用卡紅利時回傳 |
| RedYet Int | 紅利剩餘點數 | 使用信用卡紅利時回傳 |
| PeriodType String(1) | 週期種類 | 定期定額時回傳,訂單建立時所設定的週期種類 |
| Frequency Int | 執行頻率 | 定期定額時回傳,訂單建立時所設定的執行頻率 |
| ExecTimes Int | 執行次數 | 定期定額時回傳,訂單建立時所設定的執行頻率 |
| PeriodAmount Int | 訂單建立時的每次要授權金額 | 定期定額時回傳 |
| TotalSuccessTimes Int | 目前已成功授權的次數 | 定期定額時回傳,目前已成功授權的次數。 |
| TotalSuccessAmount Int | 目前已成功授權的金額合計 | 定期定額時回傳 |
| CustomField String(200) | 自訂欄位 | 提供特店使用客制化欄位 |
Data範例(解密後)
json
{
"RtnCode": 1,
"RtnMsg": "Success",
"MerchantID": "1000031",
OrderInfo":
{
"MerchantTradeNo": "test123466",
"TradeNo":"123456789",
"TradeDate": "2020/09/18 15:39:10"
},
"ThreeDInfo":
{
"ThreeDURL": "https://3durl.com.tw"
}
}Client 端方式(Client POST) ( OrderResultURL )
當消費者付款完成後,歐買尬金流一次性反饋付款結果通知,並將頁面導至廠商自製頁面。
Step1. 歐買尬金流:以 ServerPost 方式傳送付款結果訊息至廠商的 Server 網址ReturnURL
Step2. 廠商:收到歐買尬金流的付款結果訊息,回應 1|OK
注意事項:
- 若有設定此參數,請務必根據回傳的交易狀態來判斷顯示付款成功與否的頁面。
- 因各家銀行授權時間不同,若因授權時間過久未收到反饋訊息,請使用查詢訂單API查詢後再顯示付款結果。
- 若此參數設定網址未使用 https 時,部份瀏覽器可能會出現警告訊息提醒。
歐買尬金流回傳參數說明 ( OrderResultURL )
• Accept:text/html
• Content Type:application/json
• HTTP Method:POST
| 參數 / 型態 | 參數名稱 | 說明 |
|---|---|---|
| ResultData String | 回傳參數 | 廠商自製頁面可接收的回傳參數 |
ResultData參數說明
| 參數 / 型態 | 參數名稱 | 說明 |
|---|---|---|
| MerchantID String(10) | 特店編號 | 特店編號 |
| RqHeader JSON | 傳輸資料 | |
| Timestamp Number | 傳輸時間 | 時間戳 Unix timestamp |
| TransCode Int | 回傳代碼 | 1 代表傳輸資料 (MerchantID,RqHeader,Data) 接收成功,其餘均為失敗 |
| TransMsg String(200) | 回傳訊息 | 回傳訊息 |
| Data String | 加密資料 | 加密過 JSON 格式的資料。加密方法說明 |
json
{
"MerchantID": "1000031",
"RpHeader":
{
"Timestamp": 1234564848
},
"TransCode": 1,
"TransMsg": "Success",
"Data": "…"
}Data參數說明
| 參數 / 型態 | 參數名稱 | 說明 |
|---|---|---|
| RtnCode Int | 交易狀態 | 1 代表 API 執行成功,其餘代碼均為失敗。失敗代碼請參考交易訊息代碼表 |
| RtnMsg String(200) | 回應訊息 | |
| 以下為 RtnCode 為 1 時才會回傳 | ||
| PlatformID String(10) | 平台商編號 | 特約合作平台商特店編號。 |
| MerchantID String(10) | 特店編號 | |
| SimulatePaid Int | 是否為模擬付款 | 當交易為模擬付款時,才會回傳此欄位回傳值。1:代表此交易為模擬付款,RtnCode 也為 1。並非是由消費者實際真的付款,所以歐買尬金流也不會撥款給廠商,請勿對該筆交易做出貨等動作,以避免損失。 ※注意事項: ● 特店可透過廠商後台來針對單筆訂單模擬歐買尬金流回傳付款通知,以方便介接 API。 ● 此功能僅只是用於測試 ReturnURL 是否能成功接收,不會改變付款狀態。 ● 只有透過廠商後台的定期定額查詢功能發動的模擬付款通知,歐買尬金流才會傳送此參數,正常由定期定額排程所發送的付款通知,不會傳送此參數。 |
| OrderInfo JSON Object | 訂單資訊 | |
| MerchantTradeNo String(20) | 特店交易編號 | |
| TradeNo String(20) | 歐買尬金流的交易編號 | 請保存歐買尬金流交易編號與特店交易編號 [MerchantTradeNo] 的關聯。 |
| PaymentDate String(20) | 付款時間 | 格式為 yyyy/MM/dd HH:mm:ss |
| TradeAmt Int | 交易金額 | |
| PaymentType String(20) | 特店選擇的付款方式 | |
| TradeDate String(20) | 訂單成立時間 | yyyy/MM/dd HH:mm:ss |
| ChargeFee Number | 手續費 | |
| TradeStatus String(8) | 交易狀態 | 若為 0 時,代表交易訂單成立未付款。若為 1 時,代表交易訂單成立已付款。 |
| 付款方式為 CVS 時,回傳 CVSInfo | ||
| CVSInfo JSON Object | CVS 資訊 | |
| PayFrom String(10) | 繳費超商 | family:全家 ibon:7-11 |
| PaymentNo String(14) | 繳費代碼 | |
| PaymentURL String(100) | 繳費連結 | |
| StoreID String(20) | 超商代碼繳款的店舖代號 | 020328 |
| StoreName String(20) | 超商代碼繳款的店舖名稱 | 台中公民店 |
| 付款方式為 ATM 時,回傳 ATMInfo | ||
| ATMInfo JSON Object | ATM 資訊 | |
| ATMAccBank String(3) | 付款人銀行代碼 | |
| ATMAccNo String(5) | 付款人銀行帳號後五碼 | |
| 付款方式為信用卡或銀聯卡時,回傳 CardInfo | ||
| CardInfo JSON Object | 授權資訊 | |
| 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 | 紅利扣點 | 使用信用卡紅利時回傳 |
| RedDeAmt Int | 紅利折抵金額 | 使用信用卡紅利時回傳 |
| RedOkAmt Int | 實際扣款金額 | 使用信用卡紅利時回傳 |
| RedYet Int | 紅利剩餘點數 | 使用信用卡紅利時回傳 |
| PeriodType String(1) | 週期種類 | 定期定額時回傳,訂單建立時所設定的週期種類 |
| Frequency Int | 執行頻率 | 定期定額時回傳,訂單建立時所設定的執行頻率 |
| ExecTimes Int | 執行次數 | 定期定額時回傳,訂單建立時所設定的執行頻率 |
| PeriodAmount Int | 每次授權金額 | 定期定額時回傳 |
| TotalSuccessTimes Int | 已成功授權次數 | 定期定額時回傳,目前已成功授權的次數。 |
| TotalSuccessAmount Int | 已成功授權金額合計 | 定期定額時回傳 |
| CustomField String(200) | 自訂欄位 | 提供特店使用客制化欄位 |
Data範例(解密後)
json
{
"RtnCode": 1,
"RtnMsg": "Success",
"MerchantID": "1000031",
OrderInfo":
{
"MerchantTradeNo": "test123466",
"TradeNo":"123456789",
"TradeDate": "2020/09/18 15:39:10"
},
"ThreeDInfo":
{
"ThreeDURL": "https://3durl.com.tw"
}
}注意事項:
- 若未正確回應1|OK,系統會隔5~15分鐘後重發訊息給廠商,當天重複發送四次。
- 若廠商持續收到歐買尬金流回傳付款資訊,此時請檢查是否未正確回應
1|OK給歐買尬金流,常見錯誤回傳值為(“1|OK”、1|ok、_OK、1\OK、空白)。 - 若遇消費者已付款,但未收到歐買尬金流回傳付款完成資訊,此時請檢查接收回傳參數的伺服器是否服務正常,導致無法接收。請參考:無法收到歐買尬金流回傳的付款結果通知
- 廠商務必判斷交易狀態[RtnCode]是否為
1,若非1時請勿對該筆交易做出貨動作,並取得交易訊息[RtnMsg] 記錄失敗原因。
應用場景Ⅱ
當訂單是使用信用卡定期定額的交易時,在每次授權成功後,歐買尬金流會傳送付款通知結果
- Step1. 歐買尬金流:第二次授權是由歐買尬金流的排程進行授權,交易授權成功後以 Server POST 方式傳送付款通知至廠商傳送的付款完成通知回傳網址[PeriodReturnURL]。
- Step2. 廠商:收到歐買尬金流的付款通知訊息後,需比對檢查碼是否相符。
注意事項:
- 第一次授權成功時,付款結果參數會回傳到付款完成通知回傳網址ReturnURL,
- 第二次授權成功是由歐買尬金流的排程進行授權,所以從第二次開始的資料,都是回傳到所設定的付款完成通知回傳網址[PeriodReturnURL]
歐買尬金流回傳參數說明
• Accept:text/html
• Content Type:application/json
• HTTP Method:POST
| 參數 / 型態 | 參數名稱 | 說明 |
|---|---|---|
| MerchantID String(10) | 特店編號 | 特店編號 |
| RqHeader JSON | 傳輸資料 | |
| Timestamp Number | 傳輸時間 | 時間戳 Unix timestamp |
| TransCode Int | 回傳代碼 | 1 代表傳輸資料(MerchantID,RqHeader,Data)接收成功,其餘均為失敗 |
| TransMsg String(200) | 回傳訊息 | 回傳訊息 |
| Data String | 加密資料 | 加密過 JSON 格式的資料。加密方法說明 |
範例
json
{
"MerchantID": "1000031",
"RpHeader":
{
"Timestamp": 1234564848
},
"TransCode": 1,
"TransMsg": "Success",
"Data": "…"
}| 參數 / 型態 | 參數名稱 | 說明 |
|---|---|---|
| RtnCode Int | 交易狀態 | 1 代表 API 執行成功,其餘代碼均為失敗。失敗代碼請參考交易訊息代碼表 |
| RtnMsg String(200) | 回應訊息 | |
| 以下為 RtnCode 為 1 時才會回傳 | ||
| PlatformID String(10) | 平台商編號 | 特約合作平台商特店編號。 |
| MerchantID String(10) | 特店編號 | |
| OrderInfo JSON Object | 訂單資訊 | |
| MerchantTradeNo String(20) | 特店交易編號 | |
| TradeNo String(20) | 歐買尬金流的交易編號 | 請保存歐買尬金流交易編號與特店交易編號[MerchantTradeNo]的關聯。 |
| PaymentDate String(20) | 付款時間 | 格式為 yyyy/MM/dd HH:mm:ss |
| TradeAmt Int | 交易金額 | |
| PaymentType String(20) | 特店選擇的付款方式 | |
| TradeDate String(20) | 訂單成立時間 | yyyy/MM/dd HH:mm:ss |
| ChargeFee Number | 手續費 | |
| TradeStatus String(8) | 交易狀態 | 若為 0 時,代表交易訂單成立未付款。若為 1 時,代表交易訂單成立已付款。 |
| CardInfo JSON Object | 授權資訊 | |
| 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 | 紅利扣點 | 使用信用卡紅利時回傳 |
| RedDeAmt Int | 紅利折抵金額 | 使用信用卡紅利時回傳 |
| RedOkAmt Int | 實際扣款金額 | 使用信用卡紅利時回傳 |
| RedYet Int | 紅利剩餘點數 | 使用信用卡紅利時回傳 |
| PeriodType String(1) | 週期種類 | 定期定額時回傳,訂單建立時所設定的週期種類 |
| Frequency Int | 執行頻率 | 定期定額時回傳,訂單建立時所設定的執行頻率 |
| ExecTimes Int | 執行次數 | 定期定額時回傳,訂單建立時所設定的執行頻率 |
| PeriodAmount Int | 訂單建立時的每次要授權金額 | 定期定額時回傳 |
| TotalSuccessTimes Int | 目前已成功授權的次數 | 定期定額時回傳,目前已成功授權的次數。 |
| TotalSuccessAmount Int | 目前已成功授權的金額合計 | 定期定額時回傳 |
| CustomField String(200) | 自訂欄位 | 提供特店使用客制化欄位 |
Data範例(解密後)
json
{
"RtnCode": 1,
"RtnMsg": "Success",
"MerchantID": "1000031",
"OrderInfo":
{
"MerchantTradeNo": "test123466",
"TradeNo":"123456789",
"TradeDate": "2020/09/18 15:39:10"
},
"ThreeDInfo":
{
"ThreeDURL": "https://3durl.com.tw"
}
}注意事項:
- [PeriodReturnURL]每期僅會收到一次通知,如未收到通知,信用卡定期定額訂單查詢 實際授權結果。
- 若遇消費者已付款,但未收到歐買尬金流回傳付款完成資訊,此時請檢查接收回傳參數的伺服器是否服務正常,導致無法接收。
- 廠商務必判斷交易狀態[RtnCode]是否為
1,若非1時請勿對該筆交易做出貨動作,並取得交易訊息[RtnMsg] 記錄失敗原因。
