Getting started

Pagarme API

How to Build

The generated code has dependencies over external libraries like UniRest. These dependencies are defined in the composer.json file that comes with the SDK. To resolve these dependencies, we use the Composer package manager which requires PHP greater than 5.3.2 installed in your system. Visit https://getcomposer.org/download/ to download the installer file for Composer and run it in your system. Open command prompt and type composer --version. This should display the current version of the Composer installed if the installation was successful.

Using command line, navigate to the directory containing the generated files (including composer.json) for the SDK.
Run the command composer install. This should install all the required dependencies and create the vendor directory in your project directory.

[For Windows Users Only] Configuring CURL Certificate Path in php.ini

CURL used to include a list of accepted CAs, but no longer bundles ANY CA certs. So by default it will reject all SSL certificates as unverifiable. You will have to get your CA's cert and point curl at it. The steps are as follows:

Download the certificate bundle (.pem file) from https://curl.haxx.se/docs/caextract.html on to your system.
Add curl.cainfo = "PATH_TO/cacert.pem" to your php.ini file located in your php installation. “PATH_TO” must be an absolute path containing the .pem file.

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

How to Use

The following section explains how to use the PagarmeCoreApi library in a new project.

1. Open Project in an IDE

Open an IDE for PHP like PhpStorm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on Open in PhpStorm to browse to your generated SDK directory and then click OK.

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Name the directory as "test"

Add a PHP file to this project

Name it "testSDK"

Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable auto loading of classes.

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

It is important that the path inside require_once correctly points to the file autoload.php inside the vendor directory created during dependency installations.

After this you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.

3. Run the Test Project

To run your project you must set the Interpreter for your project. Interpreter is the PHP engine installed on your computer.

Open Settings from File menu.

Select PHP from within Languages & Frameworks

Browse for Interpreters near the Interpreter option and choose your interpreter.

Once the interpreter is selected, click OK

To run your project, right click on your PHP file inside your Test project and click on Run

How to Test

Unit tests in this SDK can be run using PHPUnit.

First install the dependencies using composer including the require-dev dependencies.
Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

Initialization

Authentication

In order to setup authentication and initialization of the API client, you need the following information.

Parameter	Description
basicAuthUserName	The username to use with basic authentication
basicAuthPassword	The password to use with basic authentication

API client can be initialized as following.

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

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

Class Reference

PlansController

Get singleton instance

The singleton instance of the PlansController class can be accessed from the API Client.

$plans = $client->getPlans();

getPlan

Gets a plan

function getPlan($planId)

Parameters

Parameter	Tags	Description
planId	`Required`	Plan id

Example Usage

$planId = 'plan_id';

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

deletePlan

Deletes a plan

function deletePlan(
        $planId,
        $idempotencyKey = null)

Parameters

Parameter	Tags	Description
planId	`Required`	Plan id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updatePlanMetadata

Updates the metadata from a plan

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

Parameters

Parameter	Tags	Description
planId	`Required`	The plan id
request	`Required`	Request for updating the plan metadata
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updatePlanItem

Updates a plan item

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

Parameters

Parameter	Tags	Description
planId	`Required`	Plan id
planItemId	`Required`	Plan item id
body	`Required`	Request for updating the plan item
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createPlanItem

Adds a new item to a plan

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

Parameters

Parameter	Tags	Description
planId	`Required`	Plan id
request	`Required`	Request for creating a plan item
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getPlanItem

Gets a plan item

function getPlanItem(
        $planId,
        $planItemId)

Parameters

Parameter	Tags	Description
planId	`Required`	Plan id
planItemId	`Required`	Plan item id

Example Usage

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

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

createPlan

Creates a new plan

function createPlan(
        $body,
        $idempotencyKey = null)

Parameters

Parameter	Tags	Description
body	`Required`	Request for creating a plan
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

deletePlanItem

Removes an item from a plan

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

Parameters

Parameter	Tags	Description
planId	`Required`	Plan id
planItemId	`Required`	Plan item id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getPlans

Gets all plans

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

Parameters

Parameter	Tags	Description
page	`Optional`	Page number
size	`Optional`	Page size
name	`Optional`	Filter for Plan's name
status	`Optional`	Filter for Plan's status
billingType	`Optional`	Filter for plan's billing type
createdSince	`Optional`	Filter for plan's creation date start range
createdUntil	`Optional`	Filter for plan's creation date end range

