Scenario
When the merchant is creating order, if the value of “Required additional payment information” [NeedExtraPaidInfo] is Y, additional parameters will be returned (see table below).
- Step 1. Merchant: When creating an order, if the required additional payment information parameter [NeedExtraPaidInfo] is set to Y.
- Step 2. Merchant: Return the following additional parameters when transmitting the payment results notification and order search to the merchant.
Special Note：all the additional parameter returned must be checked by checksum mechanism. Response Parameter Details:
OPAY’s transaction number for payment using TWQR.
WebATMAccBank String(3)
WebATMAccNo String(5)
Last 5 digits of the payer’s bank account.
If the bank did not provide such information, it will be returned blank.
WebATMBankName String(10)
ATMAccBank String(3)
ATM Payment Bank Code.
If the bank did not provide such information, it will be returned blank.
ATMAccNo String(5)
PaymentNo String(14)
Payment code.
If it is BARCODE, return blank.
PayFrom String(10)
Convenience store payment
- family: FamilyMart
- hilife: Hi-Life
- okmart: OK‧MART
- ibon:7-11
gwsr Int
process_date String(20)
Process Time.
The format is yyyy/MM/dd HH:mm:ss.
auth_code String(6)
Authorization code
amount Int
stage Int
Installment periods
stast Int
Amount of initial installment.
- General installment: first installment amount
- Flexible Installment: First stage installment amount
Special Note：Flexible Installment: If the bank does not return the installment amount, $0 will be returned.
staed Int
- General Installment: Amount of each installment
- Flexible Installment: Second stage installment amount
Special Note：Flexible Installment: If the bank does not return the installment amount, $0 will be returned.
eci Int
card4no String(4)
Special Note：UnionPay card transactions are made by entering the card number information on the bank side, so no card number information will be returned after the payment is made. card6no String(6)
First 6 digits of credit card.
Special Note：UnionPay card transactions are made by entering the card number information on the bank side, so no card number information will be returned after the payment is made. red_dan Int
Bonus points deducted.
red_de_amt Int
Amount deduced from bonus points.
red_ok_amt Int
Actual amount charged.
red_yet Int
Remaining bonus points.
PeriodType String(1)
Type of periods set when order was created.
Frequency Int
Execution frequency set when order was created.
ExecTimes Int
Execution frequency set when order was created.
PeriodAmount Int
Amount per authorization set when order was created.
TotalSuccessTimes Int
Number of successful authorizations to date.
TotalSuccessAmount Int
Amount authorized to date.
YAML
The provided YAML file is used to define information such as the configuration, structure, operations, and infrastructure management of the API, making it easier for developers to understand and use the 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