README

Mundipagg API

如何构建

生成的代码依赖于外部库，如UniRest。这些依赖关系在SDK附带的composer.json文件中定义。为了解决这些依赖关系，我们使用Composer包管理器，它需要在您的系统中安装PHP 5.3.2或更高版本。访问https://getcomposer.org.cn/download/下载Composer安装文件，并在您的系统中运行它。打开命令提示符，输入composer --version。如果安装成功，它将显示已安装的Composer的当前版本。

使用命令行，导航到包含生成的文件（包括composer.json）的SDK目录。
运行composer install命令。这将安装所有必需的依赖项，并在您的项目目录中创建vendor目录。

[仅限Windows用户] 在php.ini中配置CURL证书路径

CURL以前包含一组受信任的CA列表，但现在不再捆绑任何CA证书。因此，默认情况下，它将拒绝所有SSL证书，因为无法验证。您必须获取您的CA证书，并将curl指向它。步骤如下：

从https://curl.haxx.se/docs/caextract.html下载证书捆绑包（.pem文件）到您的系统。
将curl.cainfo = "PATH_TO/cacert.pem"添加到您的php.ini文件中，该文件位于您的PHP安装目录。“PATH_TO”必须是一个包含.pem文件的绝对路径。

[curl]
; A default value for the CURLOPT_CAINFO option. This is required to be an
; absolute path.
;curl.cainfo =

如何使用

以下部分解释了如何在新的项目中使用MundiAPI库。

1. 在IDE中打开项目

打开PHP的IDE，如PhpStorm。这里展示的基本工作流程也适用于您更喜欢使用不同编辑器或IDE的情况。

在PhpStorm中点击打开，浏览到生成的SDK目录，然后点击OK。

2. 添加新的测试项目

如以下所示，在解决方案名称上右键单击以创建新目录

将目录命名为"test"

向此项目添加PHP文件

命名为"testSDK"

根据您的项目设置，您可能需要在PHP代码中包含composer的自动加载器以启用类的自动加载。

require_once "../vendor/autoload.php";

确保require_once中的路径正确指向依赖安装期间在vendor目录中创建的autoload.php文件。

之后，您可以在后续部分中添加初始化客户端库并获取Controller类实例的代码。示例代码将在随后的部分中给出。

3. 运行测试项目

要运行您的项目，您必须设置项目的解释器。解释器是安装在您计算机上的PHP引擎。

从“文件”菜单打开 设置。

在 语言与框架 中选择 PHP。

在 解释器 选项附近浏览解释器并选择您的解释器。

选择解释器后，点击 确定。

要运行您的项目，在Test项目中的PHP文件上右键单击，然后点击 运行。

如何测试

此SDK中的单元测试可以使用PHPUnit运行。

首先使用composer安装依赖项，包括 require-dev 依赖项。
从命令行运行 vendor\bin\phpunit --verbose 以执行测试。如果您已全局安装PHPUnit，则使用 phpunit --verbose 运行测试。

您可以在 phpunit.xml 文件中更改PHPUnit测试配置。

初始化

身份验证

为了设置API客户端的身份验证和初始化，您需要以下信息。

参数	描述
serviceRefererName	待补充：添加描述
basicAuthUserName	用于基本身份验证的用户名
basicAuthPassword	用于基本身份验证的密码

API客户端可以如下初始化。

$serviceRefererName = 'serviceRefererName';
$basicAuthUserName = 'basicAuthUserName'; // The username to use with basic authentication
$basicAuthPassword = 'basicAuthPassword'; // The password to use with basic authentication

$client = new MundiAPILib\MundiAPIClient($serviceRefererName, $basicAuthUserName, $basicAuthPassword);

类参考

SubscriptionsController

获取单例实例

可以从API客户端访问SubscriptionsController类的单例实例。

$subscriptions = $client->getSubscriptions();

createDiscount

创建折扣