Example Usage

$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

Updates a plan

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

Parameters

Parameter	Tags	Description
planId	`Required`	Plan id
request	`Required`	Request for updating a plan
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

Back to List of Controllers

SubscriptionsController

Get singleton instance

The singleton instance of the SubscriptionsController class can be accessed from the API Client.

$subscriptions = $client->getSubscriptions();

renewSubscription

TODO: Add a method description

function renewSubscription(
        $subscriptionId,
        $idempotencyKey = null)

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	TODO: Add a parameter description
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updateSubscriptionCard

Updates the credit card from a subscription

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription id
request	`Required`	Request for updating a card
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

deleteUsage

Deletes a usage

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	The subscription id
itemId	`Required`	The subscription item id
usageId	`Required`	The usage id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createDiscount

Creates a discount

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription id
request	`Required`	Request for creating a discount
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createAnUsage

Create Usage

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription id
itemId	`Required`	Item id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updateCurrentCycleStatus

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription Id
request	`Required`	Request for updating the end date of the subscription current status
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

deleteDiscount

Deletes a discount

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription id
discountId	`Required`	Discount Id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getSubscriptionItems

Get Subscription Items

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	The subscription id
page	`Optional`	Page number
size	`Optional`	Page size
name	`Optional`	The item name
code	`Optional`	Identification code in the client system
status	`Optional`	The item statis
description	`Optional`	The item description
createdSince	`Optional`	Filter for item's creation date start range
createdUntil	`Optional`	Filter for item's creation date end range

Example Usage

$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

Updates the payment method from a subscription

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription id
request	`Required`	Request for updating the paymentmethod from a subscription
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getSubscriptionItem

Get Subscription Item

function getSubscriptionItem(
        $subscriptionId,
        $itemId)

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription Id
itemId	`Required`	Item id

Example Usage

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

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

getSubscriptions

Gets all subscriptions

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)

Parameters

Parameter	Tags	Description
page	`Optional`	Page number
size	`Optional`	Page size
code	`Optional`	Filter for subscription's code
billingType	`Optional`	Filter for subscription's billing type
customerId	`Optional`	Filter for subscription's customer id
planId	`Optional`	Filter for subscription's plan id
cardId	`Optional`	Filter for subscription's card id
status	`Optional`	Filter for subscription's status
nextBillingSince	`Optional`	Filter for subscription's next billing date start range
nextBillingUntil	`Optional`	Filter for subscription's next billing date end range
createdSince	`Optional`	Filter for subscription's creation date start range
createdUntil	`Optional`	Filter for subscriptions creation date end range

Example Usage

$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

Cancels a subscription

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription id
request	`Optional`	Request for cancelling a subscription
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createIncrement

Creates a increment

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription id
request	`Required`	Request for creating a increment
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createUsage

Creates a usage

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription Id
itemId	`Required`	Item id
body	`Required`	Request for creating a usage
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getDiscountById

TODO: Add a method description

function getDiscountById(
        $subscriptionId,
        $discountId)

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	The subscription id
discountId	`Required`	TODO: Add a parameter description

Example Usage

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

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

createSubscription

Creates a new subscription

function createSubscription(
        $body,
        $idempotencyKey = null)

Parameters

Parameter	Tags	Description
body	`Required`	Request for creating a subscription
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getIncrementById

TODO: Add a method description

function getIncrementById(
        $subscriptionId,
        $incrementId)

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	The subscription Id
incrementId	`Required`	The increment Id

Example Usage

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

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

updateSubscriptionAffiliationId

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	TODO: Add a parameter description
request	`Required`	Request for updating a subscription affiliation id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updateSubscriptionMetadata

Updates the metadata from a subscription

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	The subscription id
request	`Required`	Request for updating the subscrption metadata
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

deleteIncrement

Deletes a increment

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription id
incrementId	`Required`	Increment id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getSubscriptionCycles

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription Id
page	`Required`	Page number
size	`Required`	Page size

Example Usage

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

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

getDiscounts

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	The subscription id
page	`Required`	Page number
size	`Required`	Page size

Example Usage

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

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

updateSubscriptionBillingDate

