公众号支付

优质
小牛编辑
136浏览
2023-12-01

说明

微信公众号支付SDK。

官方文档:https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_1

请求参数类

支付参数

类名:\Yurun\PaySDK\Weixin\JSAPI\Params\Pay\Request

属性
名称类型说明
$scene_info\Yurun\PaySDK\Weixin\JSAPI\Params\SceneInfo场景信息
$openidstring微信用户在商户对应appid下的唯一标识
$sub_openidstring微信用户在子商户appid下的唯一标识
$_apiMethodstring接口名称
$device_infostring终端设备号(门店号或收银设备ID),注意:PC网页或公众号内支付请传"WEB"
$bodystring商品简单描述,该字段须严格按照规范传递,具体请见https://pay.weixin.qq.com/wiki/doc/api/H5.php?chapter=4_2
$detail\Yurun\PaySDK\Weixin\Params\Detail商品详细描述,对于使用单品优惠的商户,改字段必须按照规范上传,详见https://pay.weixin.qq.com/wiki/doc/api/danpin.php?chapter=9_102&index=2
$attachstring附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
$out_trade_nostring商户系统内部的订单号,32个字符内、可包含字母, 其他说明见https://pay.weixin.qq.com/wiki/doc/api/H5.php?chapter=4_2
$fee_typestring符合ISO 4217标准的三位字母代码,默认人民币:CNY,其他值列表详见https://pay.weixin.qq.com/wiki/doc/api/app/app.php?chapter=4_2
$total_feestring订单总金额,单位为分,详见https://pay.weixin.qq.com/wiki/doc/api/H5.php?chapter=4_2
$spbill_create_ipstring必须传正确的用户端IP
APP和网页支付提交用户端ip,Native支付填调用微信支付API的机器IP。
$time_startstring订单生成时间,格式为yyyyMMddHHmmss,如2009年12月25日9点10分10秒表示为20091225091010。
$time_expirestring订单失效时间,格式为yyyyMMddHHmmss,如2009年12月27日9点10分10秒表示为20091227091010。
注意:最短失效时间间隔必须大于5分钟
$goods_tagstring订单优惠标记(商品标记)
商品标记,代金券或立减优惠功能的参数,说明详见https://pay.weixin.qq.com/wiki/doc/api/tools/sp_coupon.php?chapter=12_1
$notify_urlstring异步接收微信支付结果通知的回调地址,通知url必须为外网可访问的url,不能携带参数。
$trade_typestring交易类型,取值如下:JSAPI,NATIVE,APP等
$limit_paystring指定支付方式
no_credit--指定不能使用信用卡支付
$needSignTypeboolean参数中需要带有sign_type
$allowReportboolean是否允许上报
$_methodstring接口请求方法
$_isSyncVerifyboolean是否同步返回验证

场景信息

类名:\Yurun\PaySDK\Weixin\JSAPI\Params\SceneInfo

属性
名称类型说明
$idstring门店唯一标识
$namestring门店名称
$area_codestring门店所在地行政区划码,详细见https://pay.weixin.qq.com/wiki/doc/api/download/store_adress.csv
$addressstring门店详细地址

商品详细描述

类名:\Yurun\PaySDK\Weixin\Params\Detail

属性
名称类型说明
$cost_priceint订单原价
1.商户侧一张小票订单可能被分多次支付,订单原价用于记录整张小票的交易金额。
2.当订单原价与支付金额不相等,则不享受优惠。
3.该字段主要用于限定同一张小票多次支付,以享受多次优惠的情况,正常支付订单不必上传此参数。
$receipt_idstring商家小票ID
$goods_detailarray<\Yurun\PaySDK\Weixin\Params\GoodsDetail>单品列表

单品信息

类名:\Yurun\PaySDK\Weixin\Params\GoodsDetail

属性
名称类型说明
$goods_idstring商品编码
$wxpay_goods_idstring微信侧商品编码
$goods_namestring商品名称
$quantityint商品数量
$priceint商品单价

简单使用

// 配置参数
$params = new \Yurun\PaySDK\Weixin\Params\PublicParams;
$params->appID = '10000000'; // 支付平台分配给开发者的应用ID 
$params->mch_id = '3333333'; // 微信支付分配的商户号
$params->key = '1111111'; // API 密钥
// 如需使用敏感接口(如退款、发送红包等)需要配置 API 证书路径(登录商户平台下载 API 证书)
$params->certPath = 'path/cert.pem', // XXX: 绝对路径!!!
$params->keyPath = 'path/key',      // XXX: 绝对路径!!!!
// 如果是子服务商需要配置
$params->sub_appid = ''; // 微信分配的子商户公众账号ID,服务商、银行服务商需要。
$params-> sub_mch_id  = ''; // 微信支付分配的子商户号,开发者模式下必填,服务商、银行服务商需要。


// SDK实例化,传入公共配置
$pay = new \Yurun\PaySDK\Weixin\SDK($params);

// 支付接口(生成支付订单)
$request = new \Yurun\PaySDK\Weixin\JSAPI\Params\Pay\Request;
$request->body = 'test'; // 商品描述
$request->out_trade_no = 'test' . mt_rand(10000000,99999999); // 订单号
$request->total_fee = 1; // 订单总金额,单位为:分
$request->spbill_create_ip = '127.0.0.1'; // 客户端ip
$request->notify_url = $GLOBALS['PAY_CONFIG']['pay_notify_url']; // 异步通知地址
$request->openid = ''; // 必须设置openid

// 调用接口
$result = $pay->execute($request);

var_dump('result:', $result);

var_dump('success:', $pay->checkResult());

var_dump('error:', $pay->getError(), 'error_code:', $pay->getErrorCode());

if($pay->checkResult())
{
    $request = new \Yurun\PaySDK\Weixin\JSAPI\Params\JSParams\Request;
    $request->prepay_id = $result['prepay_id'];
    $jsapiParams = $pay->execute($request);
    // 最后需要将数据传给js,使用WeixinJSBridge进行支付
    echo json_encode($jsapiParams);
}

详见:test/Weixin/JSAPI/unifiedorder.php