bubbstore/iugu-php-sdk

Biblioteca não oficial de integração com a API da Iugu

v1.0.2 2018-07-14 17:31 UTC

Requires

• php: ~5.6|~7.0
• guzzlehttp/guzzle: ~6.0

Requires (Dev)

• codeclimate/php-test-reporter: ~0.3
• larapack/dd: ^1.1
• mockery/mockery: ~0.9
• phpunit/phpunit: ~5.0
• squizlabs/php_codesniffer: ~2.3

MIT

• Lucas Colette

• iugu
• inboud

README

Biblioteca que realiza integração com a API da Iugu

Instalação via composer

$ composer require bubbstore/iugu-php-sdk

Serviços

Este SDK suporta os seguintes serviços:

• Clientes
• Cobrança direta
• Faturas
• Métodos de pagamento

Referência da API

Configuração

Para utilizar este SDK, será necessário utilizar seu token de acesso de sua conta Iugu.

use bubbstore\Iugu;
use bubbstore\Iugu\Exceptions\IuguException;
use bubbstore\Iugu\Exceptions\IuguValidationException;

$iugu = new Iugu('SEU_TOKEN');

Clientes

Criar cliente

$customer = $iugu->customer()->create([
    'name' => 'Lucas Colette',
    'email' => '[e-mail]',
]);

// Imprime o ID do cliente
echo $customer['id'];

Atualizar cliente

$customer = $iugu->customer()->update('ID_CLIENTE', [
    'name' => 'John'
]);

Buscar cliente

$customer = $iugu->customer()->find('ID_CLIENTE');

var_dump($customer);

Excluir cliente

$iugu->customer()->delete('ID_CLIENTE');

Cobranças diretas

Criar cobrança com boleto bancário

$charge = $iugu->charge()->create([
            'method' => 'bank_slip',
            'email' => '[e-mail]',
            'order_id' => uniqid(),
            'payer' => [
                'cpf_cnpj' => '65634052076',
                'name' => 'Lucas Colette',
                'phone_prefix' => '11',
                'phone' => '11111111',
                'email' => '[e-mail]',
                'address' => [
                    'street' => 'Foo Bar',
                    'number' => '123',
                    'district' => 'Foo',
                    'city' => 'Foo',
                    'state' => 'SP',
                    'zip_code' => '14940000',
                ],
            ],
            'items' => [
                [
                    'description' => 'Item 1',
                    'quantity' => 1,
                    'price_cents' => 1000
                ],
                [
                    'description' => 'Item 2',
                    'quantity' => 2,
                    'price_cents' => 2000
                ],
            ],
        ]);

Realizar pagamento de uma fatura com cartão

$charge = $iugu->charge()->create([
    'invoice_id' => '12345678',
    'token' => '0000000000000000' // Token gerado através da lib iugu.js
]);

Faturas

Criar fatura

$invoice = $iugu->invoice()->create([
    'order_id' => uniqid(),
    'email' => '[e-mail]',
    'due_date' => '2018-07-14',
    'notification_url' => 'https://webhook.site/08703bf2-d408-4f4c-b91c-0bc8e14352b2',
    'fines' => false,
    'per_day_interest' => false,
    'discount_cents' => 500,
    'ignore_due_email' => true,
    'payable_with' => 'bank_slip',
    'items' => [
        [
            'description' => 'Item 1',
            'quantity' => 1,
            'price_cents' => 1000
        ],
        [
            'description' => 'Item 2',
            'quantity' => 2,
            'price_cents' => 2000
        ],
        [
            'description' => 'Frete',
            'quantity' => 1,
            'price_cents' => 1000
        ],
    ],
    'payer' => [
        'cpf_cnpj' => '65634052076',
        'name' => 'Lucas Colette',
        'phone_prefix' => '11',
        'phone' => '11111111',
        'email' => '[e-mail]',
        'address' => [
            'street' => 'Foo Bar',
            'number' => '123',
            'district' => 'Foo',
            'city' => 'Foo',
            'state' => 'SP',
            'zip_code' => '14940000',
        ],
    ],
]);

// Imprime o ID da fatura
echo $invoice['id'];

Capturar fatura

$iugu->invoice()->capture('ID_FATURA');

Buscar fatura

$iugu->invoice()->find('ID_FATURA');

Reembolsar fatura

$iugu->invoice()->refund('ID_FATURA');

Cancelar fatura

$iugu->invoice()->cancel('ID_FATURA');

Métodos de pagamento

Criar método de pagamento

$payment = $iugu->paymentMethod()->create('ID_CLIENTE', [
    'description' => 'Cartão de Crédito',
    'token' => '123456',
]);

// Imprime o ID do pagamento
echo $payment['id'];

Atualizar método de pagamento

$iugu->paymentMethod()->update('ID_CLIENTE', 'ID_METODO_PAGAMENTO', [
    'description' => 'Outra description',
]);

Buscar método de pagamento

$iugu->paymentMethod()->find('ID_CLIENTE', 'ID_METODO_PAGAMENTO');

Excluir método de pagamento

$iugu->paymentMethod()->delete('ID_CLIENTE', 'ID_METODO_PAGAMENTO');

Testando

$ composer test

Change log

Consulte CHANGELOG para obter mais informações sobre o que mudou recentemente.

Contribuindo

Consulte CONTRIBUTING para obter mais detalhes.

Segurança

Se você descobrir quaisquer problemas relacionados à segurança, envie um e-mail para [e-mail] em vez de usar as issues.