Updates the billing date from a subscription

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	The subscription id
request	`Required`	Request for updating the subscription billing date
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

deleteSubscriptionItem

Deletes a subscription item

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription id
subscriptionItemId	`Required`	Subscription item id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getIncrements

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	The subscription id
page	`Optional`	Page number
size	`Optional`	Page size

Example Usage

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

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

updateSubscriptionDueDays

Updates the boleto due days from a subscription

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription Id
request	`Required`	TODO: Add a parameter description
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updateSubscriptionStartAt

Updates the start at date from a subscription

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	The subscription id
request	`Required`	Request for updating the subscription start date
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updateSubscriptionItem

Updates a subscription item

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription Id
itemId	`Required`	Item id
body	`Required`	Request for updating a subscription item
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createSubscriptionItem

Creates a new Subscription item

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription id
request	`Required`	Request for creating a subscription item
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getSubscription

Gets a subscription

function getSubscription($subscriptionId)

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription id

Example Usage

$subscriptionId = 'subscription_id';

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

getUsages

Lists all usages from a subscription item

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	The subscription id
itemId	`Required`	The subscription item id
page	`Optional`	Page number
size	`Optional`	Page size
code	`Optional`	Identification code in the client system
group	`Optional`	Identification group in the client system
usedSince	`Optional`	TODO: Add a parameter description
usedUntil	`Optional`	TODO: Add a parameter description

Example Usage

$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

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	TODO: Add a parameter description
request	`Required`	Request for updating the end date of the current signature cycle
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updateSubscriptionMiniumPrice

Atualização do valor mínimo da assinatura

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription Id
request	`Required`	Request da requisição com o valor mínimo que será configurado
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getSubscriptionCycleById

TODO: Add a method description

function getSubscriptionCycleById(
        $subscriptionId,
        $cycleId)

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	The subscription id
cycleId	`Required`	TODO: Add a parameter description

Example Usage

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

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

getUsageReport

TODO: Add a method description

function getUsageReport(
        $subscriptionId,
        $periodId)

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	The subscription Id
periodId	`Required`	The period Id

Example Usage

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

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

Back to List of Controllers

InvoicesController

Get singleton instance

The singleton instance of the InvoicesController class can be accessed from the API Client.

$invoices = $client->getInvoices();

updateInvoiceMetadata

Updates the metadata from an invoice

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

Parameters

Parameter	Tags	Description
invoiceId	`Required`	The invoice id
request	`Required`	Request for updating the invoice metadata
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getPartialInvoice

TODO: Add a method description

function getPartialInvoice($subscriptionId)

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription Id

Example Usage

$subscriptionId = 'subscription_id';

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

cancelInvoice

Cancels an invoice

function cancelInvoice(
        $invoiceId,
        $idempotencyKey = null)

Parameters

Parameter	Tags	Description
invoiceId	`Required`	Invoice id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createInvoice

Create an Invoice

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

Parameters

Parameter	Tags	Description
subscriptionId	`Required`	Subscription Id
cycleId	`Required`	Cycle Id
request	`Optional`	TODO: Add a parameter description
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getInvoices

Gets all invoices

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

Parameters

Parameter	Tags	Description
page	`Optional`	Page number
size	`Optional`	Page size
code	`Optional`	Filter for Invoice's code
customerId	`Optional`	Filter for Invoice's customer id
subscriptionId	`Optional`	Filter for Invoice's subscription id
createdSince	`Optional`	Filter for Invoice's creation date start range
createdUntil	`Optional`	Filter for Invoices creation date end range
status	`Optional`	Filter for Invoice's status
dueSince	`Optional`	Filter for Invoice's due date start range
dueUntil	`Optional`	Filter for Invoice's due date end range
customerDocument	`Optional`	TODO: Add a parameter description

Example Usage

$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

Gets an invoice

function getInvoice($invoiceId)

Parameters

Parameter	Tags	Description
invoiceId	`Required`	Invoice Id

Example Usage

$invoiceId = 'invoice_id';

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

updateInvoiceStatus

Updates the status from an invoice

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

Parameters

Parameter	Tags	Description
invoiceId	`Required`	Invoice Id
request	`Required`	Request for updating an invoice's status
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

Back to List of Controllers

OrdersController

Get singleton instance

