Download the PHP package los/mundiapi without Composer

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:

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.

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.

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.

Initialization

Authentication

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

API client can be initialized as following.

Class Reference

List of Controllers

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

ChargesController

Get singleton instance

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

getCharge

Get a charge from its id

Parameters

Example Usage

retryCharge

Retries a charge

Parameters

Example Usage

getCharges

Lists all charges

Example Usage

createCharge

Creates a new charge

Parameters

Example Usage

updateChargeCard

Updates the card from a charge

Parameters

Example Usage

updateChargePaymentMethod

Updates a charge's payment method

Parameters

Example Usage

cancelCharge

Cancel a charge

Parameters

Example Usage

captureCharge

Captures a charge

Parameters

Example Usage

Back to List of Controllers

CustomersController

Get singleton instance

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

getAddresses

Gets all adressess from a customer

Parameters

Example Usage

getCards

Get all cards from a customer

Parameters

Example Usage

getCustomers

Get all Customers

Example Usage

createCustomer

Creates a new customer

Parameters

Example Usage

getCustomer

Get a customer

Parameters

Example Usage

updateAddress

Updates an address

Parameters

Example Usage

updateCard

Updates a card

Parameters

Example Usage

getAddress

Get a customer's address

Parameters

Example Usage

deleteAddress

Delete a Customer's address

Parameters

Example Usage

deleteCard

Delete a customer's card

Parameters

Example Usage

createAddress

Creates a new address for a customer

Parameters

Example Usage

getCard

Get a customer's card

Parameters

Example Usage

createCard

Creates a new card for a customer

Parameters

Example Usage

updateCustomer

Updates a customer

Parameters

Example Usage

deleteAccessTokens

Delete a Customer's access tokens

Parameters

Example Usage

getAccessTokens

Get all access tokens from a customer

Parameters

Example Usage

deleteAccessToken

Delete a customer's access token

Parameters

Example Usage

createAccessToken

Creates a access token for a customer

Parameters

Example Usage

getAccessToken

Get a Customer's access token

Parameters

Example Usage

Back to List of Controllers

SubscriptionsController

Get singleton instance

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

updateSubscriptionBillingDate

Updates the billing date from a subscription

Parameters

Example Usage

createUsage

Creates a usage

Parameters

Example Usage

updateSubscriptionItem

Updates a subscription item

Parameters

Example Usage

getSubscriptions

Gets all subscriptions

Example Usage

updateSubscriptionCard

Updates the credit card from a subscription

Parameters

Example Usage

createSubscription

Creates a new subscription

Parameters

Example Usage

createSubscriptionItem

Creates a new Subscription item

Parameters

Example Usage

createDiscount

Creates a discount

Parameters

Example Usage

getSubscription

Gets a subscription

Parameters

Example Usage

updateSubscriptionPaymentMethod

Updates the payment method from a subscription

Parameters

Example Usage

getUsages

Lists all usages from a subscription item

Parameters

Example Usage

deleteUsage

Deletes a usage

Parameters

Example Usage

deleteDiscount

Deletes a discount

Parameters

Example Usage

cancelSubscription

Cancels a subscription

Parameters

Example Usage

deleteSubscriptionItem

Deletes a subscription item

Parameters

Example Usage

Back to List of Controllers

PlansController

Get singleton instance

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

getPlanItems

Gets all items from a plan

Parameters

Example Usage

updatePlanItem

Updates a plan item

Parameters

Example Usage

getPlan

Gets a plan

Parameters

Example Usage

createPlanItem

Adds a new item to a plan

Parameters

Example Usage

updatePlan

Updates a plan

Parameters

Example Usage

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

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

createPlan

Creates a new plan

function createPlan($body)

Parameters

Example Usage

$body = new CreatePlanRequest();

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

getPlans

Gets all plans

function getPlans()

Example Usage

$result = $plans->getPlans();

deletePlan

Deletes a plan

function deletePlan($planId)

Parameters

Example Usage

$planId = 'plan_id';

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

getPlanItem

Gets a plan item

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

function deletePlanItem(
        $planId,
        $planItemId)

Parameters

Example Usage

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

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

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

cancelInvoice

Cancels an invoice

function cancelInvoice($invoiceId)

Parameters

Example Usage

$invoiceId = 'invoice_id';

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

getLastInvoiceCharge

Gets the last charge from an invoice

function getLastInvoiceCharge($invoiceId)

Parameters

Example Usage

$invoiceId = 'invoice_id';

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

getInvoices

Gets all invoices

function getInvoices()

Example Usage

$result = $invoices->getInvoices();

getInvoice

Gets an invoice

function getInvoice($invoiceId)

Parameters

Example Usage

$invoiceId = 'invoice_id';

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

Back to List of Controllers

OrdersController

Get singleton instance

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

$orders = $client->getOrders();

getOrder

Gets an order

function getOrder($orderId)

Parameters

Example Usage

$orderId = 'order_id';

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

getOrders

Gets all orders

function getOrders()

Example Usage

$result = $orders->getOrders();

createOrder

Creates a new Order

function createOrder($body)

Parameters

Example Usage

$body = new CreateOrderRequest();

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

Back to List of Controllers