新零售支付全家桶


扫码支付接口说明

创建支付订单

扫码支付的流程中,微信平台是把创建支付订单和扣款合并到一起了,所以用一幅时序图就能讲明白扫码付款的全流程。

比如说我们到家乐福买东西,出来结账的时候,收银员在电脑上创建订单。接下来就应该轮到用户出示付款码,然后收银员就要拿着扫码器,扫描我们手机上面的付款码,就相当于把付款码文字输入到收银系统中当扫码完毕,扫码器会输入一个回车符,收银系统接收到回车符以后,接下来就要把付款码文字发送给后端系统。当然了,为了保证数据传输的安全性,应该选用HTTPS协议,这样用户的付款码就不会泄露出去。目前的开发阶段,我们可以使用HTTP协议,但是真正部署到运营环境中,必须要使用HTTPS协议。后端系统接收到付款码之后,接下来要把这个付款码和其他的参数,一起上传给微信平台,这其中就包含了APPID、商户号、随机字符串,以及数字签名等等。微信平台验证过这些数据之后看,接下来就生成支付订单,并且完成扣款,然后把支付的结果分别发送给微信用户和商户系统如果支付成功,商户系统会更新商品订单状态,然后把支付结果发送给收银系统,收银系统只是一个前端系统,它接收到通知以后,刷新一下页面,于是就能看到订单已经付款的状态了。各位同学,因为扫码支付生成订单和扣款流程合并成了一个,所以原来我们写代码要对应两幅时序图,现在只需要完成一幅时序图就可以了。看来这一章我们写的代码会更少一些。

输入参数

名称 变量名 必填 类型 示例值 描述
公众账号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
商品描述 body String(128) image形象店-深圳腾大- QQ公仔 商品简单描述,该字段须严格按照规范传递,具体请见参数规定
商品详情 detail String(6000) 单品优惠功能字段,需要接入详见单品优惠详细说明
附加数据 attach String(127) 说明 附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
商户订单号 out_trade_no String(32) 1217752501201407033233368018 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-\ *且在同一个商户号下唯一。详见商户订单号
订单金额 total_fee Int 888 订单总金额,单位为分,只能为整数,详见支付金额
货币类型 fee_type String(16) CNY 符合ISO4217标准的三位字母代码,默认人民币:CNY,详见货币类型
终端IP spbill_create_ip String(64) 8.8.8.8 支持IPV4和IPV6两种格式的IP地址。调用微信支付API的机器IP
订单优惠标记 goods_tag String(32) 1234 订单优惠标记,代金券或立减优惠功能的参数,详见代金券或立减优惠
指定支付方式 limit_pay String(32) no_credit no_credit--指定不能使用信用卡支付
交易起始时间 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。注意:最短失效时间间隔需大于1分钟
电子发票入口开放标识 receipt String(8) Y Y,传入Y时,支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能,传此字段才可生效
付款码 auth_code String(128) 120061098828009406 扫码支付付款码,设备读取用户微信中的条码或者二维码信息 (注:用户付款码条形码规则:18位纯数字,以10、11、12、13、14、15开头)
+场景信息 scene_info String(256) {"store_info" : { "id": "SZTX001", "name": "腾大餐厅", "area_code": "440305", "address": "科技园中一路腾讯大厦" }} 该字段用于上报场景信息,目前支持上报实际门店信息。该字段为JSON对象数据,对象格式为{"store_info":{"id": "门店ID","name": "名称","area_code": "编码","address": "地址" }} ,字段详细说明请点击行前的+展开

举例如下:

<xml>
   <appid>wx2421b1c4370ec43b</appid>
   <attach>订单额外描述</attach>
   <auth_code>120269300684844649</auth_code>
   <body>付款码支付测试</body>
   <device_info>1000</device_info>
   <goods_tag></goods_tag>
   <mch_id>10000100</mch_id>
   <nonce_str>8aaee146b1dee7cec9100add9b96cbe2</nonce_str>
   <out_trade_no>1415757673</out_trade_no>
   <spbill_create_ip>14.17.22.52</spbill_create_ip>
   <time_expire></time_expire>
   <total_fee>1</total_fee>
   <sign>C29DB7DB1FD4136B84AE35604756362C</sign>
</xml>

注:参数值用XML转义即可,CDATA标签用于说明数据不被XML解析器解析。

返回结果

