Enquiry and Notice / Callbacks of Shipment Orders

Introduction

ECPay will respond the callback status whenever the shipping status changes (ServerReplyURL, server-side POST).On receiving ECPay’s callback, please respond a string 1|OK.

Step1 ECPay : Send the logistics status to the (ServerReplyURL) by ServerPOST.
Step2 Merchant : Receive the logistics status from ECPay and determine whether the check code matches.
Step3 Merchant : After the check code matches, respond 1|OK on the website

HTTPS Transfer Protocol

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

Request Parameter Description

MerchantID String(10)

MerchantTradeNo String(20)

Merchant transaction number.

The merchant transaction number sent to ECPay when an order is created.

RtnCode Int

Current logistics status.

Please refer to logistics status code list.

RtnMsg String(200)

AllPayLogisticsID String(20)

logistics transaction number.

Please keep the relationship link between ECPay’s logistics transaction number and the merchant transaction number.

LogisticsType String(20)

Logistics type

LogisticsSubType String(20)

Logistics subtype

GoodsAmount Int

Goods price value.

Compensation amount for lost goods, numbers only.

UpdateStatusDate String(20)

Logistics status update time.

Format is: yyyy/MM/dd HH:mm:ss

ReceiverName String(60)

Recipient’s name

ReceiverPhone String(20)

Recipient’s phone number

ReceiverCellPhone String(20)

Recipient phone.

Only a 10-digit numeric string beginning with 09 is allowed.

ReceiverEmail String(50)

Recipient’s email.

ReceiverAddress String(200)

Recipient’s address.

CVSPaymentNo String(15)

Shipping number.

CVSValidationNo String(10)

Verification code.

(C2C)Returns if the pickup store is 7-ELEVEN.

BookingNote String(50)

Consignment number.

Returns if logistics type is set to “HOME“.

CheckMacValue String

Checksum.

Merchant must check verify this field. Please refer to the appendix Checksum for more information.

Response Parameter Description

Return plain text value

Success if value returns 1|OK
Failure if value returned is not 1|OK

Correct

				
					1|OK

Error

				
					0| ErrorMessage

Special Note：

Merchants must verify whether CheckMacValue is correct and whether the payment notice for the corresponding order has been processed accordingly. Merchants shall bear all loss incurred for negligent judgement.
If merchant’s server does not correctly return 1|OK, ECPay will run a task scheduler to resend the payment notification message to merchant up to 3 times a day. This attempt will continue for 3 days after goods status change. Merchant’s return message do not include any HTML tags, spaces, or other special characters in message returned.
The merchant’s admin portal on stage environment does not provide the testing function of callback status changed. If merchants need to know how it works, please test it on production by creating shipment orders (i.e. making a real shipment orders).
It is the Logistics Center who sends the RtnCode to ECPay; once ECPay receives from Logistics Center, ECPay will run a task scheduler to send it to merchant’s ServerReplyURL (therefore the RtnCode will NOT be responded immediately).
If merchant’s ServerReplyURL still not receives updated status, merchants can call the API (https://logistics.ecpay.com.tw/Helper/QueryLogisticsTradeInfo/V2) to check the logistics order status. In addition, the logistics status will not be updated either if some troublesome happened during the shipping process.
Common logistics status RtnCode Description：

Logistics status/method	7-ELEVEN B2C	7-ELEVEN C2C	FAMI B2C	FAMI C2C	Hi-Life B2C	Hi-Life C2C	OK C2C
Goods have arrived at logistics center	2030	2030	3024	3024	2030 3024	2030 3024	2030
Goods have been delivered to the store	2063	2073	3018	3018	2063 3018	2063 3018	2073
Customer has picked up goods successfully	2067	2067	3022	3022	2067 3022	2067 3022	3022
Customer did not pick up goods within seven days	2074	2074	3020	3020	2074 3020	2074 3020	2074

Green World