Getting started
Mundipagg API
How to Build
The generated code has dependencies over external libraries like UniRest. These dependencies are defined in the 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 . 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 ) for the SDK.
- Run the command . This should install all the required dependencies and create the 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.
How to Use
The following section explains how to use the MundiAPI 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 in PhpStorm to browse to your generated SDK directory and then click .
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.
It is important that the path inside require_once correctly points to the file 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 from menu.
Select from within
Browse for Interpreters near the option and choose your interpreter.
Once the interpreter is selected, click
To run your project, right click on your PHP file inside your Test project and click on
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 |
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.
Class Reference
List of Controllers
- SubscriptionsController
- OrdersController
- PlansController
- InvoicesController
- CustomersController
- ChargesController
- RecipientsController
- TokensController
- TransactionsController
- TransfersController
SubscriptionsController
Get singleton instance
The singleton instance of the class can be accessed from the API Client.
createDiscount
Creates a discount
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
Subscription id |
body |
|
Request for creating a discount |
idempotencyKey |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
Subscription Id |
itemId |
|
Item id |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
Subscription Id |
itemId |
|
Item id |
body |
|
Request for updating a subscription item |
idempotencyKey |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
The subscription id |
itemId |
|
The subscription item id |
usageId |
|
The usage id |
idempotencyKey |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
Subscription id |
idempotencyKey |
|
TODO: Add a parameter description |
body |
|
Request for cancelling a subscription |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
Subscription id |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
Subscription id |
incrementId |
|
Increment id |
idempotencyKey |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
The subscription Id |
incrementId |
|
The increment Id |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
The subscription id |
cycleId |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
The subscription id |
body |
|
Request for updating the subscription start date |
idempotencyKey |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
Subscription id |
body |
|
Request for updating the paymentmethod from a subscription |
idempotencyKey |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
Subscription Id |
body |
|
Request for updating the end date of the subscription current status |
idempotencyKey |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
body |
|
Request for creating a subscription |
idempotencyKey |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
page |
|
Page number |
size |
|
Page size |
code |
|
Filter for subscription's code |
billingType |
|
Filter for subscription's billing type |
customerId |
|
Filter for subscription's customer id |
planId |
|
Filter for subscription's plan id |
cardId |
|
Filter for subscription's card id |
status |
|
Filter for subscription's status |
nextBillingSince |
|
Filter for subscription's next billing date start range |
nextBillingUntil |
|
Filter for subscription's next billing date end range |
createdSince |
|
Filter for subscription's creation date start range |
createdUntil |
|
Filter for subscriptions creation date end range |
Example Usage
Errors
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 |
getUsagesDetails
GetUsagesDetails
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
Subscription Identifier |
cycleId |
|
Cycle id |
size |
|
Page size |
page |
|
Page number |
itemId |
|
Identificador do item |
group |
|
identificador da loja (account) de cada item |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
TODO: Add a parameter description |
idempotencyKey |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
Subscription Id |
page |
|
Page number |
size |
|
Page size |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
Subscription id |
itemId |
|
Item id |
idempotencyKey |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
The subscription id |
itemId |
|
The subscription item id |
page |
|
Page number |
size |
|
Page size |
code |
|
Identification code in the client system |
group |
|
Identification group in the client system |
usedSince |
|
TODO: Add a parameter description |
usedUntil |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
Subscription id |
discountId |
|
Discount Id |
idempotencyKey |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
The subscription id |
page |
|
Page number |
size |
|
Page size |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
Subscription id |
body |
|
Request for creating a subscription item |
idempotencyKey |
|
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
|
The subscription id |
page |
|
Page number |
size |
|
Page size |
name |
|
The item name |
code |
|
Identification code in the client system |
status |
|
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
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
Required |
The subscription id |
body |
Required |
Request for updating the subscription billing date |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
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 |
Example Usage
Errors
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
Parameters
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 |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
Required |
Subscription id |
subscriptionItemId |
Required |
Subscription item id |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
Errors
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 |
updateSubscriptionCard
Updates the credit card from a subscription
Parameters
Parameter |
Tags |
Description |
subscriptionId |
Required |
Subscription id |
body |
Required |
Request for updating a card |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
Required |
The subscription id |
body |
Required |
Request for updating the subscrption metadata |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
Required |
Subscription Id |
body |
Required |
TODO: Add a parameter description |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
Required |
The subscription id |
page |
Required |
Page number |
size |
Required |
Page size |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
Required |
Subscription id |
body |
Required |
Request for creating a increment |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
Required |
The subscription id |
discountId |
Required |
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
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 |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
subscriptionId |
Required |
The subscription Id |
periodId |
Required |
The period Id |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
id |
Required |
Subscription's id |
body |
Required |
TODO: Add a parameter description |
Example Usage
Errors
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
Get singleton instance
The singleton instance of the OrdersController
class can be accessed from the API Client.
updateOrderStatus
UpdateOrderStatus
Parameters
Parameter |
Tags |
Description |
id |
Required |
Order Id |
body |
Required |
Update Order Model |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
orderId |
Required |
Order Id |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
orderId |
Required |
Order Id |
body |
Required |
Order Item Model |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
orderId |
Required |
The order id |
body |
Required |
Request for updating the order metadata |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
Errors
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 |
getOrders
Gets all orders
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
Errors
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
Parameters
Parameter |
Tags |
Description |
body |
Required |
Request for creating an order |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
orderId |
Required |
Order Id |
itemId |
Required |
Item Id |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
orderId |
Required |
Order Id |
itemId |
Required |
Item Id |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
orderId |
Required |
Order Id |
itemId |
Required |
Item Id |
body |
Required |
Item Model |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
Errors
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
Parameters
Parameter |
Tags |
Description |
orderId |
Required |
Order id |
Example Usage
Errors
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
Get singleton instance
The singleton instance of the PlansController
class can be accessed from the API Client.
updatePlanItem
Updates a plan item
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
Errors
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)
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);
Errors
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)
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);
Errors
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)
Parameters
Parameter |
Tags |
Description |
planId |
Required |
Plan id |
body |
Required |
Request for creating a plan item |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$planId = 'plan_id';
$body = new PlansItemsRequest1();
$idempotencyKey = 'idempotency-key';
$result = $plans->createPlanItem($planId, $body, $idempotencyKey);
Errors
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)
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 = 175;
$size = 175;
$name = 'name';
$status = 'status';
$billingType = 'billing_type';
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");
$result = $plans->getPlans($page, $size, $name, $status, $billingType, $createdSince, $createdUntil);
Errors
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)
Parameters
Parameter |
Tags |
Description |
body |
Required |
Request for creating a plan |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$body = new PlansRequest();
$idempotencyKey = 'idempotency-key';
$result = $plans->createPlan($body, $idempotencyKey);
Errors
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 |
getPlan
Gets a plan
function getPlan($planId)
Parameters
Parameter |
Tags |
Description |
planId |
Required |
Plan id |
Example Usage
$planId = 'plan_id';
$result = $plans->getPlan($planId);
Errors
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)
Parameters
Parameter |
Tags |
Description |
planId |
Required |
Plan id |
body |
Required |
Request for updating a plan |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$planId = 'plan_id';
$body = new PlansRequest1();
$idempotencyKey = 'idempotency-key';
$result = $plans->updatePlan($planId, $body, $idempotencyKey);
Errors
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)
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);
Errors
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)
Parameters
Parameter |
Tags |
Description |
planId |
Required |
The plan id |
body |
Required |
Request for updating the plan metadata |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$planId = 'plan_id';
$body = new PlansMetadataRequest();
$idempotencyKey = 'idempotency-key';
$result = $plans->updatePlanMetadata($planId, $body, $idempotencyKey);
Errors
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
Get singleton instance
The singleton instance of the InvoicesController
class can be accessed from the API Client.
$invoices = $client->getInvoices();
createInvoice
Create an Invoice
function createInvoice(
$subscriptionId,
$cycleId,
$idempotencyKey = null,
$body = null)
Parameters
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 |
Example Usage
$subscriptionId = 'subscription_id';
$cycleId = 'cycle_id';
$idempotencyKey = 'idempotency-key';
$body = new SubscriptionsCyclesPayRequest();
$result = $invoices->createInvoice($subscriptionId, $cycleId, $idempotencyKey, $body);
Errors
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 |
getPartialInvoice
GetPartialInvoice
function getPartialInvoice($subscriptionId)
Parameters
Parameter |
Tags |
Description |
subscriptionId |
Required |
Subscription Id |
Example Usage
$subscriptionId = 'subscription_id';
$result = $invoices->getPartialInvoice($subscriptionId);
Errors
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)
Parameters
Parameter |
Tags |
Description |
invoiceId |
Required |
Invoice Id |
body |
Required |
Request for updating an invoice's status |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$invoiceId = 'invoice_id';
$body = new UpdateCurrentCycleStatusRequest();
$idempotencyKey = 'idempotency-key';
$result = $invoices->updateInvoiceStatus($invoiceId, $body, $idempotencyKey);
Errors
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)
Parameters
Parameter |
Tags |
Description |
invoiceId |
Required |
Invoice Id |
Example Usage
$invoiceId = 'invoice_id';
$result = $invoices->getInvoice($invoiceId);
Errors
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)
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);
Errors
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)
Parameters
Parameter |
Tags |
Description |
invoiceId |
Required |
The invoice id |
body |
Required |
Request for updating the invoice metadata |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$invoiceId = 'invoice_id';
$body = new InvoicesMetadataRequest();
$idempotencyKey = 'idempotency-key';
$result = $invoices->updateInvoiceMetadata($invoiceId, $body, $idempotencyKey);
Errors
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)
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 |
Fillter for invoice's document |
Example Usage
$page = 11;
$size = 11;
$code = 'code';
$customerId = 'customer_id';
$subscriptionId = 'subscription_id';
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");
$status = 'status';
$dueSince = date("D M d, Y G:i");
$dueUntil = date("D M d, Y G:i");
$customerDocument = 'customer_document';
$result = $invoices->getInvoices($page, $size, $code, $customerId, $subscriptionId, $createdSince, $createdUntil, $status, $dueSince, $dueUntil, $customerDocument);
Errors
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
Get singleton instance
The singleton instance of the CustomersController
class can be accessed from the API Client.
$customers = $client->getCustomers();
createAccessToken
Creates a access token for a customer
function createAccessToken(
$customerId,
$body,
$idempotencyKey = null)
Parameters
Parameter |
Tags |
Description |
customerId |
Required |
Customer Id |
body |
Required |
Request for creating a access token |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$customerId = 'customer_id';
$body = new CustomersAccessTokensRequest();
$idempotencyKey = 'idempotency-key';
$result = $customers->createAccessToken($customerId, $body, $idempotencyKey);
Errors
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)
Parameters
Parameter |
Tags |
Description |
customerId |
Required |
Customer Id |
page |
Optional |
Page number |
size |
Optional |
Page size |
Example Usage
$customerId = 'customer_id';
$page = 11;
$size = 11;
$result = $customers->getAccessTokens($customerId, $page, $size);
Errors
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)
Parameters
Parameter |
Tags |
Description |
customerId |
Required |
Customer id |
body |
Required |
Request for updating a customer |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$customerId = 'customer_id';
$body = new CustomersRequest();
$idempotencyKey = 'idempotency-key';
$result = $customers->updateCustomer($customerId, $body, $idempotencyKey);
Errors
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)
Parameters
Parameter |
Tags |
Description |
customerId |
Required |
Customer Id |
Example Usage
$customerId = 'customer_id';
$result = $customers->getCustomer($customerId);
Errors
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)
Parameters
Parameter |
Tags |
Description |
customerId |
Required |
Customer Id |
Example Usage
$customerId = 'customer_id';
$result = $customers->deleteAccessTokens($customerId);
Errors
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)
Parameters
Parameter |
Tags |
Description |
customerId |
Required |
Customer id |
page |
Optional |
Page number |
size |
Optional |
Page size |
Example Usage
$customerId = 'customer_id';
$page = 11;
$size = 11;
$result = $customers->getAddresses($customerId, $page, $size);
Errors
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)
Parameters
Parameter |
Tags |
Description |
customerId |
Required |
Customer Id |
body |
Required |
Request for creating an address |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$customerId = 'customer_id';
$body = new CustomersAddressesRequest();
$idempotencyKey = 'idempotency-key';
$result = $customers->createAddress($customerId, $body, $idempotencyKey);
Errors
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)
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);
Errors
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)
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);
Errors
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)
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);
Errors
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)
Parameters
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 |
Example Usage
$customerId = 'customer_id';
$addressId = 'address_id';
$body = new CustomersAddressesRequest1();
$idempotencyKey = 'idempotency-key';
$result = $customers->updateAddress($customerId, $addressId, $body, $idempotencyKey);
Errors
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)
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);
Errors
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)
Parameters
Parameter |
Tags |
Description |
customerId |
Required |
Customer id |
body |
Required |
Request for creating a card |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$customerId = 'customer_id';
$body = new CustomersCardsRequest();
$idempotencyKey = 'idempotency-key';
$result = $customers->createCard($customerId, $body, $idempotencyKey);
Errors
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)
Parameters
Parameter |
Tags |
Description |
customerId |
Required |
Customer Id |
page |
Optional |
Page number |
size |
Optional |
Page size |
Example Usage
$customerId = 'customer_id';
$page = 225;
$size = 225;
$result = $customers->getCards($customerId, $page, $size);
Errors
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)
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);
Errors
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)
Parameters
Parameter |
Tags |
Description |
body |
Required |
Request for creating a customer |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$body = new CustomersRequest1();
$idempotencyKey = 'idempotency-key';
$result = $customers->createCustomer($body, $idempotencyKey);
Errors
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)
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);
Errors
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)
Parameters
Parameter |
Tags |
Description |
customerId |
Required |
The customer id |
body |
Required |
Request for updating the customer metadata |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$customerId = 'customer_id';
$body = new CustomersMetadataRequest();
$idempotencyKey = 'idempotency-key';
$result = $customers->updateCustomerMetadata($customerId, $body, $idempotencyKey);
Errors
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 |
updateCard
Updates a card
function updateCard(
$customerId,
$cardId,
$body,
$idempotencyKey = null)
Parameters
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 |
Example Usage
$customerId = 'customer_id';
$cardId = 'card_id';
$body = new CustomersCardsRequest1();
$idempotencyKey = 'idempotency-key';
$result = $customers->updateCard($customerId, $cardId, $body, $idempotencyKey);
Errors
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)
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);
Errors
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)
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);
Errors
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
Get singleton instance
The singleton instance of the ChargesController
class can be accessed from the API Client.
$charges = $client->getCharges();
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);
Errors
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)
Parameters
Parameter |
Tags |
Description |
chargeId |
Required |
Charge id |
idempotencyKey |
Optional |
TODO: Add a parameter description |
body |
Optional |
Request for cancelling a charge |
Example Usage
$chargeId = 'charge_id';
$idempotencyKey = 'idempotency-key';
$body = new ChargesRequest();
$result = $charges->cancelCharge($chargeId, $idempotencyKey, $body);
Errors
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)
Parameters
Parameter |
Tags |
Description |
chargeId |
Required |
TODO: Add a parameter description |
idempotencyKey |
Optional |
TODO: Add a parameter description |
body |
Optional |
Request for confirm payment |
Example Usage
$chargeId = 'charge_id';
$idempotencyKey = 'idempotency-key';
$body = new CreateConfirmPaymentRequest();
$result = $charges->confirmPayment($chargeId, $idempotencyKey, $body);
Errors
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)
Parameters
Parameter |
Tags |
Description |
chargeId |
Required |
Charge id |
body |
Required |
Request for updating a charge's card |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$chargeId = 'charge_id';
$body = new ChargesCardRequest();
$idempotencyKey = 'idempotency-key';
$result = $charges->updateChargeCard($chargeId, $body, $idempotencyKey);
Errors
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)
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 = 61;
$size = 61;
$code = 'code';
$status = 'status';
$paymentMethod = 'payment_method';
$customerId = 'customer_id';
$orderId = 'order_id';
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");
$result = $charges->getCharges($page, $size, $code, $status, $paymentMethod, $customerId, $orderId, $createdSince, $createdUntil);
Errors
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)
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);
Errors
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)
Parameters
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 |
Example Usage
$chargeId = 'charge_id';
$body = new ChargesPaymentMethodRequest();
$idempotencyKey = 'idempotency-key';
$result = $charges->updateChargePaymentMethod($chargeId, $body, $idempotencyKey);
Errors
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 |
updateChargeMetadata
Updates the metadata from a charge
function updateChargeMetadata(
$chargeId,
$body,
$idempotencyKey = null)
Parameters
Parameter |
Tags |
Description |
chargeId |
Required |
The charge id |
body |
Required |
Request for updating the charge metadata |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$chargeId = 'charge_id';
$body = new ChargesMetadataRequest();
$idempotencyKey = 'idempotency-key';
$result = $charges->updateChargeMetadata($chargeId, $body, $idempotencyKey);
Errors
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)
Parameters
Parameter |
Tags |
Description |
chargeId |
Required |
Charge id |
idempotencyKey |
Optional |
TODO: Add a parameter description |
body |
Optional |
Request for capturing a charge |
Example Usage
$chargeId = 'charge_id';
$idempotencyKey = 'idempotency-key';
$body = new ChargesCaptureRequest();
$result = $charges->captureCharge($chargeId, $idempotencyKey, $body);
Errors
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)
Parameters
Parameter |
Tags |
Description |
chargeId |
Required |
Charge Id |
body |
Required |
Request for updating the due date |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$chargeId = 'charge_id';
$body = new ChargesDueDateRequest();
$idempotencyKey = 'idempotency-key';
$result = $charges->updateChargeDueDate($chargeId, $body, $idempotencyKey);
Errors
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)
Parameters
Parameter |
Tags |
Description |
body |
Required |
Request for creating a charge |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$body = new ChargesRequest1();
$idempotencyKey = 'idempotency-key';
$result = $charges->createCharge($body, $idempotencyKey);
Errors
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)
Parameters
Parameter |
Tags |
Description |
chargeId |
Required |
Charge Id |
page |
Optional |
Page number |
size |
Optional |
Page size |
Example Usage
$chargeId = 'charge_id';
$page = 61;
$size = 61;
$result = $charges->getChargeTransactions($chargeId, $page, $size);
Errors
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)
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);
Errors
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
Get singleton instance
The singleton instance of the RecipientsController
class can be accessed from the API Client.
$recipients = $client->getRecipients();
updateRecipientMetadata
Updates recipient metadata
function updateRecipientMetadata(
$recipientId,
$body,
$idempotencyKey = null)
Parameters
Parameter |
Tags |
Description |
recipientId |
Required |
Recipient id |
body |
Required |
Metadata |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$recipientId = 'recipient_id';
$body = new RecipientsMetadataRequest();
$idempotencyKey = 'idempotency-key';
$result = $recipients->updateRecipientMetadata($recipientId, $body, $idempotencyKey);
Errors
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)
Parameters
Parameter |
Tags |
Description |
recipientId |
Required |
Recipient Identificator |
body |
Required |
TODO: Add a parameter description |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$recipientId = 'recipient_id';
$body = new UpdateTransferSettingsRequest();
$idempotencyKey = 'idempotency-key';
$result = $recipients->updateRecipientTransferSettings($recipientId, $body, $idempotencyKey);
Errors
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)
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);
Errors
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)
Parameters
Parameter |
Tags |
Description |
page |
Optional |
Page number |
size |
Optional |
Page size |
Example Usage
$page = 61;
$size = 61;
$result = $recipients->getRecipients($page, $size);
Errors
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)
Parameters
Parameter |
Tags |
Description |
body |
Required |
Recipient data |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$body = new RecipientsRequest();
$idempotencyKey = 'idempotency-key';
$result = $recipients->createRecipient($body, $idempotencyKey);
Errors
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)
Parameters
Parameter |
Tags |
Description |
recipientId |
Required |
Recipient id |
Example Usage
$recipientId = 'recipient_id';
$result = $recipients->getBalance($recipientId);
Errors
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)
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 = 153;
$size = 153;
$status = 'status';
$timeframe = 'timeframe';
$paymentDateSince = date("D M d, Y G:i");
$paymentDateUntil = date("D M d, Y G:i");
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");
$result = $recipients->getAnticipations($recipientId, $page, $size, $status, $timeframe, $paymentDateSince, $paymentDateUntil, $createdSince, $createdUntil);
Errors
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)
Parameters
Parameter |
Tags |
Description |
recipientId |
Required |
Recipient id |
body |
Required |
Anticipation data |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$recipientId = 'recipient_id';
$body = new RecipientsAnticipationsRequest();
$idempotencyKey = 'idempotency-key';
$result = $recipients->createAnticipation($recipientId, $body, $idempotencyKey);
Errors
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)
Parameters
Parameter |
Tags |
Description |
recipientId |
Required |
Recipient id |
body |
Required |
Bank account data |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$recipientId = 'recipient_id';
$body = new RecipientsDefaultBankAccountRequest();
$idempotencyKey = 'idempotency-key';
$result = $recipients->updateRecipientDefaultBankAccount($recipientId, $body, $idempotencyKey);
Errors
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)
Parameters
Parameter |
Tags |
Description |
recipientId |
Required |
Recipiend id |
Example Usage
$recipientId = 'recipient_id';
$result = $recipients->getRecipient($recipientId);
Errors
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)
Parameters
Parameter |
Tags |
Description |
recipientId |
Required |
Recipient id |
body |
Required |
Recipient data |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$recipientId = 'recipient_id';
$body = new RecipientsRequest1();
$idempotencyKey = 'idempotency-key';
$result = $recipients->updateRecipient($recipientId, $body, $idempotencyKey);
Errors
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 |
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);
Errors
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)
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 = 153;
$size = 153;
$status = 'status';
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");
$result = $recipients->getTransfers($recipientId, $page, $size, $status, $createdSince, $createdUntil);
Errors
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)
Parameters
Parameter |
Tags |
Description |
recipientId |
Required |
Recipient Id |
body |
Required |
Transfer data |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$recipientId = 'recipient_id';
$body = new RecipientsTransfersRequest();
$idempotencyKey = 'idempotency-key';
$result = $recipients->createTransfer($recipientId, $body, $idempotencyKey);
Errors
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)
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);
Errors
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)
Parameters
Parameter |
Tags |
Description |
recipientId |
Required |
TODO: Add a parameter description |
body |
Required |
TODO: Add a parameter description |
Example Usage
$recipientId = 'recipient_id';
$body = new CreateWithdrawRequest();
$result = $recipients->createWithdraw($recipientId, $body);
Errors
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)
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 = 153;
$size = 153;
$status = 'status';
$createdSince = date("D M d, Y G:i");
$createdUntil = date("D M d, Y G:i");
$result = $recipients->getWithdrawals($recipientId, $page, $size, $status, $createdSince, $createdUntil);
Errors
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)
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);
Errors
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)
Parameters
Parameter |
Tags |
Description |
recipientId |
Required |
Recipient id |
body |
Required |
Metadata |
idempotencyKey |
Optional |
TODO: Add a parameter description |
Example Usage
$recipientId = 'recipient_id';
$body = new UpdateAutomaticAnticipationSettingsRequest();
$idempotencyKey = 'idempotency-key';
$result = $recipients->updateAutomaticAnticipationSettings($recipientId, $body, $idempotencyKey);
Errors
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)
Parameters
Parameter |
Tags |
Description |
code |
Required |
Recipient code |
Example Usage
$code = 'code';
$result = $recipients->getRecipientByCode($code);
Errors
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
Get singleton instance
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)
Parameters
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 |
Example Usage
$publicKey = 'public_key';
$body = new TokensRequest();
$idempotencyKey = 'idempotency-key';
$appId = 'appId';
$result = $tokens->createToken($publicKey, $body, $idempotencyKey, $appId);
Errors
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)
Parameters
Parameter |
Tags |
Description |
id |
Required |
Token id |
publicKey |
Required |
Public key |
appId |
Optional |
TODO: Add a parameter description |
Example Usage
$id = 'id';
$publicKey = 'public_key';
$appId = 'appId';
$result = $tokens->getToken($id, $publicKey, $appId);
Errors
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
Get singleton instance
The singleton instance of the TransactionsController
class can be accessed from the API Client.
$transactions = $client->getTransactions();
getTransaction
GetTransaction
function getTransaction($transactionId)
Parameters
Parameter |
Tags |
Description |
transactionId |
Required |
TODO: Add a parameter description |
Example Usage
$transactionId = 'transaction_id';
$result = $transactions->getTransaction($transactionId);
Errors
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
Get singleton instance
The singleton instance of the TransfersController
class can be accessed from the API Client.
$transfers = $client->getTransfers();
postCreateTransfer
CreateTransfer
function postCreateTransfer($body)
Parameters
Parameter |
Tags |
Description |
body |
Required |
TODO: Add a parameter description |
Example Usage
$body = new CreateTransfer();
$result = $transfers->postCreateTransfer($body);
Errors
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 |
getTransferById
GetTransferById
function getTransferById($transferId)
Parameters
Parameter |
Tags |
Description |
transferId |
Required |
TODO: Add a parameter description |
Example Usage
$transferId = 'transfer_id';
$result = $transfers->getTransferById($transferId);
Errors
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
function getTransfers1()
Example Usage
$result = $transfers->getTransfers1();
Errors
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