Merchant Submitting Customs Declaration Interface

Description

This interface can provide customs declaration function to merchant.

Request Endpoint

https://apis.5upay.com/customs/order

Name Type & Max Description Requirement
merchantId varchar(9) The unique identity of the merchant ID in PayEase system. After the merchant completes Payease system registration, the merchant can log in the merchant backend portal to check M
paySerialNumber varchar(32) The payment serial number returned by the successful payment order M
notifyUrl varchar(200) Server notification：Successful notification will be sent to the address after payment is successful.This address can take parameters(Send mechanism see response mechanism) example:“www.5upay.com/callback.action?test=test”.Note: if the parameter value of notifyUrl is not filled, your server will not receive the notice of successful payment after payment is successful. M
payer JSON Please refer to the table "Request Fields（Payer）"; (If there is no Payer information being passed to this parameter, PayEasy will follow the payer information previously generated by Merchant at the phase of the "payment collection") C
customsInfos Json(two-dimensional array) Please refer to the table "Request Fields（customsInfos）" M
hmac varchar(500) The result of parameter signature,generated by the merchant.For the method of obtaining hmac,please reference to the section "Developers" M

Request Fields（Payer）

Name Type & Max Description Requirement
payerName varchar(50) Name of the payer C
IdNum varchar(18) ID number C
phoneNum varchar(11) Phone number C

Request Fields（customsInfos）

Name Type & Max Description Requirement
customsChannel varchar(20) GUANGZHOU_OFFICAL It's Guang Zhou customs（General Customs M
NINGBO Ningbo customs
TIANJIN_OFFICAL (Tian Jin customs(General Customs))
ZHUHAI_OFFICAL (Zhu Hai customs(General Customs))
ZHENGZHOU_ZONGBAO_OFFICAL (hen Zhou Zong Bao customs(General Customs))
CHONGQING_OFFICAL (Chong Qing customs(General Customs))
ZHENGZHOU_WUBAO_OFFICAL (Zheng Zhoud Wu Bao customs(General Customs))
OFFICAL (Direct connect to General Customs))
SHENZHEN_OFFICAL (Shen Zhen customs(General Customs))
amount Long(20) UNIT: China fen，1 Yuan=100 Fen M
freight Long(20) UNIT: China fen，1 Yuan=100 Fen, If not filled, the default value is "0" O
goodsAmount Long(20) UNIT: China fen，1 Yuan=100 Fen, If not filled, the default value is "0" O
tax Long(20) UNIT: China fen，1 Yuan=100 Fen, If not filled, the default value is "0" O
insuredAmount Long(20) UNIT: China fen，1 Yuan=100 Fen, If not filled, the default value is "0" O
merchantCommerceName Max(100) The name of the merchant registered in the customs O
merchantCommerceCode Max(20) The record code of the merchant in the customs O
storeHouse varchar (50 ) Storehouse of goods O
customsCode varchar(4) 5141 Guangzhou airport C
5165 Nansha checkpoint
5167 Nansha port
5169 Panyu dongfa
5145 Guangzhou post office
5208 Huangpu development zone
5216 Taiping customs office in sha tian
5130 Guangzhou Luogang
5185 Foshan customs express supervision site
ciqCode varchar(6) 000067 The airport's national inspection organization code C
000077 Huangpu development zone organization code
443433 Huangpu zhuangyuangu organization code
functionCode varchar(10) CUS One-way send customs C
CIQ One-way send inspection
BC Simultaneously send
BBC Simultaneously send
businessType varchar(10) B2B2C C
B2C
dxpid varchar(50) DXPENT0000012770 Nanjing C
DXPENT0000012808 Chongqing
DXPENT0000012084 Guangzhou
DXPENT0000012642 Shenzhen

Sample

{ "merchantId": "100000050", "paySerialNumber": "e09b2f9474d0452db254e1977c8db0c5", "notifyUrl": "http://demo.5upay.com/sdk/customs/notify", "customsInfos": [ { "amount": 1, "customsChannel": "GUANGZHOU", "freight": 1, "goodsAmount": 1, "tax": "test", " insuredAmount ": "1", "merchantCommerceCode": "123456", "merchantCommerceName": "test", "storeHouse ": "", "customsCode ": "5208", "ciqCode ": "000067", "functionCode ": " CUS ", "businessType ": " B2C ", "dxpid": "DXPENT0000012084" } ], "hmac": "c44122ac030ec74335fb424b6eaa49ae" }

Returned Fields

Name Description
merchantId The unique identity of the merchant ID in Payease system, After the merchant completes Payease system registration, the merchant can log in the merchant backend portal to check
paySerialNumber The payment Serial Number returned by the successful payment order
status SUCCESS (This does not mean that the declaration is successful, it can only mean that the declaration request is successfully submitted to PayEase system)
FAILED
ERROR (There are issues with the merchant's request data or the system process after calling the API, please check the data according to the error returned or directly contact PayEase)
hmac The result of parameter signature,generated by the merchant.For the method of obtaining hmac,please reference to the section "Developers"

Sample

{ "hmac": "1bcd07ed8f3b8023171dd321048b1bce", "merchantId": "120140257", "paySerialNumber": "a5ff176ec5d140cc859980a41eab0e0a", "status": "SUCCESS" }

Asynchronous Return Fields

Name Description
merchantId The unique identity of the merchant ID in Payease system, After the merchant completes Payease system registration, the merchant can log in the merchant backend portal to check
paySerialNumber The payment Serial Number returned by the successful payment order
customsInfos Json(two-dimensional array) See form "Request Fields（customsInfos）"
hmac The result of parameter signature,generated by the merchant.For the method of obtaining hmac,please reference to the section "Developers"

Request Fields（customsInfos）

name Description
customsChannel GUANGZHOU_OFFICAL （General Customs）
NINGBO
TIANJIN_OFFICAL （General Customs）
ZHUHAI_OFFICAL （General Customs）
ZHENGZHOU_ZONGBAO_OFFICAL （General Customs）
CHONGQING_OFFICAL （General Customs）
ZHENGZHOU_WUBAO_OFFICAL （General Customs）
OFFICAL （Direct connect to General Customs）
SHENZHEN_OFFICAL （General Customs）
amount UNIT: China fen，1 Yuan=100 Fen
freight UNIT: China fen，1 Yuan=100 Fen, If not filled, the default value is "0"
goodsAmount UNIT: China fen，1 Yuan=100 Fen, If not filled, the default value is "0"
tax UNIT: China fen，1 Yuan=100 Fen, If not filled, the default value is "0"
status PROCESSING
SUCCESS
FAILED

Sample

{ "customsInfos": [{ "amount": "1", "customsChannel": "GUANGZHOU_OFFICAL", "freight": "1", "goodsAmount": "1", "status": "SUCCESS", "tax": "1" }], "hmac": "05827f07cfb41a72229345fd56ae87b2", "merchantId": "120140257", "paySerialNumber": "095f227843974396adcf72810d488bd5" }