README

Pagarme 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指向它。以下是步骤：

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

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

如何使用

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

1. 在IDE中打开项目

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

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

2. 添加新的测试项目

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

将目录命名为"test"

向此项目添加PHP文件

命名为"testSDK"

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

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

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

之后，您可以添加代码来初始化客户端库并获取Controller类实例。随后的部分提供了初始化客户端库和使用控制器方法的示例代码。

3. 运行测试项目

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

从文件菜单中打开设置。

在语言 & 框架中选择PHP。

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

选择解释器后，点击确定

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

如何测试

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

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

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

初始化

身份验证

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

API客户端可以按照以下方式初始化。

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

$client = new PagarmeCoreApiLib\PagarmeCoreApiClient($basicAuthUserName, $basicAuthPassword);

类参考

控制器列表

• PlansController
• SubscriptionsController
• InvoicesController
• OrdersController
• CustomersController
• RecipientsController
• ChargesController
• TransfersController
• TokensController
• SellersController
• TransactionsController

PlansController

获取单例实例

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

$plans = $client->getPlans();

getPlan

获取一个计划

function getPlan($planId)

参数

示例用法

$planId = 'plan_id';

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

deletePlan

删除一个计划

function deletePlan(
        $planId,
        $idempotencyKey = null)

参数

示例用法

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

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

updatePlanMetadata

更新计划元数据

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

参数

示例用法

$planId = 'plan_id';
$request = new UpdateMetadataRequest();
$idempotencyKey = 'idempotency-key';

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

updatePlanItem

更新计划项目

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

参数

示例用法

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

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

createPlanItem

向计划添加新项目

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

参数

示例用法

$planId = 'plan_id';
$request = new CreatePlanItemRequest();
$idempotencyKey = 'idempotency-key';

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

getPlanItem

获取计划项目

function getPlanItem(
        $planId,
        $planItemId)

参数

示例用法

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

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

createPlan

创建新的计划

function createPlan(
        $body,
        $idempotencyKey = null)

参数

示例用法

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

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

deletePlanItem

从计划中删除项目

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

参数

示例用法

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

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

getPlans

获取所有计划

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

参数

示例用法

$page = 191;
$size = 191;
$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);

updatePlan

更新计划

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

参数

示例用法

$planId = 'plan_id';
$request = new UpdatePlanRequest();
$idempotencyKey = 'idempotency-key';

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

返回控制器列表

SubscriptionsController

获取单例实例

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

$subscriptions = $client->getSubscriptions();

renewSubscription

待办：添加方法描述

function renewSubscription(
        $subscriptionId,
        $idempotencyKey = null)

参数

示例用法

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

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

updateSubscriptionCard

更新订阅的信用卡

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

参数

示例用法

$subscriptionId = 'subscription_id';
$request = new UpdateSubscriptionCardRequest();
$idempotencyKey = 'idempotency-key';

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

deleteUsage

删除使用情况

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

参数

示例用法

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

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

createDiscount

创建折扣

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

参数

示例用法

$subscriptionId = 'subscription_id';
$request = new CreateDiscountRequest();
$idempotencyKey = 'idempotency-key';

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

createAnUsage

创建使用情况

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

参数

示例用法

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

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

updateCurrentCycleStatus

待办：添加方法描述

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

参数

示例用法

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

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

deleteDiscount

删除折扣

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

参数

示例用法

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

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

getSubscriptionItems

获取订阅项

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

参数

示例用法

$subscriptionId = 'subscription_id';
$page = 191;
$size = 191;
$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);

updateSubscriptionPaymentMethod

更新订阅的支付方式

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

参数

示例用法

$subscriptionId = 'subscription_id';
$request = new UpdateSubscriptionPaymentMethodRequest();
$idempotencyKey = 'idempotency-key';

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

getSubscriptionItem

获取订阅项

function getSubscriptionItem(
        $subscriptionId,
        $itemId)

参数

示例用法

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

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

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 = 191;
$size = 191;
$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);

cancelSubscription

取消订阅

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

参数

示例用法

$subscriptionId = 'subscription_id';
$request = new CreateCancelSubscriptionRequest();
$idempotencyKey = 'idempotency-key';

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

createIncrement

创建增量

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

参数

示例用法

$subscriptionId = 'subscription_id';
$request = new CreateIncrementRequest();
$idempotencyKey = 'idempotency-key';

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

createUsage

创建使用情况

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

参数

示例用法

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

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