function createDiscount(
        $subscriptionId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅ID
body	`必需`	创建折扣的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$body = new SubscriptionsDiscountsRequest();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->createDiscount($subscriptionId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getSubscriptionItem

获取订阅项

function getSubscriptionItem(
        $subscriptionId,
        $itemId)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
项目 ID	`必需`	项目 ID

示例用法

$subscriptionId = 'subscription_id';
$itemId = 'item_id';

$result = $subscriptions->getSubscriptionItem($subscriptionId, $itemId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateSubscriptionItem

更新订阅项

function updateSubscriptionItem(
        $subscriptionId,
        $itemId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
项目 ID	`必需`	项目 ID
body	`必需`	更新订阅项的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$itemId = 'item_id';
$body = new SubscriptionsItemsRequest();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->updateSubscriptionItem($subscriptionId, $itemId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

deleteUsage

删除使用记录

function deleteUsage(
        $subscriptionId,
        $itemId,
        $usageId,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
项目 ID	`必需`	订阅项 ID
使用 ID	`必需`	使用 ID
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$itemId = 'item_id';
$usageId = 'usage_id';
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->deleteUsage($subscriptionId, $itemId, $usageId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

cancelSubscription

取消订阅

function cancelSubscription(
        $subscriptionId,
        $idempotencyKey = null,
        $body = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅ID
idempotencyKey	`可选`	待补充：添加参数描述
body	`可选`	取消订阅的请求

示例用法

$subscriptionId = 'subscription_id';
$idempotencyKey = 'idempotency-key';
$body = new SubscriptionsRequest();

$result = $subscriptions->cancelSubscription($subscriptionId, $idempotencyKey, $body);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getSubscription

获取订阅

function getSubscription($subscriptionId)

参数

参数	标签	描述
subscriptionId	`必需`	订阅ID

示例用法

$subscriptionId = 'subscription_id';

$result = $subscriptions->getSubscription($subscriptionId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

deleteIncrement

删除增量

function deleteIncrement(
        $subscriptionId,
        $incrementId,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅ID
incrementId	`必需`	增量ID
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$incrementId = 'increment_id';
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->deleteIncrement($subscriptionId, $incrementId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getIncrementById

GetIncrementById

function getIncrementById(
        $subscriptionId,
        $incrementId)

参数

参数	标签	描述
subscriptionId	`必需`	订阅ID
incrementId	`必需`	增量ID

示例用法

$subscriptionId = 'subscription_id';
$incrementId = 'increment_id';

$result = $subscriptions->getIncrementById($subscriptionId, $incrementId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getSubscriptionCycleById

GetSubscriptionCycleById

function getSubscriptionCycleById(
        $subscriptionId,
        $cycleId)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
cycleId	`必需`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$cycleId = 'cycleId';

$result = $subscriptions->getSubscriptionCycleById($subscriptionId, $cycleId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateSubscriptionStartAt

更新订阅的起始日期

function updateSubscriptionStartAt(
        $subscriptionId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
body	`必需`	更新订阅起始日期的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$body = new SubscriptionsStartAtRequest();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->updateSubscriptionStartAt($subscriptionId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

更新订阅支付方式

更新订阅的支付方式

function updateSubscriptionPaymentMethod(
        $subscriptionId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅ID
body	`必需`	从订阅中更新支付方式的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$body = new SubscriptionsPaymentMethodRequest();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->updateSubscriptionPaymentMethod($subscriptionId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateCurrentCycleStatus

更新当前周期状态

function updateCurrentCycleStatus(
        $subscriptionId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
body	`必需`	更新订阅当前状态的结束日期的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$body = new UpdateCurrentCycleStatusRequest();
$idempotencyKey = 'idempotency-key';

$subscriptions->updateCurrentCycleStatus($subscriptionId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createSubscription

创建新的订阅

function createSubscription(
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
body	`必需`	创建订阅的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$body = new SubscriptionsRequest1();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->createSubscription($body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getSubscriptions

获取所有订阅

function getSubscriptions(
        $page = null,
        $size = null,
        $code = null,
        $billingType = null,
        $customerId = null,
        $planId = null,
        $cardId = null,
        $status = null,
        $nextBillingSince = null,
        $nextBillingUntil = null,
        $createdSince = null,
        $createdUntil = null)

参数

参数	标签	描述
page	`可选`	页码
size	`可选`	每页大小
code	`可选`	按订阅代码筛选
billingType	`可选`	按订阅计费类型筛选
customerId	`可选`	按客户ID筛选
planId	`可选`	按计划ID筛选
cardId	`可选`	按卡ID筛选
status	`可选`	按状态筛选
nextBillingSince	`可选`	订阅下一个账单日期的开始范围过滤器
nextBillingUntil	`可选`	订阅下一个账单日期的结束范围过滤器
createdSince	`可选`	订阅创建日期的开始范围过滤器
createdUntil	`可选`	订阅创建日期的结束范围过滤器

示例用法

$page = 83;
$size = 83;
$code = 'code';
$billingType = 'billing_type';
$customerId = 'customer_id';
$planId = 'plan_id';
$cardId = 'card_id';
$status = 'status';
$nextBillingSince = date("D M d, Y G:i");
$nextBillingUntil = date("D M d, Y G:i");
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");

$result = $subscriptions->getSubscriptions($page, $size, $code, $billingType, $customerId, $planId, $cardId, $status, $nextBillingSince, $nextBillingUntil, $createdSince, $createdUntil);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getUsagesDetails

获取使用详情

function getUsagesDetails(
        $subscriptionId,
        $cycleId = null,
        $size = null,
        $page = null,
        $itemId = null,
        $group = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅标识符
cycleId	`可选`	周期ID
size	`可选`	每页大小
page	`可选`	页码
项目 ID	`可选`	项目标识符
组	`可选`	每个项目的商店（账户）标识符

示例用法

$subscriptionId = 'subscription_id';
$cycleId = 'cycle_id';
$size = 83;
$page = 83;
$itemId = 'item_id';
$group = 'group';

$result = $subscriptions->getUsagesDetails($subscriptionId, $cycleId, $size, $page, $itemId, $group);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

renewSubscription

续订订阅

function renewSubscription(
        $subscriptionId,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	待补充：添加参数描述
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->renewSubscription($subscriptionId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getSubscriptionCycles

获取订阅周期

function getSubscriptionCycles(
        $subscriptionId,
        $page,
        $size)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
page	`必需`	页码
size	`必需`	每页大小

示例用法

$subscriptionId = 'subscription_id';
$page = 'page';
$size = 'size';

$result = $subscriptions->getSubscriptionCycles($subscriptionId, $page, $size);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createAnUsage

创建使用情况

function createAnUsage(
        $subscriptionId,
        $itemId,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅ID
项目 ID	`必需`	项目 ID
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$itemId = 'item_id';
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->createAnUsage($subscriptionId, $itemId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getUsages

列出订阅项的所有使用情况

function getUsages(
        $subscriptionId,
        $itemId,
        $page = null,
        $size = null,
        $code = null,
        $group = null,
        $usedSince = null,
        $usedUntil = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
项目 ID	`必需`	订阅项 ID
page	`可选`	页码
size	`可选`	每页大小
code	`可选`	客户端系统中的识别码
组	`可选`	客户端系统中的识别组
usedSince	`可选`	待补充：添加参数描述
usedUntil	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$itemId = 'item_id';
$page = 83;
$size = 83;
$code = 'code';
$group = 'group';
$usedSince = date("D M d, Y G:i");
$usedUntil = date("D M d, Y G:i");

$result = $subscriptions->getUsages($subscriptionId, $itemId, $page, $size, $code, $group, $usedSince, $usedUntil);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

deleteDiscount

删除折扣

function deleteDiscount(
        $subscriptionId,
        $discountId,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅ID
discountId	`必需`	折扣 Id
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$discountId = 'discount_id';
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->deleteDiscount($subscriptionId, $discountId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getIncrements

获取增量

function getIncrements(
        $subscriptionId,
        $page = null,
        $size = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
page	`可选`	页码
size	`可选`	每页大小

示例用法

$subscriptionId = 'subscription_id';
$page = 83;
$size = 83;

$result = $subscriptions->getIncrements($subscriptionId, $page, $size);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createSubscriptionItem

创建新的订阅项

function createSubscriptionItem(
        $subscriptionId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅ID
body	`必需`	创建订阅项的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$body = new SubscriptionsItemsRequest1();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->createSubscriptionItem($subscriptionId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getSubscriptionItems

获取订阅项

function getSubscriptionItems(
        $subscriptionId,
        $page = null,
        $size = null,
        $name = null,
        $code = null,
        $status = null,
        $description = null,
        $createdSince = null,
        $createdUntil = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
page	`可选`	页码
size	`可选`	每页大小
名称	`可选`	项目名称
code	`可选`	客户端系统中的识别码
status	`可选`	项目状态
描述	`可选`	项目描述
createdSince	`可选`	过滤项目创建日期开始范围
createdUntil	`可选`	过滤项目创建日期结束范围

示例用法

$subscriptionId = 'subscription_id';
$page = 83;
$size = 83;
$name = 'name';
$code = 'code';
$status = 'status';
$description = 'description';
$createdSince = 'created_since';
$createdUntil = 'created_until';

$result = $subscriptions->getSubscriptionItems($subscriptionId, $page, $size, $name, $code, $status, $description, $createdSince, $createdUntil);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateSubscriptionBillingDate

从订阅中更新账单日期

function updateSubscriptionBillingDate(
        $subscriptionId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
body	`必需`	更新订阅账单日期的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$body = new SubscriptionsBillingDateRequest();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->updateSubscriptionBillingDate($subscriptionId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateLatestPeriodEndAt

更新最新周期结束日期

function updateLatestPeriodEndAt(
        $subscriptionId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	待补充：添加参数描述
body	`必需`	更新当前签名周期结束日期的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$body = new SubscriptionsPeriodsLatestEndAtRequest();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->updateLatestPeriodEndAt($subscriptionId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateSubscriptionAffiliationId

更新订阅归属ID

function updateSubscriptionAffiliationId(
        $subscriptionId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	待补充：添加参数描述
body	`必需`	更新订阅归属ID的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$body = new SubscriptionsGatewayAffiliationIdRequest();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->updateSubscriptionAffiliationId($subscriptionId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

deleteSubscriptionItem

删除订阅项目

function deleteSubscriptionItem(
        $subscriptionId,
        $subscriptionItemId,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅ID
subscriptionItemId	`必需`	订阅项ID
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$subscriptionItemId = 'subscription_item_id';
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->deleteSubscriptionItem($subscriptionId, $subscriptionItemId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateSubscriptionCard

更新订阅中的信用卡信息

function updateSubscriptionCard(
        $subscriptionId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅ID
body	`必需`	更新卡请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$body = new SubscriptionsCardRequest();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->updateSubscriptionCard($subscriptionId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateSubscriptionMetadata

更新订阅中的元数据

function updateSubscriptionMetadata(
        $subscriptionId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
body	`必需`	更新订阅元数据的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$body = new SubscriptionsMetadataRequest();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->updateSubscriptionMetadata($subscriptionId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateSubscriptionDueDays

更新订阅中的账单到期日

function updateSubscriptionDueDays(
        $subscriptionId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
body	`必需`	待补充：添加参数描述
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$body = new UpdateSubscriptionDueDaysRequest();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->updateSubscriptionDueDays($subscriptionId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getDiscounts

GetDiscounts

function getDiscounts(
        $subscriptionId,
        $page,
        $size)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
page	`必需`	页码
size	`必需`	每页大小

示例用法

$subscriptionId = 'subscription_id';
$page = 83;
$size = 83;

$result = $subscriptions->getDiscounts($subscriptionId, $page, $size);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createIncrement

创建增量

function createIncrement(
        $subscriptionId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅ID
body	`必需`	创建增量的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$body = new SubscriptionsIncrementsRequest();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->createIncrement($subscriptionId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getDiscountById

根据ID获取折扣

function getDiscountById(
        $subscriptionId,
        $discountId)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
discountId	`必需`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$discountId = 'discountId';

$result = $subscriptions->getDiscountById($subscriptionId, $discountId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateSubscriptionMiniumPrice

更新订阅的最小值

function updateSubscriptionMiniumPrice(
        $subscriptionId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
body	`必需`	请求包含要配置的最小值
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$body = new SubscriptionsMinimumPriceRequest();
$idempotencyKey = 'idempotency-key';

$result = $subscriptions->updateSubscriptionMiniumPrice($subscriptionId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getUsageReport

获取使用报告

function getUsageReport(
        $subscriptionId,
        $periodId)

参数

参数	标签	描述
subscriptionId	`必需`	订阅ID
periodId	`必需`	期Id

示例用法

$subscriptionId = 'subscription_id';
$periodId = 'period_id';

$result = $subscriptions->getUsageReport($subscriptionId, $periodId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateSplitSubscription

更新分割订阅

function updateSplitSubscription(
        $id,
        $body)

参数

参数	标签	描述
id	`必需`	订阅的id
body	`必需`	待补充：添加参数描述

示例用法

$id = 'id';
$body = new UpdateSubscriptionSplitRequest();

$result = $subscriptions->updateSplitSubscription($id, $body);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

返回控制器列表

OrdersController

获取单例实例

可以从API客户端访问OrdersController类的单例实例。

$orders = $client->getOrders();

updateOrderStatus

UpdateOrderStatus

function updateOrderStatus(
        $id,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
id	`必需`	订单Id
body	`必需`	更新订单模型
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$id = 'id';
$body = new UpdateOrderStatusRequest();
$idempotencyKey = 'idempotency-key';

$result = $orders->updateOrderStatus($id, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

deleteAllOrderItems

DeleteAllOrderItems

function deleteAllOrderItems(
        $orderId,
        $idempotencyKey = null)

参数

参数	标签	描述
orderId	`必需`	订单Id
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$orderId = 'orderId';
$idempotencyKey = 'idempotency-key';

$result = $orders->deleteAllOrderItems($orderId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createOrderItem

CreateOrderItem

function createOrderItem(
        $orderId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
orderId	`必需`	订单Id
body	`必需`	订单项模型
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$orderId = 'orderId';
$body = new OrdersItemsRequest();
$idempotencyKey = 'idempotency-key';

$result = $orders->createOrderItem($orderId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateOrderMetadata

更新订单的元数据

function updateOrderMetadata(
        $orderId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
orderId	`必需`	订单 ID
body	`必需`	更新订单元数据的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$orderId = 'order_id';
$body = new OrdersMetadataRequest();
$idempotencyKey = 'idempotency-key';

$result = $orders->updateOrderMetadata($orderId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getOrders

获取所有订单

function getOrders(
        $page = null,
        $size = null,
        $code = null,
        $status = null,
        $createdSince = null,
        $createdUntil = null,
        $customerId = null)

参数

参数	标签	描述
page	`可选`	页码
size	`可选`	每页大小
code	`可选`	订单代码的过滤器
status	`可选`	订单状态的过滤器
createdSince	`可选`	订单创建日期开始范围的过滤器
createdUntil	`可选`	订单创建日期结束范围的过滤器
customerId	`可选`	订单客户 ID 的过滤器

示例用法

$page = 175;
$size = 175;
$code = 'code';
$status = 'status';
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");
$customerId = 'customer_id';

$result = $orders->getOrders($page, $size, $code, $status, $createdSince, $createdUntil, $customerId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createOrder

创建新的订单

function createOrder(
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
body	`必需`	创建订单的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$body = new OrdersRequest();
$idempotencyKey = 'idempotency-key';

$result = $orders->createOrder($body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

deleteOrderItem

删除订单项

function deleteOrderItem(
        $orderId,
        $itemId,
        $idempotencyKey = null)

参数

参数	标签	描述
orderId	`必需`	订单Id
项目 ID	`必需`	项目 ID
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$orderId = 'orderId';
$itemId = 'itemId';
$idempotencyKey = 'idempotency-key';

$result = $orders->deleteOrderItem($orderId, $itemId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getOrderItem

获取订单项

function getOrderItem(
        $orderId,
        $itemId)

参数

参数	标签	描述
orderId	`必需`	订单Id
项目 ID	`必需`	项目 ID

示例用法

$orderId = 'orderId';
$itemId = 'itemId';

$result = $orders->getOrderItem($orderId, $itemId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateOrderItem

更新订单项

function updateOrderItem(
        $orderId,
        $itemId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
orderId	`必需`	订单Id
项目 ID	`必需`	项目 ID
body	`必需`	商品模型
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$orderId = 'orderId';
$itemId = 'itemId';
$body = new OrdersItemsRequest1();
$idempotencyKey = 'idempotency-key';

$result = $orders->updateOrderItem($orderId, $itemId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getOrder

获取订单

function getOrder($orderId)

参数

参数	标签	描述
orderId	`必需`	订单ID

示例用法

$orderId = 'order_id';

$result = $orders->getOrder($orderId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

返回控制器列表

PlansController

获取单例实例

可以通过API客户端访问PlansController类的单例实例。

$plans = $client->getPlans();

updatePlanItem

更新计划项

function updatePlanItem(
        $planId,
        $planItemId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
planId	`必需`	计划ID
planItemId	`必需`	计划项ID
body	`必需`	更新计划项的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$planId = 'plan_id';
$planItemId = 'plan_item_id';
$body = new PlansItemsRequest();
$idempotencyKey = 'idempotency-key';

$result = $plans->updatePlanItem($planId, $planItemId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

deletePlanItem

从计划中删除项

function deletePlanItem(
        $planId,
        $planItemId,
        $idempotencyKey = null)

参数

参数	标签	描述
planId	`必需`	计划ID
planItemId	`必需`	计划项ID
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$planId = 'plan_id';
$planItemId = 'plan_item_id';
$idempotencyKey = 'idempotency-key';

$result = $plans->deletePlanItem($planId, $planItemId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getPlanItem

获取计划项

function getPlanItem(
        $planId,
        $planItemId)

参数

参数	标签	描述
planId	`必需`	计划ID
planItemId	`必需`	计划项ID

示例用法

$planId = 'plan_id';
$planItemId = 'plan_item_id';

$result = $plans->getPlanItem($planId, $planItemId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createPlanItem

向计划中添加新项

function createPlanItem(
        $planId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
planId	`必需`	计划ID
body	`必需`	创建计划项的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$planId = 'plan_id';
$body = new PlansItemsRequest1();
$idempotencyKey = 'idempotency-key';

$result = $plans->createPlanItem($planId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getPlans

获取所有计划

function getPlans(
        $page = null,
        $size = null,
        $name = null,
        $status = null,
        $billingType = null,
        $createdSince = null,
        $createdUntil = null)

参数

参数	标签	描述
page	`可选`	页码
size	`可选`	每页大小
名称	`可选`	计划名称筛选
status	`可选`	计划状态筛选
billingType	`可选`	计费类型筛选
createdSince	`可选`	计划创建日期开始范围筛选
createdUntil	`可选`	计划创建日期结束范围筛选

示例用法

$page = 175;
$size = 175;
$name = 'name';
$status = 'status';
$billingType = 'billing_type';
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");

$result = $plans->getPlans($page, $size, $name, $status, $billingType, $createdSince, $createdUntil);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createPlan

创建新计划

function createPlan(
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
body	`必需`	创建计划的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$body = new PlansRequest();
$idempotencyKey = 'idempotency-key';

$result = $plans->createPlan($body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getPlan

获取计划

function getPlan($planId)

参数

参数	标签	描述
planId	`必需`	计划ID

示例用法

$planId = 'plan_id';

$result = $plans->getPlan($planId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updatePlan

更新计划

function updatePlan(
        $planId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
planId	`必需`	计划ID
body	`必需`	更新计划的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$planId = 'plan_id';
$body = new PlansRequest1();
$idempotencyKey = 'idempotency-key';

$result = $plans->updatePlan($planId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

deletePlan

删除计划

function deletePlan(
        $planId,
        $idempotencyKey = null)

参数

参数	标签	描述
planId	`必需`	计划ID
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$planId = 'plan_id';
$idempotencyKey = 'idempotency-key';

$result = $plans->deletePlan($planId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updatePlanMetadata

更新计划的元数据

function updatePlanMetadata(
        $planId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
planId	`必需`	计划ID
body	`必需`	更新计划元数据的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$planId = 'plan_id';
$body = new PlansMetadataRequest();
$idempotencyKey = 'idempotency-key';

$result = $plans->updatePlanMetadata($planId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

返回控制器列表

InvoicesController

获取单例实例

可以通过API客户端访问 InvoicesController 类的单例实例。

$invoices = $client->getInvoices();

创建发票

创建发票

function createInvoice(
        $subscriptionId,
        $cycleId,
        $idempotencyKey = null,
        $body = null)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID
cycleId	`必需`	周期ID
idempotencyKey	`可选`	待补充：添加参数描述
body	`可选`	待补充：添加参数描述

示例用法

$subscriptionId = 'subscription_id';
$cycleId = 'cycle_id';
$idempotencyKey = 'idempotency-key';
$body = new SubscriptionsCyclesPayRequest();

$result = $invoices->createInvoice($subscriptionId, $cycleId, $idempotencyKey, $body);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

获取部分发票

获取部分发票

function getPartialInvoice($subscriptionId)

参数

参数	标签	描述
subscriptionId	`必需`	订阅 ID

示例用法

$subscriptionId = 'subscription_id';

$result = $invoices->getPartialInvoice($subscriptionId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

更新发票状态

更新发票的状态

function updateInvoiceStatus(
        $invoiceId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
发票ID	`必需`	发票ID
body	`必需`	更新发票状态的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$invoiceId = 'invoice_id';
$body = new UpdateCurrentCycleStatusRequest();
$idempotencyKey = 'idempotency-key';

$result = $invoices->updateInvoiceStatus($invoiceId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

获取发票

获取一个发票

function getInvoice($invoiceId)

参数

参数	标签	描述
发票ID	`必需`	发票ID

示例用法

$invoiceId = 'invoice_id';

$result = $invoices->getInvoice($invoiceId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

取消发票

取消一个发票

function cancelInvoice(
        $invoiceId,
        $idempotencyKey = null)

参数

参数	标签	描述
发票ID	`必需`	发票ID
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$invoiceId = 'invoice_id';
$idempotencyKey = 'idempotency-key';

$result = $invoices->cancelInvoice($invoiceId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateInvoiceMetadata

更新发票的元数据

function updateInvoiceMetadata(
        $invoiceId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
发票ID	`必需`	发票 ID
body	`必需`	更新发票元数据的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$invoiceId = 'invoice_id';
$body = new InvoicesMetadataRequest();
$idempotencyKey = 'idempotency-key';

$result = $invoices->updateInvoiceMetadata($invoiceId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getInvoices

获取所有发票

function getInvoices(
        $page = null,
        $size = null,
        $code = null,
        $customerId = null,
        $subscriptionId = null,
        $createdSince = null,
        $createdUntil = null,
        $status = null,
        $dueSince = null,
        $dueUntil = null,
        $customerDocument = null)

参数

参数	标签	描述
page	`可选`	页码
size	`可选`	每页大小
code	`可选`	发票代码的过滤器
customerId	`可选`	发票客户 ID 的过滤器
subscriptionId	`可选`	发票订阅 ID 的过滤器
createdSince	`可选`	发票创建日期的开始范围过滤器
createdUntil	`可选`	发票创建日期的结束范围过滤器
status	`可选`	发票状态的过滤器
dueSince	`可选`	发票到期日期的开始范围过滤器
dueUntil	`可选`	发票到期日期的结束范围过滤器
customerDocument	`可选`	发票文档的过滤器

示例用法

$page = 11;
$size = 11;
$code = 'code';
$customerId = 'customer_id';
$subscriptionId = 'subscription_id';
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");
$status = 'status';
$dueSince = date("D M d, Y G:i");
$dueUntil = date("D M d, Y G:i");
$customerDocument = 'customer_document';

$result = $invoices->getInvoices($page, $size, $code, $customerId, $subscriptionId, $createdSince, $createdUntil, $status, $dueSince, $dueUntil, $customerDocument);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

返回控制器列表

CustomersController

获取单例实例

从 API 客户端可以访问 CustomersController 类的单例实例。

$customers = $client->getCustomers();

createAccessToken

为顾客创建访问令牌

function createAccessToken(
        $customerId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
customerId	`必需`	客户 ID
body	`必需`	创建访问令牌的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$customerId = 'customer_id';
$body = new CustomersAccessTokensRequest();
$idempotencyKey = 'idempotency-key';

$result = $customers->createAccessToken($customerId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getAccessTokens

获取客户的所有访问令牌

function getAccessTokens(
        $customerId,
        $page = null,
        $size = null)

参数

参数	标签	描述
customerId	`必需`	客户 ID
page	`可选`	页码
size	`可选`	每页大小

示例用法

$customerId = 'customer_id';
$page = 11;
$size = 11;

$result = $customers->getAccessTokens($customerId, $page, $size);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateCustomer

更新客户信息

function updateCustomer(
        $customerId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
customerId	`必需`	客户ID
body	`必需`	更新客户的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$customerId = 'customer_id';
$body = new CustomersRequest();
$idempotencyKey = 'idempotency-key';

$result = $customers->updateCustomer($customerId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getCustomer

获取客户信息

function getCustomer($customerId)

参数

参数	标签	描述
customerId	`必需`	客户 ID

示例用法

$customerId = 'customer_id';

$result = $customers->getCustomer($customerId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

deleteAccessTokens

删除客户的访问令牌

function deleteAccessTokens($customerId)

参数

参数	标签	描述
customerId	`必需`	客户 ID

示例用法

$customerId = 'customer_id';

$result = $customers->deleteAccessTokens($customerId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getAddresses

获取客户的全部地址

function getAddresses(
        $customerId,
        $page = null,
        $size = null)

参数

参数	标签	描述
customerId	`必需`	客户ID
page	`可选`	页码
size	`可选`	每页大小

示例用法

$customerId = 'customer_id';
$page = 11;
$size = 11;

$result = $customers->getAddresses($customerId, $page, $size);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createAddress

为客户创建新的地址

function createAddress(
        $customerId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
customerId	`必需`	客户 ID
body	`必需`	创建地址的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$customerId = 'customer_id';
$body = new CustomersAddressesRequest();
$idempotencyKey = 'idempotency-key';

$result = $customers->createAddress($customerId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getAccessToken

获取客户的访问令牌

function getAccessToken(
        $customerId,
        $tokenId)

参数

参数	标签	描述
customerId	`必需`	客户 ID
tokenId	`必需`	令牌ID

示例用法

$customerId = 'customer_id';
$tokenId = 'token_id';

$result = $customers->getAccessToken($customerId, $tokenId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

deleteAccessToken

删除客户的访问令牌

function deleteAccessToken(
        $customerId,
        $tokenId,
        $idempotencyKey = null)

参数

参数	标签	描述
customerId	`必需`	客户 ID
tokenId	`必需`	令牌ID
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$customerId = 'customer_id';
$tokenId = 'token_id';
$idempotencyKey = 'idempotency-key';

$result = $customers->deleteAccessToken($customerId, $tokenId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getAddress

获取客户的地址

function getAddress(
        $customerId,
        $addressId)

参数

参数	标签	描述
customerId	`必需`	客户ID
addressId	`必需`	地址ID

示例用法

$customerId = 'customer_id';
$addressId = 'address_id';

$result = $customers->getAddress($customerId, $addressId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateAddress

更新地址

function updateAddress(
        $customerId,
        $addressId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
customerId	`必需`	客户 ID
addressId	`必需`	地址ID
body	`必需`	更新地址的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$customerId = 'customer_id';
$addressId = 'address_id';
$body = new CustomersAddressesRequest1();
$idempotencyKey = 'idempotency-key';

$result = $customers->updateAddress($customerId, $addressId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

deleteAddress

删除客户的地址

function deleteAddress(
        $customerId,
        $addressId,
        $idempotencyKey = null)

参数

参数	标签	描述
customerId	`必需`	客户 ID
addressId	`必需`	地址ID
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$customerId = 'customer_id';
$addressId = 'address_id';
$idempotencyKey = 'idempotency-key';

$result = $customers->deleteAddress($customerId, $addressId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createCard

为顾客创建新卡

function createCard(
        $customerId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
customerId	`必需`	客户ID
body	`必需`	创建卡的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$customerId = 'customer_id';
$body = new CustomersCardsRequest();
$idempotencyKey = 'idempotency-key';

$result = $customers->createCard($customerId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getCards

获取客户的全部卡

function getCards(
        $customerId,
        $page = null,
        $size = null)

参数

参数	标签	描述
customerId	`必需`	客户 ID
page	`可选`	页码
size	`可选`	每页大小

示例用法

$customerId = 'customer_id';
$page = 225;
$size = 225;

$result = $customers->getCards($customerId, $page, $size);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

renewCard

续费卡

function renewCard(
        $customerId,
        $cardId,
        $idempotencyKey = null)

参数

参数	标签	描述
customerId	`必需`	客户ID
cardId	`必需`	卡片 ID
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$customerId = 'customer_id';
$cardId = 'card_id';
$idempotencyKey = 'idempotency-key';

$result = $customers->renewCard($customerId, $cardId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createCustomer

创建新客户

function createCustomer(
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
body	`必需`	创建客户请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$body = new CustomersRequest1();
$idempotencyKey = 'idempotency-key';

$result = $customers->createCustomer($body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getCustomers

获取所有客户

function getCustomers(
        $name = null,
        $document = null,
        $page = 1,
        $size = 10,
        $email = null,
        $code = null)

参数

参数	标签	描述
名称	`可选`	客户名称
文件	`可选`	客户的文件
page	`可选` `默认值`	搜索的当前页
size	`可选` `默认值`	搜索的页面数量
电子邮件	`可选`	客户的电子邮件
code	`可选`	客户代码

示例用法

$name = 'name';
$document = 'document';
$page = 1;
$size = 10;
$email = 'email';
$code = 'Code';

$result = $customers->getCustomers($name, $document, $page, $size, $email, $code);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateCustomerMetadata

更新客户的元数据

function updateCustomerMetadata(
        $customerId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
customerId	`必需`	客户 ID
body	`必需`	更新客户元数据请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$customerId = 'customer_id';
$body = new CustomersMetadataRequest();
$idempotencyKey = 'idempotency-key';

$result = $customers->updateCustomerMetadata($customerId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateCard

更新卡片

function updateCard(
        $customerId,
        $cardId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
customerId	`必需`	客户 ID
cardId	`必需`	卡片 ID
body	`必需`	更新卡请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$customerId = 'customer_id';
$cardId = 'card_id';
$body = new CustomersCardsRequest1();
$idempotencyKey = 'idempotency-key';

$result = $customers->updateCard($customerId, $cardId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

deleteCard

删除客户的卡

function deleteCard(
        $customerId,
        $cardId,
        $idempotencyKey = null)

参数

参数	标签	描述
customerId	`必需`	客户 ID
cardId	`必需`	卡片 ID
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$customerId = 'customer_id';
$cardId = 'card_id';
$idempotencyKey = 'idempotency-key';

$result = $customers->deleteCard($customerId, $cardId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getCard

获取客户的卡

function getCard(
        $customerId,
        $cardId)

参数

参数	标签	描述
customerId	`必需`	客户ID
cardId	`必需`	卡片 ID

示例用法

$customerId = 'customer_id';
$cardId = 'card_id';

$result = $customers->getCard($customerId, $cardId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

返回控制器列表

ChargesController

获取单例实例

可以从API客户端访问ChargesController类的单例实例。

$charges = $client->getCharges();

getCharge

根据ID获取收费

function getCharge($chargeId)

参数

参数	标签	描述
chargeId	`必需`	收费ID

示例用法

$chargeId = 'charge_id';

$result = $charges->getCharge($chargeId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

cancelCharge

取消收费

function cancelCharge(
        $chargeId,
        $idempotencyKey = null,
        $body = null)

参数

参数	标签	描述
chargeId	`必需`	收费ID
idempotencyKey	`可选`	待补充：添加参数描述
body	`可选`	取消收费请求

示例用法

$chargeId = 'charge_id';
$idempotencyKey = 'idempotency-key';
$body = new ChargesRequest();

$result = $charges->cancelCharge($chargeId, $idempotencyKey, $body);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

confirmPayment

ConfirmPayment

function confirmPayment(
        $chargeId,
        $idempotencyKey = null,
        $body = null)

参数

参数	标签	描述
chargeId	`必需`	待补充：添加参数描述
idempotencyKey	`可选`	待补充：添加参数描述
body	`可选`	确认支付的请求

示例用法

$chargeId = 'charge_id';
$idempotencyKey = 'idempotency-key';
$body = new CreateConfirmPaymentRequest();

$result = $charges->confirmPayment($chargeId, $idempotencyKey, $body);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateChargeCard

更新收费的卡片

function updateChargeCard(
        $chargeId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
chargeId	`必需`	收费ID
body	`必需`	更新收费卡片请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$chargeId = 'charge_id';
$body = new ChargesCardRequest();
$idempotencyKey = 'idempotency-key';

$result = $charges->updateChargeCard($chargeId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getCharges

列出所有收费

function getCharges(
        $page = null,
        $size = null,
        $code = null,
        $status = null,
        $paymentMethod = null,
        $customerId = null,
        $orderId = null,
        $createdSince = null,
        $createdUntil = null)

参数

参数	标签	描述
page	`可选`	页码
size	`可选`	每页大小
code	`可选`	收费代码的筛选器
status	`可选`	收费状态的筛选器
paymentMethod	`可选`	收费支付方式的筛选器
customerId	`可选`	收费客户 ID 的筛选器
orderId	`可选`	收费订单 ID 的筛选器
createdSince	`可选`	收费创建范围的开始筛选器
createdUntil	`可选`	收费创建范围的结束筛选器

示例用法

$page = 61;
$size = 61;
$code = 'code';
$status = 'status';
$paymentMethod = 'payment_method';
$customerId = 'customer_id';
$orderId = 'order_id';
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");

$result = $charges->getCharges($page, $size, $code, $status, $paymentMethod, $customerId, $orderId, $createdSince, $createdUntil);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

retryCharge

重试收费

function retryCharge(
        $chargeId,
        $idempotencyKey = null)

参数

参数	标签	描述
chargeId	`必需`	收费ID
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$chargeId = 'charge_id';
$idempotencyKey = 'idempotency-key';

$result = $charges->retryCharge($chargeId, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateChargePaymentMethod

更新一次收费的支付方式

function updateChargePaymentMethod(
        $chargeId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
chargeId	`必需`	收费ID
body	`必需`	从收费中更新支付方式的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$chargeId = 'charge_id';
$body = new ChargesPaymentMethodRequest();
$idempotencyKey = 'idempotency-key';

$result = $charges->updateChargePaymentMethod($chargeId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateChargeMetadata

更新收费的元数据

function updateChargeMetadata(
        $chargeId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
chargeId	`必需`	收费ID
body	`必需`	更新收费元数据的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$chargeId = 'charge_id';
$body = new ChargesMetadataRequest();
$idempotencyKey = 'idempotency-key';

$result = $charges->updateChargeMetadata($chargeId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

captureCharge

收取费用

function captureCharge(
        $chargeId,
        $idempotencyKey = null,
        $body = null)

参数

参数	标签	描述
chargeId	`必需`	收费ID
idempotencyKey	`可选`	待补充：添加参数描述
body	`可选`	收取费用的请求

示例用法

$chargeId = 'charge_id';
$idempotencyKey = 'idempotency-key';
$body = new ChargesCaptureRequest();

$result = $charges->captureCharge($chargeId, $idempotencyKey, $body);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateChargeDueDate

更新收费的到期日

function updateChargeDueDate(
        $chargeId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
chargeId	`必需`	收费ID
body	`必需`	更新到期日的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$chargeId = 'charge_id';
$body = new ChargesDueDateRequest();
$idempotencyKey = 'idempotency-key';

$result = $charges->updateChargeDueDate($chargeId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createCharge

创建一个新的收费

function createCharge(
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
body	`必需`	创建收费的请求
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$body = new ChargesRequest1();
$idempotencyKey = 'idempotency-key';

$result = $charges->createCharge($body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getChargeTransactions

获取收费交易

function getChargeTransactions(
        $chargeId,
        $page = null,
        $size = null)

参数

参数	标签	描述
chargeId	`必需`	收费ID
page	`可选`	页码
size	`可选`	每页大小

示例用法

$chargeId = 'charge_id';
$page = 61;
$size = 61;

$result = $charges->getChargeTransactions($chargeId, $page, $size);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getChargesSummary

获取收费概要

function getChargesSummary(
        $status,
        $createdSince = null,
        $createdUntil = null)

参数

参数	标签	描述
status	`必需`	待补充：添加参数描述
createdSince	`可选`	待补充：添加参数描述
createdUntil	`可选`	待补充：添加参数描述

示例用法

$status = 'status';
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");

$result = $charges->getChargesSummary($status, $createdSince, $createdUntil);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

返回控制器列表

RecipientsController

获取单例实例

可以从API客户端访问RecipientsController类的单例实例。

$recipients = $client->getRecipients();

updateRecipientMetadata

更新收款人元数据

function updateRecipientMetadata(
        $recipientId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
recipientId	`必需`	收款人ID
body	`必需`	元数据
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$recipientId = 'recipient_id';
$body = new RecipientsMetadataRequest();
$idempotencyKey = 'idempotency-key';

$result = $recipients->updateRecipientMetadata($recipientId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateRecipientTransferSettings

更新收款人转账设置

function updateRecipientTransferSettings(
        $recipientId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
recipientId	`必需`	收款人标识符
body	`必需`	待补充：添加参数描述
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$recipientId = 'recipient_id';
$body = new UpdateTransferSettingsRequest();
$idempotencyKey = 'idempotency-key';

$result = $recipients->updateRecipientTransferSettings($recipientId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getAnticipation

获取一个预期

function getAnticipation(
        $recipientId,
        $anticipationId)

参数

参数	标签	描述
recipientId	`必需`	收款人ID
anticipationId	`必需`	预期ID

示例用法

$recipientId = 'recipient_id';
$anticipationId = 'anticipation_id';

$result = $recipients->getAnticipation($recipientId, $anticipationId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getRecipients

检索分页收款人信息

function getRecipients(
        $page = null,
        $size = null)

参数

参数	标签	描述
page	`可选`	页码
size	`可选`	每页大小

示例用法

$page = 61;
$size = 61;

$result = $recipients->getRecipients($page, $size);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createRecipient

创建一个新的收款人

function createRecipient(
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
body	`必需`	收款人数据
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$body = new RecipientsRequest();
$idempotencyKey = 'idempotency-key';

$result = $recipients->createRecipient($body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getBalance

获取收款人的余额信息

function getBalance($recipientId)

参数

参数	标签	描述
recipientId	`必需`	收款人ID

示例用法

$recipientId = 'recipient_id';

$result = $recipients->getBalance($recipientId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getAnticipations

从收款人处检索分页的预期清单

function getAnticipations(
        $recipientId,
        $page = null,
        $size = null,
        $status = null,
        $timeframe = null,
        $paymentDateSince = null,
        $paymentDateUntil = null,
        $createdSince = null,
        $createdUntil = null)

参数

参数	标签	描述
recipientId	`必需`	收款人ID
page	`可选`	页码
size	`可选`	每页大小
status	`可选`	预期状态过滤器
时间段	`可选`	预期时间段的过滤器
paymentDateSince	`可选`	预期支付日期的起始范围过滤器
paymentDateUntil	`可选`	预期支付日期的结束范围过滤器
createdSince	`可选`	预期创建日期的起始范围过滤器
createdUntil	`可选`	预期创建日期的结束范围过滤器

示例用法

$recipientId = 'recipient_id';
$page = 153;
$size = 153;
$status = 'status';
$timeframe = 'timeframe';
$paymentDateSince = date("D M d, Y G:i");
$paymentDateUntil = date("D M d, Y G:i");
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");

$result = $recipients->getAnticipations($recipientId, $page, $size, $status, $timeframe, $paymentDateSince, $paymentDateUntil, $createdSince, $createdUntil);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createAnticipation

创建预期

function createAnticipation(
        $recipientId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
recipientId	`必需`	收款人ID
body	`必需`	预期数据
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$recipientId = 'recipient_id';
$body = new RecipientsAnticipationsRequest();
$idempotencyKey = 'idempotency-key';

$result = $recipients->createAnticipation($recipientId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateRecipientDefaultBankAccount

更新收款人的默认银行账户

function updateRecipientDefaultBankAccount(
        $recipientId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
recipientId	`必需`	收款人ID
body	`必需`	银行账户数据
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$recipientId = 'recipient_id';
$body = new RecipientsDefaultBankAccountRequest();
$idempotencyKey = 'idempotency-key';

$result = $recipients->updateRecipientDefaultBankAccount($recipientId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getRecipient

检索收款人信息

function getRecipient($recipientId)

参数

参数	标签	描述
recipientId	`必需`	收款人ID

示例用法

$recipientId = 'recipient_id';

$result = $recipients->getRecipient($recipientId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateRecipient

更新收款人

function updateRecipient(
        $recipientId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
recipientId	`必需`	收款人ID
body	`必需`	收款人数据
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$recipientId = 'recipient_id';
$body = new RecipientsRequest1();
$idempotencyKey = 'idempotency-key';

$result = $recipients->updateRecipient($recipientId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getTransfer

获取转账

function getTransfer(
        $recipientId,
        $transferId)

参数

参数	标签	描述
recipientId	`必需`	收款人ID
transferId	`必需`	转账ID

示例用法

$recipientId = 'recipient_id';
$transferId = 'transfer_id';

$result = $recipients->getTransfer($recipientId, $transferId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getTransfers

获取收款人的分页转账列表

function getTransfers(
        $recipientId,
        $page = null,
        $size = null,
        $status = null,
        $createdSince = null,
        $createdUntil = null)

参数

参数	标签	描述
recipientId	`必需`	收款人ID
page	`可选`	页码
size	`可选`	每页大小
status	`可选`	转账状态过滤器
createdSince	`可选`	转账创建日期开始范围过滤器
createdUntil	`可选`	转账创建日期结束范围过滤器

示例用法

$recipientId = 'recipient_id';
$page = 153;
$size = 153;
$status = 'status';
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");

$result = $recipients->getTransfers($recipientId, $page, $size, $status, $createdSince, $createdUntil);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createTransfer

为收款人创建转账

function createTransfer(
        $recipientId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
recipientId	`必需`	收款人ID
body	`必需`	转账数据
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$recipientId = 'recipient_id';
$body = new RecipientsTransfersRequest();
$idempotencyKey = 'idempotency-key';

$result = $recipients->createTransfer($recipientId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getAnticipationLimits

获取收款人的预期限制

function getAnticipationLimits(
        $recipientId,
        $timeframe,
        $paymentDate)

参数

参数	标签	描述
recipientId	`必需`	收款人ID
时间段	`必需`	时间段
paymentDate	`必需`	预期支付日期

示例用法

$recipientId = 'recipient_id';
$timeframe = 'timeframe';
$paymentDate = date("D M d, Y G:i");

$result = $recipients->getAnticipationLimits($recipientId, $timeframe, $paymentDate);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

createWithdraw

createWithdraw

function createWithdraw(
        $recipientId,
        $body)

参数

参数	标签	描述
recipientId	`必需`	待补充：添加参数描述
body	`必需`	待补充：添加参数描述

示例用法

$recipientId = 'recipient_id';
$body = new CreateWithdrawRequest();

$result = $recipients->createWithdraw($recipientId, $body);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getWithdrawals

获取收款人的分页转账列表

function getWithdrawals(
        $recipientId,
        $page = null,
        $size = null,
        $status = null,
        $createdSince = null,
        $createdUntil = null)

参数

参数	标签	描述
recipientId	`必需`	待补充：添加参数描述
page	`可选`	待补充：添加参数描述
size	`可选`	待补充：添加参数描述
status	`可选`	待补充：添加参数描述
createdSince	`可选`	待补充：添加参数描述
createdUntil	`可选`	待补充：添加参数描述

示例用法

$recipientId = 'recipient_id';
$page = 153;
$size = 153;
$status = 'status';
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");

$result = $recipients->getWithdrawals($recipientId, $page, $size, $status, $createdSince, $createdUntil);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getWithdrawById

GetWithdrawById

function getWithdrawById(
        $recipientId,
        $withdrawalId)

参数

参数	标签	描述
recipientId	`必需`	待补充：添加参数描述
withdrawalId	`必需`	待补充：添加参数描述

示例用法

$recipientId = 'recipient_id';
$withdrawalId = 'withdrawal_id';

$result = $recipients->getWithdrawById($recipientId, $withdrawalId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

updateAutomaticAnticipationSettings

更新收款人元数据

function updateAutomaticAnticipationSettings(
        $recipientId,
        $body,
        $idempotencyKey = null)

参数

参数	标签	描述
recipientId	`必需`	收款人ID
body	`必需`	元数据
idempotencyKey	`可选`	待补充：添加参数描述

示例用法

$recipientId = 'recipient_id';
$body = new UpdateAutomaticAnticipationSettingsRequest();
$idempotencyKey = 'idempotency-key';

$result = $recipients->updateAutomaticAnticipationSettings($recipientId, $body, $idempotencyKey);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getRecipientByCode

检索收款人信息

function getRecipientByCode($code)

参数

参数	标签	描述
code	`必需`	收款人代码

示例用法

$code = 'code';

$result = $recipients->getRecipientByCode($code);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

返回控制器列表

TokensController

获取单例实例

可以从API客户端访问类的单例实例。

$tokens = $client->getTokens();

createToken

标签： 跳过身份验证

创建Token

function createToken(
        $publicKey,
        $body,
        $idempotencyKey = null,
        $appId = null)

参数

参数	标签	描述
公钥	`必需`	公钥
body	`必需`	创建令牌的请求
idempotencyKey	`可选`	待补充：添加参数描述
appId	`可选`	待补充：添加参数描述

示例用法

$publicKey = 'public_key';
$body = new TokensRequest();
$idempotencyKey = 'idempotency-key';
$appId = 'appId';

$result = $tokens->createToken($publicKey, $body, $idempotencyKey, $appId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getToken

标签： 跳过身份验证

通过其ID获取令牌

function getToken(
        $id,
        $publicKey,
        $appId = null)

参数

参数	标签	描述
id	`必需`	令牌ID
公钥	`必需`	公钥
appId	`可选`	待补充：添加参数描述

示例用法

$id = 'id';
$publicKey = 'public_key';
$appId = 'appId';

$result = $tokens->getToken($id, $publicKey, $appId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

返回控制器列表

TransactionsController

获取单例实例

可以通过API客户端访问TransactionsController类的单例实例。

$transactions = $client->getTransactions();

getTransaction

GetTransaction

function getTransaction($transactionId)

参数

参数	标签	描述
transactionId	`必需`	待补充：添加参数描述

示例用法

$transactionId = 'transaction_id';

$result = $transactions->getTransaction($transactionId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

返回控制器列表

TransfersController

获取单例实例

可以通过API客户端访问TransfersController类的单例实例。

$transfers = $client->getTransfers();

postCreateTransfer

CreateTransfer

function postCreateTransfer($body)

参数

参数	标签	描述
body	`必需`	待补充：添加参数描述

示例用法

$body = new CreateTransfer();

$result = $transfers->postCreateTransfer($body);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getTransferById

GetTransferById

function getTransferById($transferId)

参数

参数	标签	描述
transferId	`必需`	待补充：添加参数描述

示例用法

$transferId = 'transfer_id';

$result = $transfers->getTransferById($transferId);

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

getTransfers1

获取所有转账

function getTransfers1()

示例用法

$result = $transfers->getTransfers1();

错误

错误代码	错误描述
400	无效请求
401	无效API密钥
404	未找到相关信息
412	业务验证错误
422	合同验证错误
500	内部服务器错误

返回控制器列表

mundipagg / mundiapi

维护者

详细信息

README

如何构建

[仅限Windows用户] 在php.ini中配置CURL证书路径

如何使用

1. 在IDE中打开项目

2. 添加新的测试项目

3. 运行测试项目

如何测试

初始化

身份验证

类参考

控制器列表

SubscriptionsController

获取单例实例

createDiscount

参数

示例用法

错误

getSubscriptionItem

参数

示例用法

错误

updateSubscriptionItem

参数

示例用法

错误

deleteUsage

参数

示例用法

错误

cancelSubscription

参数

示例用法

错误

getSubscription

参数

示例用法

错误

deleteIncrement

参数

示例用法

错误

getIncrementById

参数

示例用法

错误

getSubscriptionCycleById

参数

示例用法

错误

updateSubscriptionStartAt

参数

示例用法

错误

更新订阅支付方式

参数

示例用法

错误

updateCurrentCycleStatus

参数

示例用法

错误

createSubscription

参数

示例用法

错误

getSubscriptions

参数

示例用法

错误

getUsagesDetails

参数

示例用法

错误

renewSubscription

参数

示例用法