Login expired. Please log in again.

Feedback

0/300

Feedback

Submitted successfully

ok

Feedback

Network exception, please try again later

ok

报关查询API

最新更新时间:2020.04.03 版本说明


商户通过订单号查询提交的订单附加信息及订单报关状态。


注意:

对于加密字段,请参照以下加密算法:

1、获取微信支付平台证书和对应的平台证书序列号,本接口请求 http 头的“Wechatpay-Serial”需要传平台证书序列号。

2、使用微信支付平台证书的公钥,对于需要加密的参数值进行 RSA 加密。填充方案使用 `RSAES-PKCS1-v1_5`。

3、加密后的密文,使用 base64 编码后,作为请求中相应参数的值。

接口说明

适用对象:直连模式 机构模式

接口URL:https://apihk.mch.weixin.qq.com/global/v3/customs/orders

请求方式:GET

接口规则:https://wechatpay-api.gitbook.io/wechatpay-api-v3/


path 指该参数为路径参数

query 指该参数为URL参数

body 指该参数需在请求JSON传参

请求参数

参数名 变量 类型 必填 描述
机构APPID appid string(32) query 微信分配的公众账号ID
示例值:wxd678efh567hg6787
商户号 mchid string(32) query 微信支付分配的商户号
示例值:1230000109
订单类型 order_type string(16) query 4种订单号类型,选择一种
out_trade_no   商户订单号
transaction_id  微信支付订单号
sub_order_no  商户子订单号
sub_order_id  微信子订单号
示例值:out_trade_no
订单号 order_no string(32) query 根据订单号类型,传入不同的订单号码
示例值:20150806125346
海关 customs string(32) query 海关代码,枚举值参见参数规定-海关列表
示例值:SHANGHAI_ZS
偏移量 offset int query 非0整数,该次请求资源的起始位置,从0开始计数。调用方选填,默认为0
示例值:1
请求最大记录条数 limit int query 非0非负的整数,该次请求可返回的最大资源条数。调用方选填,默认值建议为20
示例值:20

请求示例:

https://apihk.mch.weixin.qq.com/global/v3/customs/orders?appid=wxd678efh567hg6787&mchid=1230000109&order_type=transaction_id&order_no=20150806125346&customs=SHANGHAI_ZS&offset=1&limit=20
    
{
JAVA示例代码
}
    

返回参数

正常返回

参数名 变量 类型 必填 描述
机构APPID appid string(32) 微信分配的公众账号ID
示例值:wxd678efh567hg6787
商户号 mchid string(32) 微信支付分配的商户号
示例值:1230000109
微信订单号 transaction_id string(32) 微信支付返回的订单号
示例值:1000320306201511078440737890
核验机构 verify_department string(16) 核验机构代码
UNIONPAY:银联
NETSUNION:网联
OTHERS:其他
示例值:UNIONPAY
核验机构流水号 verify_department_trade_id string(64) 交易流水号,来自验核机构,如银联记录的交易流水号,供商户报备海关
示例值:2018112288340107038204310100000
偏移量 offset int 返回请求时设置的偏移值
示例值:0
请求最大记录条数 limit int 返回请求时设置的最大记录数
示例值:20
查询结果总条数 total_count int 查询结果总条数
示例值:1
+报关数据包 data array 报关单结果数组,具体内容参见下方描述
示例值:
参数名 变量 类型 必填 描述
商户子单号 sub_order_no string(32) 商户子订单号
注意:仅适用于机构模式
示例值:20150806125346
微信子单号 sub_order_id string(32) 微信子订单号
注意:仅适用于机构模式
示例值:20150806125346
商户海关备案号 mch_customs_no string(32) 商户在海关登记的备案号
示例值:1234567
海关代码 customs string(32) 海关代码,详情参考章节3.5.10
示例值:SHANGHAI_ZS
币种 fee_type string(3) 固定值CNY
示例值:CNY
子单金额 order_fee int 子单金额,以分为单位
示例值:888
关税 duty int 关税,以分为单位,非必填项,不会提交给海关
示例值:888
物流费用 transport_fee int 物流费用,以分为单位
示例值:888
商品费用 product_fee int 商品费用,以分为单位
示例值:888
报关状态 state string(32) 申报结果状态码
PROCESSING:申报中
UNDECLARED:未申报
SUBMITTED:已修改未申报
SUCCESS:申报成功
FAIL:申报失败
EXCEPT:海关接口异常
示例值:PROCESSING
报关结果说明 explanation string(128) 申报结果说明,如果状态是失败或异常,显示失败原因
示例值:支付单已存在并且为非退单状态
最后更新时间 modify_time string(32) 最后更新时间,该时间取自微信服务器
示例值:2015-09-01T10:00:00+08:00

异常返回

参数名 变量 类型 必填 描述
返回状态码 code string(32) 错误码,枚举值见错误码列表
示例值:INVALID_REQUEST
返回信息 message string(256) 返回信息,如非空,为错误原因
示例值:参数格式校验错误
+详细错误描述 detail object 当code为PARAM_ERROR时返回,详细说明见下文
参数名 变量 类型 必填 描述
指示错误参数的字段 field string(256) 当错误参数位于请求 body 的 JSON 时 填写指向参数的 JSON Pointer; 当错误参数位于请求的 url 或者 querystring 时,填写参数的变量名
示例值:#/properties/payer
错误参数的值 value string(256) 错误参数的值
示例值:1346177081915535577
具体错误原因 issue string(256) 具体错误原因
示例值:与 ALLOF schema 不 符
错误参数的位置 location string(256) body:错误参数位于请求 body 的 JSON 中
url:错误参数位于请求 url 中
query:错误参数位于请求的 querystring 中
示例值:body

返回示例:

{
  "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": "支付单已存在并且为非退单状态",
      "modify_time": "2015-09-01T10:00:00+08:00"
    }
  ]
}

版本说明

关闭
V1.0
2020年4月3日
1. 报关查询API上线

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2024 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

WeChat Pay Global