getDiscountById

待办：添加方法描述

function getDiscountById(
        $subscriptionId,
        $discountId)

参数

示例用法

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

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

通过ID获取折扣

createSubscription

function createSubscription(
        $body,
        $idempotencyKey = null)

参数

示例用法

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

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

创建新的订阅

待办：添加方法描述

function getIncrementById(
        $subscriptionId,
        $incrementId)

参数

示例用法

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

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

updateSubscriptionAffiliationId

待办：添加方法描述

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

参数

示例用法

$subscriptionId = 'subscription_id';
$request = new UpdateSubscriptionAffiliationIdRequest();
$idempotencyKey = 'idempotency-key';

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

updateSubscriptionMetadata

更新订阅的元数据

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

参数

示例用法

$subscriptionId = 'subscription_id';
$request = new UpdateMetadataRequest();
$idempotencyKey = 'idempotency-key';

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

deleteIncrement

删除一个增量

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

参数

示例用法

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

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

getSubscriptionCycles

待办：添加方法描述

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

参数

示例用法

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

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

getDiscounts

待办：添加方法描述

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

参数

示例用法

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

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

updateSubscriptionBillingDate

更新订阅的计费日期

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

参数

示例用法

$subscriptionId = 'subscription_id';
$request = new UpdateSubscriptionBillingDateRequest();
$idempotencyKey = 'idempotency-key';

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

deleteSubscriptionItem

删除一个订阅项

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

参数

示例用法

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

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

getIncrements

待办：添加方法描述

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

参数

示例用法

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

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

updateSubscriptionDueDays

更新订阅的到期天数

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

参数

示例用法

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

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

updateSubscriptionStartAt

更新订阅的起始日期

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

参数

示例用法

$subscriptionId = 'subscription_id';
$request = new UpdateSubscriptionStartAtRequest();
$idempotencyKey = 'idempotency-key';

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

updateSubscriptionItem

更新订阅项

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

参数

示例用法

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

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

createSubscriptionItem

创建新的订阅项

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

参数

示例用法

$subscriptionId = 'subscription_id';
$request = new CreateSubscriptionItemRequest();
$idempotencyKey = 'idempotency-key';

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

getSubscription

获取订阅信息

function getSubscription($subscriptionId)

参数

示例用法

$subscriptionId = 'subscription_id';

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

getUsages

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

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

参数

示例用法

$subscriptionId = 'subscription_id';
$itemId = 'item_id';
$page = 27;
$size = 27;
$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);

updateLatestPeriodEndAt

待办：添加方法描述

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

参数

示例用法

$subscriptionId = 'subscription_id';
$request = new UpdateCurrentCycleEndDateRequest();
$idempotencyKey = 'idempotency-key';

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

updateSubscriptionMiniumPrice

更新订阅最小价值

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

参数

示例用法

$subscriptionId = 'subscription_id';
$request = new UpdateSubscriptionMinimumPriceRequest();
$idempotencyKey = 'idempotency-key';

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

getSubscriptionCycleById

待办：添加方法描述

function getSubscriptionCycleById(
        $subscriptionId,
        $cycleId)

参数

示例用法

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

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

getUsageReport

待办：添加方法描述

function getUsageReport(
        $subscriptionId,
        $periodId)

参数

示例用法

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

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

返回控制器列表

InvoicesController

获取单例实例

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

$invoices = $client->getInvoices();

updateInvoiceMetadata

更新发票的元数据

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

参数

示例用法

$invoiceId = 'invoice_id';
$request = new UpdateMetadataRequest();
$idempotencyKey = 'idempotency-key';

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

getPartialInvoice

待办：添加方法描述

function getPartialInvoice($subscriptionId)

参数

示例用法

$subscriptionId = 'subscription_id';

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

cancelInvoice

取消发票

function cancelInvoice(
        $invoiceId,
        $idempotencyKey = null)

参数

示例用法

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

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

createInvoice

创建发票

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

参数

示例用法

$subscriptionId = 'subscription_id';
$cycleId = 'cycle_id';
$request = new CreateInvoiceRequest();
$idempotencyKey = 'idempotency-key';

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

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 = 27;
$size = 27;
$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);

getInvoice

获取发票

function getInvoice($invoiceId)

参数

示例用法

$invoiceId = 'invoice_id';

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

updateInvoiceStatus

更新发票状态

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

参数

示例用法

