Login expired. Please log in again.

Feedback

0/300

Feedback

Submitted successfully

ok

Feedback

Network exception, please try again later

ok

Query Customs Declaration API

Latest update time:2022.08.04 Release notes

Merchants query additional order information submitted and declaration status by order No.

1. API Intro

Applicable object: Common mode Institutional mode

API rules:https://apihk.mch.weixin.qq.com/v3/global/customs/orders

Request method:GET


Pathparameter is a path parameter.
Queryparameter needs to be passed in the request URL.
Bodyparameter needs to be passed in the request JSON.

2. Request Parameters

Name Variable Name Type Required Description
Institution APPID appid string[1,32] Yes QuerySpecifies Official Account ID assigned
by WeChat
Example: wxd678efh567hg6787
Merchant ID mchid string[1,32] Yes Query pecifies Merchant ID assigned by
WeChat Payment
Example: 1230000109
Order type order_type string[1,16] Yes Query Select one of the four order types: out_trade_no - Merchant order No.
transaction_id - WeChat Pay order No.
sub_order_no - Merchant sub-order No.
sub_order_id - WeChat sub-order No.
Example: out_trade_no
Order No. order_no string[1,32] Yes Query Specify an order No. depending on the selected order type.
Example: 20150806125346
Customs customs string[1,32] Yes Query Customs for declaration. For the enumerated values, refer to Parameter Specifications
Example: SHANGHAI_ZS
Offset offset int No Query CA non-negative integer, which indicates the start position of requested resources, starting from 0. Optional. It is 0 by default.
Example: 1
Maximum number of returned records limit int No Query A positive integer, which indicates the maximum number of resource records that can be returned for this request. Optional. The suggested default value is 20.
Example: 20

Request Eample:


https://apihk.mch.weixin.qq.com/v3/global/customs/orders?appid=wxd678efh567hg6787&mchid=1230000109&order_type=out_trade_no&order_no=20150806125346&customs=SHANGHAI_ZS

{
  "currency": "CNY",
  "out_trade_no": "P20150806125346",
  "sub_mchid": "1900000109"
}

									{
										"stock_id": ".NET",
										"limit": 10,
									}

									{
										"stock_id": "Python",
										"stock_creator_mchid": "123456",
										"limit": 10,
									}

3. Response Parameters

Response for successful request:

Name Variable Name Type Required Description
Institution APPID appid string[1,32] Yes Official Account ID assigned by WeChat
Example: wxd678efh567hg6787
Merchant ID mchid string[1,32] Yes Merchant ID assigned by WeChat Pay
Example: 1230000109
WeChat order No. transaction_id string[1,32] Yes Order No. returned by WeChat Pay
Example: 1000320306201511078440737890
Verification institution verify_department string[1,16] Yes Verification institution code
UNIONPAY:Unionpay
NETSUNION:NetsUnion
OTHERS:Others
Example: UNIONPAY
Transaction ID from verification institution verify_department_trade_id string[1,64] Yes Transaction ID from the verification institution (such as UnionPay) for the merchant to register at the customs
Example: 2018112288340107038204310100000
Offset offset int Yes The offset from which the resource records are returned for the request
Example: 0
Maximum number of returned records limit int Yes The maximum number of returned records for the request
Example: 20
Total number of query results total_count int Yes Total number of query results
Example: 1
Customs declaration data packet data Array Yes Total number of query results
Name Variable Name Type Required Description
Merchant sub-order No. sub_order_no string[1,32] No Merchant sub-order No.
Example: 20150806125346
WeChat sub-order No. sub_order_id string[1,32] No WeChat sub-order No.
Example: 20150806125346
WeChat sub-order No. mch_customs_no string[1,32] No Customs registration No. of the merchant
Example: 1234567
Customs code customs string[1,32] Yes Customs code. See Parameter Specifications.
Example: SHANGHAI_ZS
Currency fee_type string[1,3] No The value is always CNY.
Example: CNY
Sub-order amount order_fee int No Sub-order amount (in 0.01 CNY)
Example: 888
Tariff duty int No Tariff (in 0.01 CNY). It is not required and will not be submitted to the customs.
Example: 888
Logistics fee transport_fee int No Logistics fee (in 0.01 CNY)
Example: 888
Product price product_fee int No Product price (in 0.01 CNY)
Example: 888
Declaration status state string[1,32] Yes Declaration result status code
PROCESSING:Declaration in process
UNDECLARED:Undeclared
SUBMITTED:Modified but not declared
SUCCESS:Declaration succeeded
FAIL:Declaration failed
EXCEPT:Exceptional customs API
Example: PROCESSING
Declaration result description explanation string[1,128] No Description of declaration results. The failure reason will be displayed in case of failure or exception.
Example: The payment order already exists and is in a non-refund status.
Last update time modify_time string[1,32] Yes Last update time, which is obtained from the WeChat server.
Example: 2015-09-01T10:00:00+08:00

