Pagarme API
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 =
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.
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
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.
In order to setup authentication and initialization of the API client, you need the following information.
Parameter
Description
serviceRefererName
TODO: add a description
basicAuthUserName
The username to use with basic authentication
basicAuthPassword
The password to use with basic authentication
API client can be initialized as following.
$ serviceRefererName = 'serviceRefererName ' ;
$ basicAuthUserName = 'basicAuthUserName ' ; // The username to use with basic authentication
$ basicAuthPassword = 'basicAuthPassword ' ; // The password to use with basic authentication
$ client = new PagarmeCoreApiLib \PagarmeCoreApiClient ($ serviceRefererName , $ basicAuthUserName , $ basicAuthPassword );
SubscriptionsController
The singleton instance of the SubscriptionsController
class can be accessed from the API Client.
$ subscriptions = $ client ->getSubscriptions ();
updateSubscriptionCard
Updates the credit card from a subscription
function updateSubscriptionCard(
$ subscriptionId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription id
body
Required
Request for updating a card
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ body = new UpdateSubscriptionCardRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->updateSubscriptionCard ($ subscriptionId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
deleteUsage
Deletes a usage
function deleteUsage(
$ subscriptionId ,
$ itemId ,
$ usageId ,
$ idempotencyKey = null )
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
$ subscriptionId = 'subscription_id ' ;
$ itemId = 'item_id ' ;
$ usageId = 'usage_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->deleteUsage ($ subscriptionId , $ itemId , $ usageId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createDiscount
Creates a discount
function createDiscount(
$ subscriptionId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription id
body
Required
Request for creating a discount
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ body = new CreateDiscountRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->createDiscount ($ subscriptionId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createAnUsage
Create Usage
function createAnUsage(
$ subscriptionId ,
$ itemId ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription id
itemId
Required
Item id
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ itemId = 'item_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->createAnUsage ($ subscriptionId , $ itemId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getUsages
Lists all usages from a subscription item
function getUsages(
$ subscriptionId ,
$ itemId ,
$ page = null ,
$ size = null ,
$ code = null ,
$ group = null ,
$ usedSince = null ,
$ usedUntil = null )
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
$ subscriptionId = 'subscription_id ' ;
$ itemId = 'item_id ' ;
$ page = 69 ;
$ size = 69 ;
$ 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 );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateCurrentCycleStatus
UpdateCurrentCycleStatus
function updateCurrentCycleStatus(
$ subscriptionId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription Id
body
Required
Request for updating the end date of the subscription current status
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ body = new UpdateCurrentCycleStatusRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ subscriptions ->updateCurrentCycleStatus ($ subscriptionId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateSubscriptionPaymentMethod
Updates the payment method from a subscription
function updateSubscriptionPaymentMethod(
$ subscriptionId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription id
body
Required
Request for updating the paymentmethod from a subscription
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ body = new UpdateSubscriptionPaymentMethodRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->updateSubscriptionPaymentMethod ($ subscriptionId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
deleteDiscount
Deletes a discount
function deleteDiscount(
$ subscriptionId ,
$ discountId ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription id
discountId
Required
Discount Id
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ discountId = 'discount_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->deleteDiscount ($ subscriptionId , $ discountId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getSubscriptionItems
Get Subscription Items
function getSubscriptionItems(
$ subscriptionId ,
$ page = null ,
$ size = null ,
$ name = null ,
$ code = null ,
$ status = null ,
$ description = null ,
$ createdSince = null ,
$ createdUntil = null )
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
$ subscriptionId = 'subscription_id ' ;
$ page = 69 ;
$ size = 69 ;
$ 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 );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createSubscriptionItem
Creates a new Subscription item
function createSubscriptionItem(
$ subscriptionId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription id
body
Required
Request for creating a subscription item
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ body = new CreateSubscriptionItemRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->createSubscriptionItem ($ subscriptionId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getSubscriptionItem
Get Subscription Item
function getSubscriptionItem(
$ subscriptionId ,
$ itemId )
Parameter
Tags
Description
subscriptionId
Required
Subscription Id
itemId
Required
Item id
$ subscriptionId = 'subscription_id ' ;
$ itemId = 'item_id ' ;
$ result = $ subscriptions ->getSubscriptionItem ($ subscriptionId , $ itemId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateSubscriptionItem
Updates a subscription item
function updateSubscriptionItem(
$ subscriptionId ,
$ itemId ,
$ body ,
$ idempotencyKey = null )
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
$ subscriptionId = 'subscription_id ' ;
$ itemId = 'item_id ' ;
$ body = new UpdateSubscriptionItemRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->updateSubscriptionItem ($ subscriptionId , $ itemId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
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 )
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
$ page = 160 ;
$ size = 160 ;
$ 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 );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createSubscription
Creates a new subscription
function createSubscription(
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
body
Required
Request for creating a subscription
idempotencyKey
Optional
TODO: Add a parameter description
$ body = new CreateSubscriptionRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->createSubscription ($ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
cancelSubscription
Cancels a subscription
function cancelSubscription(
$ subscriptionId ,
$ idempotencyKey = null ,
$ body = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription id
idempotencyKey
Optional
TODO: Add a parameter description
body
Optional
Request for cancelling a subscription
$ subscriptionId = 'subscription_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ body = new CreateCancelSubscriptionRequest ();
$ result = $ subscriptions ->cancelSubscription ($ subscriptionId , $ idempotencyKey , $ body );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getSubscription
Gets a subscription
function getSubscription($ subscriptionId )
Parameter
Tags
Description
subscriptionId
Required
Subscription id
$ subscriptionId = 'subscription_id ' ;
$ result = $ subscriptions ->getSubscription ($ subscriptionId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createIncrement
Creates a increment
function createIncrement(
$ subscriptionId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription id
body
Required
Request for creating a increment
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ body = new CreateIncrementRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->createIncrement ($ subscriptionId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getDiscountById
GetDiscountById
function getDiscountById(
$ subscriptionId ,
$ discountId )
Parameter
Tags
Description
subscriptionId
Required
The subscription id
discountId
Required
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ discountId = 'discountId ' ;
$ result = $ subscriptions ->getDiscountById ($ subscriptionId , $ discountId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateSubscriptionAffiliationId
UpdateSubscriptionAffiliationId
function updateSubscriptionAffiliationId(
$ subscriptionId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
TODO: Add a parameter description
body
Required
Request for updating a subscription affiliation id
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ body = new UpdateSubscriptionAffiliationIdRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->updateSubscriptionAffiliationId ($ subscriptionId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateSubscriptionMetadata
Updates the metadata from a subscription
function updateSubscriptionMetadata(
$ subscriptionId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
The subscription id
body
Required
Request for updating the subscrption metadata
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ body = new UpdateMetadataRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->updateSubscriptionMetadata ($ subscriptionId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
deleteIncrement
Deletes a increment
function deleteIncrement(
$ subscriptionId ,
$ incrementId ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription id
incrementId
Required
Increment id
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ incrementId = 'increment_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->deleteIncrement ($ subscriptionId , $ incrementId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getIncrementById
GetIncrementById
function getIncrementById(
$ subscriptionId ,
$ incrementId )
Parameter
Tags
Description
subscriptionId
Required
The subscription Id
incrementId
Required
The increment Id
$ subscriptionId = 'subscription_id ' ;
$ incrementId = 'increment_id ' ;
$ result = $ subscriptions ->getIncrementById ($ subscriptionId , $ incrementId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getSubscriptionCycles
GetSubscriptionCycles
function getSubscriptionCycles(
$ subscriptionId ,
$ page ,
$ size )
Parameter
Tags
Description
subscriptionId
Required
Subscription Id
page
Required
Page number
size
Required
Page size
$ subscriptionId = 'subscription_id ' ;
$ page = 'page ' ;
$ size = 'size ' ;
$ result = $ subscriptions ->getSubscriptionCycles ($ subscriptionId , $ page , $ size );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
renewSubscription
RenewSubscription
function renewSubscription(
$ subscriptionId ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
TODO: Add a parameter description
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->renewSubscription ($ subscriptionId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getDiscounts
GetDiscounts
function getDiscounts(
$ subscriptionId ,
$ page ,
$ size )
Parameter
Tags
Description
subscriptionId
Required
The subscription id
page
Required
Page number
size
Required
Page size
$ subscriptionId = 'subscription_id ' ;
$ page = 160 ;
$ size = 160 ;
$ result = $ subscriptions ->getDiscounts ($ subscriptionId , $ page , $ size );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateSubscriptionBillingDate
Updates the billing date from a subscription
function updateSubscriptionBillingDate(
$ subscriptionId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
The subscription id
body
Required
Request for updating the subscription billing date
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ body = new UpdateSubscriptionBillingDateRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->updateSubscriptionBillingDate ($ subscriptionId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
deleteSubscriptionItem
Deletes a subscription item
function deleteSubscriptionItem(
$ subscriptionId ,
$ subscriptionItemId ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription id
subscriptionItemId
Required
Subscription item id
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ subscriptionItemId = 'subscription_item_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->deleteSubscriptionItem ($ subscriptionId , $ subscriptionItemId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getIncrements
GetIncrements
function getIncrements(
$ subscriptionId ,
$ page = null ,
$ size = null )
Parameter
Tags
Description
subscriptionId
Required
The subscription id
page
Optional
Page number
size
Optional
Page size
$ subscriptionId = 'subscription_id ' ;
$ page = 160 ;
$ size = 160 ;
$ result = $ subscriptions ->getIncrements ($ subscriptionId , $ page , $ size );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateSubscriptionDueDays
Updates the boleto due days from a subscription
function updateSubscriptionDueDays(
$ subscriptionId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription Id
body
Required
TODO: Add a parameter description
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ body = new UpdateSubscriptionDueDaysRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->updateSubscriptionDueDays ($ subscriptionId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateSubscriptionStartAt
Updates the start at date from a subscription
function updateSubscriptionStartAt(
$ subscriptionId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
The subscription id
body
Required
Request for updating the subscription start date
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ body = new UpdateSubscriptionStartAtRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->updateSubscriptionStartAt ($ subscriptionId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateLatestPeriodEndAt
UpdateLatestPeriodEndAt
function updateLatestPeriodEndAt(
$ subscriptionId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
TODO: Add a parameter description
body
Required
Request for updating the end date of the current signature cycle
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ body = new UpdateCurrentCycleEndDateRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->updateLatestPeriodEndAt ($ subscriptionId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateSubscriptionMiniumPrice
Atualização do valor mínimo da assinatura
function updateSubscriptionMiniumPrice(
$ subscriptionId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription Id
body
Required
Request da requisição com o valor mínimo que será configurado
idempotencyKey
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ body = new UpdateSubscriptionMinimumPriceRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ subscriptions ->updateSubscriptionMiniumPrice ($ subscriptionId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getSubscriptionCycleById
GetSubscriptionCycleById
function getSubscriptionCycleById(
$ subscriptionId ,
$ cycleId )
Parameter
Tags
Description
subscriptionId
Required
The subscription id
cycleId
Required
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ cycleId = 'cycleId ' ;
$ result = $ subscriptions ->getSubscriptionCycleById ($ subscriptionId , $ cycleId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getUsageReport
GetUsageReport
function getUsageReport(
$ subscriptionId ,
$ periodId )
Parameter
Tags
Description
subscriptionId
Required
The subscription Id
periodId
Required
The period Id
$ subscriptionId = 'subscription_id ' ;
$ periodId = 'period_id ' ;
$ result = $ subscriptions ->getUsageReport ($ subscriptionId , $ periodId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateSplitSubscription
UpdateSplitSubscription
function updateSplitSubscription(
$ id ,
$ body )
Parameter
Tags
Description
id
Required
Subscription's id
body
Required
TODO: Add a parameter description
$ id = 'id ' ;
$ body = new UpdateSubscriptionSplitRequest ();
$ result = $ subscriptions ->updateSplitSubscription ($ id , $ body );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
Back to List of Controllers
OrdersController
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 )
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
$ page = 160 ;
$ size = 160 ;
$ 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 );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createOrder
Creates a new Order
function createOrder(
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
body
Required
Request for creating an order
idempotencyKey
Optional
TODO: Add a parameter description
$ body = new CreateOrderRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ orders ->createOrder ($ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
deleteAllOrderItems
DeleteAllOrderItems
function deleteAllOrderItems(
$ orderId ,
$ idempotencyKey = null )
Parameter
Tags
Description
orderId
Required
Order Id
idempotencyKey
Optional
TODO: Add a parameter description
$ orderId = 'orderId ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ orders ->deleteAllOrderItems ($ orderId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createOrderItem
CreateOrderItem
function createOrderItem(
$ orderId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
orderId
Required
Order Id
body
Required
Order Item Model
idempotencyKey
Optional
TODO: Add a parameter description
$ orderId = 'orderId ' ;
$ body = new CreateOrderItemRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ orders ->createOrderItem ($ orderId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateOrderItem
UpdateOrderItem
function updateOrderItem(
$ orderId ,
$ itemId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
orderId
Required
Order Id
itemId
Required
Item Id
body
Required
Item Model
idempotencyKey
Optional
TODO: Add a parameter description
$ orderId = 'orderId ' ;
$ itemId = 'itemId ' ;
$ body = new UpdateOrderItemRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ orders ->updateOrderItem ($ orderId , $ itemId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
deleteOrderItem
DeleteOrderItem
function deleteOrderItem(
$ orderId ,
$ itemId ,
$ idempotencyKey = null )
Parameter
Tags
Description
orderId
Required
Order Id
itemId
Required
Item Id
idempotencyKey
Optional
TODO: Add a parameter description
$ orderId = 'orderId ' ;
$ itemId = 'itemId ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ orders ->deleteOrderItem ($ orderId , $ itemId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getOrderItem
GetOrderItem
function getOrderItem(
$ orderId ,
$ itemId )
Parameter
Tags
Description
orderId
Required
Order Id
itemId
Required
Item Id
$ orderId = 'orderId ' ;
$ itemId = 'itemId ' ;
$ result = $ orders ->getOrderItem ($ orderId , $ itemId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
closeOrder
CloseOrder
function closeOrder(
$ id ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
id
Required
Order Id
body
Required
Update Order Model
idempotencyKey
Optional
TODO: Add a parameter description
$ id = 'id ' ;
$ body = new UpdateOrderStatusRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ orders ->closeOrder ($ id , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateOrderMetadata
Updates the metadata from an order
function updateOrderMetadata(
$ orderId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
orderId
Required
The order id
body
Required
Request for updating the order metadata
idempotencyKey
Optional
TODO: Add a parameter description
$ orderId = 'order_id ' ;
$ body = new UpdateMetadataRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ orders ->updateOrderMetadata ($ orderId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getOrder
Gets an order
function getOrder($ orderId )
Parameter
Tags
Description
orderId
Required
Order id
$ orderId = 'order_id ' ;
$ result = $ orders ->getOrder ($ orderId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
Back to List of Controllers
PlansController
The singleton instance of the PlansController
class can be accessed from the API Client.
$ plans = $ client ->getPlans ();
getPlan
Gets a plan
function getPlan($ planId )
Parameter
Tags
Description
planId
Required
Plan id
$ planId = 'plan_id ' ;
$ result = $ plans ->getPlan ($ planId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updatePlan
Updates a plan
function updatePlan(
$ planId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
planId
Required
Plan id
body
Required
Request for updating a plan
idempotencyKey
Optional
TODO: Add a parameter description
$ planId = 'plan_id ' ;
$ body = new UpdatePlanRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ plans ->updatePlan ($ planId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
deletePlan
Deletes a plan
function deletePlan(
$ planId ,
$ idempotencyKey = null )
Parameter
Tags
Description
planId
Required
Plan id
idempotencyKey
Optional
TODO: Add a parameter description
$ planId = 'plan_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ plans ->deletePlan ($ planId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updatePlanMetadata
Updates the metadata from a plan
function updatePlanMetadata(
$ planId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
planId
Required
The plan id
body
Required
Request for updating the plan metadata
idempotencyKey
Optional
TODO: Add a parameter description
$ planId = 'plan_id ' ;
$ body = new UpdateMetadataRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ plans ->updatePlanMetadata ($ planId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updatePlanItem
Updates a plan item
function updatePlanItem(
$ planId ,
$ planItemId ,
$ body ,
$ idempotencyKey = null )
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
$ planId = 'plan_id ' ;
$ planItemId = 'plan_item_id ' ;
$ body = new UpdatePlanItemRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ plans ->updatePlanItem ($ planId , $ planItemId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getPlanItem
Gets a plan item
function getPlanItem(
$ planId ,
$ planItemId )
Parameter
Tags
Description
planId
Required
Plan id
planItemId
Required
Plan item id
$ planId = 'plan_id ' ;
$ planItemId = 'plan_item_id ' ;
$ result = $ plans ->getPlanItem ($ planId , $ planItemId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
deletePlanItem
Removes an item from a plan
function deletePlanItem(
$ planId ,
$ planItemId ,
$ idempotencyKey = null )
Parameter
Tags
Description
planId
Required
Plan id
planItemId
Required
Plan item id
idempotencyKey
Optional
TODO: Add a parameter description
$ planId = 'plan_id ' ;
$ planItemId = 'plan_item_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ plans ->deletePlanItem ($ planId , $ planItemId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createPlanItem
Adds a new item to a plan
function createPlanItem(
$ planId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
planId
Required
Plan id
body
Required
Request for creating a plan item
idempotencyKey
Optional
TODO: Add a parameter description
$ planId = 'plan_id ' ;
$ body = new CreatePlanItemRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ plans ->createPlanItem ($ planId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createPlan
Creates a new plan
function createPlan(
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
body
Required
Request for creating a plan
idempotencyKey
Optional
TODO: Add a parameter description
$ body = new CreatePlanRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ plans ->createPlan ($ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getPlans
Gets all plans
function getPlans(
$ page = null ,
$ size = null ,
$ name = null ,
$ status = null ,
$ billingType = null ,
$ createdSince = null ,
$ createdUntil = null )
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
$ page = 160 ;
$ size = 160 ;
$ 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 );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
Back to List of Controllers
InvoicesController
The singleton instance of the InvoicesController
class can be accessed from the API Client.
$ invoices = $ client ->getInvoices ();
getPartialInvoice
GetPartialInvoice
function getPartialInvoice($ subscriptionId )
Parameter
Tags
Description
subscriptionId
Required
Subscription Id
$ subscriptionId = 'subscription_id ' ;
$ result = $ invoices ->getPartialInvoice ($ subscriptionId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
cancelInvoice
Cancels an invoice
function cancelInvoice(
$ invoiceId ,
$ idempotencyKey = null )
Parameter
Tags
Description
invoiceId
Required
Invoice id
idempotencyKey
Optional
TODO: Add a parameter description
$ invoiceId = 'invoice_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ invoices ->cancelInvoice ($ invoiceId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getInvoice
Gets an invoice
function getInvoice($ invoiceId )
Parameter
Tags
Description
invoiceId
Required
Invoice Id
$ invoiceId = 'invoice_id ' ;
$ result = $ invoices ->getInvoice ($ invoiceId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createInvoice
Create an Invoice
function createInvoice(
$ subscriptionId ,
$ cycleId ,
$ idempotencyKey = null ,
$ body = null )
Parameter
Tags
Description
subscriptionId
Required
Subscription Id
cycleId
Required
Cycle Id
idempotencyKey
Optional
TODO: Add a parameter description
body
Optional
TODO: Add a parameter description
$ subscriptionId = 'subscription_id ' ;
$ cycleId = 'cycle_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ body = new CreateInvoiceRequest ();
$ result = $ invoices ->createInvoice ($ subscriptionId , $ cycleId , $ idempotencyKey , $ body );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateInvoiceMetadata
Updates the metadata from an invoice
function updateInvoiceMetadata(
$ invoiceId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
invoiceId
Required
The invoice id
body
Required
Request for updating the invoice metadata
idempotencyKey
Optional
TODO: Add a parameter description
$ invoiceId = 'invoice_id ' ;
$ body = new UpdateMetadataRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ invoices ->updateInvoiceMetadata ($ invoiceId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
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 )
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
$ page = 252 ;
$ size = 252 ;
$ 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 );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateInvoiceStatus
Updates the status from an invoice
function updateInvoiceStatus(
$ invoiceId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
invoiceId
Required
Invoice Id
body
Required
Request for updating an invoice's status
idempotencyKey
Optional
TODO: Add a parameter description
$ invoiceId = 'invoice_id ' ;
$ body = new UpdateInvoiceStatusRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ invoices ->updateInvoiceStatus ($ invoiceId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
Back to List of Controllers
CustomersController
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 ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
customerId
Required
Customer Id
cardId
Required
Card id
body
Required
Request for updating a card
idempotencyKey
Optional
TODO: Add a parameter description
$ customerId = 'customer_id ' ;
$ cardId = 'card_id ' ;
$ body = new UpdateCardRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ customers ->updateCard ($ customerId , $ cardId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
deleteCard
Delete a customer's card
function deleteCard(
$ customerId ,
$ cardId ,
$ idempotencyKey = null )
Parameter
Tags
Description
customerId
Required
Customer Id
cardId
Required
Card Id
idempotencyKey
Optional
TODO: Add a parameter description
$ customerId = 'customer_id ' ;
$ cardId = 'card_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ customers ->deleteCard ($ customerId , $ cardId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getCard
Get a customer's card
function getCard(
$ customerId ,
$ cardId )
Parameter
Tags
Description
customerId
Required
Customer id
cardId
Required
Card id
$ customerId = 'customer_id ' ;
$ cardId = 'card_id ' ;
$ result = $ customers ->getCard ($ customerId , $ cardId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateAddress
Updates an address
function updateAddress(
$ customerId ,
$ addressId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
customerId
Required
Customer Id
addressId
Required
Address Id
body
Required
Request for updating an address
idempotencyKey
Optional
TODO: Add a parameter description
$ customerId = 'customer_id ' ;
$ addressId = 'address_id ' ;
$ body = new UpdateAddressRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ customers ->updateAddress ($ customerId , $ addressId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getAddress
Get a customer's address
function getAddress(
$ customerId ,
$ addressId )
Parameter
Tags
Description
customerId
Required
Customer id
addressId
Required
Address Id
$ customerId = 'customer_id ' ;
$ addressId = 'address_id ' ;
$ result = $ customers ->getAddress ($ customerId , $ addressId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
deleteAddress
Delete a Customer's address
function deleteAddress(
$ customerId ,
$ addressId ,
$ idempotencyKey = null )
Parameter
Tags
Description
customerId
Required
Customer Id
addressId
Required
Address Id
idempotencyKey
Optional
TODO: Add a parameter description
$ customerId = 'customer_id ' ;
$ addressId = 'address_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ customers ->deleteAddress ($ customerId , $ addressId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
deleteAccessToken
Delete a customer's access token
function deleteAccessToken(
$ customerId ,
$ tokenId ,
$ idempotencyKey = null )
Parameter
Tags
Description
customerId
Required
Customer Id
tokenId
Required
Token Id
idempotencyKey
Optional
TODO: Add a parameter description
$ customerId = 'customer_id ' ;
$ tokenId = 'token_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ customers ->deleteAccessToken ($ customerId , $ tokenId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getAccessToken
Get a Customer's access token
function getAccessToken(
$ customerId ,
$ tokenId )
Parameter
Tags
Description
customerId
Required
Customer Id
tokenId
Required
Token Id
$ customerId = 'customer_id ' ;
$ tokenId = 'token_id ' ;
$ result = $ customers ->getAccessToken ($ customerId , $ tokenId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createAccessToken
Creates a access token for a customer
function createAccessToken(
$ customerId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
customerId
Required
Customer Id
body
Required
Request for creating a access token
idempotencyKey
Optional
TODO: Add a parameter description
$ customerId = 'customer_id ' ;
$ body = new CreateAccessTokenRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ customers ->createAccessToken ($ customerId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getAccessTokens
Get all access tokens from a customer
function getAccessTokens(
$ customerId ,
$ page = null ,
$ size = null )
Parameter
Tags
Description
customerId
Required
Customer Id
page
Optional
Page number
size
Optional
Page size
$ customerId = 'customer_id ' ;
$ page = 252 ;
$ size = 252 ;
$ result = $ customers ->getAccessTokens ($ customerId , $ page , $ size );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createAddress
Creates a new address for a customer
function createAddress(
$ customerId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
customerId
Required
Customer Id
body
Required
Request for creating an address
idempotencyKey
Optional
TODO: Add a parameter description
$ customerId = 'customer_id ' ;
$ body = new CreateAddressRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ customers ->createAddress ($ customerId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getAddresses
Gets all adressess from a customer
function getAddresses(
$ customerId ,
$ page = null ,
$ size = null )
Parameter
Tags
Description
customerId
Required
Customer id
page
Optional
Page number
size
Optional
Page size
$ customerId = 'customer_id ' ;
$ page = 252 ;
$ size = 252 ;
$ result = $ customers ->getAddresses ($ customerId , $ page , $ size );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createCustomer
Creates a new customer
function createCustomer(
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
body
Required
Request for creating a customer
idempotencyKey
Optional
TODO: Add a parameter description
$ body = new CreateCustomerRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ customers ->createCustomer ($ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getCustomers
Get all Customers
function getCustomers(
$ name = null ,
$ document = null ,
$ page = 1 ,
$ size = 10 ,
$ email = null ,
$ code = null )
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
$ name = 'name ' ;
$ document = 'document ' ;
$ page = 1 ;
$ size = 10 ;
$ email = 'email ' ;
$ code = 'Code ' ;
$ result = $ customers ->getCustomers ($ name , $ document , $ page , $ size , $ email , $ code );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
deleteAccessTokens
Delete a Customer's access tokens
function deleteAccessTokens($ customerId )
Parameter
Tags
Description
customerId
Required
Customer Id
$ customerId = 'customer_id ' ;
$ result = $ customers ->deleteAccessTokens ($ customerId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createCard
Creates a new card for a customer
function createCard(
$ customerId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
customerId
Required
Customer id
body
Required
Request for creating a card
idempotencyKey
Optional
TODO: Add a parameter description
$ customerId = 'customer_id ' ;
$ body = new CreateCardRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ customers ->createCard ($ customerId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getCards
Get all cards from a customer
function getCards(
$ customerId ,
$ page = null ,
$ size = null )
Parameter
Tags
Description
customerId
Required
Customer Id
page
Optional
Page number
size
Optional
Page size
$ customerId = 'customer_id ' ;
$ page = 252 ;
$ size = 252 ;
$ result = $ customers ->getCards ($ customerId , $ page , $ size );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateCustomer
Updates a customer
function updateCustomer(
$ customerId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
customerId
Required
Customer id
body
Required
Request for updating a customer
idempotencyKey
Optional
TODO: Add a parameter description
$ customerId = 'customer_id ' ;
$ body = new UpdateCustomerRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ customers ->updateCustomer ($ customerId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getCustomer
Get a customer
function getCustomer($ customerId )
Parameter
Tags
Description
customerId
Required
Customer Id
$ customerId = 'customer_id ' ;
$ result = $ customers ->getCustomer ($ customerId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
renewCard
Renew a card
function renewCard(
$ customerId ,
$ cardId ,
$ idempotencyKey = null )
Parameter
Tags
Description
customerId
Required
Customer id
cardId
Required
Card Id
idempotencyKey
Optional
TODO: Add a parameter description
$ customerId = 'customer_id ' ;
$ cardId = 'card_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ customers ->renewCard ($ customerId , $ cardId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateCustomerMetadata
Updates the metadata a customer
function updateCustomerMetadata(
$ customerId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
customerId
Required
The customer id
body
Required
Request for updating the customer metadata
idempotencyKey
Optional
TODO: Add a parameter description
$ customerId = 'customer_id ' ;
$ body = new UpdateMetadataRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ customers ->updateCustomerMetadata ($ customerId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
Back to List of Controllers
ChargesController
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 ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
chargeId
Required
The charge id
body
Required
Request for updating the charge metadata
idempotencyKey
Optional
TODO: Add a parameter description
$ chargeId = 'charge_id ' ;
$ body = new UpdateMetadataRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ charges ->updateChargeMetadata ($ chargeId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
captureCharge
Captures a charge
function captureCharge(
$ chargeId ,
$ idempotencyKey = null ,
$ body = null )
Parameter
Tags
Description
chargeId
Required
Charge id
idempotencyKey
Optional
TODO: Add a parameter description
body
Optional
Request for capturing a charge
$ chargeId = 'charge_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ body = new CreateCaptureChargeRequest ();
$ result = $ charges ->captureCharge ($ chargeId , $ idempotencyKey , $ body );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateChargePaymentMethod
Updates a charge's payment method
function updateChargePaymentMethod(
$ chargeId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
chargeId
Required
Charge id
body
Required
Request for updating the payment method from a charge
idempotencyKey
Optional
TODO: Add a parameter description
$ chargeId = 'charge_id ' ;
$ body = new UpdateChargePaymentMethodRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ charges ->updateChargePaymentMethod ($ chargeId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getChargeTransactions
GetChargeTransactions
function getChargeTransactions(
$ chargeId ,
$ page = null ,
$ size = null )
Parameter
Tags
Description
chargeId
Required
Charge Id
page
Optional
Page number
size
Optional
Page size
$ chargeId = 'charge_id ' ;
$ page = 252 ;
$ size = 252 ;
$ result = $ charges ->getChargeTransactions ($ chargeId , $ page , $ size );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateChargeDueDate
Updates the due date from a charge
function updateChargeDueDate(
$ chargeId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
chargeId
Required
Charge Id
body
Required
Request for updating the due date
idempotencyKey
Optional
TODO: Add a parameter description
$ chargeId = 'charge_id ' ;
$ body = new UpdateChargeDueDateRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ charges ->updateChargeDueDate ($ chargeId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getCharges
Lists all charges
function getCharges(
$ page = null ,
$ size = null ,
$ code = null ,
$ status = null ,
$ paymentMethod = null ,
$ customerId = null ,
$ orderId = null ,
$ createdSince = null ,
$ createdUntil = null )
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
$ page = 252 ;
$ size = 252 ;
$ 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 );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateChargeCard
Updates the card from a charge
function updateChargeCard(
$ chargeId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
chargeId
Required
Charge id
body
Required
Request for updating a charge's card
idempotencyKey
Optional
TODO: Add a parameter description
$ chargeId = 'charge_id ' ;
$ body = new UpdateChargeCardRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ charges ->updateChargeCard ($ chargeId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getCharge
Get a charge from its id
function getCharge($ chargeId )
Parameter
Tags
Description
chargeId
Required
Charge id
$ chargeId = 'charge_id ' ;
$ result = $ charges ->getCharge ($ chargeId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
cancelCharge
Cancel a charge
function cancelCharge(
$ chargeId ,
$ idempotencyKey = null ,
$ body = null )
Parameter
Tags
Description
chargeId
Required
Charge id
idempotencyKey
Optional
TODO: Add a parameter description
body
Optional
Request for cancelling a charge
$ chargeId = 'charge_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ body = new CreateCancelChargeRequest ();
$ result = $ charges ->cancelCharge ($ chargeId , $ idempotencyKey , $ body );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getChargesSummary
GetChargesSummary
function getChargesSummary(
$ status ,
$ createdSince = null ,
$ createdUntil = null )
Parameter
Tags
Description
status
Required
TODO: Add a parameter description
createdSince
Optional
TODO: Add a parameter description
createdUntil
Optional
TODO: Add a parameter description
$ status = 'status ' ;
$ createdSince = date ("D M d, Y G:i " );
$ createdUntil = date ("D M d, Y G:i " );
$ result = $ charges ->getChargesSummary ($ status , $ createdSince , $ createdUntil );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
retryCharge
Retries a charge
function retryCharge(
$ chargeId ,
$ idempotencyKey = null )
Parameter
Tags
Description
chargeId
Required
Charge id
idempotencyKey
Optional
TODO: Add a parameter description
$ chargeId = 'charge_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ charges ->retryCharge ($ chargeId , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createCharge
Creates a new charge
function createCharge(
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
body
Required
Request for creating a charge
idempotencyKey
Optional
TODO: Add a parameter description
$ body = new CreateChargeRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ charges ->createCharge ($ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
confirmPayment
ConfirmPayment
function confirmPayment(
$ chargeId ,
$ idempotencyKey = null ,
$ body = null )
Parameter
Tags
Description
chargeId
Required
TODO: Add a parameter description
idempotencyKey
Optional
TODO: Add a parameter description
body
Optional
Request for confirm payment
$ chargeId = 'charge_id ' ;
$ idempotencyKey = 'idempotency-key ' ;
$ body = new CreateConfirmPaymentRequest ();
$ result = $ charges ->confirmPayment ($ chargeId , $ idempotencyKey , $ body );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
Back to List of Controllers
RecipientsController
The singleton instance of the RecipientsController
class can be accessed from the API Client.
$ recipients = $ client ->getRecipients ();
getTransfer
Gets a transfer
function getTransfer(
$ recipientId ,
$ transferId )
Parameter
Tags
Description
recipientId
Required
Recipient id
transferId
Required
Transfer id
$ recipientId = 'recipient_id ' ;
$ transferId = 'transfer_id ' ;
$ result = $ recipients ->getTransfer ($ recipientId , $ transferId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateRecipient
Updates a recipient
function updateRecipient(
$ recipientId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
recipientId
Required
Recipient id
body
Required
Recipient data
idempotencyKey
Optional
TODO: Add a parameter description
$ recipientId = 'recipient_id ' ;
$ body = new UpdateRecipientRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ recipients ->updateRecipient ($ recipientId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getRecipient
Retrieves recipient information
function getRecipient($ recipientId )
Parameter
Tags
Description
recipientId
Required
Recipiend id
$ recipientId = 'recipient_id ' ;
$ result = $ recipients ->getRecipient ($ recipientId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createAnticipation
Creates an anticipation
function createAnticipation(
$ recipientId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
recipientId
Required
Recipient id
body
Required
Anticipation data
idempotencyKey
Optional
TODO: Add a parameter description
$ recipientId = 'recipient_id ' ;
$ body = new CreateAnticipationRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ recipients ->createAnticipation ($ recipientId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
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 )
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
$ recipientId = 'recipient_id ' ;
$ page = 252 ;
$ size = 252 ;
$ 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 );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getAnticipationLimits
Gets the anticipation limits for a recipient
function getAnticipationLimits(
$ recipientId ,
$ timeframe ,
$ paymentDate )
Parameter
Tags
Description
recipientId
Required
Recipient id
timeframe
Required
Timeframe
paymentDate
Required
Anticipation payment date
$ recipientId = 'recipient_id ' ;
$ timeframe = 'timeframe ' ;
$ paymentDate = date ("D M d, Y G:i " );
$ result = $ recipients ->getAnticipationLimits ($ recipientId , $ timeframe , $ paymentDate );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getRecipients
Retrieves paginated recipients information
function getRecipients(
$ page = null ,
$ size = null )
Parameter
Tags
Description
page
Optional
Page number
size
Optional
Page size
$ page = 252 ;
$ size = 252 ;
$ result = $ recipients ->getRecipients ($ page , $ size );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createRecipient
Creates a new recipient
function createRecipient(
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
body
Required
Recipient data
idempotencyKey
Optional
TODO: Add a parameter description
$ body = new CreateRecipientRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ recipients ->createRecipient ($ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getWithdrawById
GetWithdrawById
function getWithdrawById(
$ recipientId ,
$ withdrawalId )
Parameter
Tags
Description
recipientId
Required
TODO: Add a parameter description
withdrawalId
Required
TODO: Add a parameter description
$ recipientId = 'recipient_id ' ;
$ withdrawalId = 'withdrawal_id ' ;
$ result = $ recipients ->getWithdrawById ($ recipientId , $ withdrawalId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateRecipientDefaultBankAccount
Updates the default bank account from a recipient
function updateRecipientDefaultBankAccount(
$ recipientId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
recipientId
Required
Recipient id
body
Required
Bank account data
idempotencyKey
Optional
TODO: Add a parameter description
$ recipientId = 'recipient_id ' ;
$ body = new UpdateRecipientBankAccountRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ recipients ->updateRecipientDefaultBankAccount ($ recipientId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateRecipientMetadata
Updates recipient metadata
function updateRecipientMetadata(
$ recipientId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
recipientId
Required
Recipient id
body
Required
Metadata
idempotencyKey
Optional
TODO: Add a parameter description
$ recipientId = 'recipient_id ' ;
$ body = new UpdateMetadataRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ recipients ->updateRecipientMetadata ($ recipientId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getTransfers
Gets a paginated list of transfers for the recipient
function getTransfers(
$ recipientId ,
$ page = null ,
$ size = null ,
$ status = null ,
$ createdSince = null ,
$ createdUntil = null )
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
$ recipientId = 'recipient_id ' ;
$ page = 210 ;
$ size = 210 ;
$ 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 );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createTransfer
Creates a transfer for a recipient
function createTransfer(
$ recipientId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
recipientId
Required
Recipient Id
body
Required
Transfer data
idempotencyKey
Optional
TODO: Add a parameter description
$ recipientId = 'recipient_id ' ;
$ body = new CreateTransferRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ recipients ->createTransfer ($ recipientId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
createWithdraw
CreateWithdraw
function createWithdraw(
$ recipientId ,
$ body )
Parameter
Tags
Description
recipientId
Required
TODO: Add a parameter description
body
Required
TODO: Add a parameter description
$ recipientId = 'recipient_id ' ;
$ body = new CreateWithdrawRequest ();
$ result = $ recipients ->createWithdraw ($ recipientId , $ body );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getWithdrawals
Gets a paginated list of transfers for the recipient
function getWithdrawals(
$ recipientId ,
$ page = null ,
$ size = null ,
$ status = null ,
$ createdSince = null ,
$ createdUntil = null )
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
$ recipientId = 'recipient_id ' ;
$ page = 210 ;
$ size = 210 ;
$ 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 );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateAutomaticAnticipationSettings
Updates recipient metadata
function updateAutomaticAnticipationSettings(
$ recipientId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
recipientId
Required
Recipient id
body
Required
Metadata
idempotencyKey
Optional
TODO: Add a parameter description
$ recipientId = 'recipient_id ' ;
$ body = new UpdateAutomaticAnticipationSettingsRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ recipients ->updateAutomaticAnticipationSettings ($ recipientId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getAnticipation
Gets an anticipation
function getAnticipation(
$ recipientId ,
$ anticipationId )
Parameter
Tags
Description
recipientId
Required
Recipient id
anticipationId
Required
Anticipation id
$ recipientId = 'recipient_id ' ;
$ anticipationId = 'anticipation_id ' ;
$ result = $ recipients ->getAnticipation ($ recipientId , $ anticipationId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
updateRecipientTransferSettings
UpdateRecipientTransferSettings
function updateRecipientTransferSettings(
$ recipientId ,
$ body ,
$ idempotencyKey = null )
Parameter
Tags
Description
recipientId
Required
Recipient Identificator
body
Required
TODO: Add a parameter description
idempotencyKey
Optional
TODO: Add a parameter description
$ recipientId = 'recipient_id ' ;
$ body = new UpdateTransferSettingsRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ result = $ recipients ->updateRecipientTransferSettings ($ recipientId , $ body , $ idempotencyKey );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getBalance
Get balance information for a recipient
function getBalance($ recipientId )
Parameter
Tags
Description
recipientId
Required
Recipient id
$ recipientId = 'recipient_id ' ;
$ result = $ recipients ->getBalance ($ recipientId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getRecipientByCode
Retrieves recipient information
function getRecipientByCode($ code )
Parameter
Tags
Description
code
Required
Recipient code
$ code = 'code ' ;
$ result = $ recipients ->getRecipientByCode ($ code );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getDefaultRecipient
GetDefaultRecipient
function getDefaultRecipient()
$ result = $ recipients ->getDefaultRecipient ();
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
Back to List of Controllers
TokensController
The singleton instance of the TokensController
class can be accessed from the API Client.
$ tokens = $ client ->getTokens ();
createToken
Tags: Skips Authentication
CreateToken
function createToken(
$ publicKey ,
$ body ,
$ idempotencyKey = null ,
$ appId = null )
Parameter
Tags
Description
publicKey
Required
Public key
body
Required
Request for creating a token
idempotencyKey
Optional
TODO: Add a parameter description
appId
Optional
TODO: Add a parameter description
$ publicKey = 'public_key ' ;
$ body = new CreateTokenRequest ();
$ idempotencyKey = 'idempotency-key ' ;
$ appId = 'appId ' ;
$ result = $ tokens ->createToken ($ publicKey , $ body , $ idempotencyKey , $ appId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getToken
Tags: Skips Authentication
Gets a token from its id
function getToken(
$ id ,
$ publicKey ,
$ appId = null )
Parameter
Tags
Description
id
Required
Token id
publicKey
Required
Public key
appId
Optional
TODO: Add a parameter description
$ id = 'id ' ;
$ publicKey = 'public_key ' ;
$ appId = 'appId ' ;
$ result = $ tokens ->getToken ($ id , $ publicKey , $ appId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
Back to List of Controllers
TransactionsController
The singleton instance of the TransactionsController
class can be accessed from the API Client.
$ transactions = $ client ->getTransactions ();
getTransaction
GetTransaction
function getTransaction($ transactionId )
Parameter
Tags
Description
transactionId
Required
TODO: Add a parameter description
$ transactionId = 'transaction_id ' ;
$ result = $ transactions ->getTransaction ($ transactionId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
Back to List of Controllers
TransfersController
The singleton instance of the TransfersController
class can be accessed from the API Client.
$ transfers = $ client ->getTransfers ();
getTransferById
GetTransferById
function getTransferById($ transferId )
Parameter
Tags
Description
transferId
Required
TODO: Add a parameter description
$ transferId = 'transfer_id ' ;
$ result = $ transfers ->getTransferById ($ transferId );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
postCreateTransfer
CreateTransfer
function postCreateTransfer($ body )
Parameter
Tags
Description
body
Required
TODO: Add a parameter description
$ body = new CreateTransfer ();
$ result = $ transfers ->postCreateTransfer ($ body );
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
getTransfers1
Gets all transfers
$ result = $ transfers ->getTransfers1 ();
Error Code
Error Description
400
Invalid request
401
Invalid API key
404
An informed resource was not found
412
Business validation error
422
Contract validation error
500
Internal server error
Back to List of Controllers