1. 技术文章
  2. 小程序支付接口

小程序支付接口

由 痞子三分冷 提交于 2019-12-04 09:29:00

 

统一下单接口

这里下单不是我们业务中下单，这里的下单是对我们微信支付接口下单

应用场景

商户在小程序中先调用该接口在微信支付服务后台生成预支付交易单，返回正确的预支付交易后调起支付。

接口链接

URL地址：https://api.mch.weixin.qq.com/pay/unifiedorder

字段名变量名必填类型示例值描述
小程序ID appid 是 String(32) wxd678efh567hg6787 微信分配的小程序ID
商户号 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) MD5 签名类型，默认为MD5，支持HMAC-SHA256和MD5。
商品描述 body 是 String(128) 腾讯充值中心-QQ会员充值 商品简单描述，该字段请按照规范传递，具体请见参数规定
商品详情 detail 否 String(6000)   商品详细描述，对于使用单品优惠的商户，该字段必须按照规范上传，详见“单品优惠参数说明”
附加数据 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(64) 123.12.12.123 支持IPV4和IPV6两种格式的IP地址。调用微信支付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。订单失效时间是针对订单号而言的，由于在请求支付的时候有一个必传参数prepay_id只有两小时的有效期，所以在重入时间超过2小时的时候需要重新请求下单接口获取新的prepay_id。其他详见时间规则建议：最短失效时间间隔大于1分钟
订单优惠标记 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，详细说明见参数规定
商品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】。
电子发票入口开放标识 receipt 否 String(8) Y Y，传入Y时，支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能，传此字段才可生效
+场景信息 scene_info 否 String(256) {"store_info" : { "id": "SZTX001", "name": "腾大餐厅", "area_code": "440305", "address": "科技园中一路腾讯大厦" }} 该字段常用于线下活动时的场景信息上报，支持上报实际门店信息，商户也可以按需求自己上报相关信息。该字段为JSON对象数据，对象格式为{"store_info":{"id": "门店ID","name": "名称","area_code": "编码","address": "地址" }} ，字段详细说明请点击行前的+展开

在里面我们只对必传字段进行解释，其他字段根据开发的需求而定

1 appid

​ 我们小程序的唯一标识，在注册的时候我们已经知道了
2 mch_id

​ 我们使用支付，就必须开通支付，以公司的证件开通，开通过后就分配该mch_id

3 nonce_str:随机字符串不能超过32位

​ 代码实现：

def get_random(self):
    import random
    data = "123456789zxcvbnmasdfghjklqwertyuiopZXCVBNMASDFGHJKLQWERTYUIOP"
    nonce_str = "".join(random.sample(data, 30))
    return nonce_str

4 sign：签名，期作用是为了防止我们发送的数据陪黑客拦截，在上面表格的链接中官方已经给出算法，我们这里直接实现：

 def get_sign():
        data_dic = {
            #随机字符串
            "nonce_str": nonce_str,
            #商城订单号，不能重复，大家可以更具公司要求，生成订单号
            "out_trade_no": out_trade_no,
            #客户端请求的ip
            "spbill_create_ip": spbill_create_ip,
            #回调地址，就是微信服务异步通知我们的支付结果时候的url,这个url不能携带参数
            #错误 http://www.test.com/notify_url?name=weixin
            #正确 http://www.test.com/notify_url
            "notify_url": notify_url,
            #用户唯一标识，是那个用户要发起支付
            "openid": open_id,
            #订单表述
            "body": body,
            #固定值，用小程序支付必须传这个JSAPI
            "trade_type": "JSAPI",
            "appid": appid,
            #该次支付所要支付的钱数，是以分为单位，大家要注意
            "total_fee": total_fee,
            "mch_id": mch_id
        }
        #这里pay_apikey是和mch_id一起分配的
        sign_str = "&".join([f"{k}={data_dic[k]}" for k in sorted(data_dic)])
        sign_str = f"{sign_str}&key={pay_apikey}"
        import hashlib
        md5 = hashlib.md5()
        md5.update(sign_str.encode("utf-8"))
        sign = md5.hexdigest()
        return sign.upper()