$invoiceId = 'invoice_id';
$request = new UpdateInvoiceStatusRequest();
$idempotencyKey = 'idempotency-key';

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

返回控制器列表

OrdersController

获取单例实例

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

$orders = $client->getOrders();

getOrders

获取所有订单

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

参数

示例用法

$page = 27;
$size = 27;
$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);

updateOrderItem

待办：添加方法描述

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

参数

示例用法

$orderId = 'orderId';
$itemId = 'itemId';
$request = new UpdateOrderItemRequest();
$idempotencyKey = 'idempotency-key';

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

deleteAllOrderItems

待办：添加方法描述

function deleteAllOrderItems(
        $orderId,
        $idempotencyKey = null)

参数

示例用法

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

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

deleteOrderItem

待办：添加方法描述

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

参数

示例用法

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

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

closeOrder

待办：添加方法描述

function closeOrder(
        $id,
        $request,
        $idempotencyKey = null)

参数

示例用法

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

$result = $orders->closeOrder($id, $request, $idempotencyKey);

createOrder

创建一个新的订单

function createOrder(
        $body,
        $idempotencyKey = null)

参数

示例用法

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

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

createOrderItem

待办：添加方法描述

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

参数

示例用法

$orderId = 'orderId';
$request = new CreateOrderItemRequest();
$idempotencyKey = 'idempotency-key';

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

getOrderItem

待办：添加方法描述

function getOrderItem(
        $orderId,
        $itemId)

参数

示例用法

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

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

updateOrderMetadata

更新订单的元数据

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

参数

示例用法

$orderId = 'order_id';
$request = new UpdateMetadataRequest();
$idempotencyKey = 'idempotency-key';

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

getOrder

获取订单

function getOrder($orderId)

参数

示例用法

$orderId = 'order_id';

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

返回控制器列表

CustomersController

获取单例实例

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

$customers = $client->getCustomers();

updateCard

更新一张卡

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

参数

示例用法

$customerId = 'customer_id';
$cardId = 'card_id';
$request = new UpdateCardRequest();
$idempotencyKey = 'idempotency-key';

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

updateAddress

更新地址

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

参数

示例用法

$customerId = 'customer_id';
$addressId = 'address_id';
$request = new UpdateAddressRequest();
$idempotencyKey = 'idempotency-key';

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

deleteAccessToken

删除客户的访问令牌

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

参数

示例用法

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

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

createCustomer

创建新客户

function createCustomer(
        $request,
        $idempotencyKey = null)

参数

示例用法

$request = new CreateCustomerRequest();
$idempotencyKey = 'idempotency-key';

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

createAddress

为顾客创建新的地址

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

参数

示例用法

$customerId = 'customer_id';
$request = new CreateAddressRequest();
$idempotencyKey = 'idempotency-key';

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

deleteAccessTokens

删除顾客的访问令牌

function deleteAccessTokens($customerId)

参数

示例用法

$customerId = 'customer_id';

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

getAddress

获取顾客的地址

function getAddress(
        $customerId,
        $addressId)

参数

示例用法

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

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

deleteAddress

删除顾客的地址

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

参数

示例用法

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

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

createCard

为顾客创建新的卡

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

参数

示例用法

$customerId = 'customer_id';
$request = new CreateCardRequest();
$idempotencyKey = 'idempotency-key';

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

getCustomers

获取所有顾客

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

参数

示例用法

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

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

updateCustomer

更新顾客信息

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

参数

示例用法

$customerId = 'customer_id';
$request = new UpdateCustomerRequest();
$idempotencyKey = 'idempotency-key';

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

createAccessToken

为顾客创建访问令牌

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

参数

示例用法

$customerId = 'customer_id';
$request = new CreateAccessTokenRequest();
$idempotencyKey = 'idempotency-key';

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

getAccessTokens

获取顾客的所有访问令牌

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

参数

示例用法

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

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

getCards

获取顾客的所有卡

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

参数

示例用法

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

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

renewCard

续期卡

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

参数

示例用法

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

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

getAccessToken

获取客户的访问令牌

function getAccessToken(
        $customerId,
        $tokenId)

参数

示例用法

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

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

updateCustomerMetadata

更新客户的元数据

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

参数

示例用法

$customerId = 'customer_id';
$request = new UpdateMetadataRequest();
$idempotencyKey = 'idempotency-key';

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

deleteCard

删除客户的卡片

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

参数

示例用法

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

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

getAddresses

获取客户的所有地址

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

参数