The singleton instance of the OrdersController class can be accessed from the API Client.

$orders = $client->getOrders();

getOrders

Gets all orders

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

Parameters

Parameter	Tags	Description
page	`Optional`	Page number
size	`Optional`	Page size
code	`Optional`	Filter for order's code
status	`Optional`	Filter for order's status
createdSince	`Optional`	Filter for order's creation date start range
createdUntil	`Optional`	Filter for order's creation date end range
customerId	`Optional`	Filter for order's customer id

Example Usage

$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

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
orderId	`Required`	Order Id
itemId	`Required`	Item Id
request	`Required`	Item Model
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

deleteAllOrderItems

TODO: Add a method description

function deleteAllOrderItems(
        $orderId,
        $idempotencyKey = null)

Parameters

Parameter	Tags	Description
orderId	`Required`	Order Id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

deleteOrderItem

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
orderId	`Required`	Order Id
itemId	`Required`	Item Id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

closeOrder

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
id	`Required`	Order Id
request	`Required`	Update Order Model
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createOrder

Creates a new Order

function createOrder(
        $body,
        $idempotencyKey = null)

Parameters

Parameter	Tags	Description
body	`Required`	Request for creating an order
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createOrderItem

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
orderId	`Required`	Order Id
request	`Required`	Order Item Model
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getOrderItem

TODO: Add a method description

function getOrderItem(
        $orderId,
        $itemId)

Parameters

Parameter	Tags	Description
orderId	`Required`	Order Id
itemId	`Required`	Item Id

Example Usage

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

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

updateOrderMetadata

Updates the metadata from an order

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

Parameters

Parameter	Tags	Description
orderId	`Required`	The order id
request	`Required`	Request for updating the order metadata
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getOrder

Gets an order

function getOrder($orderId)

Parameters

Parameter	Tags	Description
orderId	`Required`	Order id

Example Usage

$orderId = 'order_id';

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

Back to List of Controllers

CustomersController

Get singleton instance

The singleton instance of the CustomersController class can be accessed from the API Client.

$customers = $client->getCustomers();

updateCard

Updates a card

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

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id
cardId	`Required`	Card id
request	`Required`	Request for updating a card
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updateAddress

Updates an address

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

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id
addressId	`Required`	Address Id
request	`Required`	Request for updating an address
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

deleteAccessToken

Delete a customer's access token

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

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id
tokenId	`Required`	Token Id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createCustomer

Creates a new customer

function createCustomer(
        $request,
        $idempotencyKey = null)

Parameters

Parameter	Tags	Description
request	`Required`	Request for creating a customer
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createAddress

Creates a new address for a customer

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

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id
request	`Required`	Request for creating an address
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

deleteAccessTokens

Delete a Customer's access tokens

function deleteAccessTokens($customerId)

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id

Example Usage

$customerId = 'customer_id';

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

getAddress

Get a customer's address

function getAddress(
        $customerId,
        $addressId)

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer id
addressId	`Required`	Address Id

Example Usage

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

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

deleteAddress

Delete a Customer's address

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

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id
addressId	`Required`	Address Id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createCard

Creates a new card for a customer

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

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer id
request	`Required`	Request for creating a card
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getCustomers

Get all Customers

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

Parameters

Parameter	Tags	Description
name	`Optional`	Name of the Customer
document	`Optional`	Document of the Customer
page	`Optional` `DefaultValue`	Current page the the search
size	`Optional` `DefaultValue`	Quantity pages of the search
email	`Optional`	Customer's email
code	`Optional`	Customer's code

Example Usage

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

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

updateCustomer

Updates a customer

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

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer id
request	`Required`	Request for updating a customer
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createAccessToken

Creates a access token for a customer

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

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id
request	`Required`	Request for creating a access token
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getAccessTokens

Get all access tokens from a customer

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

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id
page	`Optional`	Page number
size	`Optional`	Page size

Example Usage

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

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

getCards

Get all cards from a customer

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

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id
page	`Optional`	Page number
size	`Optional`	Page size

Example Usage

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

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

renewCard

Renew a card

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

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer id
cardId	`Required`	Card Id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getAccessToken

Get a Customer's access token

function getAccessToken(
        $customerId,
        $tokenId)

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id
tokenId	`Required`	Token Id

Example Usage

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

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