最终将数据组织成xml数据。如下：

<xml>
   <appid>wx2421b1c4370ec43b</appid>
   <body>JSAPI支付测试</body>
   <mch_id>10000100</mch_id>
   <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解析器解析。

这里最终是以xml的形式发送数据，所以我们发送数据的时候要用heard头中的"content-type:application/xml"

发送请求代码：

#将xml数据转化成字典
def xml_to_dic(self, xml_data):
    import xml.etree.ElementTree as ET
    xml_dict = {}
    root = ET.fromstring(xml_data)
    for child in root:
        xml_dict[child.tag] = child.text
        return xml_dict

def get_body_data():
    body_data = f"""
           <xml>
               <appid>{appid}</appid>
               <mch_id>{mch_id}</mch_id>
               <nonce_str>{nonce_str}</nonce_str>
               <sign>{sign}</sign>
               <body>{body}</body>
               <out_trade_no>{out_trade_no}</out_trade_no>
               <total_fee>{total_free}</total_fee>
               <spbill_create_ip>{spbill_create_ip}</spbill_create_ip>
               <notify_url>{notify_url}</notify_url>
               <openid>{open_id}</openid>
               <trade_type>JSAPI</trade_type> 
           </xml>"""
    import requests
    url = "https://api.mch.weixin.qq.com/pay/unifiedorder"
    response = requests.post(url, data_body.encode("utf-8"), headers={'content-type': "application/xml"})
    #由于返回的数据也是xml的，我们需要将xml数据转化成字典，
    res_dict =xml_to_dic(response.content)

返回结果

字段名变量名必填类型示例值描述
返回状态码 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) weixin://wxpay/bizpayurl/up?pr=NwY5Mz9&groupid=00 trade_type=NATIVE时有返回，此url用于生成支付二维码，然后提供给用户进行扫码支付。注意：code_url的值并非固定，使用时按照URL格式转成二维码即可
 
 

统一下单接口

这里下单不是我们业务中下单，这里的下单是对我们微信支付接口下单

应用场景

商户在小程序中先调用该接口在微信支付服务后台生成预支付交易单，返回正确的预支付交易后调起支付。

接口链接

URL地址：https://api.mch.weixin.qq.com/pay/unifiedorder

字段名变量名必填类型示例值描述
小程序ID appid 是 String(32) wxd678efh567hg6787 微信分配的小程序ID
商户号 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) MD5 签名类型，默认为MD5，支持HMAC-SHA256和MD5。
商品描述 body 是 String(128) 腾讯充值中心-QQ会员充值 商品简单描述，该字段请按照规范传递，具体请见参数规定
商品详情 detail 否 String(6000)   商品详细描述，对于使用单品优惠的商户，该字段必须按照规范上传，详见“单品优惠参数说明”
附加数据 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(64) 123.12.12.123 支持IPV4和IPV6两种格式的IP地址。调用微信支付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。订单失效时间是针对订单号而言的，由于在请求支付的时候有一个必传参数prepay_id只有两小时的有效期，所以在重入时间超过2小时的时候需要重新请求下单接口获取新的prepay_id。其他详见时间规则建议：最短失效时间间隔大于1分钟
订单优惠标记 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，详细说明见参数规定
商品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】。
电子发票入口开放标识 receipt 否 String(8) Y Y，传入Y时，支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能，传此字段才可生效
+场景信息 scene_info 否 String(256) {"store_info" : { "id": "SZTX001", "name": "腾大餐厅", "area_code": "440305", "address": "科技园中一路腾讯大厦" }} 该字段常用于线下活动时的场景信息上报，支持上报实际门店信息，商户也可以按需求自己上报相关信息。该字段为JSON对象数据，对象格式为{"store_info":{"id": "门店ID","name": "名称","area_code": "编码","address": "地址" }} ，字段详细说明请点击行前的+展开

在里面我们只对必传字段进行解释，其他字段根据开发的需求而定

