\WxPayApi

接口访问类,包含所有微信支付API列表的封装,类中方法为static方法, 每个接口有默认超时时间(除提交被扫支付为10s,上报超时时间为1s外,其他均为6s)

Summary

Methods
Properties
Constants
unifiedOrder()
orderQuery()
closeOrder()
refund()
refundQuery()
downloadBill()
micropay()
reverse()
report()
bizpayurl()
shorturl()
notify()
getNonceStr()
replyNotify()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
reportCostTime()
postXmlCurl()
getMillisecond()
No private properties found
N/A

Methods

unifiedOrder()

unifiedOrder(\WxPayUnifiedOrder  $inputObj, integer  $timeOut = 6) : \成功时返回,其他抛异常

统一下单,WxPayUnifiedOrder中out_trade_no、body、total_fee、trade_type必填 appid、mchid、spbill_create_ip、nonce_str不需要填入

Parameters

\WxPayUnifiedOrder $inputObj
integer $timeOut

Throws

\WxPayException

Returns

\成功时返回,其他抛异常

orderQuery()

orderQuery(\WxPayOrderQuery  $inputObj, integer  $timeOut = 6) : \成功时返回,其他抛异常

查询订单,WxPayOrderQuery中out_trade_no、transaction_id至少填一个 appid、mchid、spbill_create_ip、nonce_str不需要填入

Parameters

\WxPayOrderQuery $inputObj
integer $timeOut

Throws

\WxPayException

Returns

\成功时返回,其他抛异常

closeOrder()

closeOrder(\WxPayCloseOrder  $inputObj, integer  $timeOut = 6) : \成功时返回,其他抛异常

关闭订单,WxPayCloseOrder中out_trade_no必填 appid、mchid、spbill_create_ip、nonce_str不需要填入

Parameters

\WxPayCloseOrder $inputObj
integer $timeOut

Throws

\WxPayException

Returns

\成功时返回,其他抛异常

refund()

refund(\WxPayRefund  $inputObj, integer  $timeOut = 6) : \成功时返回,其他抛异常

申请退款,WxPayRefund中out_trade_no、transaction_id至少填一个且 out_refund_no、total_fee、refund_fee、op_user_id为必填参数 appid、mchid、spbill_create_ip、nonce_str不需要填入

Parameters

\WxPayRefund $inputObj
integer $timeOut

Throws

\WxPayException

Returns

\成功时返回,其他抛异常

refundQuery()

refundQuery(\WxPayRefundQuery  $inputObj, integer  $timeOut = 6) : \成功时返回,其他抛异常

查询退款 提交退款申请后,通过调用该接口查询退款状态。退款有一定延时, 用零钱支付的退款20分钟内到账,银行卡支付的退款3个工作日后重新查询退款状态。 WxPayRefundQuery中out_refund_no、out_trade_no、transaction_id、refund_id四个参数必填一个 appid、mchid、spbill_create_ip、nonce_str不需要填入

Parameters

\WxPayRefundQuery $inputObj
integer $timeOut

Throws

\WxPayException

Returns

\成功时返回,其他抛异常

downloadBill()

downloadBill(\WxPayDownloadBill  $inputObj, integer  $timeOut = 6) : \成功时返回,其他抛异常

下载对账单,WxPayDownloadBill中bill_date为必填参数 appid、mchid、spbill_create_ip、nonce_str不需要填入

Parameters

\WxPayDownloadBill $inputObj
integer $timeOut

Throws

\WxPayException

Returns

\成功时返回,其他抛异常

micropay()

micropay(\WxPayWxPayMicroPay  $inputObj, integer  $timeOut = 10) 

提交被扫支付API 收银员使用扫码设备读取微信用户刷卡授权码以后,二维码或条码信息传送至商户收银台, 由商户收银台或者商户后台调用该接口发起支付。 WxPayWxPayMicroPay中body、out_trade_no、total_fee、auth_code参数必填 appid、mchid、spbill_create_ip、nonce_str不需要填入

Parameters

\WxPayWxPayMicroPay $inputObj
integer $timeOut

reverse()

reverse(\WxPayReverse  $inputObj, integer  $timeOut = 6) 

撤销订单API接口,WxPayReverse中参数out_trade_no和transaction_id必须填写一个 appid、mchid、spbill_create_ip、nonce_str不需要填入

Parameters

\WxPayReverse $inputObj
integer $timeOut

Throws

\WxPayException

report()

report(\WxPayReport  $inputObj, integer  $timeOut = 1) : \成功时返回,其他抛异常

测速上报,该方法内部封装在report中,使用时请注意异常流程 WxPayReport中interface_url、return_code、result_code、user_ip、execute_time_必填 appid、mchid、spbill_create_ip、nonce_str不需要填入

Parameters

\WxPayReport $inputObj
integer $timeOut

Throws

\WxPayException

Returns

\成功时返回,其他抛异常

bizpayurl()

bizpayurl(\WxPayBizPayUrl  $inputObj, integer  $timeOut = 6) : \成功时返回,其他抛异常

生成二维码规则,模式一生成支付二维码 appid、mchid、spbill_create_ip、nonce_str不需要填入

Parameters

\WxPayBizPayUrl $inputObj
integer $timeOut

Throws

\WxPayException

Returns

\成功时返回,其他抛异常

shorturl()

shorturl(\WxPayShortUrl  $inputObj, integer  $timeOut = 6) : \成功时返回,其他抛异常

转换短链接 该接口主要用于扫码原生支付模式一中的二维码链接转成短链接(weixin://wxpay/s/XXXXXX), 减小二维码数据量,提升扫描速度和精确度。 appid、mchid、spbill_create_ip、nonce_str不需要填入

Parameters

\WxPayShortUrl $inputObj
integer $timeOut

Throws

\WxPayException

Returns

\成功时返回,其他抛异常

notify()

notify(\function  $callback,   $msg) 

支付结果通用通知

Parameters

\function $callback

直接回调函数使用方法: notify(you_function); 回调类成员函数方法:notify(array($this, you_function)); $callback 原型为:function function_name($data){}

$msg

getNonceStr()

getNonceStr(integer  $length = 32) : \产生的随机字符串

产生随机字符串,不长于32位

Parameters

integer $length

Returns

\产生的随机字符串

replyNotify()

replyNotify(string  $xml) 

直接输出xml

Parameters

string $xml

reportCostTime()

reportCostTime(  $url, integer  $startTimeStamp, array  $data) 

上报数据, 上报的时候将屏蔽所有异常流程

Parameters

$url
integer $startTimeStamp
array $data

postXmlCurl()

postXmlCurl(string  $xml, string  $url, boolean  $useCert = false, integer  $second = 30) 

以post方式提交xml到对应的接口url

Parameters

string $xml

需要post的xml数据

string $url

url

boolean $useCert

是否需要证书,默认不需要

integer $second

url执行超时时间,默认30s

Throws

\WxPayException

getMillisecond()

getMillisecond() 

获取毫秒级别的时间戳