Scenario
Client-side notification(OrderResultURL)
When a payment is completed, ECPay can also return and redirect the payment result to the OrderResultURL, which is a webpage set by merchants when creating order .
- Step1. ECPay: redirect the payment result to OrderResultURL.
- Step2. Merchant’s webpage (OrderResultURL): receives the notification.
Special note:
- If merchants want to display the payment result on webpage when receiving the notification.
- Be sure to check and determine which page to be displayed based on the status in notifications.
- Since the authorization time varies from banks, if you does not receive the notifications, please call the API (searching order API) to query the order state.
- Please use HTTPS, otherwise some browsers may pop up alert message.
Message format
- Accept ：text/html
- Content Type ：application/x-www-form-urlencoded
- HTTP Method ：POST
Response
ResultData String
Payment result.
Response Example
Parameters in the ResultData (Json format):
MerchantID String(10)
Merchant ID
RpHeader Object
Timestamp Number
Unix timestamp
TransCode Int
Response codes to indicate whether the payload is successfully accepted.
- 1: Payload (i.e. MerchantID, RqHeader, and Data) is successfully accepted by ECPay.
- Others: failed.
TransMsg String(200)
Response message to indicate whether the payload is successfully accepted.
Data String
Payload of JSON that has been encrypted.
ResultData Example (Json format)
Message payload of Data (Json format):
RtnCode Int
Response codes to indicate whether the API is successfully executed or not.
- 1: API is successfully executed.
- Others: failed.
- For more details please see error codes.
RtnMsg String(200)
Response messages.
PlatformID String(10)
MerchantID String(10)
MerchantMemberID String(30)
BindCardID String(64)
Binding Credit Card Code
IsSameCard Bool
Are credit cards repeating their bindings?
OrderInfo Object
Order information
MerchantTradeNo String(20)
Merchant’s order ID
TradeNo String(20)
ECPay’s order ID. Please save this parameter in merchant’s system in order to keep the relation between ECPay’s order ID merchants’ order ID MerchantTradeNo.
TradeAmt Int
Transaction amount
TradeDate String(20)
Time at which the order was created. Format: yyyy/MM/dd HH:mm:ss
PaymentType String(20)
Payment method
PaymentDate String(20)
Date of payment. Format: yyyy/MM/dd HH:mm:ss
ChargeFee Number
ECPay’s service charge
ProcessFee Number
ECPay’s transaction processing fee
TradeStatus String(8)
Status of transaction
CardInfo JSON
AuthCode String(6)
Authorization code. Not returned if using Union Pay card.
Gwsr Int
ID of authorization
ProcessDate String(20)
Date of processing authorization. Format: yyyy/MM/dd HH:mm:ss
Amount Int
Transaction/authorization amount
Eci Int
Return value of 3D (VBV). This is a value returned from the Directory Server (Visa, MasterCard, and JCB) to indicate the authentication results of cardholder’s credit card payment on 3D Secure.
Possible values:
5, 6, 2, 1: The value returned (ECI) means that transaction was a 3D secure authentication.
Card6No String(6)
First 6 digits of credit card
Card4No String(4)
Last 4 digits of credit card
CardValidYY String(2)
Credit Card Expiration Year
CardValidMM String(2)
Credit Card Expiration Month
Stage Int
Number of installments
Stast Int
Amount of down payment
Staed Int
Amount of each period (except for down payment)
CustomField String(200)
A parameter for merchant to place customized value.