PHPackages                             egcservices/iugu-extension - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. egcservices/iugu-extension

ActiveLibrary[Payment Processing](/categories/payments)

egcservices/iugu-extension
==========================

Extensão do IUGU. Criada por Gabriel Perez. Atualizada por Elson Costa.

2.0.1(4y ago)022MITPHPPHP ^7.4|^8.0

Since Apr 8Pushed 4y agoCompare

[ Source](https://github.com/elsongabriel/iugu-extension)[ Packagist](https://packagist.org/packages/egcservices/iugu-extension)[ RSS](/packages/egcservices-iugu-extension/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (3)Versions (16)Used By (0)

Iugu-extension
==============

[](#iugu-extension)

Biblioteca base utilizada [egcservices/iugu-php-sdk](https://github.com/elsongabriel/iugu-php-sdk)

Biblioteca que realiza integração com a API da [Iugu](http://www.iugu.com)

[![StyleCI](https://camo.githubusercontent.com/0b0fe1d2a74d634444c26f4147182f3f5623c41fda60dab3fa2aae815c2c741a/68747470733a2f2f7374796c6563692e696f2f7265706f732f3134303930323034302f736869656c643f6272616e63683d6d6173746572)](https://styleci.io/repos/140902040)

Instalação via composer
-----------------------

[](#instalação-via-composer)

```
$ composer require egcservices/iugu-extension
```

Serviços
--------

[](#serviços)

Este SDK extende os seguintes serviços:

- [Marketplace/Ações da Conta Mestre](https://dev.iugu.com/reference#criar-subconta)
- [Split](https://dev.iugu.com/reference#criar-split-1)
- [Relatórios](https://dev.iugu.com/reference#extrato-financeiro)
- [Planos](https://dev.iugu.com/reference#criar-plano)

[Referência da API](https://dev.iugu.com/reference)
[Documentação iugu-php-sdk](https://github.com/elsongabriel/iugu-php-sdk)

### Configuração

[](#configuração)

Para utilizar este SDK, será necessário inserir em seu .env

```
IUGU_API_KEY=CHAVE_API_IUGU
IUGU_API_TEST_KEY=CHAVE_DE_TEST_API_IUGU
IUGU_ACCOUNT_ID=ID_DA_CONTA_MASTER
```

E em config/services.php

```
'iugu' => [
    'account_id'   => env('IUGU_ACCOUNT_ID', ''),
    'api_test_key' => env('IUGU_API_TEST_KEY', ''),
    'api_key'      => env('IUGU_API_KEY', ''),
]
```

Ao realizar use das classes, será necessario fazer o seguinte e instaciar a classe iugu

```
use services\Iugu\Iugu;
use egcservices\Iugu\Exceptions\IuguException;
use egcservices\Iugu\Exceptions\IuguValidationException;

$iugu = new Iugu;
// Também possivel setar apitoken na chamada da classe
$iugu = new Iugu('apiKey');
```

### MarketPlace

[](#marketplace)

#### Listar subcontas

[](#listar-subcontas)

```
$response = $iugu->marketplace()->list();

// Imprime uma lista de subcontas
echo $response;
```

#### Criar MarketPlace

[](#criar-marketplace)

- [Referência](https://dev.iugu.com/reference#criar-subconta)

```
$response = $iugu->marketplace()->create([
    'parametros'
]);

// Imprime o ID da subconta
dd($response);
```

#### Editar MarketPlace

[](#editar-marketplace)

- [Referência](https://dev.iugu.com/reference#atualizar-subconta)

```
$response = $iugu->marketplace()->update('SUBCONTA_ID',[
    'parametros'
]);

// Imprime a subconta atualizada
dd($response);
```

#### Enviar verificação de subconta

[](#enviar-verificação-de-subconta)

- [Referência](https://dev.iugu.com/reference#enviar-verificacao-de-conta)

```
$response = $iugu->marketplace()->requestVerification('SUBCONTA_ID',[
    'parametros'
]);

dd($response);
```

#### Ver subconta

[](#ver-subconta)

- [Referência](https://dev.iugu.com/reference#atualizar-subconta)

```
$response = $iugu->marketplace()->show('SUBCONTA_ID');

dd($response);
```

#### Pedido de saque

[](#pedido-de-saque)

```
$response = $iugu->marketplace()->requestWithdraw('SUBCONTA_ID');

dd($response);
```

### Master

[](#master)

#### Adicionar Domicílio Bancário

[](#adicionar-domicílio-bancário)

- [Referência](https://dev.iugu.com/reference#adicionar-domicilio-bancario)

```
    $iugu->master()->createBankVerificantion(['parametros']);
```

#### Verificar Envio de Domicilio Bancario

[](#verificar-envio-de-domicilio-bancario)

- [Referência](https://dev.iugu.com/reference#verificar-envio-de-domicilio-bancario)

```
    $iugu->master()->showBankVerificantion();
```

#### Solicitar verificação para uso de Cartão de Crédito

[](#solicitar-verificação-para-uso-de-cartão-de-crédito)

⚠️ O documento de comprovante de Contrato Social ou documento de Atividade é obrigatório
Além deste documento é necessário enviar (CNH ou RG) ou CPF caso não possua CNH.

- [Referência](https://dev.iugu.com/reference#solicitar-verifica%C3%A7%C3%A3o-para-uso-de-cart%C3%A3o-de-cr%C3%A9dito)

```
    $iugu->master()->requestCreditCardVerification(['parametros']);
```

#### Verificar Solicitação de cartão de crédito

[](#verificar-solicitação-de-cartão-de-crédito)

- [Referência](https://dev.iugu.com/reference#verificar-solicita%C3%A7%C3%A3o-de-cart%C3%A3o-de-cr%C3%A9dito)

```
    $iugu->master()->checkCreditCardVerification();
```

#### Configurar Pagamentos

[](#configurar-pagamentos)

Habilita ou Desabilita o Pix.

- [Referência](https://dev.iugu.com/reference#configurar-pagamentos)

```
    $iugu->master()->settingPix(TRUE or FALSE)
```

#### Consultar Gestão de Cobranças.

[](#consultar-gestão-de-cobranças)

- [Referência](https://dev.iugu.com/reference#reenviar-gatilho-por-per%C3%ADodo)

```
    $iugu->master()->ConsultManagement()
```

### Alterar Gestão de Cobranças.

[](#alterar-gestão-de-cobranças)

- [Referência](https://dev.iugu.com/reference#alterar-gest%C3%A3o-1)

```
    $iugu->master()->updateManagement()
```

### Multi Split

[](#multi-split)

⚠️ Criar um novo multi split sobrepõe o que já está configurado. Todas as faturas pagas em uma conta irão respeitar as regras de splits criadas.

#### Criar split

[](#criar-split)

- [Referencia](https://dev.iugu.com/reference#criar-split-1)

```
$response = $iugu->split()->create(['parametros']);

dd($response);
```

#### Listar splits

[](#listar-splits)

```
$response = $iugu->split()->list();

dd($response);
```

#### Visualizar split

[](#visualizar-split)

```
$response = $iugu->split()->search('split_id');

dd($response);
```

#### Consultar splits

[](#consultar-splits)

```
$response = $iugu->split()->current('split_id');

dd($response);
```

#### Planos

[](#planos)

### Listar um plano

[](#listar-um-plano)

- [Referência](https://dev.iugu.com/reference#listar-plano)

```
$response = $iugu->plan->list();

dd($response);
```

### criar um plano

[](#criar-um-plano)

- [Paramentros](https://dev.iugu.com/reference#criar-plano)

```
$response = $iugu->plan->create(['paramentros']);

dd($response);
```

### Alterar um Plano

[](#alterar-um-plano)

- [Paramentros](https://dev.iugu.com/reference#alterar-plano)

```
$response = $iugu->plan->update('id', ['paramentros']);

dd($response);
```

### Remover Plano

[](#remover-plano)

- [referência](https://dev.iugu.com/reference#remover-plano)

```
$response = $iugu->plan->destroy('id');

dd($response);
```

### Buscar Plano

[](#buscar-plano)

- [referência](https://dev.iugu.com/reference#buscar-plano)

```
$response = $iugu->plan->get('id');

dd($response);
```

### Buscar Plano pelo Identificador

[](#buscar-plano-pelo-identificador)

- [referência](https://dev.iugu.com/reference#buscar-plano-pelo-identificador)

```
$response = $iugu->plan->getByIdentifier('identifier');

dd($response);
```

### alterar um plano

[](#alterar-um-plano-1)

#### Helps

[](#helps)

Consts

```
// Obtenha um array com todos os bancos aceitos pela Iugu
const BANKS = [
    'Itaú', 'Bradesco', 'Caixa Econômica', ...
]

const PERSON_TYPE = [
    'Pessoa Física', 'Pessoa Jurídica'
];

const PERSON_TYPE_PHYSICAL = 'Pessoa Física';
const PERSON_TYPE_LEGAL    = 'Pessoa Jurídica';

const INTERVAL_TYPES            = [
    'weeks', 'months'
];

const INTERVAL_TYPE_WEEKS      = 'weeks';
const INTERVAL_TYPE_MONTHS     = 'months';

const PAYABLE_WITHS            = [
    'all', 'credit_card', 'bank_slip', 'pix'
];

const PAYABLE_WITH_ALL         = 'all';
const PAYABLE_WITH_CREDIT_CARD = 'credit_card';
const PAYABLE_WITH_BANK_SLIP   = 'bank_slip';
const PAYABLE_WITH_PIX         = 'pix';
```

iugu-php-sdk
============

[](#iugu-php-sdk)

Biblioteca que realiza integração com a API da [Iugu](http://www.iugu.com)

[![StyleCI](https://camo.githubusercontent.com/0b0fe1d2a74d634444c26f4147182f3f5623c41fda60dab3fa2aae815c2c741a/68747470733a2f2f7374796c6563692e696f2f7265706f732f3134303930323034302f736869656c643f6272616e63683d6d6173746572)](https://styleci.io/repos/140902040)[![Maintainability](https://camo.githubusercontent.com/eb8f7fb22b8758040c4cf59785d78dc7c787b13a5e5d82229ee1cdf1f16189fc/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f64346536366639386164303533396530623635642f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/egcservices/iugu-php-sdk/maintainability)

Instalação via composer
-----------------------

[](#instalação-via-composer-1)

```
$ composer require egcservices/iugu-php-sdk
```

Serviços
--------

[](#serviços-1)

Este SDK suporta os seguintes serviços:

- [Clientes](https://dev.iugu.com/reference#testinput-2)
- [Cobrança direta](https://dev.iugu.com/reference#cobranca-direta)
- [Faturas](https://dev.iugu.com/reference#criar-fatura)
- [Métodos de pagamento](https://dev.iugu.com/reference#testinput-3)

[Referência da API](https://dev.iugu.com/reference)

### Configuração

[](#configuração-1)

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

```
use egcservices\Iugu;
use egcservices\Iugu\Exceptions\IuguException;
use egcservices\Iugu\Exceptions\IuguValidationException;

$iugu = new Iugu('SEU_TOKEN');
```

### Clientes

[](#clientes)

#### Criar cliente

[](#criar-cliente)

```
$customer = $iugu->customer()->create([
    'name' => 'Lucas Colette',
    'email' => 'lucas@bubb.com.br',
]);

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

#### Atualizar cliente

[](#atualizar-cliente)

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

#### Buscar cliente

[](#buscar-cliente)

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

var_dump($customer);
```

#### Excluir cliente

[](#excluir-cliente)

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

### Cobranças diretas

[](#cobranças-diretas)

#### Criar cobrança com boleto bancário

[](#criar-cobrança-com-boleto-bancário)

```
$charge = $iugu->charge()->create([
            'method' => 'bank_slip',
            'email' => 'lucas@bubb.com.br',
            'order_id' => uniqid(),
            'payer' => [
                'cpf_cnpj' => '65634052076',
                'name' => 'Lucas Colette',
                'phone_prefix' => '11',
                'phone' => '11111111',
                'email' => 'lucas@bubb.com.br',
                '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

[](#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
-------

[](#faturas)

#### Criar fatura

[](#criar-fatura)

```
$invoice = $iugu->invoice()->create([
    'order_id' => uniqid(),
    'email' => 'lucas@bubb.com.br',
    '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' => 'lucas@bubb.com.br',
        '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

[](#capturar-fatura)

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

#### Buscar fatura

[](#buscar-fatura)

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

#### Reembolsar fatura

[](#reembolsar-fatura)

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

#### Cancelar fatura

[](#cancelar-fatura)

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

Métodos de pagamento
--------------------

[](#métodos-de-pagamento)

#### Criar método 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

[](#atualizar-método-de-pagamento)

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

#### Buscar método de pagamento

[](#buscar-método-de-pagamento)

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

#### Excluir método de pagamento

[](#excluir-método-de-pagamento)

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

Testando
--------

[](#testando)

```
$ composer test
```

Change log
----------

[](#change-log)

Consulte [CHANGELOG](.github/CHANGELOG.md) para obter mais informações sobre o que mudou recentemente.

Contribuindo
------------

[](#contribuindo)

Consulte [CONTRIBUTING](.github/CONTRIBUTING.md) para obter mais detalhes.

Segurança
---------

[](#segurança)

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

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 85.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~4 days

Total

15

Last Release

1805d ago

Major Versions

1.0.4.6 → 2.02021-06-01

PHP version history (3 changes)v1.0PHP ~5.6|~7.0

1.0.1PHP ~5.6|^7.0

2.0PHP ^7.4|^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/24e99729583abb961401bfb8e2d3f8f080469273f42105495961056890cc81a9?d=identicon)[elsoncosta](/maintainers/elsoncosta)

---

Top Contributors

[![GabrielJPerez](https://avatars.githubusercontent.com/u/46225106?v=4)](https://github.com/GabrielJPerez "GabrielJPerez (40 commits)")[![elsongabriel](https://avatars.githubusercontent.com/u/7812282?v=4)](https://github.com/elsongabriel "elsongabriel (7 commits)")

---

Tags

phpextensionpaymentphp80iuguinboud

### Embed Badge

![Health badge](/badges/egcservices-iugu-extension/health.svg)

```
[![Health](https://phpackages.com/badges/egcservices-iugu-extension/health.svg)](https://phpackages.com/packages/egcservices-iugu-extension)
```

###  Alternatives

[omalizadeh/laravel-multi-payment

A driver-based laravel package for online payments via multiple gateways

491.1k](/packages/omalizadeh-laravel-multi-payment)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)