Skip to content

信用卡定期定額

信用卡定期定額查詢(Server)

應用場景

提供查詢信用卡定期定額明細記錄。

介接路徑

廠商傳入參數說明:(JSON 格式,名稱前若有紅色星號*必填欄位):

  • Content Type:application/json
  • HTTP Method:POST
參數 / 型態參數名稱說明
*MerchantID
String(10)
特店編號請填入由歐買尬金流提供的特店編號
*RqHeader
JSON
傳輸資料 
*Timestamp
Number
傳輸時間時間戳 Unix timestamp

※注意事項:
若時間戳跟歐買尬金流伺服器接收到時間超過 10 分鐘時,交易會失敗無法進行
*Revision
String(10)
串接版號請參考 系統介接測試相關資訊的串接版號 。例:1.0.0
*Data
String
加密資料加密過 JSON 格式的資料。加密方法說明

範例

json
{
  "MerchantID": "1000031", 
  "RqHeader": 
  {
    "Timestamp": 1234567890,
    "Revision": "1.0.0"
  },
  "Data": "…"
}

Data參數說明:請在加密前對參數值進行 URLEncode

參數 / 型態參數名稱說明
PlatformID
String(10)
特約合作平台商代號為專案合作的平台商使用。此參數請帶空值。
*MerchantID
String(10)
特店編號 
*MerchantTradeNo
String(20)
特店交易編號 

Data範例

json
{
  "MerchantID": "1000031", 
  "PlatformID":  "1000031",
  "Data": "…"
}

### 歐買尬金流回傳參數說明:(JSON 格式)

參數 / 型態參數名稱說明
MerchantID
String(10)
特店編號 
RqHeader
JSON
傳輸資料 
Timestamp
Number
傳輸時間時間戳 Unix timestamp

※注意事項:
若時間戳跟歐買尬金流伺服器接收到時間超過 10 分鐘時,交易會失敗無法進行
TransCode
Int
回傳代碼1 代表傳輸資料(MerchantID,RqHeader,Data)接收成功,其餘均為失敗
TransMsg
String(200)
回傳訊息回傳訊息
Data
String
加密資料加密過 JSON 格式的資料。加密方法說明

範例

json
{
    "MerchantID": "1000031", 
    "RpHeader": 
    {
        "Timestamp": 1234564848
    },
    "TransCode": 1,
    "TransMsg": "成功",
    "Data": "…"
}

Data參數說明:請在解密後對參數值進行 URLDecode

參數 / 型態參數名稱說明
RtnCode
Int
交易狀態1 代表 API 執行成功,其餘代碼均為失敗。
RtnMsg
String(200)
回應訊息 
以下為 RtnCode 為 1 時才會回傳
PlatformID
String(10)
平台商編號特約合作平台商特店編號。
MerchantID
String(10)
特店編號 
OrderInfo
JSON Object
訂單資訊此欄位顯示為定期定額的第一筆資料,第二筆之後的資料為 ExecLog
MerchantTradeNo
String(20)
特店交易編號 
TradeNo
String(20)
歐買尬金流的交易編號 
TradeAmt
Int
交易金額 
TradeDate
String(20)
訂單成立時間yyyy/MM/dd HH:mm:ss
PaymentType
String(20)
特店選擇的付款方式Credit/CVS/ATM
PaymentDate
String(20)
付款時間格式為 yyyy/MM/dd HH:mm:ss
ChargeFee
Number
手續費 
TradeStatus
String(8)
交易狀態若為 0 時,代表交易訂單成立未付款。
若為 1 時,代表交易訂單成立已付款。
ExecStatus
String(1)
執行狀態回傳值如下:
1. 若為 0 時代表已取消
2. 若為 1 時代表執行中
3. 若為 2 時代表執行完成
ExecLog
Array
每次授權明細每一次的授權紀錄。
例如,若已成功授權 3 次 (TotalSuccessTimes 為 3),則會顯示 3 筆授權紀錄。
RtnCode
Int
交易狀態若回傳值時為 1 時代表授權成功,其餘為失敗,失敗代碼請參考交易訊息代碼一覽表
Amount
Int
授權金額 
Gwsr
Int
授權交易單號 
ProcessDate
String(20)
授權成功處理時間格式為 yyyy/MM/dd HH:mm:ss
AuthCode
String(6)
授權碼 
TradeNo
String(20)
歐買尬的交易編號請保存歐買尬的交易編號與特店交易編號 [MerchantTradeNo] 的關聯。
ChargeFee
Number
手續費格式為整數 8 位,小數 2 位
CardInfo
JSON Object
授權資訊 
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)
信用卡卡號末四碼 
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": "20180914001",
        "TradeNo": "1809261503338172",
        "TradeAmt": 55,
        "PaymentType": "Credit",
        "PaymentDate": "2022/04/25 15:48:38",
        "TradeDate" :"2022/04/25 15:48:38",
        "TradeStatus": "1",
        "ChargeFee": 2.013
    },
    "CustomField": "",
    "ExecStatus": "1",
        "ExecLog": [
            {
                "RtnCode": 1,
                "Amount": 55,
                "Gwsr": 10705560,
                "ProcessDate": "2022/04/25 15:48:38",
                "AuthCode": "432540",
                "TradeNo": "2204251548338091",
                "ChargeFee": 0.0
            },
            {
                "RtnCode": 1,
                "Amount": 55,
                "Gwsr": 10705572,
                "ProcessDate": "2022/04/26 08:03:05",
                "AuthCode": "492894",
                "TradeNo": "20220426080305791468",
                "ChargeFee": 0.0
            },
            {
                "RtnCode": 0,
                "Amount": 0,
                "Gwsr": 0,
                "ProcessDate": "2022/04/27 08:02:49",
                "AuthCode": null,
                "TradeNo": "20220427080249393874",
                "ChargeFee": 0.0
            },
            {
                "RtnCode": 1,
                "Amount": 55,
                "Gwsr": 10705594,
                "ProcessDate": "2022/04/28 08:02:43",
                "AuthCode": "011331",
                "TradeNo": "202204280802434e-005",
                "ChargeFee": 0.0
            }
    ],
    "CardInfo": 
    {
        "PeriodType": "D",
        "Frequency": 1,
        "ExecTimes": 55,
        "PeriodAmount": 55,
        "TotalSuccessTimes": 3,
        "TotalSuccessAmount": 165,
        "AuthCode": "432540",
        "Gwsr": 10705560,
        "ProcessDate": "2022/04/25 15:48:38",
        "Amount": 55,
        "Eci": 7,
        "Card6No": "414763",
                "Card4No": "8405"
    }
}