updateCustomerMetadata

Updates the metadata a customer

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

Parameters

Parameter	Tags	Description
customerId	`Required`	The customer id
request	`Required`	Request for updating the customer metadata
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

deleteCard

Delete a customer's card

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

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id
cardId	`Required`	Card Id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getAddresses

Gets all adressess from a customer

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

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer id
page	`Optional`	Page number
size	`Optional`	Page size

Example Usage

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

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

getCustomer

Get a customer

function getCustomer($customerId)

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer Id

Example Usage

$customerId = 'customer_id';

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

getCard

Get a customer's card

function getCard(
        $customerId,
        $cardId)

Parameters

Parameter	Tags	Description
customerId	`Required`	Customer id
cardId	`Required`	Card id

Example Usage

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

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

Back to List of Controllers

RecipientsController

Get singleton instance

The singleton instance of the RecipientsController class can be accessed from the API Client.

$recipients = $client->getRecipients();

updateRecipient

Updates a recipient

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

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient id
request	`Required`	Recipient data
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createAnticipation

Creates an anticipation

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

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient id
request	`Required`	Anticipation data
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getAnticipationLimits

Gets the anticipation limits for a recipient

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

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient id
timeframe	`Required`	Timeframe
paymentDate	`Required`	Anticipation payment date

Example Usage

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

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

getRecipients

Retrieves paginated recipients information

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

Parameters

Parameter	Tags	Description
page	`Optional`	Page number
size	`Optional`	Page size

Example Usage

$page = 241;
$size = 241;

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

getWithdrawById

TODO: Add a method description

function getWithdrawById(
        $recipientId,
        $withdrawalId)

Parameters

Parameter	Tags	Description
recipientId	`Required`	TODO: Add a parameter description
withdrawalId	`Required`	TODO: Add a parameter description

Example Usage

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

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

updateRecipientDefaultBankAccount

Updates the default bank account from a recipient

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

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient id
request	`Required`	Bank account data
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updateRecipientMetadata

Updates recipient metadata

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

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient id
request	`Required`	Metadata
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getTransfers

Gets a paginated list of transfers for the recipient

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

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient id
page	`Optional`	Page number
size	`Optional`	Page size
status	`Optional`	Filter for transfer status
createdSince	`Optional`	Filter for start range of transfer creation date
createdUntil	`Optional`	Filter for end range of transfer creation date

Example Usage

$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

Gets a transfer

function getTransfer(
        $recipientId,
        $transferId)

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient id
transferId	`Required`	Transfer id

Example Usage

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

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

createWithdraw

TODO: Add a method description

function createWithdraw(
        $recipientId,
        $request)

Parameters

Parameter	Tags	Description
recipientId	`Required`	TODO: Add a parameter description
request	`Required`	TODO: Add a parameter description

Example Usage

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

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

updateAutomaticAnticipationSettings

Updates recipient metadata

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

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient id
request	`Required`	Metadata
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getAnticipation

Gets an anticipation

function getAnticipation(
        $recipientId,
        $anticipationId)

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient id
anticipationId	`Required`	Anticipation id

Example Usage

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

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

updateRecipientTransferSettings

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient Identificator
request	`Required`	TODO: Add a parameter description
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getAnticipations

Retrieves a paginated list of anticipations from a recipient

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

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient id
page	`Optional`	Page number
size	`Optional`	Page size
status	`Optional`	Filter for anticipation status
timeframe	`Optional`	Filter for anticipation timeframe
paymentDateSince	`Optional`	Filter for start range for anticipation payment date
paymentDateUntil	`Optional`	Filter for end range for anticipation payment date
createdSince	`Optional`	Filter for start range for anticipation creation date
createdUntil	`Optional`	Filter for end range for anticipation creation date

Example Usage

$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

Retrieves recipient information

function getRecipient($recipientId)

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipiend id

Example Usage

$recipientId = 'recipient_id';

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

getBalance

Get balance information for a recipient

function getBalance($recipientId)

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient id

Example Usage

$recipientId = 'recipient_id';

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

getWithdrawals

Gets a paginated list of transfers for the recipient

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

Parameters

