信用卡定期定額
信用卡定期定額訂單查詢
應用場景
特店進行信用卡定期定額訂單查詢作業，可查詢每一次的授權明細。
Step1. 特店：以Server POST方式傳送以下參數至API網址。
Step2. 歐買尬金流：接受並檢核正確後，回傳信用卡定期定額訂單資訊。
介接路徑
- 正式環境：https://payment.funpoint.com.tw/Cashier/QueryCreditCardPeriodInfo
- 測試環境：https://payment-stage.funpoint.com.tw/Cashier/QueryCreditCardPeriodInfo
特店傳入參數說明 (名稱前若有紅色星號*為必填欄位)：
- Content Type：application/x-www-form-urlencoded
- HTTP Method：POST
| 參數/型態 | 參數名稱 | 說明 |
|---|---|---|
| *MerchantID String(10) | 特店編號 | |
| PlatformID String(10) | 特約合作平台商代號(由歐買尬金流提供) | 為專案合作的平台商使用。一般特店或平台商本身介接，則參數請帶放空值。若為專案合作平台商的特店使用時，則參數請帶平台商所綁的特店編號[MerchantID]。 |
| *MerchantTradeNo String(20) | 特店交易編號 | 訂單產生時傳送給歐買尬金流的特店交易編號。 |
| *TimeStamp String(20) | 驗證時間 | 將當下的時間轉為 UnixTimeStamp (見範例)用於驗證此次介接的時間區間。 歐買尬金流驗證時間區間暫訂為 3 分鐘內有效，超過則此次介接無效。 參考資料： https://www.epochconverter.com/ |
| *CheckMacValue String | 檢查碼 | 請參考附錄檢查碼機制與產生檢查碼範例程式。 |
歐買尬金流回傳參數說明：
查詢結果會直接回傳至頁面，並以JSON格式表示。
回傳範例（為方便說明，以下的回傳範例經過排版）：
json
{
"MerchantID":"1050123",
"MerchantTradeNo":"FunPoint1234",
"TradeNo":"20140721173014442498",
"RtnCode":1,
"PeriodType":"D",
"Frequency":1,
"ExecTimes":12,
"PeriodAmount":1000,
"amount":1000,
"gwsr":24548751,
"process_date":"2014/07/21 17:35:45",
"auth_code":"237523",
"card4no":"2369",
"card6no":"523782",
"TotalSuccessTimes":3,
"TotalSuccessAmount":3000,
"ExecStatus":"1",
"ExecLog":
[
{"RtnCode":1,"amount":1000,"gwsr":24548751,"process_date":"2014/07/21
17:35:45","auth_code":"237523","TradeNo":"20140721173014442498"},
{"RtnCode":1,"amount":1000,"gwsr":24549277,"process_date":"2014/07/22
01:12:30","auth_code":"185279","TradeNo":"20140722011230346534"},
{"RtnCode":1,"amount":1000,"gwsr":24552639,"process_date":"2014/07/23
01:12:25","auth_code":"693851","TradeNo":"20140723011225646424"}
]
}回傳的JSON可分為「（一）主要授權資訊」、「（二）定期定額授權明細」二部分。
分別說明如下：
（一）主要授權資訊（下方範例所框選部分）：
{
"MerchantID":"1050123",
"MerchantTradeNo":"FunPoint1234",
"TradeNo":"20140721173014442498",
"RtnCode":1,
"PeriodType":"D",
"Frequency":1,
"ExecTimes":12,
"PeriodAmount":1000,
"amount":1000,
"gwsr":24548751,
"process_date":"2014/07/21 17:35:45",
"auth_code":"237523",
"card4no":"2369",
"card6no":"523782",
"TotalSuccessTimes":3,
"TotalSuccessAmount":3000,
"ExecStatus":"1",
"MerchantTradeNo":"FunPoint1234",
"TradeNo":"20140721173014442498",
"RtnCode":1,
"PeriodType":"D",
"Frequency":1,
"ExecTimes":12,
"PeriodAmount":1000,
"amount":1000,
"gwsr":24548751,
"process_date":"2014/07/21 17:35:45",
"auth_code":"237523",
"card4no":"2369",
"card6no":"523782",
"TotalSuccessTimes":3,
"TotalSuccessAmount":3000,
"ExecStatus":"1",
"ExecLog":
[
{"RtnCode":1,"amount":1000,"gwsr":24548751,"process_date":"2014/07/21
17:35:45","auth_code":"237523","TradeNo":"20140721173014442498"},
{"RtnCode":1,"amount":1000,"gwsr":24549277,"process_date":"2014/07/22
01:12:30","auth_code":"185279","TradeNo":"20140722011230346534"},
{"RtnCode":1,"amount":1000,"gwsr":24552639,"process_date":"2014/07/23
01:12:25","auth_code":"693851","TradeNo":"20140723011225646424"}
]
}
主要授權資訊之參數說明：
| 參數/型態 | 參數名稱 | 說明 |
|---|---|---|
| MerchantID String(10) | 特店編號 | |
| MerchantTradeNo String(20) | 特店交易編號 | 訂單產生時傳送給歐買尬金流的特店交易編號。 |
| TradeNo String(20) | 歐買尬金流的交易編號 | 首次授權所產生的歐買尬金流交易編號 |
| RtnCode Int | 交易狀態 | 回傳值為 1 時代表授權成功，其餘為失敗，失敗代碼請參考交易訊息代碼一覽表 |
| PeriodType String(1) | 週期種類 | 訂單建立時所設定的週期種類 |
| Frequency Int | 執行頻率 | 訂單建立時所設定的執行頻率 |
| ExecTimes Int | 執行次數 | 訂單建立時所設定的執行次數 |
| PeriodAmount Int | 每次授權金額 | 訂單建立時的每次要授權金額 |
| amount Int | 授權金額 | 所授權的金額 |
| gwsr Int | 授權交易單號 | 所授權的交易單號 |
| process_date String(20) | 授權成功處理時間 | 格式為 yyyy/MM/dd HH:mm:ss |
| auth_code String(6) | 授權碼 | |
| card4no String(4) | 卡片的末 4 碼 | 卡片的末四碼 |
| card6no String(6) | 卡片的前 6 碼 | 卡片的前六碼 |
| TotalSuccessTimes Int | 已成功授權次數合計 | 目前已成功授權的次數 |
| TotalSuccessAmount Int | 已成功授權總金額 | 目前已成功授權的金額合計 |
| ExecStatus String(1) | 執行狀態 | 回傳值如下： 1. 若為 0 代表已取消2. 若為 1 代表執行中3. 若為 2 代表執行完成 |
| ExecLog Array | 每次授權明細 | 每一次的授權紀錄。 例如，若已成功授權 3 次 (TotalSuccessTimes 為 3)，則會顯示 3 筆授權紀錄。 欄位內容詳見下列定期定額授權明細之參數說明。 |
（二）定期定額授權明細（下方範例所框選部分）：
{ "MerchantID":"1050123",
"MerchantTradeNo":"FunPoint1234",
"TradeNo":"20140721173014442498",
"RtnCode":1,
"PeriodType":"D",
"Frequency":1,
"ExecTimes":12,
"PeriodAmount":1000,
"amount":1000,
"gwsr":24548751,
"process_date":"2014/07/21 17:35:45",
"auth_code":"237523",
"card4no":"2369",
"card6no":"523782",
"TotalSuccessTimes":3,
"TotalSuccessAmount":3000,
"ExecStatus":"1",
"ExecLog":
[
{"RtnCode":1,"amount":1000,"gwsr":24548751,"process_date":"2014/07/21
17:35:45","auth_code":"237523","TradeNo":"20140721173014442498"},
{"RtnCode":1,"amount":1000,"gwsr":24549277,"process_date":"2014/07/22
01:12:30","auth_code":"185279","TradeNo":"20140722011230326435"},
]
} [
{"RtnCode":1,"amount":1000,"gwsr":24548751,"process_date":"2014/07/21
17:35:45","auth_code":"237523","TradeNo":"20140721173014442498"},
{"RtnCode":1,"amount":1000,"gwsr":24549277,"process_date":"2014/07/22
01:12:30","auth_code":"185279","TradeNo":"20140722011230326435"},
]
定期定額授權明細之參數說明：
| 參數/型態 | 參數名稱 | 說明 |
|---|---|---|
| RtnCode Int | 交易狀態 | 若回傳值時為 1 時代表授權成功，其餘為失敗，失敗代碼請參考交易訊息代碼一覽表 |
| amount Int | 授權金額 | 所授權的金額 |
| gwsr Int | 授權交易單號 | 所授權的交易單號 |
| process_date String(20) | 授權成功處理時間 | 格式為 yyyy/MM/dd HH:mm:ss |
| auth_code String(6) | 授權碼 | |
| TradeNo String(20) | 歐買尬金流的交易編號 | 請保存歐買尬金流的交易編號與特店交易編號[MerchantTradeNo]的關連。 |
信用卡定期定額訂單作業
應用場景
特店進行信用卡定期定額訂單交易作業。
- Cancel：停用本筆定期定額後續授權交易作業。 Step1. 特店：以Server POST方式傳送以下參數至API網址。
Step2. 歐買尬金流：接受並檢核正確後，回傳信用卡定期定額作業結果。
介接路徑
- 正式環境：https://payment.funpoint.com.tw/Cashier/CreditCardPeriodAction
- 測試環境：https://payment-stage.funpoint.com.tw/Cashier/CreditCardPeriodAction
特店傳入參數說明 (名稱前若有紅色星號*為必填欄位)：
- Content Type：application/x-www-form-urlencoded
- HTTP Method：POST
| 參數/型態 | 參數名稱 | 說明 |
|---|---|---|
| *MerchantID String(10) | 特店編號 | |
| PlatformID String(10) | 特約合作平台商代號 (由歐買尬金流提供) | 為專案合作的平台商使用。一般特店或平台商本身介接，則參數請帶放空值。若為專案合作平台商的特店使用時，則參數請帶平台商所綁的特店編號[MerchantID]。 |
| *MerchantTradeNo String(20) | 特店交易編號 | 訂單產生時傳送給歐買尬金流的特店交易編號。 |
| *Action String(20) | 作業類型 | Cancel：停用定期定額後續交易 |
| *TimeStamp Int | 驗證時間 | 將當下的時間轉為 UnixTimeStamp (見範例)用於驗證此次介接的時間區間。 歐買尬金流驗證時間區間暫訂為 3 分鐘內有效，超過則此次介接無效。 參考資料 ： http://www.epochconverter.com/ |
| *CheckMacValue String | 檢查碼 | 請參考附錄檢查碼機制與產生檢查碼範例程式。 |
注意事項：
停用交易成功後，無法重新啟用，只能重新發動新定期定額訂單進行交易。
歐買尬金流回傳參數說明：
- Content Type：application/x-www-form-urlencoded
- HTTP Method：POST
| 參數/型態 | 參數名稱 | 說明 |
|---|---|---|
| RtnCode Int | 交易狀態 | 回傳值為 1 時代表授權成功，其餘為失敗。 |
| RtnMsg String(200) | 交易訊息 | 交易訊息 |
| MerchantID String(10) | 特店編號 | |
| MerchantTradeNo String(20) | 特店交易編號 | 訂單產生時傳送給歐買尬金流的特店交易編號。 |
| CheckMacValue String | 檢查碼 | 特店必須檢查檢查碼 [CheckMacValue] 來驗證，請參考附錄檢查碼機制 |
注意事項：
特店務必判斷檢查碼[CheckMacValue]是否正確，以及是否已經對該筆訂單的付款通知，做過相對應的處理，以免造成交易狀態無法同步的損失。