\Alipay\EasySDK\Payment\CommonClient

Summary

Methods
Properties
Constants
__construct()
create()
query()
refund()
close()
cancel()
queryRefund()
downloadBill()
verifyNotify()
agent()
auth()
asyncNotify()
route()
optional()
batchOptional()
No public properties found
No constants found
No protected methods found
$_kernel
N/A
No private methods found
No private properties found
N/A

Properties

$_kernel

$_kernel

Methods

__construct()

__construct(mixed  $kernel) : mixed

Parameters

mixed $kernel

Returns

mixed —

create()

create(string  $subject, string  $outTradeNo, string  $totalAmount, string  $buyerId) : \Alipay\EasySDK\Payment\Common\Models\AlipayTradeCreateResponse

Parameters

string $subject
string $outTradeNo
string $totalAmount
string $buyerId

Throws

\AlibabaCloud\Tea\Exception\TeaError
\Exception
\AlibabaCloud\Tea\Exception\TeaUnableRetryError

Returns

\Alipay\EasySDK\Payment\Common\Models\AlipayTradeCreateResponse —

query()

query(string  $outTradeNo) : \Alipay\EasySDK\Payment\Common\Models\AlipayTradeQueryResponse

Parameters

string $outTradeNo

Throws

\AlibabaCloud\Tea\Exception\TeaError
\Exception
\AlibabaCloud\Tea\Exception\TeaUnableRetryError

Returns

\Alipay\EasySDK\Payment\Common\Models\AlipayTradeQueryResponse —

refund()

refund(string  $outTradeNo, string  $refundAmount) : \Alipay\EasySDK\Payment\Common\Models\AlipayTradeRefundResponse

Parameters

string $outTradeNo
string $refundAmount

Throws

\AlibabaCloud\Tea\Exception\TeaError
\Exception
\AlibabaCloud\Tea\Exception\TeaUnableRetryError

Returns

\Alipay\EasySDK\Payment\Common\Models\AlipayTradeRefundResponse —

close()

close(string  $outTradeNo) : \Alipay\EasySDK\Payment\Common\Models\AlipayTradeCloseResponse

Parameters

string $outTradeNo

Throws

\AlibabaCloud\Tea\Exception\TeaError
\Exception
\AlibabaCloud\Tea\Exception\TeaUnableRetryError

Returns

\Alipay\EasySDK\Payment\Common\Models\AlipayTradeCloseResponse —

cancel()

cancel(string  $outTradeNo) : \Alipay\EasySDK\Payment\Common\Models\AlipayTradeCancelResponse

Parameters

string $outTradeNo

Throws

\AlibabaCloud\Tea\Exception\TeaError
\Exception
\AlibabaCloud\Tea\Exception\TeaUnableRetryError

Returns

\Alipay\EasySDK\Payment\Common\Models\AlipayTradeCancelResponse —

queryRefund()

queryRefund(string  $outTradeNo, string  $outRequestNo) : \Alipay\EasySDK\Payment\Common\Models\AlipayTradeFastpayRefundQueryResponse

Parameters

string $outTradeNo
string $outRequestNo

Throws

\AlibabaCloud\Tea\Exception\TeaError
\Exception
\AlibabaCloud\Tea\Exception\TeaUnableRetryError

Returns

\Alipay\EasySDK\Payment\Common\Models\AlipayTradeFastpayRefundQueryResponse —

downloadBill()

downloadBill(string  $billType, string  $billDate) : \Alipay\EasySDK\Payment\Common\Models\AlipayDataDataserviceBillDownloadurlQueryResponse

Parameters

string $billType
string $billDate

Throws

\AlibabaCloud\Tea\Exception\TeaError
\Exception
\AlibabaCloud\Tea\Exception\TeaUnableRetryError

Returns

\Alipay\EasySDK\Payment\Common\Models\AlipayDataDataserviceBillDownloadurlQueryResponse —

verifyNotify()

verifyNotify(string[]  $parameters) : bool

Parameters

string[] $parameters

Returns

bool —

agent()

agent( $appAuthToken) : $this

ISV代商户代用,指定appAuthToken

Parameters

$appAuthToken

String 代调用token

Returns

$this —

本客户端,便于链式调用

auth()

auth( $authToken) : $this

用户授权调用,指定authToken

Parameters

$authToken

String 用户授权token

Returns

$this —

asyncNotify()

asyncNotify( $url) : $this

设置异步通知回调地址,此处设置将在本调用中覆盖Config中的全局配置

Parameters

$url

String 异步通知回调地址,例如:https://www.test.com/callback

Returns

$this —

route()

route( $testUrl) : $this

将本次调用强制路由到后端系统的测试地址上,常用于线下环境内外联调,沙箱与线上环境设置无效

Parameters

$testUrl

String 后端系统测试地址

Returns

$this —

optional()

optional( $key,  $value) : $this

设置API入参中没有的其他可选业务请求参数(biz_content下的字段)

Parameters

$key

String 业务请求参数名称(biz_content下的字段名,比如timeout_express)

$value

object 业务请求参数的值,一个可以序列化成JSON的对象 如果该字段是一个字符串类型(String、Price、Date在SDK中都是字符串),请使用String储存 如果该字段是一个数值型类型(比如:Number),请使用Long储存 如果该字段是一个复杂类型,请使用嵌套的array指定各下级字段的值 如果该字段是一个数组,请使用array储存各个值

Returns

$this —

batchOptional()

batchOptional( $optionalArgs) : $this

批量设置API入参中没有的其他可选业务请求参数(biz_content下的字段) optional方法的批量版本

Parameters

$optionalArgs

array 可选参数集合,每个参数由key和value组成,key和value的格式请参见optional方法的注释

Returns

$this —