https://github.com/igorsamaral/iugu-php
Iugu PHP SDK
https://github.com/igorsamaral/iugu-php
gateway-api iugu lib php php-library sdk
Last synced: 6 months ago
JSON representation
Iugu PHP SDK
- Host: GitHub
- URL: https://github.com/igorsamaral/iugu-php
- Owner: igorsamaral
- Created: 2021-07-01T14:42:15.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-06T17:43:56.000Z (almost 5 years ago)
- Last Synced: 2025-10-19T09:18:11.052Z (8 months ago)
- Topics: gateway-api, iugu, lib, php, php-library, sdk
- Language: PHP
- Homepage:
- Size: 38.1 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introdução
Essa Lib foi construída com o intuito de torná-la flexível, de forma que todos possam utilizar todas as features, de todas as versões de API.
Você pode acessar a documentação oficial da Iugu acessando esse [link](https://dev.iugu.com/).
## Índice
- [Instalação](#instalação)
- [Configuração](#configuração)
- [Clientes](#clientes)
- [Criando um cliente](#criando-um-cliente)
- [Retornando clientes](#retornando-clientes)
- [Retornando um cliente](#retornando-um-cliente)
- [Tokens e cobrança direta](#tokens-e-cobraça-direta)
- [Criando Token](#criando-um-token)
- [Cobrança direta](#cobrança-direta)
- [Faturas](#faturas)
- [Criando uma fatura](#criando-uma-fatura)
- [Retornando faturas](#retornando-faturas)
- [Retornando uma fatura](#retornando-uma-fatura)
## Instalação
Instale a biblioteca utilizando o comando
`composer require igorsamaral/iugu-php`
## Configuração
Para incluir a biblioteca em seu projeto, basta fazer o seguinte:
```php
["MEU_HEADER_CUSTOMIZADO" => "VALOR HEADER CUSTOMIZADO"]]
);
```
E então, você pode poderá utilizar o cliente para fazer requisições ao Iugu.com.br, como nos exemplos abaixo.
## Clientes
Clientes representam os usuários de sua loja, ou negócio. Este objeto contém informações sobre eles, como nome, e-mail e telefone, além de outros campos.
### Criando um cliente
```php
customers()->create([
"email" => "joao.neves@email.com",
"name" => "João das Neves",
"notes" => "lorem...",
"phone" => "999999999",
"phone_prefix" => "11",
"cpf_cnpj" => "11743685009",
"zip_code" => "76814112",
"number" => "100",
"street" => "Rua Cabedelo",
"city" => "Porto Velho",
"state" => "RO",
"district" => "Marcos Freire",
"complement" => "complemento...",
"custom_variables" => [
"key" => "value"
]
]);
```
### Retornando clientes
```php
customers()->getList();
```
### Retornando um cliente
```php
customers()->get([
"id" => "ID_DO_CLIENTE"
]);
```
## Tokens e cobraça direta
O Token é uma representação do meio de pagamento do cliente (por ex: seu cartão de crédito), sendo totalmente seguro, de forma que não é possível que alguém consiga as informações do cartão de crédito do cliente utilizando esse token. O token é gerado para uma transação específica, tornando-o ainda mais seguro.
### Criando um token
```php
paymentToken()->create([
"account_id" => "ID_DA_SUA_CONTA_IUGU",
"customer_id" => "ID_DO_CUSTOMER",
"method" => "credit_card",
"data" => [
"number" => "4242424242424242",
"verification_value" => "648",
"first_name" => "João",
"last_name" => "das Neves",
"month" => "01",
"year" => "2023"
],
"test" => true,
]);
```
### Cobrança direta
Cobrança simples via boleto ou cartão de crédito.
```php
charges()->create([
"token" => "ID_DO_TOKEN_DE_PAGAMENTO_CRIADO",
"customer_id" => "ID_DO_CUSTOMER",
"total" => 10000,
"payer" => [
"cpf_cnpj" => "84752882000",
"name" => "João das Neves",
"address" => [
"zip_code" => "72917210",
"number" => "100"
]
],
"items": [
[
"description" => "Descrição do item 1",
"quantity" => 1,
"price_cents" => 10000
]
]
]);
```
## Faturas
Cria uma fatura para um cliente.
### Criando uma fatura
```php
invoices()->create([
"email" => "joao@email.com.br",
"due_date" => "2021-07-21",
"items" => [
[
"description" => "Descrição do item 1",
"quantity" => 1,
"price_cents" => 10000
]
],
"total" => 10000,
"payer" => [
"cpf_cnpj" => "84752882000",
"name" => "João das Neves",
"address" => [
"zip_code" => "72917210",
"number" => "100"
]
]
]);
```
### Retornando faturas
```php
invoices()->getList();
```
### Retornando uma fatura
```php
invoices()->get([
"id" => "ID_DA_FATURA"
]);
```