订单附加信息查询接口
应用场景
商户通过订单号查询提交的订单附加信息。如果是微信收集的实名信息,查询接口不返回实名信息内容
接口链接
URL地址: https://api.mch.weixin.qq.com/cgi-bin/mch/customs/customdeclarequery
是否需要证书
否
请求参数
请求方式:post 数据格式:xml 签名方式:MD5
字段名 | 变量名 | 必填 | 类型 | 示例值 | 说明 |
---|---|---|---|---|---|
签名类型 | sign_type | 否 | String(32) | MD5 | 暂只支持MD5 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名,详见签名生成算法 |
公众账号ID | appid | 是 | String(32) | wxd678efh567hg6787 | 微信分配的公众账号ID |
商户号 | mch_id | 是 | String(32) | 1230000109 | 微信支付分配的商户号 |
商户订单号 | out_trade_no | 四选一 | String(32) | 20150806125346 | 商户侧系统内部的订单号, out_trade_no、transaction_id、sub_order_no、sub_order_id至少一个必填,同时存在时优先级如下:sub_order_id> sub_order_no> transaction_id> out_trade_no |
微信支付订单号 | transaction_id | String(28) | 1000320306201511078440737890 | 微信支付系统内部订单号, out_trade_no、transaction_id、sub_order_no、sub_order_id至少一个必填,同时存在时优先级如下:sub_order_id> sub_order_no> transaction_id> out_trade_no | |
商户子订单号 | sub_order_no | String(32) | 20150806125346 | 商户侧系统内部子订单号, out_trade_no、transaction_id、sub_order_no、sub_order_id至少一个必填,同时存在时优先级如下:sub_order_id> sub_order_no> transaction_id> out_trade_no | |
微信子订单号 | sub_order_id | String(32) | 20150806125346 | 微信支付系统内部子订单号, out_trade_no、transaction_id、sub_order_no、sub_order_id至少一个必填,同时存在时优先级如下:sub_order_id> sub_order_no> transaction_id> out_trade_no | |
海关 | customs | 是 | String(32) | SHANGHAI |
GUANGZHOU_ZS 广州(总署版) HANGZHOU_ZS 杭州(总署版) NINGBO 宁波 ZHENGZHOU_BS 郑州(保税物流中心) CHONGQING 重庆 SHANGHAI_ZS 上海(总署版) SHENZHEN 深圳 ZHENGZHOU_ZH_ZS 郑州综保(总署版) TIANJIN 天津(需要推送订单至天津海关时,需要在商户管理后台同时配置天津海关备案信息与天津国检备案信息;调用报关接口时只需推送天津海关,即请求一次报关接口。) 接口文档列表没有的海关,商户在商户平台新增海关备案信息时选“广州(总署)”,备案号和备案名称填商户在海关登记的信息,然后按商户平台登记的信息调用“订单附加信息提交接口”即可 |
应答参数列表
字段名 | 变量名 | 必填 | 类型 | 示例值 | 说明 |
---|---|---|---|---|---|
返回状态码 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL 此字段是通信标识,非交易标识,交易是否成功需要查看result_code来判断 |
返回信息 | return_msg | 否 | String(128) | 签名失败 | 返回信息,如非空,为错误原因 签名失败 参数格式校验错误 |
以下字段在return_code为SUCCESS的时候有返回
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名,详见签名生成算法 |
公众账号ID | appid | 是 | String(32) | wxd678efh567hg6787 | 微信分配的公众账号ID |
商户号 | mch_id | 是 | String(32) | 1230000109 | 微信支付分配的商户号 |
业务结果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
错误代码 | err_code | 否 | String(32) | SYSTEMERROR | 详细参见第6节错误列表 |
错误代码描述 | err_code_des | 否 | String(128) | 系统错误 | 错误返回的信息描述 |
以下字段在return_code 和result_code都为SUCCESS的时候有返回
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
微信支付订单号 | transaction_id | 是 | String(28) | 1000320306201511078440737890 | 微信支付返回的订单号 |
笔数 | count | 是 | int | 1 | 笔数 |
商户子订单号 | sub_order_no_$n | 否 | String(32) | 20150806125346 | 商户子订单号 |
微信子订单号 | sub_order_id_$n | 否 | String(32) | 20150806125346 | 微信子订单号 |
商户海关备案号 | mch_customs_no_$n | 否 | String(32) | 1234567 | 商户在海关登记的备案号 |
海关 | customs_$n | 是 | String(2) | SHANGHAI |
GUANGZHOU 广州 HANGZHOU 杭州 NINGBO 宁波 ZHENGZHOU_BS 郑州(保税物流中心) CHONGQING 重庆 SHANGHAI 上海 ZHENGZHOU_ZH 郑州(综保区) |
币种 | fee_type_$n | 否 | String(3) | CNY | 币种 |
应付金额 | order_fee_$n | 否 | int | 888 | 子单金额,以分为单位 |
关税 | duty_$n | 否 | int | 888 | 关税,以分为单位,非必填项,不会提交给海关 |
物流费 | transport_fee_$n | 否 | int | 888 | 物流费用,以分为单位 | 商品价格 | product_fee_$n | 否 | int | 888 | 商品费用,以分为单位 |
状态码 | state_$n | 是 | String(2) | UNDECLARED |
状态码 UNDECLARED -- 未申报 SUBMITTED -- 申报已提交(订单已经送海关,商户重新申报,并且海关还有修改接口,那么记录的状态会是这个) PROCESSING -- 申报中 SUCCESS -- 申报成功 FAIL -- 申报失败 EXCEPT --海关接口异常 |
申报结果说明 | explanation_$n | 否 | String(128) | 支付单已存在并且为非退单状态 | 申报结果说明,如果状态是失败或异常,显示失败原因 |
最后更新时间 | modify_time_$n | 是 | String(14) | 20091227091010 | 最后更新时间,格式为yyyyMMddhhmmss,如2009年12月27日9点10分10秒表示为20091227091010。时区为GMT+8 beijing。该时间取自微信服务器 |
订购人和支付人身份信息校验结果 | cert_check_result_$n | 是 | String(256) | UNCHECKED |
UNCHECKED 商户未上传订购人身份信息 SAME 商户上传的订购人身份信息与支付人身份信息一致 DIFFERENT 商户上传的订购人身份信息与支付人身份信息不一致 |
验核机构 | verify_department | 是 | String(16) | UNIONPAY | 验核机构包括: |
验核机构交易流水号 | verify_department_trade_id | 是 | String(64) | 2018112288340107038204310100000 | 交易流水号,来自验核机构,如银联记录的交易流水号,供商户报备海关 |
PS:$n表示记录的序号,取值为0~($ count -1),例如count指示返回的退款记录有2条。第一条序号为“0”,第二条序号为“1”。