Gitee
\
Wechat
Lib

\WechatWechatPay

微信支付SDK

Summary

Methods
Properties
Constants
__construct()
getError()
getErrorCode()
getAppid()
getConfig()
postXml()
postXmlSSL()
getArrayResult()
createMicroPay()
getNotify()
replyXml()
getPrepayId()
getQrcPrepayId()
getQrcPayUrl()
createMchPay()
closeOrder()
queryOrder()
refund()
refundQuery()
getBill()
sendRedPack()
queryRedPack()
transfers()
queryTransfers()
shortUrl()
sendCoupon()
$appid
$config
$mch_id
$partnerKey
$ssl_cer
$ssl_key
$errMsg
$errCode
MCH_BASE_URL
createXml()
_parseResult()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

MCH_BASE_URL

MCH_BASE_URL = 'https://api.mch.weixin.qq.com'

支付接口基础地址

Properties

$appid

$appid :

公众号appid

Type

$config

$config :

公众号配置

Type

$mch_id

$mch_id :

商户身份ID

Type

$partnerKey

$partnerKey :

商户支付密钥Key

Type

$ssl_cer

$ssl_cer :

证书路径

Type

$ssl_key

$ssl_key :

Type

$errMsg

$errMsg :

执行错误消息及代码

Type

$errCode

$errCode :

Type

Methods

__construct()

__construct(array  $options = array())

WechatPay constructor.

Parameters

array $options

getError()

getError() : string

获取当前错误内容

Returns

string

getErrorCode()

getErrorCode() : integer

当前当前错误代码

Returns

integer

getAppid()

getAppid() : string

获取当前操作公众号APPID

Returns

string

getConfig()

getConfig() : array

获取SDK配置参数

Returns

array

postXml()

postXml(array  $data, string  $url) : mixed

POST提交XML

Parameters

array $data
string $url

Returns

mixed

postXmlSSL()

postXmlSSL(array  $data, string  $url) : mixed

使用证书post请求XML

Parameters

array $data
string $url

Returns

mixed

getArrayResult()

getArrayResult(array  $data, string  $url, string  $method = 'postXml') : array

POST提交获取Array结果

Parameters

array $data

需要提交的数据
string $url
string $method

Returns

array

createMicroPay()

createMicroPay(string  $auth_code, string  $out_trade_no, integer  $total_fee, string  $body, null  $goods_tag = null) : array|boolean

创建刷卡支付参数包

Parameters

string $auth_code

授权Code号
string $out_trade_no

商户订单号
integer $total_fee

支付费用
string $body

订单标识
null $goods_tag

商品标签

Returns

array|boolean

getNotify()

getNotify() : boolean|array

支付通知验证处理

Returns

boolean|array

replyXml()

replyXml(array  $data, boolean  $isReturn = false) : string

支付XML统一回复

Parameters

array $data

需要回复的XML内容数组
boolean $isReturn

是否返回XML内容，默认不返回

Returns

string

getPrepayId()

getPrepayId(string  $openid, string  $body, string  $out_trade_no, integer  $total_fee, string  $notify_url, string  $trade_type = "JSAPI", string  $goods_tag = null, string  $fee_type = 'CNY', null  $no_credit = null) : boolean|string

获取预支付ID

Parameters

string $openid

用户openid，JSAPI必填
string $body

商品标题
string $out_trade_no

第三方订单号
integer $total_fee

订单总价
string $notify_url

支付成功回调地址
string $trade_type

支付类型JSAPI|NATIVE|APP
string $goods_tag

商品标记，代金券或立减优惠功能的参数
string $fee_type

交易币种
null $no_credit

是否禁止信用

Returns

boolean|string

getQrcPrepayId()

getQrcPrepayId(string  $openid, string  $body, string  $out_trade_no, integer  $total_fee, string  $notify_url, string  $goods_tag = null, string  $fee_type = 'CNY') : boolean|string

获取二维码预支付ID

Parameters

string $openid

用户openid，JSAPI必填
string $body

商品标题
string $out_trade_no

第三方订单号
integer $total_fee

订单总价
string $notify_url

支付成功回调地址
string $goods_tag

商品标记，代金券或立减优惠功能的参数
string $fee_type

交易币种

Returns

boolean|string

getQrcPayUrl()

getQrcPayUrl(string  $product_id) : string