示例用法

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

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

getCustomer

获取客户信息

function getCustomer($customerId)

参数

示例用法

$customerId = 'customer_id';

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

getCard

获取客户的卡片

function getCard(
        $customerId,
        $cardId)

参数

示例用法

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

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

返回控制器列表

RecipientsController

获取单例实例

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

$recipients = $client->getRecipients();

updateRecipient

更新收件人信息

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

参数

示例用法

$recipientId = 'recipient_id';
$request = new UpdateRecipientRequest();
$idempotencyKey = 'idempotency-key';

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

createAnticipation

创建预期款项

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

参数

示例用法

$recipientId = 'recipient_id';
$request = new CreateAnticipationRequest();
$idempotencyKey = 'idempotency-key';

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

getAnticipationLimits

获取收件人的预期款项限额

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

参数

示例用法

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

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

getRecipients

检索分页的接收者信息

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

参数

示例用法

$page = 241;
$size = 241;

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

getWithdrawById

待办：添加方法描述

function getWithdrawById(
        $recipientId,
        $withdrawalId)

参数

示例用法

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

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

updateRecipientDefaultBankAccount

更新接收者的默认银行账户

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

参数

示例用法

$recipientId = 'recipient_id';
$request = new UpdateRecipientBankAccountRequest();
$idempotencyKey = 'idempotency-key';

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

updateRecipientMetadata

更新接收者元数据

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

参数

示例用法

$recipientId = 'recipient_id';
$request = new UpdateMetadataRequest();
$idempotencyKey = 'idempotency-key';

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

getTransfers

获取接收者的分页转账列表

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

参数

示例用法

$recipientId = 'recipient_id';
$page = 241;
$size = 241;
$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);

getTransfer

获取转账

function getTransfer(
        $recipientId,
        $transferId)

参数

示例用法

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

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

createWithdraw

待办：添加方法描述

function createWithdraw(
        $recipientId,
        $request)

参数

示例用法

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

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

updateAutomaticAnticipationSettings

更新接收者元数据

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

参数

示例用法

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

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

getAnticipation

获取预期待遇

function getAnticipation(
        $recipientId,
        $anticipationId)

参数

示例用法

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

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

updateRecipientTransferSettings

待办：添加方法描述

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

参数

示例用法

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

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

getAnticipations

从接收者那里检索分页的预期列表

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

参数

示例用法

$recipientId = 'recipient_id';
$page = 241;
$size = 241;
$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);

getRecipient

检索接收者信息

function getRecipient($recipientId)

参数

示例用法

$recipientId = 'recipient_id';

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

getBalance

获取接收者的余额信息

function getBalance($recipientId)

参数

示例用法

$recipientId = 'recipient_id';

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

getWithdrawals

获取接收者的分页转账列表

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

参数

示例用法

$recipientId = 'recipient_id';
$page = 241;
$size = 241;
$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);

createTransfer

为接收者创建转账

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

参数

示例用法

$recipientId = 'recipient_id';
$request = new CreateTransferRequest();
$idempotencyKey = 'idempotency-key';

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

createRecipient

创建新的接收者

function createRecipient(
        $request,
        $idempotencyKey = null)

参数

示例用法

$request = new CreateRecipientRequest();
$idempotencyKey = 'idempotency-key';

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

getRecipientByCode

检索接收者信息

function getRecipientByCode($code)

参数

示例用法

$code = 'code';

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

getDefaultRecipient

待办：添加方法描述

function getDefaultRecipient()

示例用法

$result = $recipients->getDefaultRecipient();

返回控制器列表

ChargesController

获取单例实例

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

$charges = $client->getCharges();

updateChargeMetadata

更新收费的元数据

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

参数

示例用法

$chargeId = 'charge_id';
$request = new UpdateMetadataRequest();
$idempotencyKey = 'idempotency-key';

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

updateChargePaymentMethod

更新费用支付方式

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

参数

示例用法

$chargeId = 'charge_id';
$request = new UpdateChargePaymentMethodRequest();
$idempotencyKey = 'idempotency-key';

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

getChargeTransactions

待办：添加方法描述

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

参数

示例用法

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

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

updateChargeDueDate

更新费用到期日

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

参数

示例用法

$chargeId = 'charge_id';
$request = new UpdateChargeDueDateRequest();
$idempotencyKey = 'idempotency-key';

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

getCharges

列出所有费用

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

参数

示例用法

$page = 77;
$size = 77;
$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);

