應用場景
特店在產生訂單時，若是否需要額外的付款資訊[NeedExtraPaidInfo]為Y時，將增加回傳額外參數。
- Step 1. 特店：產生訂單時，設定是否需要額外的付款資訊[NeedExtraPaidInfo]為Y時。
- Step 2. 綠界：傳送付款結果通知與查詢訂單時會額外回傳以下參數給特店
注意事項：額外回傳的參數全部都需要加入檢查碼計算。
綠界回傳參數說明
AlipayID String(10)
付款人在支付寶的系統編號
目前已無提供此付款方式
AlipayTradeNo String(20)
支付寶交易編號
目前已無提供此付款方式
TenpayTradeNo String(20)
財付通交易編號
目前已無提供此付款方式
TWQRTradeNo String(64)
行動支付交易編號
若付款方式為行動支付TWQR時才回傳
WebATMAccBank String(3)
付款人銀行代碼
若該銀行未提供，則回傳空白
WebATMAccNo String(5)
付款人銀行帳號後五碼
若該銀行未提供，則回傳空白
WebATMBankName String(10)
銀行名稱
請參考付款方式一覽表
ATMAccBank String(3)
付款人銀行代碼
若該銀行未提供，則回傳空白
ATMAccNo String(5)
付款人銀行帳號後五碼
若該銀行未提供，則回傳空白
PaymentNo String(14)
繳費代碼
BARCODE則回傳空白
PayFrom String(10)
繳費超商
- family：全家
- hilife：萊爾富
- okmart：OK超商
- ibon：7-11
gwsr Int
授權交易單號
此參數值與查詢信用卡明細的CreditRefundID相同。
process_date String(20)
處理時間
格式為yyyy/MM/dd HH:mm:ss
auth_code String(6)
授權碼
amount Int
金額
stage Int
分期期數
stast Int
頭期金額
- 一般分期：頭期金額
- 圓夢彈性分期：第一階段各期金額
注意事項：圓夢彈性分期：若銀行未回傳分期金額時，會回傳0元
staed Int
各期金額
- 一般分期：各期金額
- 圓夢彈性分期：第二階段各期金額
注意事項：圓夢彈性分期：若銀行未回傳分期金額時，會回傳0元
eci Int
3D(VBV)
回傳值(eci=5,6,2,1 代表該筆交易3D交易)
card4no String(4)
卡片的末4碼
注意事項：銀聯卡交易是於銀行端輸入卡號資訊，故付款完成後不會有卡號資料的回傳。
card6no String(6)
卡片的前6碼
注意事項：銀聯卡交易是於銀行端輸入卡號資訊，故付款完成後不會有卡號資料的回傳。
red_dan Int
紅利扣點
red_de_amt Int
紅利折抵金額
red_ok_amt Int
實際扣款金額
red_yet Int
紅利剩餘點數
PeriodType String(1)
訂單建立時的所設定的週期種類
Frequency Int
訂單建立時的所設定的執行頻率
ExecTimes Int
訂單建立時的所設定的執行頻率
PeriodAmount Int
訂單建立時的每次要授權金額
TotalSuccessTimes Int
目前已成功授權的次數
TotalSuccessAmount Int
目前已成功授權的金額合計
YAML
提供的 YAML 文件用於定義 API 的配置、結構、操作和基礎設施管理等資訊，方便開發人員理解和使用 API。
openapi: 3.1.0
info:
title: ECPay Additional Returned Parameters API
version: 1.0.0
servers:
- url: ReturnUrl
description: Production Environment
- url: ReturnUrl
description: Testing Environment
paths:
/payment/Result:
post:
summary: Additional Returned Parameters
description: Notify the merchant of additional payment information.
requestBody:
required: true
content:
html/text:
schema:
type: object
properties:
AlipayID:
type: string
maxLength: 10
description: Payee's system number in Alipay
AlipayTradeNo:
type: string
maxLength: 20
description: Alipay transaction number
TenpayTradeNo:
type: string
maxLength: 20
description: Tenpay transaction number
TWQRTradeNo:
type: string
maxLength: 64
description: Mobile payment transaction number. Returned only when the payment method is TWQR.
WebATMAccBank:
type: string
maxLength: 3
description: Payer's bank code for WebATM
WebATMAccNo:
type: string
maxLength: 5
description: Last five digits of the payer's bank account for WebATM
WebATMBankName:
type: string
maxLength: 10
description: Bank name
ATMAccBank:
type: string
maxLength: 3
description: Payer's bank code for ATM
ATMAccNo:
type: string
maxLength: 5
description: Last five digits of the payer's bank account for ATM
PaymentNo:
type: string
maxLength: 14
description: Payment code
PayFrom:
type: string
maxLength: 10
description: Payment store
enum: [family, hilife, okmart, ibon]
gwsr:
type: integer
description: Authorization transaction number. This parameter value is the same as CreditRefundID in credit card details query.
process_date:
type: string
maxLength: 20
format: date-time
description: Processing time
auth_code:
type: string
maxLength: 6
description: Authorization code
amount:
type: integer
description: Amount
stage:
type: integer
description: Number of installments
stast:
type: integer
description: Initial payment amount
staed:
type: integer
description: Subsequent payment amount
eci:
type: integer
description: 3D (VBV) return value (eci=5,6,2,1 represents 3D transaction)
card4no:
type: string
maxLength: 4
description: Last 4 digits of the card
card6no:
type: string
maxLength: 6
description: First 6 digits of the card
red_dan:
type: integer
description: Bonus point deduction
red_de_amt:
type: integer
description: Bonus redemption amount
red_ok_amt:
type: integer
description: Actual deduction amount
red_yet:
type: integer
description: Remaining bonus points
PeriodType:
type: string
maxLength: 1
description: Period type set when the order is created
Frequency:
type: integer
description: Execution frequency set when the order is created
ExecTimes:
type: integer
description: Execution frequency set when the order is created
PeriodAmount:
type: integer
description: Authorization amount per time set when the order is created
TotalSuccessTimes:
type: integer
description: Total number of successful authorizations at present
TotalSuccessAmount:
type: integer
description: Total amount of successful authorizations at present
responses:
'200':
description: Success
content:
text/plain:
schema:
type: string
example: 1|OK
'400':
description: Invalid request
'500':
description: Server error