Parameter	Tags	Description
recipientId	`Required`	TODO: Add a parameter description
page	`Optional`	TODO: Add a parameter description
size	`Optional`	TODO: Add a parameter description
status	`Optional`	TODO: Add a parameter description
createdSince	`Optional`	TODO: Add a parameter description
createdUntil	`Optional`	TODO: Add a parameter description

Example Usage

$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

Creates a transfer for a recipient

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

Parameters

Parameter	Tags	Description
recipientId	`Required`	Recipient Id
request	`Required`	Transfer data
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createRecipient

Creates a new recipient

function createRecipient(
        $request,
        $idempotencyKey = null)

Parameters

Parameter	Tags	Description
request	`Required`	Recipient data
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getRecipientByCode

Retrieves recipient information

function getRecipientByCode($code)

Parameters

Parameter	Tags	Description
code	`Required`	Recipient code

Example Usage

$code = 'code';

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

getDefaultRecipient

TODO: Add a method description

function getDefaultRecipient()

Example Usage

$result = $recipients->getDefaultRecipient();

Back to List of Controllers

ChargesController

Get singleton instance

The singleton instance of the ChargesController class can be accessed from the API Client.

$charges = $client->getCharges();

updateChargeMetadata

Updates the metadata from a charge

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

Parameters

Parameter	Tags	Description
chargeId	`Required`	The charge id
request	`Required`	Request for updating the charge metadata
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updateChargePaymentMethod

Updates a charge's payment method

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

Parameters

Parameter	Tags	Description
chargeId	`Required`	Charge id
request	`Required`	Request for updating the payment method from a charge
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getChargeTransactions

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
chargeId	`Required`	Charge Id
page	`Optional`	Page number
size	`Optional`	Page size

Example Usage

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

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

updateChargeDueDate

Updates the due date from a charge

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

Parameters

Parameter	Tags	Description
chargeId	`Required`	Charge Id
request	`Required`	Request for updating the due date
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getCharges

Lists all charges

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

Parameters

Parameter	Tags	Description
page	`Optional`	Page number
size	`Optional`	Page size
code	`Optional`	Filter for charge's code
status	`Optional`	Filter for charge's status
paymentMethod	`Optional`	Filter for charge's payment method
customerId	`Optional`	Filter for charge's customer id
orderId	`Optional`	Filter for charge's order id
createdSince	`Optional`	Filter for the beginning of the range for charge's creation
createdUntil	`Optional`	Filter for the end of the range for charge's creation

Example Usage

$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

Captures a charge

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

Parameters

Parameter	Tags	Description
chargeId	`Required`	Charge id
request	`Optional`	Request for capturing a charge
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updateChargeCard

Updates the card from a charge

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

Parameters

Parameter	Tags	Description
chargeId	`Required`	Charge id
request	`Required`	Request for updating a charge's card
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getCharge

Get a charge from its id

function getCharge($chargeId)

Parameters

Parameter	Tags	Description
chargeId	`Required`	Charge id

Example Usage

$chargeId = 'charge_id';

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

getChargesSummary

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
status	`Required`	TODO: Add a parameter description
createdSince	`Optional`	TODO: Add a parameter description
createdUntil	`Optional`	TODO: Add a parameter description

Example Usage

$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

Retries a charge

function retryCharge(
        $chargeId,
        $idempotencyKey = null)

Parameters

Parameter	Tags	Description
chargeId	`Required`	Charge id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

cancelCharge

Cancel a charge

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

Parameters

Parameter	Tags	Description
chargeId	`Required`	Charge id
request	`Optional`	Request for cancelling a charge
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

createCharge

Creates a new charge

function createCharge(
        $request,
        $idempotencyKey = null)

Parameters

Parameter	Tags	Description
request	`Required`	Request for creating a charge
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

confirmPayment

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
chargeId	`Required`	TODO: Add a parameter description
request	`Optional`	Request for confirm payment
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

Back to List of Controllers

TransfersController

Get singleton instance

The singleton instance of the TransfersController class can be accessed from the API Client.

$transfers = $client->getTransfers();

getTransferById

TODO: Add a method description

function getTransferById($transferId)

Parameters

Parameter	Tags	Description
transferId	`Required`	TODO: Add a parameter description

Example Usage

$transferId = 'transfer_id';

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

createTransfer

TODO: Add a method description

function createTransfer($request)

Parameters

Parameter	Tags	Description
request	`Required`	TODO: Add a parameter description