获取支付规二维码

Parameters

string $product_id

商户定义的商品id 或者订单号

Returns

string

createMchPay()

createMchPay(string  $prepay_id) : array

创建JSAPI支付参数包

Parameters

string $prepay_id

Returns

array

closeOrder()

closeOrder(string  $out_trade_no) : boolean

关闭订单

Parameters

string $out_trade_no

Returns

boolean

queryOrder()

queryOrder(  $out_trade_no) : boolean|array

查询订单详情

Parameters

$out_trade_no

Returns

boolean|array

refund()

refund(string  $out_trade_no, string  $transaction_id, string  $out_refund_no, integer  $total_fee, integer  $refund_fee, integer|null  $op_user_id = null, string  $refund_account = '', string  $refund_desc = '', string  $refund_fee_type = 'CNY') : boolean

订单退款接口

Parameters

string $out_trade_no

商户订单号
string $transaction_id

微信订单号，与 out_refund_no 二选一（不选时传0或false）
string $out_refund_no

商户退款订单号，与 transaction_id 二选一（不选时传0或false）
integer $total_fee

商户订单总金额
integer $refund_fee

退款金额，不可大于订单总金额
integer|null $op_user_id

操作员ID，默认商户ID
string $refund_account

退款资金来源 仅针对老资金流商户使用 REFUND_SOURCE_UNSETTLED_FUNDS --- 未结算资金退款（默认使用未结算资金退款） REFUND_SOURCE_RECHARGE_FUNDS --- 可用余额退款
string $refund_desc

退款原因
string $refund_fee_type

退款货币种类

Returns

boolean

refundQuery()

refundQuery(string  $out_trade_no) : boolean|array

退款查询接口

Parameters

string $out_trade_no

Returns

boolean|array

getBill()

getBill(string  $bill_date, string  $bill_type = 'ALL') : boolean|array

获取对账单

Parameters

string $bill_date

账单日期，如 20141110
string $bill_type

ALL|SUCCESS|REFUND|REVOKED

Returns

boolean|array

sendRedPack()

sendRedPack(string  $openid, integer  $total_amount, string  $mch_billno, string  $sendname, string  $wishing, string  $act_name, string  $remark, null|integer  $total_num = 1, null|string  $scene_id = null, string  $risk_info = '', null|string  $consume_mch_id = null) : array|boolean

发送现金红包

Parameters

string $openid

红包接收者OPENID
integer $total_amount

红包总金额
string $mch_billno

商户订单号
string $sendname

商户名称
string $wishing

红包祝福语
string $act_name

活动名称
string $remark

备注信息
null|integer $total_num

红包发放总人数（大于1为裂变红包）
null|string $scene_id

场景id
string $risk_info

活动信息
null|string $consume_mch_id

资金授权商户号

Returns

array|boolean

queryRedPack()

queryRedPack(string  $billno) : boolean|array

现金红包状态查询

Parameters

string $billno

Returns

boolean|array

transfers()

transfers(string  $openid, integer  $amount, string  $billno, string  $desc) : boolean|array

企业付款

Parameters

string $openid

红包接收者OPENID
integer $amount

红包总金额
string $billno

商户订单号
string $desc

备注信息

Returns

boolean|array

queryTransfers()

queryTransfers(string  $billno) : boolean|array

企业付款查询

Parameters

string $billno

Returns

boolean|array

shortUrl()

shortUrl(string  $url) : boolean|string

二维码链接转成短链接

Parameters

string $url

需要处理的长链接

Returns

boolean|string

sendCoupon()

sendCoupon(integer  $coupon_stock_id, string  $partner_trade_no, string  $openid, string  $op_user_id = null) : boolean|array

发放代金券

Parameters

integer $coupon_stock_id

代金券批次id
string $partner_trade_no

商户此次发放凭据号（格式：商户id+日期+流水号），商户侧需保持唯一性
string $openid

Openid信息
string $op_user_id

操作员帐号, 默认为商户号 可在商户平台配置操作员对应的api权限

Returns

boolean|array

createXml()

createXml(array  $data) : string

设置标配的请求参数，生成签名，生成接口参数xml

Parameters

array $data

Returns

string

_parseResult()

_parseResult(array  $result) : boolean|array

解析返回的结果

Parameters

array $result

Returns

boolean|array