los/mundiapi

Mundipagg API

Getting started

Mundipagg API, _(*1)

How to Build

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

• 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.

, _(*3)

[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:, _(*4)

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

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

How to Use

The following section explains how to use the MundiAPI library in a new project., _(*5)

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., _(*6)

, _(*7)

Click on Open in PhpStorm to browse to your generated SDK directory and then click OK., _(*8)

, _(*9)

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:, _(*10)

, _(*11)

Name the directory as "test", _(*12)

, _(*13)

Add a PHP file to this project, _(*14)

, _(*15)

Name it "testSDK", _(*16)

, _(*17)

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

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., _(*19)

, _(*20)

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., _(*21)

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., _(*22)

Open Settings from File menu., _(*23)

, _(*24)

Select PHP from within Languages & Frameworks, _(*25)

, _(*26)

Browse for Interpreters near the Interpreter option and choose your interpreter., _(*27)

, _(*28)

Once the interpreter is selected, click OK, _(*29)

, _(*30)

To run your project, right click on your PHP file inside your Test project and click on Run, _(*31)

, _(*32)

How to Test

Unit tests in this SDK can be run using PHPUnit., _(*33)

1. First install the dependencies using composer including the require-dev dependencies.
2. 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., _(*34)

Initialization

Authentication

In order to setup authentication and initialization of the API client, you need the following information., _(*35)

API client can be initialized as following., _(*36)

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

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

Class Reference

List of Controllers

• ChargesController
• CustomersController
• SubscriptionsController
• PlansController
• InvoicesController
• OrdersController

ChargesController

Get singleton instance

The singleton instance of the ChargesController class can be accessed from the API Client., _(*37)

$charges = $client->getCharges();

getCharge

Get a charge from its id, _(*38)

function getCharge($chargeId)

Parameters

Example Usage

$chargeId = 'ch_wbnd47nCJJFKVZQy';

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

retryCharge

Retries a charge, _(*39)

function retryCharge($chargeId)

Parameters

Example Usage

$chargeId = 'charge_id';

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

getCharges

Lists all charges, _(*40)

function getCharges()

Example Usage

$result = $charges->getCharges();

createCharge

Creates a new charge, _(*41)

function createCharge($request)

Parameters

Example Usage

$request = new CreateChargeRequest();

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

updateChargeCard

Updates the card from a charge, _(*42)

function updateChargeCard(
        $chargeId,
        $request)

Parameters

Example Usage

$chargeId = 'charge_id';
$request = new UpdateChargeCardRequest();

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

updateChargePaymentMethod

Updates a charge's payment method, _(*43)

function updateChargePaymentMethod(
        $chargeId,
        $request)

Parameters

Example Usage

$chargeId = 'charge_id';
$request = new UpdateChargePaymentMethodRequest();

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

cancelCharge

Cancel a charge, _(*44)

function cancelCharge(
        $chargeId,
        $request = null)

Parameters

Example Usage

$chargeId = 'charge_id';
$request = new CreateCancelChargeRequest();

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

captureCharge

Captures a charge, _(*45)

function captureCharge(
        $chargeId,
        $request = null)

Parameters

Example Usage

$chargeId = 'charge_id';
$request = new CreateCaptureChargeRequest();

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

Back to List of Controllers, _(*46)

CustomersController

Get singleton instance

The singleton instance of the CustomersController class can be accessed from the API Client., _(*47)

$customers = $client->getCustomers();

getAddresses

Gets all adressess from a customer, _(*48)

function getAddresses($customerId)

Parameters

Example Usage

$customerId = 'customer_id';

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

getCards

Get all cards from a customer, _(*49)

function getCards($customerId)

Parameters

Example Usage

$customerId = 'customer_id';

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

getCustomers

Get all Customers, _(*50)

function getCustomers()

Example Usage

$result = $customers->getCustomers();

createCustomer

Creates a new customer, _(*51)

function createCustomer($request)

Parameters

Example Usage

$request = new CreateCustomerRequest();

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

getCustomer

Get a customer, _(*52)

function getCustomer($customerId)

Parameters

Example Usage

$customerId = 'customer_id';

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

updateAddress

Updates an address, _(*53)

function updateAddress(
        $customerId,
        $addressId,
        $request)

Parameters

Example Usage

$customerId = 'customer_id';
$addressId = 'address_id';
$request = new UpdateAddressRequest();

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

updateCard

Updates a card, _(*54)

function updateCard(
        $customerId,
        $cardId,
        $request)

Parameters

Example Usage

$customerId = 'customer_id';
$cardId = 'card_id';
$request = new UpdateCardRequest();

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

getAddress

Get a customer's address, _(*55)

function getAddress(
        $customerId,
        $addressId)

Parameters

Example Usage

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

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

deleteAddress

Delete a Customer's address, _(*56)

function deleteAddress(
        $customerId,
        $addressId)

Parameters

Example Usage

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

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

deleteCard

Delete a customer's card, _(*57)

function deleteCard(
        $customerId,
        $cardId)

Parameters

Example Usage

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

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

createAddress

Creates a new address for a customer, _(*58)

function createAddress(
        $customerId,
        $request)

Parameters

Example Usage

$customerId = 'customer_id';
$request = new CreateAddressRequest();

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

getCard

Get a customer's card, _(*59)

function getCard(
        $customerId,
        $cardId)

Parameters

Example Usage

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

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

createCard

Creates a new card for a customer, _(*60)

function createCard(
        $customerId,
        $request)

Parameters

Example Usage

$customerId = 'customer_id';
$request = new CreateCardRequest();

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

updateCustomer

Updates a customer, _(*61)

function updateCustomer(
        $customerId,
        $request)

Parameters

Example Usage

$customerId = 'customer_id';
$request = new UpdateCustomerRequest();

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

deleteAccessTokens

Delete a Customer's access tokens, _(*62)

function deleteAccessTokens($customerId)

Parameters

Example Usage

$customerId = 'customer_id';

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

getAccessTokens

Get all access tokens from a customer, _(*63)

function getAccessTokens($customerId)

Parameters

Example Usage

$customerId = 'customer_id';

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

deleteAccessToken

Delete a customer's access token, _(*64)

function deleteAccessToken(
        $customerId,
        $tokenId)

Parameters

Example Usage

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

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

createAccessToken

Creates a access token for a customer, _(*65)

function createAccessToken(
        $customerId,
        $request)

Parameters

Example Usage

$customerId = 'customer_id';
$request = new CreateAccessTokenRequest();

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

getAccessToken

Get a Customer's access token, _(*66)

function getAccessToken(
        $customerId,
        $tokenId)

Parameters

Example Usage

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

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

Back to List of Controllers, _(*67)

SubscriptionsController

Get singleton instance

The singleton instance of the SubscriptionsController class can be accessed from the API Client., _(*68)

$subscriptions = $client->getSubscriptions();

updateSubscriptionBillingDate

Updates the billing date from a subscription, _(*69)

function updateSubscriptionBillingDate(
        $subscriptionId,
        $request)

Parameters

Example Usage

$subscriptionId = 'subscription_id';
$request = new UpdateSubscriptionBillingDateRequest();

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

createUsage

Creates a usage, _(*70)

function createUsage(
        $subscriptionId,
        $itemId,
        $body)

Parameters

Example Usage

$subscriptionId = 'subscription_id';
$itemId = 'item_id';
$body = new CreateUsageRequest();

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

updateSubscriptionItem

Updates a subscription item, _(*71)

function updateSubscriptionItem(
        $subscriptionId,
        $itemId,
        $body)

Parameters

Example Usage

$subscriptionId = 'subscription_id';
$itemId = 'item_id';
$body = new UpdateSubscriptionItemRequest();

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

getSubscriptions

Gets all subscriptions, _(*72)

function getSubscriptions()

Example Usage

$result = $subscriptions->getSubscriptions();

updateSubscriptionCard

Updates the credit card from a subscription, _(*73)

function updateSubscriptionCard(
        $subscriptionId,
        $request)

Parameters

Example Usage

$subscriptionId = 'subscription_id';
$request = new UpdateSubscriptionCardRequest();

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

createSubscription

Creates a new subscription, _(*74)

function createSubscription($body)

Parameters

Example Usage

$body = new CreateSubscriptionRequest();

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

createSubscriptionItem

Creates a new Subscription item, _(*75)

function createSubscriptionItem(
        $subscriptionId,
        $request)

Parameters

Example Usage

$subscriptionId = 'subscription_id';
$request = new CreateSubscriptionItemRequest();

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

createDiscount

Creates a discount, _(*76)

function createDiscount(
        $subscriptionId,
        $request)

Parameters

Example Usage

$subscriptionId = 'subscription_id';
$request = new CreateDiscountRequest();

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

getSubscription

Gets a subscription, _(*77)

function getSubscription($subscriptionId)

Parameters

Example Usage

$subscriptionId = 'subscription_id';

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

updateSubscriptionPaymentMethod

Updates the payment method from a subscription, _(*78)

function updateSubscriptionPaymentMethod(
        $subscriptionId,
        $request)

Parameters

Example Usage

$subscriptionId = 'subscription_id';
$request = new UpdateSubscriptionPaymentMethodRequest();

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

getUsages

Lists all usages from a subscription item, _(*79)

function getUsages(
        $subscriptionId,
        $itemId)

Parameters

Example Usage

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

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

deleteUsage

Deletes a usage, _(*80)

function deleteUsage(
        $subscriptionId,
        $itemId,
        $usageId)

Parameters

Example Usage

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

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

deleteDiscount

Deletes a discount, _(*81)

function deleteDiscount(
        $subscriptionId,
        $discountId)

Parameters

Example Usage

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

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

cancelSubscription

Cancels a subscription, _(*82)

function cancelSubscription(
        $subscriptionId,
        $request = null)

Parameters

Example Usage

$subscriptionId = 'subscription_id';
$request = new CreateCancelSubscriptionRequest();

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

deleteSubscriptionItem

Deletes a subscription item, _(*83)

function deleteSubscriptionItem(
        $subscriptionId,
        $subscriptionItemId)

Parameters

Example Usage

$subscriptionId = 'subscription_id';
$subscriptionItemId = 'subscription_item_id';

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

Back to List of Controllers, _(*84)

PlansController

Get singleton instance

The singleton instance of the PlansController class can be accessed from the API Client., _(*85)

$plans = $client->getPlans();

getPlanItems

Gets all items from a plan, _(*86)

function getPlanItems($planId)

Parameters

Example Usage

$planId = 'plan_id';

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

updatePlanItem

Updates a plan item, _(*87)

function updatePlanItem(
        $planId,
        $planItemId,
        $body)

Parameters

Example Usage

$planId = 'plan_id';
$planItemId = 'plan_item_id';
$body = new UpdatePlanItemRequest();

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

getPlan

Gets a plan, _(*88)

function getPlan($planId)

Parameters

Example Usage

$planId = 'plan_id';

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

createPlanItem

Adds a new item to a plan, _(*89)

function createPlanItem(
        $planId,
        $request)

Parameters

Example Usage

$planId = 'plan_id';
$request = new CreatePlanItemRequest();

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

updatePlan

Updates a plan, _(*90)

function updatePlan(
        $planId,
        $request)

Parameters

Example Usage

$planId = 'plan_id';
$request = new UpdatePlanRequest();

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

createPlan

Creates a new plan, _(*91)

function createPlan($body)

Parameters

Example Usage

$body = new CreatePlanRequest();

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

getPlans

Gets all plans, _(*92)

function getPlans()

Example Usage

$result = $plans->getPlans();

deletePlan

Deletes a plan, _(*93)

function deletePlan($planId)

Parameters

Example Usage

$planId = 'plan_id';

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

getPlanItem

Gets a plan item, _(*94)

function getPlanItem(
        $planId,
        $planItemId)

Parameters

Example Usage

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

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

deletePlanItem

Removes an item from a plan, _(*95)

function deletePlanItem(
        $planId,
        $planItemId)

Parameters

Example Usage

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

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

Back to List of Controllers, _(*96)

InvoicesController

Get singleton instance

The singleton instance of the InvoicesController class can be accessed from the API Client., _(*97)

$invoices = $client->getInvoices();

cancelInvoice

Cancels an invoice, _(*98)

function cancelInvoice($invoiceId)

Parameters

Example Usage

$invoiceId = 'invoice_id';

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

getLastInvoiceCharge

Gets the last charge from an invoice, _(*99)

function getLastInvoiceCharge($invoiceId)

Parameters

Example Usage

$invoiceId = 'invoice_id';

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

getInvoices

Gets all invoices, _(*100)

function getInvoices()

Example Usage

$result = $invoices->getInvoices();

getInvoice

Gets an invoice, _(*101)

function getInvoice($invoiceId)

Parameters

Example Usage

$invoiceId = 'invoice_id';

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

Back to List of Controllers, _(*102)

OrdersController

Get singleton instance

The singleton instance of the OrdersController class can be accessed from the API Client., _(*103)

$orders = $client->getOrders();

getOrder

Gets an order, _(*104)

function getOrder($orderId)

Parameters

Example Usage

$orderId = 'order_id';

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

getOrders

Gets all orders, _(*105)

function getOrders()

Example Usage

$result = $orders->getOrders();

createOrder

Creates a new Order, _(*106)

function createOrder($body)

Parameters

Example Usage

$body = new CreateOrderRequest();

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

Back to List of Controllers, _(*107)