站內付2.0 API技術文件Web

付款 / 建立交易

應用場景

特店Server需將從特店Web取得到的PayToken，送至綠界Server建立交易。

❗ 注意事項：此 API 需與銀行連線，如遇銀行連線不穩定時可能導致回應時間增加。特店如需設定 API 連線逾時的時間，建議至少 30 秒以上。

API介接網址

  • 測試環境: https://ecpg-stage.ecpay.com.tw/Merchant/CreatePayment
  • 正式環境: https://ecpg.ecpay.com.tw/Merchant/CreatePayment

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)
特店編號 必填

PayToken String(64)
付款代碼 必填

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

必須與取得廠商驗證碼 API 的 MerchantTradeNo相同

Data參數範例(Json格式)

				
					{
    "MerchantID": "3002607",
    "PayToken": "enter your paytoken",
    "MerchantTradeNo": "test123456789"
}

綠界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格式) : 3D驗證

需進行3D驗證時，回傳以下參數

RtnCode Int
交易狀態

1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。

RtnMsg String(200)
回應訊息

PlatformID String(10)
平台商編號

MerchantID String(10)
特店編號

OrderInfo Object
訂單資訊 

MerchantTradeNo String(20)
特店交易編號 

ThreeDInfo JSON
3D驗證資訊 

ThreeDURL String(200)
3D驗證網址 

❗ 注意事項：3D驗證連結，請勿使用 iframe 方式開啟

Data參數說明(Json格式) : 銀聯卡

需進行銀聯卡驗證時，回傳以下參數

RtnCode Int
交易狀態

1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。

RtnMsg String(200)
回應訊息

PlatformID String(10)
平台商編號

MerchantID String(10)
特店編號

OrderInfo Object
訂單資訊 

MerchantTradeNo String(20)
特店交易編號 

UnionPayInfo Object
銀聯卡驗證資訊 

UnionPayURL String(200)
銀聯卡驗證網址 

❗ 注意事項：

  • 銀聯卡驗證連結，請勿使用 iframe 方式開啟
  • 測試環境提供的驗證網址為綠界模擬測試頁面

Data參數說明(Json格式) : 不需要3D、銀聯卡驗證

當付款方式為信用卡一次付清、定期定額、分期付款且不需要進行3D或銀聯卡驗證時，將直接回傳以下授權結果

RtnCode Int
交易狀態

1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。

RtnMsg String(200)
回應訊息

PlatformID String(10)
平台商編號

MerchantID String(10)
特店編號

OrderInfo Object
訂單資訊 

MerchantTradeNo String(20)
特店交易編號 

TradeNo String(20)
綠界交易編號 

TradeAmt Int
交易金額 

TradeDate String(20)
訂單成立時間 

格式為 yyyy/MM/dd HH:mm:ss

PaymentType String(20)
付款方式 

PaymentDate String(20)
付款時間 

格式為 yyyy/MM/dd HH:mm:ss

ChargeFee Number
手續費 

TradeStatus String(8)
交易狀態 

CardInfo Object
信用卡授權資訊 

AuthCode String(6)
銀行授權碼 

Gwsr Int
授權交易單號 

ProcessDate String(20)
交易時間 

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
目前已成功授權的金額合計 

定期定額時回傳

IssuingBank String(30)
銀行名稱 

IssuingBankCode String(10)
銀行代碼 

CustomField String(200)
自訂欄位 

提供特店使用客制化欄位

Data參數說明(Json格式) : ATM

當付款方式為 ATM 時，將回傳以下參數

RtnCode Int
交易狀態

1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。

RtnMsg String(200)
回應訊息

PlatformID String(10)
平台商編號

MerchantID String(10)
特店編號

OrderInfo Object
訂單資訊 

MerchantTradeNo String(20)
特店交易編號 

TradeNo String(20)
綠界交易編號 

TradeAmt Int
交易金額 

TradeDate String(20)
訂單成立時間 

格式為 yyyy/MM/dd HH:mm:ss

PaymentType String(20)
付款方式 

PaymentDate String(20)
付款時間 

格式為 yyyy/MM/dd HH:mm:ss

ChargeFee Number
手續費 

TradeStatus String(8)
交易狀態 

ATMInfo Object
ATM資訊 

BankCode String(3)
繳費銀行代碼 

vAccount String(16)
繳費虛擬帳號 

ExpireDate String(10)
繳費期限 

格式為 yyyy/MM/dd

CustomField String(200)
自訂欄位 

Data參數說明(Json格式) : 超商代碼

當付款方式為超商代碼時，將回傳以下參數

RtnCode Int
交易狀態

1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。

RtnMsg String(200)
回應訊息

PlatformID String(10)
平台商編號

MerchantID String(10)
特店編號

OrderInfo Object
訂單資訊 

MerchantTradeNo String(20)
特店交易編號 

TradeNo String(20)
綠界交易編號 

TradeAmt Int
交易金額 

TradeDate String(20)
訂單成立時間 

格式為 yyyy/MM/dd HH:mm:ss

PaymentType String(20)
付款方式 

PaymentDate String(20)
付款時間 

格式為 yyyy/MM/dd HH:mm:ss

ChargeFee Number
手續費 

TradeStatus String(8)
交易狀態 

CVSInfo Object
超商代碼資訊 

PaymentNo String(14)
繳費代碼 

ExpireDate String(20)
繳費期限 

格式為 yyyy/MM/dd HH:mm:ss

PaymentURL String(100)
繳費連結 

由綠界科技提供手機上顯示的三段式繳費條碼網頁

CustomField String(200)
自訂欄位 

提供特店使用客制化欄位

Data參數說明(Json格式) : 超商條碼資訊

當付款方式為超商條碼時，將回傳以下參數

RtnCode Int
交易狀態

1 代表 API 執行成功，其餘代碼均為失敗，失敗代碼請參考交易訊息代碼表。

RtnMsg String(200)
回應訊息

PlatformID String(10)
平台商編號

MerchantID String(10)
特店編號

OrderInfo Object
訂單資訊 

MerchantTradeNo String(20)
特店交易編號 

TradeNo String(20)
綠界交易編號 

TradeAmt Int
交易金額 

TradeDate String(20)
訂單成立時間 

格式為 yyyy/MM/dd HH:mm:ss

PaymentType String(20)
付款方式 

PaymentDate String(20)
付款時間 

格式為 yyyy/MM/dd HH:mm:ss

ChargeFee Number
手續費 

TradeStatus String(8)
交易狀態 

BarcodeInfo Object
超商條碼資訊 

回傳只有三段號碼，並不會回傳條碼圖，需自行轉換成 code39 的三段條碼

ExpireDate String(20)
繳費期限 

格式為 yyyy/MM/dd HH:mm:ss

Barcode1 String(20)
條碼第一段號碼 

格式為9碼數字

Barcode2 String(20)
條碼第二段號碼 

格式為16碼數字

Barcode3 String(20)
條碼第三段號碼 

格式為15碼數字

CustomField String(200)
自訂欄位 

提供特店使用客制化欄位

Data參數範例(Json格式)： ※範例以【3D驗證】回傳結果為例

				
					{
    "RtnCode": 1,
    "RtnMsg": "Success",
    "PlatformID": "1234567890",
    "MerchantID": "1234567890",
    "OrderInfo": {
        "MerchantTradeNo": "test123466"
    },
    "ThreeDInfo": {
        "ThreeDURL": "https://3durl.com.tw"
    }
}

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

綠界官方網站