1 appid

​ 我们小程序的唯一标识，在注册的时候我们已经知道了
2 mch_id

​ 我们使用支付，就必须开通支付，以公司的证件开通，开通过后就分配该mch_id

3 nonce_str:随机字符串不能超过32位

​ 代码实现：

def get_random(self):
    import random
    data = "123456789zxcvbnmasdfghjklqwertyuiopZXCVBNMASDFGHJKLQWERTYUIOP"
    nonce_str = "".join(random.sample(data, 30))
    return nonce_str

4 sign：签名，期作用是为了防止我们发送的数据陪黑客拦截，在上面表格的链接中官方已经给出算法，我们这里直接实现：

 def get_sign():
        data_dic = {
            #随机字符串
            "nonce_str": nonce_str,
            #商城订单号，不能重复，大家可以更具公司要求，生成订单号
            "out_trade_no": out_trade_no,
            #客户端请求的ip
            "spbill_create_ip": spbill_create_ip,
            #回调地址，就是微信服务异步通知我们的支付结果时候的url,这个url不能携带参数
            #错误 http://www.test.com/notify_url?name=weixin
            #正确 http://www.test.com/notify_url
            "notify_url": notify_url,
            #用户唯一标识，是那个用户要发起支付
            "openid": open_id,
            #订单表述
            "body": body,
            #固定值，用小程序支付必须传这个JSAPI
            "trade_type": "JSAPI",
            "appid": appid,
            #该次支付所要支付的钱数，是以分为单位，大家要注意
            "total_fee": total_fee,
            "mch_id": mch_id
        }
        #这里pay_apikey是和mch_id一起分配的
        sign_str = "&".join([f"{k}={data_dic[k]}" for k in sorted(data_dic)])
        sign_str = f"{sign_str}&key={pay_apikey}"
        import hashlib
        md5 = hashlib.md5()
        md5.update(sign_str.encode("utf-8"))
        sign = md5.hexdigest()
        return sign.upper()

最终将数据组织成xml数据。如下：

<xml>
   <appid>wx2421b1c4370ec43b</appid>
   <body>JSAPI支付测试</body>
   <mch_id>10000100</mch_id>
   <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解析器解析。

这里最终是以xml的形式发送数据，所以我们发送数据的时候要用heard头中的"content-type:application/xml"

发送请求代码：

#将xml数据转化成字典
def xml_to_dic(self, xml_data):
    import xml.etree.ElementTree as ET
    xml_dict = {}
    root = ET.fromstring(xml_data)
    for child in root:
        xml_dict[child.tag] = child.text
        return xml_dict

def get_body_data():
    body_data = f"""
           <xml>
               <appid>{appid}</appid>
               <mch_id>{mch_id}</mch_id>
               <nonce_str>{nonce_str}</nonce_str>
               <sign>{sign}</sign>
               <body>{body}</body>
               <out_trade_no>{out_trade_no}</out_trade_no>
               <total_fee>{total_free}</total_fee>
               <spbill_create_ip>{spbill_create_ip}</spbill_create_ip>
               <notify_url>{notify_url}</notify_url>
               <openid>{open_id}</openid>
               <trade_type>JSAPI</trade_type> 
           </xml>"""
    import requests
    url = "https://api.mch.weixin.qq.com/pay/unifiedorder"
    response = requests.post(url, data_body.encode("utf-8"), headers={'content-type': "application/xml"})
    #由于返回的数据也是xml的，我们需要将xml数据转化成字典，
    res_dict =xml_to_dic(response.content)

返回结果

字段名变量名必填类型示例值描述
返回状态码 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) weixin://wxpay/bizpayurl/up?pr=NwY5Mz9&groupid=00 trade_type=NATIVE时有返回，此url用于生成支付二维码，然后提供给用户进行扫码支付。注意：code_url的值并非固定，使用时按照URL格式转成二维码即可
标签
小程序
xml格式
string
sign
易学教程内所有资源均来自网络或用户发布的内容，如有违反法律规定的内容欢迎反馈！
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!