名称 变量名 必填 类型 示例值 描述
返回状态码 return_code String(16) SUCCESS SUCCESS/FAIL此字段是接口通信情况标识,非交易成功与否的标识
返回信息 return_msg String(128) OK 当return_code为FAIL时返回信息为错误原因 ,例如签名失败参数格式校验错误

当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的时,还会包括以下字段:

名称 变量名 必填 类型 示例值 描述
用户标识 openid String(128) Y 用户在商户appid 下的唯一标识
是否关注公众账号 is_subscribe String(1) Y 用户是否关注公众账号,仅在公众账号类型支付有效,取值范围:Y或N;Y-关注;N-未关注
交易类型 trade_type String(16) MICROPAY MICROPAY 付款码支付
付款银行 bank_type String(32) CMC 银行类型,采用字符串类型的银行标识,详见银行类型
货币类型 fee_type String(16) CNY 符合ISO 4217标准的三位字母代码,默认人民币:CNY,详见货币类型
订单金额 total_fee Int 888 订单总金额,单位为分,只能为整数,详见支付金额
应结订单金额 settlement_total_fee Int 100 当订单使用了免充值型优惠券后返回该参数,应结订单金额=订单金额-免充值优惠券金额。
代金券金额 coupon_fee Int 100 “代金券”金额<=订单金额,订单金额-“代金券”金额=现金支付金额,详见支付金额
现金支付货币类型 cash_fee_type String(16) CNY 符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型
现金支付金额 cash_fee Int 100 订单现金支付金额,详见支付金额
微信支付订单号 transaction_id String(32) 1217752501201407033233368018 微信支付订单号
商户订单号 out_trade_no String(32) 1217752501201407033233368018 商户系统内部订单号,要求32个字符内,只能是数字、大小写字母_-\ *且在同一个商户号下唯一。
商家数据包 attach String(128) 123456 商家数据包,原样返回
支付完成时间 time_end String(14) 20141030133525 订单生成时间,格式为yyyyMMddHHmmss,如2009年12月25日9点10分10秒表示为20091225091010。详见时间规则
营销详情 promotion_detail String(6000) 示例见下文 新增返回,单品优惠功能字段,需要接入请见详细说明

举例如下:

&lt;xml&gt;
   &lt;return_code&gt;&lt;![CDATA[SUCCESS]]&gt;&lt;/return_code&gt;
   &lt;return_msg&gt;&lt;![CDATA[OK]]&gt;&lt;/return_msg&gt;
   &lt;appid&gt;&lt;![CDATA[wx2421b1c4370ec43b]]&gt;&lt;/appid&gt;
   &lt;mch_id&gt;&lt;![CDATA[10000100]]&gt;&lt;/mch_id&gt;
   &lt;device_info&gt;&lt;![CDATA[1000]]&gt;&lt;/device_info&gt;
   &lt;nonce_str&gt;&lt;![CDATA[GOp3TRyMXzbMlkun]]&gt;&lt;/nonce_str&gt;
   &lt;sign&gt;&lt;![CDATA[D6C76CB785F07992CDE05494BB7DF7FD]]&gt;&lt;/sign&gt;
   &lt;result_code&gt;&lt;![CDATA[SUCCESS]]&gt;&lt;/result_code&gt;
   &lt;openid&gt;&lt;![CDATA[oUpF8uN95-Ptaags6E_roPHg7AG0]]&gt;&lt;/openid&gt;
   &lt;is_subscribe&gt;&lt;![CDATA[Y]]&gt;&lt;/is_subscribe&gt;
   &lt;trade_type&gt;&lt;![CDATA[MICROPAY]]&gt;&lt;/trade_type&gt;
   &lt;bank_type&gt;&lt;![CDATA[CCB_DEBIT]]&gt;&lt;/bank_type&gt;
   &lt;total_fee&gt;1&lt;/total_fee&gt;
   &lt;coupon_fee&gt;0&lt;/coupon_fee&gt;
   &lt;fee_type&gt;&lt;![CDATA[CNY]]&gt;&lt;/fee_type&gt;
   &lt;transaction_id&gt;&lt;![CDATA[1008450740201411110005820873]]&gt;&lt;/transaction_id&gt;
   &lt;out_trade_no&gt;&lt;![CDATA[1415757673]]&gt;&lt;/out_trade_no&gt;
   &lt;attach&gt;&lt;![CDATA[订单额外描述]]&gt;&lt;/attach&gt;
   &lt;time_end&gt;&lt;![CDATA[20141111170043]]&gt;&lt;/time_end&gt;
&lt;/xml&gt;

