Repush Customs Declaration
Update Time:2025.01.07If additional order information has been submitted to the customs but is lost in the electronic port, the customs declaration re-push API can be used to push the information to the customs again (the additional order information must be in the SUCCESS or EXCEPT state). For re-push, out_trade_no (merchant order No. upon payment) or transaction_id (WeChat Pay order No.) must be included. For a split order, sub_order_no (merchant sub-order No.) or sub_order_id (WeChat sub-order No.) must be included.
1. API Intro
Applicable object: Common mode Institutional mode
API rules:https://apihk.mch.weixin.qq.com/v3/global/customs/redeclare
Request method:POST
Path parameter is a path parameter.
Query parameter needs to be passed in the request URL.
Body parameter needs to be passed in the request JSON.
2. Request Parameters
Name | Variable Name | Type | Required | Description |
---|---|---|---|---|
Institution APPID | appid | string[1,32] | Yes | Body Specifies Official Account ID assigned |
Merchant ID | mchid | string[1,32] | Yes | Body Specifies Merchant ID assigned by |
Merchant order No. | out_trade_no | string[1,32] | Yes | Body internal order No. of the merchant system. Should be within 32 characters and can only contain numbers, uppercase and lowercase letters, and _-|*@. It is unique for a merchant ID. |
WeChat order No. | transaction_id | string[1,32] | Yes | Body Order No. returned by WeChat Pay |
Customs | customs | string[1,32] | Yes | Body Customs for declaration. For the enumerated values, refer to Parameter Specifications |
Merchant's customs registration No. | merchant_customs_no | string[1,32] | Yes | Body Customs registration No. of the merchant |
Merchant sub-order No. | sub_order_no | string[1,32] | No | Body Merchant sub-order No. It is required if there is a split order. |
WeChat sub-order No. | sub_order_id | string[1,32] | No | Body For a non-split order, this field can be left blank. Otherwise, pass either sub_order_no or sub_order_id. |
Request Example:
JSON
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 |
Merchant ID | mchid | string[1,32] | Yes | Merchant ID assigned by WeChat Pay |
Declaration status | state | string[1,32] | Yes | Declaration result status code |
Merchant order No. | out_trade_no | string[1,32] | Yes | internal order No. of the merchant system. Should be within 32 characters and can only contain numbers, uppercase and lowercase letters, and _-|*@. It is unique for a merchant ID. |
WeChat order No. | transaction_id | string[1,32] | Yes | Order No. returned by WeChat Pay |
Merchant sub-order No. | sub_order_no | string[1,32] | No | Merchant sub-order No. It is required if there is a split order. |
WeChat sub-order No. | sub_order_id | string[1,32] | No | WeChat sub-order No. |
Last update time | modify_time | string[1,32] | Yes | Last update time, which is obtained from the WeChat server. |
Description of declaration results | explanation | string[1,32] | No | Description of declaration results. The failure reason will be displayed in case of failure or exception. |
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. | |||
|
Response Example:
SUCCESS
ERROR
4. Error Codes
Error Message | Description | Solution |
---|---|---|
INVALID_REQUEST | 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. | 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. |
SYSTEMERROR | System error | Declare again, or contact WeChat Pay Assistant to find out the reason. |