Response for failed request:

Name Variable Name Type Required Description
Returned status code code string[1,32] Yes Error code. See the error code list for the enumerated values.
Returned information message string[1,256] Yes Returned message. It indicates the reason for the error if not empty.
Detailed error description detail object No It is returned when code is PARAM_ERROR. Details will be described below.
Name Variable Name Type Required Description
The location of incorrect parameter field string[1,256] Yes If the incorrect parameter is in the JSON for request body, it is populated with the JSON Pointer pointing to this parameter. If the incorrect parameter is in the request URL or querystring, it is populated with the variable name of this parameter.
Value of the incorrect parameter value string[1,256] Yes Value of the incorrect parameter
Cause of error issue string[1,256] Yes Cause of error
Location of the incorrect parameter location string[1,256] No body: The incorrect parameter is in the JSON for request body
url: The incorrect parameter is in the request URL
query: The incorrect parameter is in the querystring of the request

Response Example:

  {
	"appid": "wxd678efh567hg6787",
	"mchid": "1230000109",
	"transaction_id": "1000320306201511078440737890",
	"verify_department": "UNIONPAY",
	"verify_department_trade_id": "2018112288340107038204310100000",
	"offset": 0,
	"limit": 20,
	"total_count": 1,
	"data": [{
		"sub_order_no": "20150806125346",
		"sub_order_id": "20150806125346",
		"mch_customs_no": "1234567",
		"customs": "SHANGHAI_ZS",
		"fee_type": "CNY",
		"order_fee": 888,
		"duty": 888,
		"transport_fee": 888,
		"product_fee": 888,
		"state": "PROCESSING",
		"explanation": "The payment order already exists and is in a non-refund status",
		"modify_time": "2015-09-01T10:00:00+08:00"
	}]
}
{
	"code": "INVALID_REQUEST",
	"message": "Parameter format verification error",
	"detail": {
		"field": "#/properties/payer",
		"value": "1346177081915535577",
		"issue": "与ALLOF schema不符",
		"location": "body"
	}
}

									{
										"stock_id": ".NET",
										"limit": 10,
									}

									{
										"stock_id": "Python",
										"stock_creator_mchid": "123456",
										"limit": 10,
									}

4. Error Codes

Error Message Description Solution
INVALID_REQUEST Payer's ID No. registered in WeChat is invalid. Please make a check. There is a problem with the payer's identity information registered in WeChat. Contact WeChat Pay Assistant to find out the reason.
Customs declaration record does not exist. The customs declaration record does not exist. Please apply again or contact WeChat Pay Assistant to find out the reason.
Customs information is not configured. The customs declaration API is only accessible after the customs information has been configured for the merchant. Please configure the customs information by referring to the customs registration guidelines above.
NOAUTH The merchant has not registered with the current customs. The merchant has not registered with the current customs. Try again after the registration is completed.
Self-Clearance is not enabled. error Check whether the Self-Clearance tool has been enabled for the merchant ("WeChat Pay Merchants Platform" > "Product Center" > "Apply for Self-Clearance").
PARAM_ERROR Parameter error Invalid parameter. The parameter may be incorrect or is missing. Check whether the API parameters have been summited as required.
Merchant entered invalid user ID No. Enter the correct ID No. If you still get an error, contact WeChat Pay Assistant to find out the reason.
SYSTEMERROR System error Declare again, or contact WeChat Pay Assistant to find out the reason.
USER_ACCOUNT_ABNORMAL The identity information on the payment order for declaration does not match the payer's registered identity information. Customs declaration is not allowed. The identity information on the payment order for declaration does not match the payer's registered identity information. Enter the actual payer's identity information and declare again.


    Page Navigation

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2024 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

WeChat Pay Global

置顶