Results / ATM, CVS, or BARCODE Code Retrieval Notification

Scenario

Server Site Post (PaymentInfoURL)
After an order with payment methods ATM / CVS / BARCODE has been created to the user, the merchant will receive the order result from ECPay and response the parameter details.

  • Step1. ECPay : The code (virtual account number) retrieval results message will be transmitted via ServerPost to the merchant’s server URL [PaymentInfoURL]
  • Step2. Merchant: Upon receiving the code retrieval message from ECPay , check and verify whether the checksum value is correct.
  • Step3. Merchant: If the checksum value is correct, respond 1|OK on the webpage end.

Client Site Post (ClientRedirectURL)
After an order has been created to the user, ECPay will return the code (virtual account number) retrieval results message one-time and redirect to the merchant’s designated page.

  • Step1. ECPay : The code (virtual account number) retrieval results message will be transmitted to the merchant and redirect the page to the merchant’s designated page.
  • Step2. Merchant: Upon receiving the code retrieval message from ECPay , check and verify whether the checksum value is correct.

HTTPS Transfer Protocol

  • Accept :text/html
  • Content Type :application/x-www-form-urlencoded
  • HTTP Method :POST

Return Parameters Description

MerchantID String(10)

Merchant ID.

MerchantTradeNo String(20)

Merchant transaction ID.

  • Merchant Transaction ID transmitted to ecpay when order was created.
StoreID String(20)

Merchant store ID.

  • The parameter allows merchants to enter specific store ID.
  • This parameter only allows a combination of upper and lower case alphanumeric characters.

RtnCode Int

Transaction status.
  • When the ATM return value is 2, this means the transaction status is success. The rest indicate failure.
  • When the CVS / BARCODE return value is 10100073 this means the transaction status is success. The rest indicate failure.

RtnMsg String(200)

Transaction message.

TradeNo String(20)

transaction ID.

  • Please save the link between the ECPay transaction ID and the merchant transaction ID [MerchantTradeNo].

TradeAmt Int

Transaction amount.

PaymentType String(20)

Merchant payment method.

TradeDate String(20)

Transaction time.

  • The format is yyyy/MM/dd HH:mm:ss
CustomField1 String(50)
Merchant notes field
CustomField2 String(50)
Merchant notes field
CustomField3 String(50)
Merchant notes field
CustomField4 String(50)
Merchant notes field

CheckMacValue String

Checksum.

When ChoosePayment parameter is ATM payment method return parameters:

BankCode String(3)

Payment bank code

vAccount String(16)

Payment virtual account number

ExpireDate String(100)

Payment deadline.

  • The format is yyyy/MM/dd

❗ Special Note:When ATM is selected for transaction, if the payment amount is incorrect, overdue, or repetitive, it is the bank which validates the information related to the payment and the account, rather than the ECPay .

When ChoosePayment parameter is CVS payment method or BARCODE payment method return parameters:

PaymentNo String(14)

Payment code.

  • Return when payment method is CVS, return blank if payment method is BARCODE.

ExpireDate String(20)

Payment deadline.

  • The format is yyyy/MM/dd HH:mm:ss

Barcode1 String(20)

First barcode strip number.

Barcode2 String(20)

Second barcode strip number.

Barcode3 String(20)

Third barcode strip number.

Merchant parameter transmission details:

The value returned is a text string and does not have parameter names

  • If the first digit returned is 1, it is success.
  • If the first digit returned is 0, it is failure. 0|ErrorMessage refers (error code – error message).
  • The value only means whether the merchant receives the return message from ECPay and parameters are correct.The value does not affect the status of order.

❗ Special Note:

When receiving code retrieval results notifications, please confirm the following details in order to receive the code retrieved notification sent by ECPay .

  • (1) Please make sure that parameter for the return URL [PaymentInfoURL] used to confirm the order creation parameter has been developed and completed.
  • (2) Please confirm that the return URL [PaymentInfoURL] for payment is available externally.
The code (virtual account number) retrieval result will be returned to the page based in the chart as follows. It is displayed in “parameter=value” format. Parameters are separated by an ampersand (&). For example:
				
					Barcode1=&Barcode2=&Barcode3=&ExpireDate=2017/12/28 00:39:03&MerchantID=2000132&MerchantTradeNo=Test1513787899&PaymentNo=LLL17355880822&PaymentType=CVS_CVS&RtnCode=10100073&RtnMsg=Get CVS Code Succeeded.&TradeAmt=2000&TradeDate=2017/12/21 00:39:03&TradeNo=17122100383415923452&StoreID=&CustomField1=&CustomField2=&CustomField3=&CustomField4=&CheckMacValue=C25373CE6379BB6116FAE8398F4A8E60B71B289D955F6B8A9D9F53FDCC97F571
				
			

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

Green World