Example Usage

$request = new CreateTransfer();

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

getTransfers

Gets all transfers

function getTransfers()

Example Usage

$result = $transfers->getTransfers();

Back to List of Controllers

TokensController

Get singleton instance

The singleton instance of the TokensController class can be accessed from the API Client.

$tokens = $client->getTokens();

createToken

Tags: Skips Authentication

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
publicKey	`Required`	Public key
request	`Required`	Request for creating a token
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getToken

Tags: Skips Authentication

Gets a token from its id

function getToken(
        $id,
        $publicKey)

Parameters

Parameter	Tags	Description
id	`Required`	Token id
publicKey	`Required`	Public key

Example Usage

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

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

Back to List of Controllers

SellersController

Get singleton instance

The singleton instance of the SellersController class can be accessed from the API Client.

$sellers = $client->getSellers();

createSeller

TODO: Add a method description

function createSeller(
        $request,
        $idempotencyKey = null)

Parameters

Parameter	Tags	Description
request	`Required`	Seller Model
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updateSellerMetadata

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
sellerId	`Required`	Seller Id
request	`Required`	Request for updating the charge metadata
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

updateSeller

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
id	`Required`	TODO: Add a parameter description
request	`Required`	Update Seller model
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

deleteSeller

TODO: Add a method description

function deleteSeller(
        $sellerId,
        $idempotencyKey = null)

Parameters

Parameter	Tags	Description
sellerId	`Required`	Seller Id
idempotencyKey	`Optional`	TODO: Add a parameter description

Example Usage

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

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

getSellerById

TODO: Add a method description

function getSellerById($id)

Parameters

Parameter	Tags	Description
id	`Required`	Seller Id

Example Usage

$id = 'id';

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

getSellers

TODO: Add a method description

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

Parameters

Parameter	Tags	Description
page	`Optional`	Page number
size	`Optional`	Page size
name	`Optional`	TODO: Add a parameter description
document	`Optional`	TODO: Add a parameter description
code	`Optional`	TODO: Add a parameter description
status	`Optional`	TODO: Add a parameter description
type	`Optional`	TODO: Add a parameter description
createdSince	`Optional`	TODO: Add a parameter description
createdUntil	`Optional`	TODO: Add a parameter description

Example Usage

$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);

Back to List of Controllers

TransactionsController

Get singleton instance

The singleton instance of the TransactionsController class can be accessed from the API Client.

$transactions = $client->getTransactions();

getTransaction

TODO: Add a method description

function getTransaction($transactionId)

Parameters

Parameter	Tags	Description
transactionId	`Required`	TODO: Add a parameter description

Example Usage

$transactionId = 'transaction_id';

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

Back to List of Controllers

Name		Name	Last commit message	Last commit date
Latest commit History 8 Commits
examples		examples
src		src
LICENSE		LICENSE
README.md		README.md
composer.json		composer.json

License

juniormaciel/pagarme-core-api-php

Folders and files

Latest commit

History

Repository files navigation

Getting started

How to Build

[For Windows Users Only] Configuring CURL Certificate Path in php.ini

How to Use

1. Open Project in an IDE

2. Add a new Test Project

3. Run the Test Project

How to Test

Initialization

Authentication

Class Reference

List of Controllers

PlansController

Get singleton instance

getPlan

Parameters

Example Usage

deletePlan

Parameters

Example Usage

updatePlanMetadata

Parameters

Example Usage

updatePlanItem

Parameters

Example Usage

createPlanItem

Parameters

Example Usage

getPlanItem

Parameters

Example Usage

createPlan

Parameters

Example Usage

deletePlanItem

Parameters

Example Usage

getPlans

Parameters

Example Usage

updatePlan

Parameters

Example Usage

SubscriptionsController

Get singleton instance

renewSubscription

Parameters

Example Usage

updateSubscriptionCard

Parameters

Example Usage

deleteUsage

Parameters

Example Usage

createDiscount

Parameters

Example Usage

createAnUsage

Parameters

Example Usage

updateCurrentCycleStatus

Parameters

Example Usage

deleteDiscount

Parameters

Example Usage

getSubscriptionItems

Parameters

Example Usage

updateSubscriptionPaymentMethod

Parameters

Example Usage

getSubscriptionItem