信用卡定期定額訂單作業

應用場景

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

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


Step 1. 特店:以幕後方式傳送以下參數至API網址。

Step 2. 綠界:接受並檢核正確後,回傳信用卡定期定額作業結果。

API介接網址

  • 測試環境:https://ecpayment-stage.ecpay.com.tw/1.0.0/Cashier/CreditCardPeriodAction
  • 正式環境:https://ecpayment.ecpay.com.tw/1.0.0/Cashier/CreditCardPeriodAction

HTTPS 傳輸協定

  • Content Type:application/json
  • HTTP Method:POST

特店Request參數說明 (Json格式)

MerchantID String(10)
特店編號 必填

RqHeader Object
傳輸資料 必填

Timestamp Number
傳輸時間 必填

請將傳輸時間轉換為時間戳(GMT+8),綠界會利用此參數將當下的時間轉為 Unix TimeStamp 來驗證此次介接的時間區間。

❗ 注意事項
  • 驗證時間區間為 10 分鐘內有效,若超過此驗證時間則此次訂單將無法建立,產生時間戳請參考相關資料
  • 合作特店須進行主機「時間校正」,避免主機產生時差,導致API無法正常運作。

Data String
加密資料 必填

此參數為加密過的 JSON 格式資料,加密方式請參考說明

特店Request參數範例 (Json格式)

				
					{
    "MerchantID": "3002607",
    "RqHeader": {
        "Timestamp": 1234567890
    },
    "Data": "enter your data"
}
				
			

Data參數說明(Json格式)

❗ 注意事項:請在加密前對參數值進行 URLEncode

PlatformID String(10)
特約合作平台商代號 

  • 為專案合作的平台商使用
  • 一般特店或平台商本身介接,則參數請帶空值
  • 專案合作平台商的特店使用時,參數請帶平台商所綁的特店編號 MerchantID

❗ 注意事項:如果有帶入此參數,則外層MerchantID必須與PlatformID帶入相同值。

MerchantID String(10)
特店編號 必填

MerchantTradeNo String(20)
特店交易編號 必填

Action String(20)
作業方式 

  • ReAuth:補授權失敗交易(該功能於測試環境中無法使用)
  • Cancel:停用定期定額後續交易

❗ 注意事項:

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

Data參數範例(Json格式)

				
					{
    "MerchantID": "3002607",
    "PlatformID": "2000132",
    "MerchantTradeNo": "123486456",
    "Action": "ReAuth"
} 

				
			

綠界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)
特店編號

MerchantTradeNo String(20)
特店交易編號

Data參數範例(Json格式)

				
					{
    "RtnCode": 1,
    "RtnMsg": "Success",
    "PlatformID": "1234567890",
    "MerchantID": "1234567890",
    "MerchantTradeNo": "123456789014"
}
				
			

Copyright © Green World FinTech Service Co., Ltd. All rights reserved.

綠界官方網站