captureCharge

扣款

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

参数

示例用法

$chargeId = 'charge_id';
$request = new CreateCaptureChargeRequest();
$idempotencyKey = 'idempotency-key';

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

updateChargeCard

更新费用卡片

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

参数

示例用法

$chargeId = 'charge_id';
$request = new UpdateChargeCardRequest();
$idempotencyKey = 'idempotency-key';

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

getCharge

根据ID获取费用

function getCharge($chargeId)

参数

示例用法

$chargeId = 'charge_id';

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

getChargesSummary

待办：添加方法描述

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

参数

示例用法

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

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

retryCharge

重试费用

function retryCharge(
        $chargeId,
        $idempotencyKey = null)

参数

示例用法

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

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

cancelCharge

取消费用

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

参数

示例用法

$chargeId = 'charge_id';
$request = new CreateCancelChargeRequest();
$idempotencyKey = 'idempotency-key';

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

createCharge

创建新的费用

function createCharge(
        $request,
        $idempotencyKey = null)

参数

示例用法

$request = new CreateChargeRequest();
$idempotencyKey = 'idempotency-key';

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

confirmPayment

待办：添加方法描述

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

参数

示例用法

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

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

返回控制器列表

TransfersController

获取单例实例

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

$transfers = $client->getTransfers();

getTransferById

待办：添加方法描述

function getTransferById($transferId)

参数

示例用法

$transferId = 'transfer_id';

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

createTransfer

待办：添加方法描述

function createTransfer($request)

参数

示例用法

$request = new CreateTransfer();

$result = $transfers->createTransfer($request);

getTransfers

获取所有转账

function getTransfers()

示例用法

$result = $transfers->getTransfers();

返回控制器列表

TokensController

获取单例实例

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

$tokens = $client->getTokens();

createToken

标签： 跳过身份验证

待办：添加方法描述

function createToken(
        $publicKey,
        $request,
        $idempotencyKey = null)

参数

示例用法

$publicKey = 'public_key';
$request = new CreateTokenRequest();
$idempotencyKey = 'idempotency-key';

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

getToken

标签： 跳过身份验证

根据ID获取令牌

function getToken(
        $id,
        $publicKey)

参数

示例用法

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

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

返回控制器列表

SellersController

获取单例实例

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

$sellers = $client->getSellers();

createSeller

待办：添加方法描述

function createSeller(
        $request,
        $idempotencyKey = null)

参数

示例用法

$request = new CreateSellerRequest();
$idempotencyKey = 'idempotency-key';

$result = $sellers->createSeller($request, $idempotencyKey);

updateSellerMetadata

待办：添加方法描述

function updateSellerMetadata(
        $sellerId,
        $request,
        $idempotencyKey = null)

参数

示例用法

$sellerId = 'seller_id';
$request = new UpdateMetadataRequest();
$idempotencyKey = 'idempotency-key';

$result = $sellers->updateSellerMetadata($sellerId, $request, $idempotencyKey);

updateSeller

待办：添加方法描述

function updateSeller(
        $id,
        $request,
        $idempotencyKey = null)

参数

示例用法

$id = 'id';
$request = new UpdateSellerRequest();
$idempotencyKey = 'idempotency-key';

$result = $sellers->updateSeller($id, $request, $idempotencyKey);

deleteSeller

待办：添加方法描述

function deleteSeller(
        $sellerId,
        $idempotencyKey = null)

参数

示例用法

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

$result = $sellers->deleteSeller($sellerId, $idempotencyKey);

getSellerById

待办：添加方法描述

function getSellerById($id)

参数

示例用法

$id = 'id';

$result = $sellers->getSellerById($id);

getSellers

待办：添加方法描述

function getSellers(
        $page = null,
        $size = null,
        $name = null,
        $document = null,
        $code = null,
        $status = null,
        $type = null,
        $createdSince = null,
        $createdUntil = null)

参数

示例用法

$page = 77;
$size = 77;
$name = 'name';
$document = 'document';
$code = 'code';
$status = 'status';
$type = 'type';
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");

$result = $sellers->getSellers($page, $size, $name, $document, $code, $status, $type, $createdSince, $createdUntil);

返回控制器列表

TransactionsController

获取单例实例

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

$transactions = $client->getTransactions();

getTransaction

待办：添加方法描述

function getTransaction($transactionId)

参数

示例用法

$transactionId = 'transaction_id';

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

返回控制器列表