README.md

SDK GERENCIANET FOR PHP

Sdk for Gerencianet Pagamentos' API. For more informations about parameters and values, please refer to Gerencianet documentation.

⚠️ This module is under development and is based on the new API that Gerencianet is about to release. It won't work in production by now.

Installation

$ php composer.phar require gerencianet/gerencianet-sdk-php

Get start

Require the module and namespaces:

require __DIR__ . '/../sdk/vendor/autoload.php';

use Gerencianet\Gerencianet;
use Gerencianet\Models\Address;
use Gerencianet\Models\Customer;
use Gerencianet\Models\Item;
use Gerencianet\Models\Metadata;
use Gerencianet\Models\Repass;
use Gerencianet\Models\Shipping;
use Gerencianet\Models\Subscription;
use Gerencianet\Models\GerencianetException;

If your system already has any class above, you can use PHP' namespaces for conflict resolution as below:

require __DIR__ . '/../sdk/vendor/autoload.php';

...
use Gerencianet\Models\Address as GerencianetAddress;
...

All code must be within a try-catch. Gerencianet::error method can be used to print a JSON back to your frontend.

try {
  /* code */
} catch(GerencianetException $e) {
  Gerencianet::error($e);
} catch(Exception $ex) {
  Gerencianet::error($ex);
}

For development environment

Instantiate the module passing your apiKey, your apiSecret and the third parameter is used to change the environment to sandbox:

$apiKey = 'your_client_id';
$apiSecret = 'your_client_secret';

$apiGN = new Gerencianet($apiKey, $apiSecret, true);

For production environment

To change the environment to production just change the third parameter to false as follow:

$apiKey = 'your_client_id';
$apiSecret = 'your_client_secret';

$apiGN = new Gerencianet($apiKey, $apiSecret, false);

Creating charge

To create a new charge, you must create at least one item:

$item = new Item();
$item->name('Item Gerencianet')
     ->value(5000) // The value must be a integer (ex.: R$ 50,00 = 5000)
     ->amount(2);

$response = $apiGN->createCharge()
                  ->addItem($item)
                  ->run()
                  ->response();

You have two options to add items in the charge:

• Add one item at a time:

$response = $apiGN->createCharge()
                  ->addItem($item)
                  ->run()
                  ->response();

• Add many items:

$response = $apiGN->createCharge()
                  ->addItems([$item1, $item2])
                  ->run()
                  ->response();

Charge can also have shipping and metadata:

$shipping = new Shipping();
$shipping->name('Shipping')
         ->value(2500);

$metadata = new Metadata();
$metadata->customId('MyID')
         ->notificationUrl('http://your_domain/your_notification_url');

$response = $apiGN->createCharge()
                  ...
                  ->addShipping($shipping)
                  ->metadata($metadata)
                  ->run()
                  ->response();

As the item, shipping also has two ways to be added:

• Add one shipping at a time:

$response = $apiGN->createCharge()
                  ...
                  ->addShipping($shipping)
                  ->run()
                  ->response();

• Add many shippings:

$response = $apiGN->createCharge()
                  ...
                  ->addShippings([$shipping1, $shipping2])
                  ->run()
                  ->response();

Running tests

To run tests install PHPUnit and run the following command:

$ phpunit -c tests/config.xml tests

Additional docs

• Associating a customer to a charge
• Subscriptions
• Detailing charge and subscriptions
• Creating payment
• Notification
• Marketplace
• Getting installments and total bol

License

• MIT