\EasyWeChat\PaymentAPI

__construct()

__construct(\EasyWeChat\Payment\Merchant  $merchant, \Doctrine\Common\Cache\Cache|null  $cache = null) 

API constructor.

Parameters

getHttp()

getHttp() : \EasyWeChat\Core\Http

Return the http instance.

Returns

setHttp()

setHttp(\EasyWeChat\Core\Http  $http) : $this

Set the http instance.

Parameters

Returns

getAccessToken()

getAccessToken() : \EasyWeChat\Core\AccessToken

Return the current accessToken.

Returns

setAccessToken()

setAccessToken(\EasyWeChat\Core\AccessToken  $accessToken) : $this

Set the request token.

Parameters

Returns

maxRetries()

maxRetries(integer  $retries) 

Parameters

parseJSON()

parseJSON(string  $method, array  $args) : \EasyWeChat\Support\Collection

Parse JSON from response and check error.

Parameters

Throws

\EasyWeChat\Core\Exceptions\HttpException

Returns

| null

pay()

pay(\EasyWeChat\Payment\Order  $order) : \EasyWeChat\Support\Collection

Pay the order.

Parameters

Returns

prepare()

prepare(\EasyWeChat\Payment\Order  $order) : \EasyWeChat\Support\Collection

Prepare order to pay.

Parameters

Returns

query()

query(string  $orderNo, string  $type = self::OUT_TRADE_NO) : \EasyWeChat\Support\Collection

Query order.

Parameters

Returns

queryByTransactionId()

queryByTransactionId(string  $transactionId) : \EasyWeChat\Support\Collection

Query order by transaction_id.

Parameters

Returns

close()

close(  $tradeNo) : \EasyWeChat\Support\Collection

Close order by out_trade_no.

Parameters

Returns

reverse()

reverse(string  $orderNo, string  $type = self::OUT_TRADE_NO) : \EasyWeChat\Support\Collection

Reverse order.

Parameters

Returns

reverseByTransactionId()

reverseByTransactionId(integer  $transactionId) : \EasyWeChat\Support\Collection

Reverse order by transaction_id.

Parameters

Returns

refund()

refund(string  $orderNo, string  $refundNo, float  $totalFee, float  $refundFee = null, string  $opUserId = null, string  $type = self::OUT_TRADE_NO, string  $refundAccount = 'REFUND_SOURCE_UNSETTLED_FUNDS', string  $refundReason = '') : \EasyWeChat\Support\Collection

Make a refund request.

Parameters

Returns

refundByTransactionId()

refundByTransactionId(string  $orderNo, string  $refundNo, float  $totalFee, float  $refundFee = null, string  $opUserId = null, string  $refundAccount = 'REFUND_SOURCE_UNSETTLED_FUNDS', string  $refundReason = '') : \EasyWeChat\Support\Collection

Refund by transaction id.

Parameters

Returns

queryRefund()

queryRefund(string  $orderNo, string  $type = self::OUT_TRADE_NO) : \EasyWeChat\Support\Collection

Query refund status.

Parameters

Returns

queryRefundByRefundNo()

queryRefundByRefundNo(string  $refundNo) : \EasyWeChat\Support\Collection

Query refund status by out_refund_no.

Parameters

Returns

queryRefundByTransactionId()

queryRefundByTransactionId(string  $transactionId) : \EasyWeChat\Support\Collection

Query refund status by transaction_id.

Parameters

Returns

queryRefundByRefundId()

queryRefundByRefundId(string  $refundId) : \EasyWeChat\Support\Collection

Query refund status by refund_id.

Parameters

Returns

downloadBill()

downloadBill(string  $date, string  $type = self::BILL_TYPE_ALL) : \Psr\Http\Message\ResponseInterface

Download bill history as a table file.

Parameters

Returns

urlShorten()

urlShorten(string  $url) : \EasyWeChat\Support\Collection

Convert long url to short url.

Parameters

Returns

report()

report(string  $api, integer  $timeConsuming, string  $resultCode, string  $returnCode, array  $other = array()) : \EasyWeChat\Support\Collection

Report API status to WeChat.

Parameters

Returns

authCodeToOpenId()

authCodeToOpenId(string  $authCode) : \EasyWeChat\Support\Collection

Get openid by auth code.

Parameters

Returns

setMerchant()

setMerchant(\EasyWeChat\Payment\Merchant  $merchant) : $this

Merchant setter.

Parameters

Returns

getMerchant()

getMerchant() : \EasyWeChat\Payment\Merchant

Merchant getter.

Returns

sandboxMode()

sandboxMode(boolean  $enabled = false) : $this

Set sandbox mode.

Parameters

Returns

getSignkey()

getSignkey(string  $api) : string

Return key to sign.

Parameters

Returns

getCache()

getCache() : \Doctrine\Common\Cache\Cache

Return the cache manager.

Returns

registerHttpMiddlewares()

registerHttpMiddlewares() 

Register Guzzle middlewares.

accessTokenMiddleware()

accessTokenMiddleware() : \Closure

Attache access token to request query.

Returns

logMiddleware()

logMiddleware() : \Closure

Log the request.

Returns

retryMiddleware()

retryMiddleware() : \Closure

Return retry middleware.

Returns

checkAndThrow()

checkAndThrow(array  $contents) 

Check the array data errors, and Throw exception when the contents contains error.

Parameters

Throws

\EasyWeChat\Core\Exceptions\HttpException

request()

request(string  $api, array  $params, string  $method = 'post', array  $options = array(), boolean  $returnResponse = false) : \EasyWeChat\Support\Collection|\Psr\Http\Message\ResponseInterface

Make a API request.

Parameters

Returns

safeRequest()

safeRequest(string  $api, array  $params, string  $method = 'post') : \EasyWeChat\Support\Collection

Request with SSL.

Parameters

Returns

parseResponse()

parseResponse(\Psr\Http\Message\ResponseInterface  $response) : \EasyWeChat\Support\Collection

Parse Response XML to array.

Parameters

Returns

wrapApi()

wrapApi(string  $resource) : string

Wrap API.

Parameters

Returns

getSandboxSignKey()

getSandboxSignKey() : string

Get sandbox sign key.

Returns