Files
cunkebao_v3/Server/extend/alipay-sdk-all/v3/docs/Api/AlipayOpenSpOperationResultApi.md

89 lines
6.5 KiB
Markdown
Raw Normal View History

2025-03-12 12:18:06 +08:00
# Alipay\OpenAPISDK\AlipayOpenSpOperationResultApi
All URIs are relative to https://openapi.alipay.com.
Method | HTTP request | Description
------------- | ------------- | -------------
[**query()**](AlipayOpenSpOperationResultApi.md#query) | **GET** /v3/alipay/open/sp/operation/result/query | 查询服务商代运营操作结果
## `query()`
```php
query($operateType, $batchNo, $accessProductCode, $merchantNo, $alipayAccount, $isvScenePermissions): \Alipay\OpenAPISDK\Model\AlipayOpenSpOperationResultQueryResponseModel
```
查询服务商代运营操作结果
查询服务商代运营操作(代运营授权或者账号绑定)结果。提供两种查询方式: 方式一operate_type + batch_no提供基于操作批次的精确查询只查询本操作批次的代运营操作结果不反映最终代运营操作结果。 方式一查询方式优先级更高。 方式二operate_type + access_product_code + merchant_no + alipay_account 参数组合,可以查询代运营操作最终结果,任意一个操作批次成功都会体现在最终结果中。 方式三operate_type + isv_scene_permissions + merchant_no + alipay_account 参数组合,可以查询代运营操作最终结果,任意一个操作批次成功都会体现在最终结果中(仅支持查询授权结果)。
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Alipay\OpenAPISDK\Api\AlipayOpenSpOperationResultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
// 初始化alipay参数
$alipayConfig = new \Alipay\OpenAPISDK\Util\Model\AlipayConfig();
$alipayConfig->setAppId('app_id');
$alipayConfig->setPrivateKey('private_key');
// 密钥模式
$alipayConfig->setAlipayPublicKey('alipay_public_key');
// 证书模式
// $alipayConfig->setAppCertPath('../appCertPublicKey.crt');
// $alipayConfig->setAlipayPublicCertPath('../alipayCertPublicKey_RSA2.crt');
// $alipayConfig->setRootCertPath('../alipayRootCert.crt');
$alipayConfig->setEncryptKey('encrypt_key');
$alipayConfigUtil = new \Alipay\OpenAPISDK\Util\AlipayConfigUtil($alipayConfig);
$apiInstance->setAlipayConfigUtil($alipayConfigUtil);
$operateType = ACCOUNT_BIND; // string | 代运营操作类型。取值如下 ACCOUNT_BIND账号绑定 OPERATION_AUTH代运营授权。
$batchNo = 2020222342342; // string | 支付宝操作批次号。 batch_no提供基于操作批次的精确查询只查询本操作批次的代运营操作结果不反映最终代运营操作结果。 注意: 1.access_product_code、merchant_no、alipay_account三个参数组合与传入 batch_no 为两种查询方式,不可同时为空且以 batch_no 优先。 2.access_product_code、merchant_no、alipay_account三个参数组合可以查询最终代运营操作结果。
$accessProductCode = OPENAPI_BIND_DEFAULT; // string | 接入的产品编号。未传batch_no时必填枚举如下 OPENAPI_BIND_DEFAULT操作类型为账号绑定 OPENAPI_AUTH_DEFAULT操作类型为代运营授权。
$merchantNo = 2088912341234123; // string | 支付宝商户号。支持间连、直连商户值为2088开头。 未传batch_no时需注意 若查询间连商户则 merchant_no 必填; 若查询直连商户则merchant_no和alipay_account不能同时为空都有值优先取merchant_no。
$alipayAccount = testaccount@test.com; // string | 支付宝登录账号通常为手机号或者邮箱。未传batch_no时需注意 1.当查询merchant_no为间连商户时 * 若 operate_type=ACCOUNT_BIND则alipay_account必填。 * 若 operate_type=OPERATION_AUTH则alipay_account无需传入。 2.当查询merchant_no为直连商户时 * merchant_no和alipay_account不能同时为空都有值优先取merchant_no。
$isvScenePermissions = SHOP_MANAGE:SHOP_MANAGE_BASE;PROMOTION_MANAGE:PROMOTION_MANAGE_BASE; // string | 场景授权列表结构结构场景codeA:权限code1,权限code2;场景codeB:权限code1,权限code2;
try {
$result = $apiInstance->query($operateType, $batchNo, $accessProductCode, $merchantNo, $alipayAccount, $isvScenePermissions);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AlipayOpenSpOperationResultApi->query: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**operateType** | **string**| 代运营操作类型。取值如下 ACCOUNT_BIND账号绑定 OPERATION_AUTH代运营授权。 | [optional]
**batchNo** | **string**| 支付宝操作批次号。 batch_no提供基于操作批次的精确查询只查询本操作批次的代运营操作结果不反映最终代运营操作结果。 注意: 1.access_product_code、merchant_no、alipay_account三个参数组合与传入 batch_no 为两种查询方式,不可同时为空且以 batch_no 优先。 2.access_product_code、merchant_no、alipay_account三个参数组合可以查询最终代运营操作结果。 | [optional]
**accessProductCode** | **string**| 接入的产品编号。未传batch_no时必填枚举如下 OPENAPI_BIND_DEFAULT操作类型为账号绑定 OPENAPI_AUTH_DEFAULT操作类型为代运营授权。 | [optional]
**merchantNo** | **string**| 支付宝商户号。支持间连、直连商户值为2088开头。 未传batch_no时需注意 若查询间连商户则 merchant_no 必填; 若查询直连商户则merchant_no和alipay_account不能同时为空都有值优先取merchant_no。 | [optional]
**alipayAccount** | **string**| 支付宝登录账号通常为手机号或者邮箱。未传batch_no时需注意 1.当查询merchant_no为间连商户时 * 若 operate_type&#x3D;ACCOUNT_BIND则alipay_account必填。 * 若 operate_type&#x3D;OPERATION_AUTH则alipay_account无需传入。 2.当查询merchant_no为直连商户时 * merchant_no和alipay_account不能同时为空都有值优先取merchant_no。 | [optional]
**isvScenePermissions** | **string**| 场景授权列表结构结构场景codeA:权限code1,权限code2;场景codeB:权限code1,权限code2; | [optional]
### Return type
**\Alipay\OpenAPISDK\Model\AlipayOpenSpOperationResultQueryResponseModel**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#api-endpoints)
[[Back to README]](../../README.md)