信用卡定期定額訂單作業(Server)

應用場景

提供特店執行信用卡定期定額訂單交易作業 。

  • ReAuth:最新一筆定期定額交易授權失敗時,可發動進行補授權作業。
  • Cancel:停用本筆定期定額後續授權交易作業。

介接路徑

廠商傳入參數說明:(JSON 格式,名稱前若有紅色星號*必填欄位):

  • Content Type:application/json
  • HTTP Method:POST
參數 / 型態參數名稱說明
*MerchantID
String(10)
特店編號請填入由歐買尬金流提供的特店編號
*RqHeader
JSON
傳輸資料 
*Timestamp
Number
傳輸時間時間戳 Unix timestamp

※注意事項:
若時間戳跟歐買尬金流伺服器接收到時間超過 10 分鐘時,交易會失敗無法進行
*Revision
String(10)
串接版號請參考 系統介接測試相關資訊的串接版號 。例:1.0.0
*Data
String
加密資料加密過 JSON 格式的資料。加密方法說明

範例

json
{
    "MerchantID": "1000031", 
    "RqHeader": 
    {
        "Timestamp": 1234567890,
        "Revision": "1.0.0"
    },
    "Data": "…"
}

Data參數說明:請在加密前對參數值進行 URLEncode

參數 / 型態參數名稱說明
PlatformID
String(10)
特約合作平台商代號為專案合作的平台商使用。此參數請帶空值。
*MerchantID
String(10)
特店編號 
*MerchantTradeNo
String(20)
特店交易編號 
*Action
String(20)
作業方式ReAuth:補授權失敗交易
Cancel:停用定期定額後續交易

※ 注意事項:

  1. 定期訂額信用卡補授權作業,限當筆交易最新一筆授權失敗時才能使用。例如 : 第二期授權失敗,但第三期成功時,此時無法授權第二期失敗的交易。
  2. 停用交易成功後,無法重新啟用,只能重新發動新定期定額訂單進行交易。

Data範例

json
{
    "MerchantID": "1000031", 
    "PlatformID":  "",
    "MerchantTradeNo":"123486456",
    "Action":"ReAuth"
}

### 歐買尬金流回傳參數說明:(JSON 格式)

參數 / 型態參數名稱說明
MerchantID
String(10)
特店編號 
RqHeader
JSON
傳輸資料 
Timestamp
Number
傳輸時間時間戳 Unix timestamp

※注意事項:
若時間戳跟歐買尬金流伺服器接收到時間超過 10 分鐘時,交易會失敗無法進行
TransCode
Int
回傳代碼1 代表傳輸資料(MerchantID,RqHeader,Data)接收成功,其餘均為失敗
TransMsg
String(200)
回傳訊息回傳訊息
Data
String
加密資料加密過 JSON 格式的資料。加密方法說明

範例

json
{
    "MerchantID": "1000031", 
    "RpHeader": 
    {
        "Timestamp": 1234564848
    },
    "TransCode": 1,
    "TransMsg": "成功",
    "Data": "…"
}

Data參數說明:請在解密後對參數值進行 URLDecode

參數 / 型態參數名稱說明
RtnCode
Int
交易狀態1 代表 API 執行成功,其餘代碼均為失敗。
RtnMsg
String(200)
回應訊息 
以下為 RtnCode 為 1 時才會回傳
PlatformID
String(10)
平台商編號 
MerchantID
String(10)
特店編號 
MerchantTradeNo
String(20)
特店交易編號 

Data解密後

json
{
    "RtnCode": 1,
    "RtnMsg":"Success",
    "MerchantID":"1000031",
    "MerchantTradeNo": "1234567890"
}