程序喵目录
1、统一下单接口
2、查询订单
3、关闭订单
4、申请退款
5、查询退款
6、下载对账单
7、支付结果通知
8、交易保障
9、转换短链接
注意
在这9个API接口中，只有在申请退款请求中才使用证书，需要双向证书。 详见证书使用
改版之后的文档将错误码进行开放式查询：http://wxpay.wxutil.com/errcode/index.php
统一下单接口
应用场景
除被扫支付场景以外，商户系统先调用该接口在微信支付服务后台生成预支付交易单，返回正确的预支付交易回话标识后再按扫码、JSAPI、APP等不同场景生成交易串调起支付。
接口链接
URL地址：https://api.mch.weixin.qq.com/pay/unifiedorder
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号ID | appid | 是 | String(32) | wxd678efh567hg6787 | 微信支付分配的公众账号ID（企业号corpid即为此appId） |
| 商户号 | mch_id | 是 | String(32) | 1230000109 | 微信支付分配的商户号 |
| 设备号 | device_info | 否 | String(32) | 013467007045764 | 自定义参数，可以为终端设备号(门店号或收银设备ID)，PC网页或公众号内支付可以传"WEB" |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，长度要求在32位以内。推荐随机数生成算法 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 通过签名算法计算得出的签名值，详见签名生成算法 |
| 签名类型 | sign_type | 否 | String(32) | HMAC-SHA256 | 签名类型，默认为MD5，支持HMAC-SHA256和MD5。 |
| 商品描述 | body | 是 | String(128) | 腾讯充值中心-QQ会员充值 | 商品简单描述，该字段请按照规范传递，具体请见参数规定 |
| 商品详情 | detail | 否 | String(6000) | { "cost_price": 608800, "receipt_id": "wx123", "goods_detail": [{ "goods_id": "商品编码", "wxpay_goods_id": "1001", "goods_name": "iPhone6s 16G", "quantity": 1, "price": 528800 }, { "goods_id": "商品编码", "wxpay_goods_id": "1002", "goods_name": "iPhone6s 32G", "quantity": 1, "price": 608800 }] } | 商品详细列表，使用Json格式，传输签名前请务必使用CDATA标签将JSON文本串保护起来。 cost_price Int 可选 32 订单原价，商户侧一张小票订单可能被分多次支付，订单原价用于记录整张小票的支付金额。当订单原价与支付金额不相等则被判定为拆单，无法享受优惠。 receipt_id String 可选 32 商家小票ID goods_detail 服务商必填 []： |
| 附加数据 | attach | 否 | String(127) | 深圳分店 | 附加数据，在查询API和支付通知中原样返回，可作为自定义参数使用。 |
| 商户订单号 | out_trade_no | 是 | String(32) | 20150806125346 | 商户系统内部订单号，要求32个字符内、且在同一个商户号下唯一。 详见商户订单号 |
| 标价币种 | fee_type | 否 | String(16) | CNY | 符合ISO 4217标准的三位字母代码，默认人民币：CNY，详细列表请参见货币类型 |
| 标价金额 | total_fee | 是 | Int | 88 | 订单总金额，单位为分，详见支付金额 |
| 终端IP | spbill_create_ip | 是 | String(16) | 123.12.12.123 | APP和网页支付提交用户端ip，Native支付填调用微信支付API的机器IP。 |
| 交易起始时间 | time_start | 否 | String(14) | 20091225091010 | 订单生成时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则 |
| 交易结束时间 | time_expire | 否 | String(14) | 20091227091010 | 订单失效时间，格式为yyyyMMddHHmmss，如2009年12月27日9点10分10秒表示为20091227091010。其他详见时间规则 注意：最短失效时间间隔必须大于5分钟 |
| 商品标记 | goods_tag | 否 | String(32) | WXG | 商品标记，使用代金券或立减优惠功能时需要的参数，说明详见代金券或立减优惠 |
| 通知地址 | notify_url | 是 | String(256) | http://www.weixin.qq.com/wxpay/pay.php | 异步接收微信支付结果通知的回调地址，通知url必须为外网可访问的url，不能携带参数。 |
| 交易类型 | trade_type | 是 | String(16) | JSAPI | 取值如下：JSAPI，NATIVE，APP等，说明详见参数规定 |
| 商品ID | product_id | 否 | String(32) | 12235413214070356458058 | trade_type=NATIVE时（即扫码支付），此参数必传。此参数为二维码中包含的商品ID，商户自行定义。 |
| 指定支付方式 | limit_pay | 否 | String(32) | no_credit | 上传此参数no_credit--可限制用户不能使用信用卡支付 |
| 用户标识 | openid | 否 | String(128) | oUpF8uMuAJO_M2pxb1Q9zNjWeS6o | trade_type=JSAPI时（即公众号支付），此参数必传，此参数为微信用户在商户对应appid下的唯一标识。openid如何获取，可参考【获取openid】。企业号请使用【企业号OAuth2.0接口】获取企业号内成员userid，再调用【企业号userid转openid接口】进行转换 |
举例如下：
<xml>
<appid>wx2421b1c4370ec43b</appid>
<attach>支付测试</attach>
<body>JSAPI支付测试</body>
<mch_id>10000100</mch_id>
<detail>
<![CDATA[{ "goods_detail":[ { "goods_id":"iphone6s_16G", "wxpay_goods_id":"1001", "goods_name":"iPhone6s 16G", "quantity":1, "price":528800, "goods_category":"123456", "body":"苹果手机" }, { "goods_id":"iphone6s_32G", "wxpay_goods_id":"1002", "goods_name":"iPhone6s 32G", "quantity":1, "price":608800, "goods_category":"123789", "body":"苹果手机" } ] }]]>
</detail>
<nonce_str>1add1a30ac87aa2db72f57a2375d8fec</nonce_str>
<notify_url>http://wxpay.wxutil.com/pub_v2/pay/notify.v2.php</notify_url>
<openid>oUpF8uMuAJO_M2pxb1Q9zNjWeS6o</openid>
<out_trade_no>1415659990</out_trade_no>
<spbill_create_ip>14.23.150.211</spbill_create_ip>
<total_fee>1</total_fee>
<trade_type>JSAPI</trade_type>
<sign>0CB01533B8C1EF103065174F50BCA001</sign>
</xml>注：参数值用XML转义即可，CDATA标签用于说明数据不被XML解析器解析。
返回结果
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看result_code来判断 |
| 返回信息 | return_msg | 否 | String(128) | 签名失败 | 返回信息，如非空，为错误原因 签名失败 参数格式校验错误 |
以下字段在return_code为SUCCESS的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 调用接口提交的公众账号ID |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 调用接口提交的商户号 |
| 设备号 | device_info | 否 | String(32) | 013467007045764 | 自定义参数，可以为请求支付的终端设备号等 |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 微信返回的随机字符串 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 微信返回的签名值，详见签名算法 |
| 业务结果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 错误代码 | err_code | 否 | String(32) | SYSTEMERROR | 详细参见下文错误列表 |
| 错误代码描述 | err_code_des | 否 | String(128) | 系统错误 | 错误信息描述 |
以下字段在return_code 和result_code都为SUCCESS的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 交易类型 | trade_type | 是 | String(16) | JSAPI | 交易类型，取值为：JSAPI，NATIVE，APP等，说明详见参数规定 |
| 预支付交易会话标识 | prepay_id | 是 | String(64) | wx201410272009395522657a690389285100 | 微信生成的预支付回话标识，用于后续接口调用中使用，该值有效期为2小时 |
| 二维码链接 | code_url | 否 | String(64) | URl：weixin：//wxpay/s/An4baqw | trade_type为NATIVE时有返回，用于生成二维码，展示给用户进行扫码支付 |
举例如下：
<xml> <return_code><![CDATA[SUCCESS]]></return_code> <return_msg><![CDATA[OK]]></return_msg> <appid><![CDATA[wx2421b1c4370ec43b]]></appid> <mch_id><![CDATA[10000100]]></mch_id> <nonce_str><![CDATA[IITRi8Iabbblz1Jc]]></nonce_str> <openid><![CDATA[oUpF8uMuAJO_M2pxb1Q9zNjWeS6o]]></openid> <sign><![CDATA[7921E432F65EB8ED0CE9755F0E86D72F]]></sign> <result_code><![CDATA[SUCCESS]]></result_code> <prepay_id><![CDATA[wx201411101639507cbf6ffd8b0779950874]]></prepay_id> <trade_type><![CDATA[JSAPI]]></trade_type> </xml>
错误码
| 名称 | 描述 | 原因 | 解决方案 |
|---|---|---|---|
| NOAUTH | 商户无此接口权限 | 商户未开通此接口权限 | 请商户前往申请此接口权限 |
| NOTENOUGH | 余额不足 | 用户帐号余额不足 | 用户帐号余额不足，请用户充值或更换支付卡后再支付 |
| ORDERPAID | 商户订单已支付 | 商户订单已支付，无需重复操作 | 商户订单已支付，无需更多操作 |
| ORDERCLOSED | 订单已关闭 | 当前订单已关闭，无法支付 | 当前订单已关闭，请重新下单 |
| SYSTEMERROR | 系统错误 | 系统超时 | 系统异常，请用相同参数重新调用 |
| APPID_NOT_EXIST | APPID不存在 | 参数中缺少APPID | 请检查APPID是否正确 |
| MCHID_NOT_EXIST | MCHID不存在 | 参数中缺少MCHID | 请检查MCHID是否正确 |
| APPID_MCHID_NOT_MATCH | appid和mch_id不匹配 | appid和mch_id不匹配 | 请确认appid和mch_id是否匹配 |
| LACK_PARAMS | 缺少参数 | 缺少必要的请求参数 | 请检查参数是否齐全 |
| OUT_TRADE_NO_USED | 商户订单号重复 | 同一笔交易不能多次提交 | 请核实商户订单号是否重复提交 |
| SIGNERROR | 签名错误 | 参数签名结果不正确 | 请检查签名参数和方法是否都符合签名算法要求 |
| XML_FORMAT_ERROR | XML格式错误 | XML格式错误 | 请检查XML参数格式是否正确 |
| REQUIRE_POST_METHOD | 请使用post方法 | 未使用post传递参数 | 请检查请求参数是否通过post方法提交 |
| POST_DATA_EMPTY | post数据为空 | post数据不能为空 | 请检查post数据是否为空 |
| NOT_UTF8 | 编码格式错误 | 未使用指定编码格式 | 请使用UTF-8编码格式 |
2、查询订单
应用场景
该接口提供所有微信支付订单的查询，商户可以通过查询订单接口主动查询订单状态，完成下一步的业务逻辑。
需要调用查询接口的情况：
当商户后台、网络、服务器等出现异常，商户系统最终未接收到支付通知；
调用支付接口后，返回系统错误或未知交易状态情况；
调用被扫支付API，返回USERPAYING的状态；
调用关单或撤销接口API之前，需确认支付状态；
接口链接
https://api.mch.weixin.qq.com/pay/orderquery
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号ID | appid | 是 | String(32) | wxd678efh567hg6787 | 微信支付分配的公众账号ID（企业号corpid即为此appId） |
| 商户号 | mch_id | 是 | String(32) | 1230000109 | 微信支付分配的商户号 |
| 微信订单号 | transaction_id | 二选一 | String(32) | 1009660380201506130728806387 | 微信的订单号，建议优先使用 |
| 商户订单号 | out_trade_no | String(32) | 20150806125346 | 商户系统内部的订单号，请确保在同一商户号下唯一。 | |
| 随机字符串 | nonce_str | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 随机字符串，不长于32位。推荐随机数生成算法 |
| 签名 | sign | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 通过签名算法计算得出的签名值，详见签名生成算法 |
| 签名类型 | sign_type | 否 | String(32) | HMAC-SHA256 | 签名类型，目前支持HMAC-SHA256和MD5，默认为MD5 |
举例如下：
<xml> <appid>wx2421b1c4370ec43b</appid> <mch_id>10000100</mch_id> <nonce_str>ec2316275641faa3aacf3cc599e8730f</nonce_str> <transaction_id>1008450740201411110005820873</transaction_id> <sign>FDD167FAA73459FD921B144BAF4F4CA2</sign> </xml>
返回结果
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看trade_state来判断 |
| 返回信息 | return_msg | 否 | String(128) | 签名失败 | 返回信息，如非空，为错误原因 签名失败 参数格式校验错误 |
以下字段在return_code为SUCCESS的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号ID | appid | 是 | String(32) | wxd678efh567hg6787 | 微信分配的公众账号ID |
| 商户号 | mch_id | 是 | String(32) | 1230000109 | 微信支付分配的商户号 |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于32位。推荐随机数生成算法 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名，详见签名生成算法 |
| 业务结果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 错误代码 | err_code | 否 | String(32) | SYSTEMERROR | 错误码 |
| 错误代码描述 | err_code_des | 否 | String(128) | 系统错误 | 结果信息描述 |
以下字段在return_code 和result_code都为SUCCESS的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 设备号 | device_info | 否 | String(32) | 013467007045764 | 微信支付分配的终端设备号， |
| 用户标识 | openid | 是 | String(128) | oUpF8uMuAJO_M2pxb1Q9zNjWeS6o | 用户在商户appid下的唯一标识 |
| 是否关注公众账号 | is_subscribe | 否 | String(1) | Y | 用户是否关注公众账号，Y-关注，N-未关注，仅在公众账号类型支付有效 |
| 交易类型 | trade_type | 是 | String(16) | JSAPI | 调用接口提交的交易类型，取值如下：JSAPI，NATIVE，APP，MICROPAY，详细说明见参数规定 |
| 交易状态 | trade_state | 是 | String(32) | SUCCESS | SUCCESS—支付成功 REFUND—转入退款 NOTPAY—未支付 CLOSED—已关闭 REVOKED—已撤销（刷卡支付） USERPAYING--用户支付中 PAYERROR--支付失败(其他原因，如银行返回失败) |
| 付款银行 | bank_type | 是 | String(16) | CMC | 银行类型，采用字符串类型的银行标识 |
| 标价金额 | total_fee | 是 | Int | 100 | 订单总金额，单位为分 |
| 应结订单金额 | settlement_total_fee | 否 | Int | 100 | 应结订单金额=订单金额-非充值代金券金额，应结订单金额<=订单金额。 |
| 标价币种 | fee_type | 否 | String(8) | CNY | 货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型 |
| 现金支付金额 | cash_fee | 是 | Int | 100 | 现金支付金额订单现金支付金额，详见支付金额 |
| 现金支付币种 | cash_fee_type | 否 | String(16) | CNY | 货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型 |
| 代金券金额 | coupon_fee | 否 | Int | 100 | “代金券”金额<=订单金额，订单金额-“代金券”金额=现金支付金额，详见支付金额 |
| 代金券使用数量 | coupon_count | 否 | Int | 1 | 代金券使用数量 |
| 代金券类型 | coupon_type_$n | 否 | String | CASH | CASH--充值代金券 NO_CASH---非充值代金券 订单使用代金券时有返回（取值：CASH、NO_CASH）。$n为下标,从0开始编号，举例：coupon_type_$0 |
| 代金券ID | coupon_id_$n | 否 | String(20) | 10000 | 代金券ID, $n为下标，从0开始编号 |
| 单个代金券支付金额 | coupon_fee_$n | 否 | Int | 100 | 单个代金券支付金额, $n为下标，从0开始编号 |
| 微信支付订单号 | transaction_id | 是 | String(32) | 1009660380201506130728806387 | 微信支付订单号 |
| 商户订单号 | out_trade_no | 是 | String(32) | 20150806125346 | 商户系统的订单号，与请求一致。 |
| 附加数据 | attach | 否 | String(128) | 深圳分店 | 附加数据，原样返回 |
| 支付完成时间 | time_end | 是 | String(14) | 20141030133525 | 订单支付时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则 |
| 交易状态描述 | trade_state_desc | 是 | String(256) | 支付失败，请重新下单支付 | 对当前查询订单状态的描述和下一步操作的指引 |
举例如下：
<xml> <return_code><![CDATA[SUCCESS]]></return_code> <return_msg><![CDATA[OK]]></return_msg> <appid><![CDATA[wx2421b1c4370ec43b]]></appid> <mch_id><![CDATA[10000100]]></mch_id> <device_info><![CDATA[1000]]></device_info> <nonce_str><![CDATA[TN55wO9Pba5yENl8]]></nonce_str> <sign><![CDATA[BDF0099C15FF7BC6B1585FBB110AB635]]></sign> <result_code><![CDATA[SUCCESS]]></result_code> <openid><![CDATA[oUpF8uN95-Ptaags6E_roPHg7AG0]]></openid> <is_subscribe><![CDATA[Y]]></is_subscribe> <trade_type><![CDATA[MICROPAY]]></trade_type> <bank_type><![CDATA[CCB_DEBIT]]></bank_type> <total_fee>1</total_fee> <fee_type><![CDATA[CNY]]></fee_type> <transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id> <out_trade_no><![CDATA[1415757673]]></out_trade_no> <attach><![CDATA[订单额外描述]]></attach> <time_end><![CDATA[20141111170043]]></time_end> <trade_state><![CDATA[SUCCESS]]></trade_state> </xml>
错误码
| 名称 | 描述 | 原因 | 解决方案 |
|---|---|---|---|
| ORDERNOTEXIST | 此交易订单号不存在 | 查询系统中不存在此交易订单号 | 该API只能查提交支付交易返回成功的订单，请商户检查需要查询的订单号是否正确 |
| SYSTEMERROR | 系统错误 | 后台系统返回错误 | 系统异常，请再调用发起查询 |
3、关闭订单
应用场景
以下情况需要调用关单接口：商户订单支付失败需要生成新单号重新发起支付，要对原订单号调用关单，避免重复支付；系统下单后，用户支付超时，系统退出不再受理，避免用户继续，请调用关单接口。
注意：订单生成后不能马上调用关单接口，最短调用时间间隔为5分钟。
接口链接
接口链接：https://api.mch.weixin.qq.com/pay/closeorder
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID（企业号corpid即为此appId） |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
| 商户订单号 | out_trade_no | 是 | String(32) | 1217752501201407033233368018 | 商户系统内部的订单号 |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 商户系统内部的订单号,32个字符内、可包含字母, 其他说明见安全规范 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名，详见签名生成算法 |
| 签名类型 | sign_type | 否 | String(32) | HMAC-SHA256 | 签名类型，目前支持HMAC-SHA256和MD5，默认为MD5 |
示例代码
<xml> <appid>wx2421b1c4370ec43b</appid> <mch_id>10000100</mch_id> <nonce_str>4ca93f17ddf3443ceabf72f26d64fe0e</nonce_str> <out_trade_no>1415983244</out_trade_no> <sign>59FF1DF214B2D279A0EA7077C54DD95D</sign> </xml>
返回结果
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 返回信息 | return_msg | 否 | String(128) | 签名失败 | 返回信息，如非空，为错误原因 签名失败 参数格式校验错误 |
以下字段在return_code为SUCCESS的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于32位 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名，验证签名算 |
| 业务结果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 业务结果描述 | result_msg | 是 | String(32) | OK | 对于业务执行的详细描述 |
| 错误代码 | err_code | 否 | String(32) | SYSTEMERROR | 详细参见第6节错误列表 |
| 错误代码描述 | err_code_des | 否 | String(128) | 系统错误 | 结果信息描述 |
示例代码
<xml> <return_code><![CDATA[SUCCESS]]></return_code> <return_msg><![CDATA[OK]]></return_msg> <appid><![CDATA[wx2421b1c4370ec43b]]></appid> <mch_id><![CDATA[10000100]]></mch_id> <nonce_str><![CDATA[BFK89FC6rxKCOjLX]]></nonce_str> <sign><![CDATA[72B321D92A7BFA0B2509F3D13C7B1631]]></sign> <result_code><![CDATA[SUCCESS]]></result_code> <result_msg><![CDATA[OK]]></result_msg> </xml>
错误码
| 名称 | 描述 | 原因 | 解决方案 |
|---|---|---|---|
| ORDERPAID | 订单已支付 | 订单已支付，不能发起关单 | 订单已支付，不能发起关单，请当作已支付的正常交易 |
| SYSTEMERROR | 系统错误 | 系统错误 | 系统异常，请重新调用该API |
| ORDERNOTEXIST | 订单不存在 | 订单系统不存在此订单 | 不需要关单，当作未提交的支付的订单 |
| ORDERCLOSED | 订单已关闭 | 订单已关闭，无法重复关闭 | 订单已关闭，无需继续调用 |
| SIGNERROR | 签名错误 | 参数签名结果不正确 | 请检查签名参数和方法是否都符合签名算法要求 |
| REQUIRE_POST_METHOD | 请使用post方法 | 未使用post传递参数 | 请检查请求参数是否通过post方法提交 |
| XML_FORMAT_ERROR | XML格式错误 | XML格式错误 | 请检查XML参数格式是否正确 |
4、申请退款
应用场景
当交易发生之后一段时间内，由于买家或者卖家的原因需要退款时，卖家可以通过退款接口将支付款退还给买家，微信支付将在收到退款请求并且验证成功之后，按照退款规则将支付款按原路退到买家帐号上。
注意：
交易时间超过一年的订单无法提交退款；
微信支付退款支持单笔交易分多次退款，多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。一笔退款失败后重新提交，要采用原来的退款单号。总退款金额不能超过用户实际支付金额。
接口链接
接口链接：https://api.mch.weixin.qq.com/secapi/pay/refund
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID（企业号corpid即为此appId） |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
| 设备号 | device_info | 否 | String(32) | 013467007045764 | 终端设备号 |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于32位。推荐随机数生成算法 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名，详见签名生成算法 |
| 签名类型 | sign_type | 否 | String(32) | HMAC-SHA256 | 签名类型，目前支持HMAC-SHA256和MD5，默认为MD5 |
| 微信订单号 | transaction_id | 二选一 | String(28) | 1217752501201407033233368018 | 微信生成的订单号，在支付通知中有返回 |
| 商户订单号 | out_trade_no | String(32) | 1217752501201407033233368018 | 商户侧传给微信的订单号 | |
| 商户退款单号 | out_refund_no | 是 | String(32) | 1217752501201407033233368018 | 商户系统内部的退款单号，商户系统内部唯一，同一退款单号多次请求只退一笔 |
| 订单金额 | total_fee | 是 | Int | 100 | 订单总金额，单位为分，只能为整数，详见支付金额 |
| 退款金额 | refund_fee | 是 | Int | 100 | 退款总金额，订单总金额，单位为分，只能为整数，详见支付金额 |
| 货币种类 | refund_fee_type | 否 | String(8) | CNY | 货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型 |
| 操作员 | op_user_id | 是 | String(32) | 1900000109 | 操作员帐号, 默认为商户号 |
| 退款资金来源 | refund_account | 否 | String(30) | REFUND_SOURCE_RECHARGE_FUNDS | 仅针对老资金流商户使用 REFUND_SOURCE_UNSETTLED_FUNDS---未结算资金退款（默认使用未结算资金退款） REFUND_SOURCE_RECHARGE_FUNDS---可用余额退款 |
举例如下：
<xml> <appid>wx2421b1c4370ec43b</appid> <mch_id>10000100</mch_id> <nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str> <op_user_id>10000100</op_user_id> <out_refund_no>1415701182</out_refund_no> <out_trade_no>1415757673</out_trade_no> <refund_fee>1</refund_fee> <total_fee>1</total_fee> <transaction_id></transaction_id> <sign>FE56DD4AA85C0EECA82C35595A69E153</sign> </xml>
返回结果
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 返回信息 | return_msg | 否 | String(128) | 签名失败 | 返回信息，如非空，为错误原因 签名失败 参数格式校验错误 |
以下字段在return_code为SUCCESS的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 业务结果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL SUCCESS退款申请接收成功，结果通过退款查询接口查询 FAIL 提交业务失败 |
| 错误代码 | err_code | 否 | String(32) | SYSTEMERROR | 列表详见错误码列表 |
| 错误代码描述 | err_code_des | 否 | String(128) | 系统超时 | 结果信息描述 |
| 公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
| 设备号 | device_info | 否 | String(32) | 013467007045764 | 微信支付分配的终端设备号，与下单一致 |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于32位 |
| 签名 | sign | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 签名，详见签名算法 |
| 微信订单号 | transaction_id | 是 | String(28) | 4007752501201407033233368018 | 微信订单号 |
| 商户订单号 | out_trade_no | 是 | String(32) | 33368018 | 商户系统内部的订单号 |
| 商户退款单号 | out_refund_no | 是 | String(32) | 121775250 | 商户退款单号 |
| 微信退款单号 | refund_id | 是 | String(28) | 2007752501201407033233368018 | 微信退款单号 |
| 退款渠道 | refund_channel | 否 | String(16) | ORIGINAL | ORIGINAL—原路退款 BALANCE—退回到余额 |
| 退款金额 | refund_fee | 是 | Int | 100 | 退款总金额,单位为分,可以做部分退款 |
| 应结退款金额 | settlement_refund_fee | 否 | Int | 100 | 去掉非充值代金券退款金额后的退款金额，退款金额=申请退款金额-非充值代金券退款金额，退款金额<=申请退款金额 |
| 标价金额 | total_fee | 是 | Int | 100 | 订单总金额，单位为分，只能为整数，详见支付金额 |
| 应结订单金额 | settlement_total_fee | 否 | Int | 100 | 去掉非充值代金券金额后的订单总金额，应结订单金额=订单金额-非充值代金券金额，应结订单金额<=订单金额。 |
| 标价币种 | fee_type | 否 | String(8) | CNY | 订单金额货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型 |
| 现金支付金额 | cash_fee | 是 | Int | 100 | 现金支付金额，单位为分，只能为整数，详见支付金额 |
| 现金支付币种 | cash_fee_type | 否 | String(16) | CNY | 货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型 |
| 现金退款金额 | cash_refund_fee | 否 | Int | 100 | 现金退款金额，单位为分，只能为整数，详见支付金额 |
| 代金券类型 | coupon_type_$n | 否 | String(8) | CASH | CASH--充值代金券 NO_CASH---非充值代金券 订单使用代金券时有返回（取值：CASH、NO_CASH）。$n为下标,从0开始编号，举例：coupon_type_0 |
| 代金券退款总金额 | coupon_refund_fee | 否 | Int | 100 | 代金券退款金额<=退款金额，退款金额-代金券或立减优惠退款金额为现金，说明详见代金券或立减优惠 |
| 单个代金券退款金额 | coupon_refund_fee_$n | 否 | Int | 100 | 代金券退款金额<=退款金额，退款金额-代金券或立减优惠退款金额为现金，说明详见代金券或立减优惠 |
| 退款代金券使用数量 | coupon_refund_count | 否 | Int | 1 | 退款代金券使用数量 |
| 退款代金券ID | coupon_refund_id_$n | 否 | String(20) | 10000 | 退款代金券ID, $n为下标，从0开始编号 |
举例如下：
<xml> <return_code><![CDATA[SUCCESS]]></return_code> <return_msg><![CDATA[OK]]></return_msg> <appid><![CDATA[wx2421b1c4370ec43b]]></appid> <mch_id><![CDATA[10000100]]></mch_id> <nonce_str><![CDATA[NfsMFbUFpdbEhPXP]]></nonce_str> <sign><![CDATA[B7274EB9F8925EB93100DD2085FA56C0]]></sign> <result_code><![CDATA[SUCCESS]]></result_code> <transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id> <out_trade_no><![CDATA[1415757673]]></out_trade_no> <out_refund_no><![CDATA[1415701182]]></out_refund_no> <refund_id><![CDATA[2008450740201411110000174436]]></refund_id> <refund_channel><![CDATA[]]></refund_channel> <refund_fee>1</refund_fee> </xml>
错误码
| 名称 | 描述 | 原因 | 解决方案 |
|---|---|---|---|
| SYSTEMERROR | 接口返回错误 | 系统超时 | 请用相同参数再次调用API |
| USER_ACCOUNT_ABNORMAL | 退款请求失败 | 用户帐号注销 | 此状态代表退款申请失败，商户可自行处理退款。 |
| NOTENOUGH | 余额不足 | 商户可用退款余额不足 | 此状态代表退款申请失败，商户可根据具体的错误提示做相应的处理。 |
| INVALID_TRANSACTIONID | 无效transaction_id | 请求参数未按指引进行填写 | 请求参数错误，检查原交易号是否存在或发起支付交易接口返回失败 |
| PARAM_ERROR | 参数错误 | 请求参数未按指引进行填写 | 请求参数错误，请重新检查再调用退款申请 |
| APPID_NOT_EXIST | APPID不存在 | 参数中缺少APPID | 请检查APPID是否正确 |
| MCHID_NOT_EXIST | MCHID不存在 | 参数中缺少MCHID | 请检查MCHID是否正确 |
| APPID_MCHID_NOT_MATCH | appid和mch_id不匹配 | appid和mch_id不匹配 | 请确认appid和mch_id是否匹配 |
| REQUIRE_POST_METHOD | 请使用post方法 | 未使用post传递参数 | 请检查请求参数是否通过post方法提交 |
| SIGNERROR | 签名错误 | 参数签名结果不正确 | 请检查签名参数和方法是否都符合签名算法要求 |
| XML_FORMAT_ERROR | XML格式错误 | XML格式错误 | 请检查XML参数格式是否正确 |
5、查询退款
应用场景
提交退款申请后，通过调用该接口查询退款状态。退款有一定延时，用零钱支付的退款20分钟内到账，银行卡支付的退款3个工作日后重新查询退款状态。
接口链接
接口链接：https://api.mch.weixin.qq.com/pay/refundquery
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信支付分配的公众账号ID（企业号corpid即为此appId） |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
| 设备号 | device_info | 否 | String(32) | 013467007045764 | 商户自定义的终端设备号，如门店编号、设备的ID等 |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于32位。推荐随机数生成算法 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名，详见签名生成算法 |
| 签名类型 | sign_type | 否 | String(32) | HMAC-SHA256 | 签名类型，目前支持HMAC-SHA256和MD5，默认为MD5 |
| 微信订单号 | transaction_id | 四选一 | String(32) | 1217752501201407033233368018 | 微信订单号 |
| 商户订单号 | out_trade_no | String(32) | 1217752501201407033233368018 | 商户系统内部的订单号 | |
| 商户退款单号 | out_refund_no | String(32) | 1217752501201407033233368018 | 商户侧传给微信的退款单号 | |
| 微信退款单号 | refund_id | String(28) | 1217752501201407033233368018 | 微信生成的退款单号，在申请退款接口有返回 |
举例如下：
<xml> <appid>wx2421b1c4370ec43b</appid> <mch_id>10000100</mch_id> <nonce_str>0b9f35f484df17a732e537c37708d1d0</nonce_str> <out_refund_no></out_refund_no> <out_trade_no>1415757673</out_trade_no> <refund_id></refund_id> <transaction_id></transaction_id> <sign>66FFB727015F450D167EF38CCC549521</sign> </xml>
返回数据
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 返回信息 | return_msg | 否 | String(128) | 签名失败 | 返回信息，如非空，为错误原因 签名失败 参数格式校验错误 |
以下字段在return_code为SUCCESS的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 业务结果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL SUCCESS退款申请接收成功，结果通过退款查询接口查询 FAIL |
| 错误码 | err_code | 是 | String(32) | SYSTEMERROR | 错误码详见第6节 |
| 错误描述 | err_code_des | 是 | String(32) | 系统错误 | 结果信息描述 |
| 公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID（企业号corpid即为此appId） |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
| 设备号 | device_info | 否 | String(32) | 013467007045764 | 终端设备号 |
| 随机字符串 | nonce_str | 是 | String(28) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于32位 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名，详见签名算法 |
| 微信订单号 | transaction_id | 是 | String(32) | 1217752501201407033233368018 | 微信订单号 |
| 商户订单号 | out_trade_no | 是 | String(32) | 1217752501201407033233368018 | 商户系统内部的订单号 |
| 订单金额 | total_fee | 是 | Int | 100 | 订单总金额，单位为分，只能为整数，详见支付金额 |
| 应结订单金额 | settlement_total_fee | 否 | Int | 100 | 应结订单金额=订单金额-非充值代金券金额，应结订单金额<=订单金额。 |
| 货币种类 | fee_type | 否 | String(8) | CNY | 订单金额货币类型，符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型 |
| 现金支付金额 | cash_fee | 是 | Int | 100 | 现金支付金额，单位为分，只能为整数，详见支付金额 |
| 退款笔数 | refund_count | 是 | Int | 1 | 退款记录数 |
| 商户退款单号 | out_refund_no_$n | 是 | String(32) | 1217752501201407033233368018 | 商户退款单号 |
| 微信退款单号 | refund_id_$n | 是 | String(28) | 1217752501201407033233368018 | 微信退款单号 |
| 退款渠道 | refund_channel_$n | 否 | String(16) | ORIGINAL | ORIGINAL—原路退款 BALANCE—退回到余额 |
| 申请退款金额 | refund_fee_$n | 是 | Int | 100 | 退款总金额,单位为分,可以做部分退款 |
| 退款金额 | settlement_refund_fee_$n | 否 | Int | 100 | 退款金额=申请退款金额-非充值代金券退款金额，退款金额<=申请退款金额 |
| 退款资金来源 | refund_account | 否 | String(30) | REFUND_SOURCE_RECHARGE_FUNDS | REFUND_SOURCE_RECHARGE_FUNDS---可用余额退款/基本账户 REFUND_SOURCE_UNSETTLED_FUNDS---未结算资金退款 |
| 代金券类型 | coupon_type_$n | 否 | Int | CASH | CASH--充值代金券 NO_CASH---非充值代金券 订单使用代金券时有返回（取值：CASH、NO_CASH）。$n为下标,从0开始编号，举例：coupon_type_$0 |
| 总代金券退款金额 | coupon_refund_fee_$n | 否 | Int | 100 | 代金券退款金额<=退款金额，退款金额-代金券或立减优惠退款金额为现金，说明详见代金券或立减优惠 |
| 退款代金券使用数量 | coupon_refund_count_$n | 否 | Int | 1 | 退款代金券使用数量 ,$n为下标,从0开始编号 |
| 退款代金券ID | coupon_refund_id_$n_$m | 否 | String(20) | 10000 | 退款代金券ID, $n为下标，$m为下标，从0开始编号 |
| 单个代金券退款金额 | coupon_refund_fee_$n_$m | 否 | Int | 100 | 单个退款代金券支付金额, $n为下标，$m为下标，从0开始编号 |
| 退款状态 | refund_status_$n | 是 | String(16) | SUCCESS | 退款状态： SUCCESS—退款成功 FAIL—退款失败 PROCESSING—退款处理中 CHANGE—转入代发，退款到银行发现用户的卡作废或者冻结了，导致原路退款银行卡失败，资金回流到商户的现金帐号，需要商户人工干预，通过线下或者财付通转账的方式进行退款。 |
| 退款入账账户 | refund_recv_accout_$n | 是 | String(64) | 招商银行信用卡0403 | 取当前退款单的退款入账方 1）退回银行卡： {银行名称}{卡类型}{卡尾号} 2）退回支付用户零钱: 支付用户零钱 |
举例如下：
<xml> <appid><![CDATA[wx2421b1c4370ec43b]]></appid> <mch_id><![CDATA[10000100]]></mch_id> <nonce_str><![CDATA[TeqClE3i0mvn3DrK]]></nonce_str> <out_refund_no_0><![CDATA[1415701182]]></out_refund_no_0> <out_trade_no><![CDATA[1415757673]]></out_trade_no> <refund_count>1</refund_count> <refund_fee_0>1</refund_fee_0> <refund_id_0><![CDATA[2008450740201411110000174436]]></refund_id_0> <refund_status_0><![CDATA[PROCESSING]]></refund_status_0> <result_code><![CDATA[SUCCESS]]></result_code> <return_code><![CDATA[SUCCESS]]></return_code> <return_msg><![CDATA[OK]]></return_msg> <sign><![CDATA[1F2841558E233C33ABA71A961D27561C]]></sign> <transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id> </xml>
错误码
| 名称 | 描述 | 原因 | 解决方案 |
|---|---|---|---|
| SYSTEMERROR | 接口返回错误 | 系统超时 | 请尝试再次掉调用API。 |
| REFUNDNOTEXIST | 退款订单查询失败 | 订单号错误或订单状态不正确 | 请检查订单号是否有误以及订单状态是否正确，如：未支付、已支付未退款 |
| INVALID_TRANSACTIONID | 无效transaction_id | 请求参数未按指引进行填写 | 请求参数错误，检查原交易号是否存在或发起支付交易接口返回失败 |
| PARAM_ERROR | 参数错误 | 请求参数未按指引进行填写 | 请求参数错误，请检查参数再调用退款申请 |
| APPID_NOT_EXIST | APPID不存在 | 参数中缺少APPID | 请检查APPID是否正确 |
| MCHID_NOT_EXIST | MCHID不存在 | 参数中缺少MCHID | 请检查MCHID是否正确 |
| APPID_MCHID_NOT_MATCH | appid和mch_id不匹配 | appid和mch_id不匹配 | 请确认appid和mch_id是否匹配 |
| REQUIRE_POST_METHOD | 请使用post方法 | 未使用post传递参数 | 请检查请求参数是否通过post方法提交 |
| SIGNERROR | 签名错误 | 参数签名结果不正确 | 请检查签名参数和方法是否都符合签名算法要求 |
| XML_FORMAT_ERROR | XML格式错误 | XML格式错误 | 请检查XML参数格式是否正确 |
6、下载对账单
应用场景
商户可以通过该接口下载历史交易清单。比如掉单、系统错误等导致商户侧和微信侧数据不一致，通过对账单核对后可校正支付状态。
注意：
1、微信侧未成功下单的交易不会出现在对账单中。支付成功后撤销的交易会出现在对账单中，跟原支付单订单号一致，bill_type为REVOKED；
2、微信在次日9点启动生成前一天的对账单，建议商户10点后再获取；
3、对账单中涉及金额的字段单位为“元”。
4、对账单接口只能下载三个月以内的账单。
接口链接
https://api.mch.weixin.qq.com/pay/downloadbill
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID（企业号corpid即为此appId） |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
| 设备号 | device_info | 否 | String(32) | 013467007045764 | 微信支付分配的终端设备号 |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于32位。推荐随机数生成算法 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名，详见签名生成算法 |
| 签名类型 | sign_type | 否 | String(32) | HMAC-SHA256 | 签名类型，目前支持HMAC-SHA256和MD5，默认为MD5 |
| 对账单日期 | bill_date | 是 | String(8) | 20140603 | 下载对账单的日期，格式：20140603 |
| 账单类型 | bill_type | 是 | String(8) | ALL | ALL，返回当日所有订单信息，默认值 SUCCESS，返回当日成功支付的订单 REFUND，返回当日退款订单 |
| 压缩账单 | tar_type | 否 | String(8) | GZIP | 非必传参数，固定值：GZIP，返回格式为.gzip的压缩包账单。不传则默认为数据流形式。 |
示例代码
<xml> <appid>wx2421b1c4370ec43b</appid> <bill_date>20141110</bill_date> <bill_type>ALL</bill_type> <mch_id>10000100</mch_id> <nonce_str>21df7dc9cd8616b56919f20d9f679233</nonce_str> <sign>332F17B766FC787203EBE9D6E40457A1</sign> </xml>
返回结果
失败时，返回以下字段
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | return_code | 是 | String(16) | FAIL | FAIL |
| 返回信息 | return_msg | 否 | String(128) | 签名失败 | 返回信息，如非空，为错误原因 如：签名失败、参数格式错误等。 |
成功时，数据以文本表格的方式返回，第一行为表头，后面各行为对应的字段内容，字段内容跟查询订单或退款结果一致，具体字段说明可查阅相应接口。
第一行为表头，根据请求下载的对账单类型不同而不同(由bill_type决定),目前有：
当日所有订单
交易时间,公众账号ID,商户号,子商户号,设备号,微信订单号,商户订单号,用户标识,交易类型,交易状态,付款银行,货币种类,总金额,代金券或立减优惠金额,微信退款单号,商户退款单号,退款金额,代金券或立减优惠退款金额，退款类型，退款状态,商品名称,商户数据包,手续费,费率
当日成功支付的订单
交易时间,公众账号ID,商户号,子商户号,设备号,微信订单号,商户订单号,用户标识,交易类型,交易状态,付款银行,货币种类,总金额,代金券或立减优惠金额,商品名称,商户数据包,手续费,费率
当日退款的订单
交易时间,公众账号ID,商户号,子商户号,设备号,微信订单号,商户订单号,用户标识,交易类型,交易状态,付款银行,货币种类,总金额,代金券或立减优惠金额,退款申请时间,退款成功时间,微信退款单号,商户退款单号,退款金额,代金券或立减优惠退款金额,退款类型,退款状态,商品名称,商户数据包,手续费,费率
从第二行起，为数据记录，各参数以逗号分隔，参数前增加`符号，为标准键盘1左边键的字符，字段顺序与表头一致。
倒数第二行为订单统计标题，最后一行为统计数据
总交易单数，总交易额，总退款金额，总代金券或立减优惠退款金额，手续费总金额
举例如下：
交易时间,公众账号ID,商户号,子商户号,设备号,微信订单号,商户订单号,用户标识,交易类型,交易状态,付款银行,货币种类,总金额,代金券或立减优惠金额,微信退款单号,商户退款单号,退款金额,代金券或立减优惠退款金额,退款类型,退款状态,商品名称,商户数据包,手续费,费率
`2014-11-1016：33：45,`wx2421b1c4370ec43b,`10000100,`0,`1000,`1001690740201411100005734289,`1415640626,`085e9858e3ba5186aafcbaed1,`MICROPAY,`SUCCESS,`CFT,`CNY,`0.01,`0.0,`0,`0,`0,`0,`,`,`被扫支付测试,`订单额外描述,`0,`0.60%
`2014-11-1016：46：14,`wx2421b1c4370ec43b,`10000100,`0,`1000,`1002780740201411100005729794,`1415635270,`085e9858e90ca40c0b5aee463,`MICROPAY,`SUCCESS,`CFT,`CNY,`0.01,`0.0,`0,`0,`0,`0,`,`,`被扫支付测试,`订单额外描述,`0,`0.60%
总交易单数,总交易额,总退款金额,总代金券或立减优惠退款金额,手续费总金额 `2,`0.02,`0.0,`0.0,`0
错误码
| 名称 | 描述 | 原因 | 解决方案 |
|---|---|---|---|
| SYSTEMERROR | 下载失败 | 系统超时 | 请尝试再次查询。 |
| invalid bill_type | 参数错误 | 请求参数未按指引进行填写 | 参数错误，请重新检查 |
| data format error | |||
| missing parameter | |||
| SIGN ERROR | |||
| NO Bill Exist | 账单不存在 | 当前商户号没有已成交的订单，不生成对账单 | 请检查当前商户号在指定日期内是否有成功的交易。 |
| Bill Creating | 账单未生成 | 当前商户号没有已成交的订单或对账单尚未生成 | 请先检查当前商户号在指定日期内是否有成功的交易，如指定日期有交易则表示账单正在生成中，请在上午10点以后再下载。 |
| CompressGZip Error | 账单压缩失败 | 账单压缩失败，请稍后重试 | 账单压缩失败，请稍后重试 |
| UnCompressGZip Error | 账单解压失败 | 账单解压失败，请稍后重试 | 账单解压失败，请稍后重试 |
7、支付结果通知
应用场景
支付完成后，微信会把相关支付结果和用户信息发送给商户，商户需要接收处理，并返回应答。
对后台通知交互时，如果微信收到商户的应答不是成功或超时，微信认为通知失败，微信会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但微信不保证通知最终能成功。 （通知频率为15/15/30/180/1800/1800/1800/1800/3600，单位：秒）
注意：同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。
推荐的做法是，当收到通知进行处理时，首先检查对应业务数据的状态，判断该通知是否已经处理过，如果没有处理过再进行处理，如果处理过直接返回结果成功。在对业务数据进行状态检查和处理之前，要采用数据锁进行并发控制，以避免函数重入造成的数据混乱。
特别提醒：商户系统对于支付结果通知的内容一定要做签名验证，防止数据泄漏导致出现“假通知”，造成资金损失。
技术人员可登进微信商户后台扫描加入接口报警群。
接口链接
该链接是通过【统一下单API】中提交的参数notify_url设置，如果链接无法访问，商户将无法接收到微信通知。
通知url必须为直接可访问的url，不能携带参数。示例：notify_url：“https://pay.weixin.qq.com/wxpay/pay.action”
通知参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看result_code来判断 |
| 返回信息 | return_msg | 否 | String(128) | 签名失败 | 返回信息，如非空，为错误原因 签名失败 参数格式校验错误 |
以下字段在return_code为SUCCESS的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID（企业号corpid即为此appId） |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
| 设备号 | device_info | 否 | String(32) | 013467007045764 | 微信支付分配的终端设备号， |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于32位 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名，详见签名算法 |
| 签名类型 | sign_type | 否 | String(32) | HMAC-SHA256 | 签名类型，目前支持HMAC-SHA256和MD5，默认为MD5 |
| 业务结果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 错误代码 | err_code | 否 | String(32) | SYSTEMERROR | 错误返回的信息描述 |
| 错误代码描述 | err_code_des | 否 | String(128) | 系统错误 | 错误返回的信息描述 |
| 用户标识 | openid | 是 | String(128) | wxd930ea5d5a258f4f | 用户在商户appid下的唯一标识 |
| 是否关注公众账号 | is_subscribe | 否 | String(1) | Y | 用户是否关注公众账号，Y-关注，N-未关注，仅在公众账号类型支付有效 |
| 交易类型 | trade_type | 是 | String(16) | JSAPI | JSAPI、NATIVE、APP |
| 付款银行 | bank_type | 是 | String(16) | CMC | 银行类型，采用字符串类型的银行标识，银行类型见银行列表 |
| 订单金额 | total_fee | 是 | Int | 100 | 订单总金额，单位为分 |
| 应结订单金额 | settlement_total_fee | 否 | Int | 100 | 应结订单金额=订单金额-非充值代金券金额，应结订单金额<=订单金额。 |
| 货币种类 | fee_type | 否 | String(8) | CNY | 货币类型，符合ISO4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型 |
| 现金支付金额 | cash_fee | 是 | Int | 100 | 现金支付金额订单现金支付金额，详见支付金额 |
| 现金支付货币类型 | cash_fee_type | 否 | String(16) | CNY | 货币类型，符合ISO4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型 |
| 总代金券金额 | coupon_fee | 否 | Int | 10 | 代金券金额<=订单金额，订单金额-代金券金额=现金支付金额，详见支付金额 |
| 代金券使用数量 | coupon_count | 否 | Int | 1 | 代金券使用数量 |
| 代金券类型 | coupon_type_$n | 否 | Int | CASH | CASH--充值代金券 NO_CASH---非充值代金券 订单使用代金券时有返回（取值：CASH、NO_CASH）。$n为下标,从0开始编号，举例：coupon_type_0 |
| 代金券ID | coupon_id_$n | 否 | String(20) | 10000 | 代金券ID,$n为下标，从0开始编号 |
| 单个代金券支付金额 | coupon_fee_$n | 否 | Int | 100 | 单个代金券支付金额,$n为下标，从0开始编号 |
| 微信支付订单号 | transaction_id | 是 | String(32) | 1217752501201407033233368018 | 微信支付订单号 |
| 商户订单号 | out_trade_no | 是 | String(32) | 1212321211201407033568112322 | 商户系统的订单号，与请求一致。 |
| 商家数据包 | attach | 否 | String(128) | 123456 | 商家数据包，原样返回 |
| 支付完成时间 | time_end | 是 | String(14) | 20141030133525 | 支付完成时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则 |
举例如下：
<xml> <appid><![CDATA[wx2421b1c4370ec43b]]></appid> <attach><![CDATA[支付测试]]></attach> <bank_type><![CDATA[CFT]]></bank_type> <fee_type><![CDATA[CNY]]></fee_type> <is_subscribe><![CDATA[Y]]></is_subscribe> <mch_id><![CDATA[10000100]]></mch_id> <nonce_str><![CDATA[5d2b6c2a8db53831f7eda20af46e531c]]></nonce_str> <openid><![CDATA[oUpF8uMEb4qRXf22hE3X68TekukE]]></openid> <out_trade_no><![CDATA[1409811653]]></out_trade_no> <result_code><![CDATA[SUCCESS]]></result_code> <return_code><![CDATA[SUCCESS]]></return_code> <sign><![CDATA[B552ED6B279343CB493C5DD0D78AB241]]></sign> <sub_mch_id><![CDATA[10000100]]></sub_mch_id> <time_end><![CDATA[20140903131540]]></time_end> <total_fee>1</total_fee> <trade_type><![CDATA[JSAPI]]></trade_type> <transaction_id><![CDATA[1004400740201409030005092168]]></transaction_id> </xml>
返回参数
商户处理后同步返回给微信参数：
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL SUCCESS表示商户接收通知成功并校验成功 |
| 返回信息 | return_msg | 否 | String(128) | OK | 返回信息，如非空，为错误原因： 签名失败 参数格式校验错误 |
举例如下：
<xml> <return_code><![CDATA[SUCCESS]]></return_code> <return_msg><![CDATA[OK]]></return_msg> </xml>
8、交易保障
应用场景
商户在调用微信支付提供的相关接口时，会得到微信支付返回的相关信息以及获得整个接口的响应时间。为提高整体的服务水平，协助商户一起提高服务质量，微信支付提供了相关接口调用耗时和返回信息的主动上报接口，微信支付可以根据商户侧上报的数据进一步优化网络部署，完善服务监控，和商户更好的协作为用户提供更好的业务体验。
接口链接
https://api.mch.weixin.qq.com/payitil/report
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID（企业号corpid即为此appId） |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
| 设备号 | device_info | 否 | String(32) | 013467007045764 | 微信支付分配的终端设备号，商户自定义 |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于32位。推荐随机数生成算法 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名，详见签名生成算法 |
| 签名类型 | sign_type | 否 | String(32) | HMAC-SHA256 | 签名类型，目前支持HMAC-SHA256和MD5，默认为MD5 |
| 接口URL | interface_url | 是 | String(127) | https://api.mch.weixin.qq.com/pay/unifiedorder | 报对应的接口的完整URL，类似： https://api.mch.weixin.qq.com/pay/unifiedorder 对于刷卡支付，为更好的和商户共同分析一次业务行为的整体耗时情况，对于两种接入模式，请都在门店侧对一次刷卡支付进行一次单独的整体上报，上报URL指定为： https://api.mch.weixin.qq.com/pay/micropay/total 关于两种接入模式具体可参考本文档章节：刷卡支付商户接入模式 其它接口调用仍然按照调用一次，上报一次来进行。 |
| 接口耗时 | execute_time | 是 | Int | 1000 | 接口耗时情况，单位为毫秒 |
| 返回状态码 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看trade_state来判断 |
| 返回信息 | return_msg | 否 | String(128) | 签名失败 | 返回信息，如非空，为错误原因 签名失败 参数格式校验错误 |
| 业务结果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 错误代码 | err_code | 否 | String(32) | SYSTEMERROR | ORDERNOTEXIST—订单不存在 SYSTEMERROR—系统错误 |
| 错误代码描述 | err_code_des | 否 | String(128) | 系统错误 | 结果信息描述 |
| 商户订单号 | out_trade_no | 否 | String(32) | 1217752501201407033233368018 | 商户系统内部的订单号,商户可以在上报时提供相关商户订单号方便微信支付更好的提高服务质量。 |
| 访问接口IP | user_ip | 是 | String(16) | 8.8.8.8 | 发起接口调用时的机器IP |
| 商户上报时间 | time | 否 | String(14) | 20091227091010 | 系统时间，格式为yyyyMMddHHmmss，如2009年12月27日9点10分10秒表示为20091227091010。其他详见时间规则 |
返回结果
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看result_code来判断 |
| 返回信息 | return_msg | 否 | String(128) | 签名失败 | 返回信息，如非空，为错误原因 签名失败 参数格式校验错误 |
以下字段在return_code为SUCCESS的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 业务结果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
错误码
无
9、转换短链接
应用场景
该接口主要用于扫码原生支付模式一中的二维码链接转成短链接(weixin://wxpay/s/XXXXXX)，减小二维码数据量，提升扫描速度和精确度。
接口链接
https://api.mch.weixin.qq.com/tools/shorturl
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID（企业号corpid即为此appId） |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
| URL链接 | long_url | 是 | String(512、 | weixin：//wxpay/bizpayurl?sign=XXXXX&appid=XXXXX&mch_id=XXXXX&product_id=XXXXXX&time_stamp=XXXXXX&nonce_str=XXXXX | 需要转换的URL，签名用原串，传输需URLencode |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于32位。推荐随机数生成算法 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名，详见签名生成算法 |
| 签名类型 | sign_type | 否 | String(32) | HMAC-SHA256 | 签名类型，目前支持HMAC-SHA256和MD5，默认为MD5 |
返回结果
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看result_code来判断 |
| 返回信息 | return_msg | 否 | String(128) | 签名失败 | 返回信息，如非空，为错误原因签名失败 参数格式校验错误 |
以下字段在return_code为SUCCESS的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号ID |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于32位。推荐随机数生成算法 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名，详见签名生成算法 |
| 业务结果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 错误代码 | err_code | 否 | String(32) | SYSTEMERROR | SYSTEMERROR—系统错误 URLFORMATERROR—URL格式错误 |
| URL链接 | short_url | 是 | String(64) | weixin：//wxpay/s/XXXXXX | 转换后的URL |
错误码
| 名称 | 描述 | 原因 | 解决方案 |
|---|---|---|---|
| SIGNERROR | 签名错误 | 参数签名结果不正确 | 请检查签名参数和方法是否都符合签名算法要求 |
| REQUIRE_POST_METHOD | 请使用post方法 | 未使用post传递参数 | 请检查请求参数是否通过post方法提交 |
| APPID_NOT_EXIST | APPID不存在 | 参数中缺少APPID | 请检查APPID是否正确 |
| MCHID_NOT_EXIST | MCHID不存在 | 参数中缺少MCHID | 请检查MCHID是否正确 |
| APPID_MCHID_NOT_MATCH | appid和mch_id不匹配 | appid和mch_id不匹配 | 请确认appid和mch_id是否匹配 |
| LACK_PARAMS | 缺少参数 | 缺少必要的请求参数 | 请检查参数是否齐全 |
| XML_FORMAT_ERROR | XML格式错误 | XML格式错误 | 请检查XML参数格式是否正确 |
| POST_DATA_EMPTY | post数据为空 | post数据不能为空 | 请检查post数据是否为空 |
未经允许请勿转载：程序喵 » 微信公众号开发教程——微信扫码支付开发者文档（下）