错误码

注意:如果当前交易返回的支付状态是明确的错误原因造成的支付失败(支付确认失败),请重新下单支付;如果当前交易返回的支付状态是不明错误(支付结果未知),请调用查询订单接口确认状态,如果长时间(建议30秒)都得不到明确状态请调用撤销订单接口。

名称 描述 支付状态 原因 解决方案
SYSTEMERROR 接口返回错误 支付结果未知 系统超时 请立即调用被扫订单结果查询API,查询当前订单状态,并根据订单的状态决定下一步的操作。
PARAM_ERROR 参数错误 支付确认失败 请求参数未按指引进行填写 请根据接口返回的详细信息检查您的程序
ORDERPAID 订单已支付 支付确认失败 订单号重复 请确认该订单号是否重复支付,如果是新单,请使用新订单号提交
NOAUTH 商户无权限 支付确认失败 商户没有开通被扫支付权限 请开通商户号权限。请联系产品或商务申请
AUTHCODEEXPIRE 二维码已过期,请用户在微信上刷新后再试 支付确认失败 用户的条码已经过期 请收银员提示用户,请用户在微信上刷新条码,然后请收银员重新扫码。 直接将错误展示给收银员
NOTENOUGH 余额不足 支付确认失败 用户的零钱余额不足 请收银员提示用户更换当前支付的卡,然后请收银员重新扫码。建议:商户系统返回给收银台的提示为“用户余额不足.提示用户换卡支付”
NOTSUPORTCARD 不支持卡类型 支付确认失败 用户使用卡种不支持当前支付形式 请用户重新选择卡种 建议:商户系统返回给收银台的提示为“该卡不支持当前支付,提示用户换卡支付或绑新卡支付”
ORDERCLOSED 订单已关闭 支付确认失败 该订单已关 商户订单号异常,请重新下单支付
ORDERREVERSED 订单已撤销 支付确认失败 当前订单已经被撤销 当前订单状态为“订单已撤销”,请提示用户重新支付
BANKERROR 银行系统异常 支付结果未知 银行端超时 请立即调用被扫订单结果查询API,查询当前订单的不同状态,决定下一步的操作。
USERPAYING 用户支付中,需要输入密码 支付结果未知 该笔交易因为业务规则要求,需要用户输入支付密码。 等待5秒,然后调用被扫订单结果查询API,查询当前订单的不同状态,决定下一步的操作。
AUTH_CODE_ERROR 付款码参数错误 支付确认失败 请求参数未按指引进行填写 每个二维码仅限使用一次,请刷新再试
AUTH_CODE_INVALID 付款码检验错误 支付确认失败 收银员扫描的不是微信支付的条码 请扫描微信支付被扫条码/二维码
XML_FORMAT_ERROR XML格式错误 支付确认失败 XML格式错误 请检查XML参数格式是否正确
REQUIRE_POST_METHOD 请使用post方法 支付确认失败 未使用post传递参数 请检查请求参数是否通过post方法提交
SIGNERROR 签名错误 支付确认失败 参数签名结果不正确 请检查签名参数和方法是否都符合签名算法要求
LACK_PARAMS 缺少参数 支付确认失败 缺少必要的请求参数 请检查参数是否齐全
NOT_UTF8 编码格式错误 支付确认失败 未使用指定编码格式 请使用UTF-8编码格式
BUYER_MISMATCH 支付帐号错误 支付确认失败 暂不支持同一笔订单更换支付方 请确认支付方是否相同
APPID_NOT_EXIST APPID不存在 支付确认失败 参数中缺少APPID 请检查APPID是否正确
MCHID_NOT_EXIST MCHID不存在 支付确认失败 参数中缺少MCHID 请检查MCHID是否正确
OUT_TRADE_NO_USED 商户订单号重复 支付确认失败 同一笔交易不能多次提交 请核实商户订单号是否重复提交
APPID_MCHID_NOT_MATCH appid和mch_id不匹配 支付确认失败 appid和mch_id不匹配 请确认appid和mch_id是否匹配
INVALID_REQUEST 无效请求 支付确认失败 商户系统异常导致,商户权限异常、重复请求支付、证书错误、频率限制等 请确认商户系统是否正常,是否具有相应支付权限,确认证书是否正确,控制频率
TRADE_ERROR 交易错误 支付确认失败 业务错误导致交易失败、用户账号异常、风控、规则限制等 请确认帐号是否存在异常

页面列表

ITEM_HTML