PHPackages                             webflixtec/sdk-php-ipag - 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. webflixtec/sdk-php-ipag

ActiveLibrary

webflixtec/sdk-php-ipag
=======================

v1.1.2(11mo ago)052MITPHPPHP >=7.4

Since Apr 4Pushed 11mo agoCompare

[ Source](https://github.com/webflixtec/sdk-php-ipag)[ Packagist](https://packagist.org/packages/webflixtec/sdk-php-ipag)[ RSS](/packages/webflixtec-sdk-php-ipag/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (9)Versions (5)Used By (0)

[![iPag Logo](https://camo.githubusercontent.com/18323541a0103e65c1d2c1bc3a268ce42ede9ca8120129ed7cad59f9ed9e0ff8/68747470733a2f2f626c6f672e697061672e636f6d2e62722f77702d636f6e74656e742f75706c6f6164732f323032322f30372f6c6f676f2d697061672e706e67)](https://camo.githubusercontent.com/18323541a0103e65c1d2c1bc3a268ce42ede9ca8120129ed7cad59f9ed9e0ff8/68747470733a2f2f626c6f672e697061672e636f6d2e62722f77702d636f6e74656e742f75706c6f6164732f323032322f30372f6c6f676f2d697061672e706e67) **SDK** para PHP
===============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================

[](#--sdk-para-php)

A ferramenta certa para efetuar a sua integração de forma rápida e segura com os serviços iPag.

### Observação

[](#observação)

Este SDK, não necessariamente, reflete todos dos recursos e funcionalidades disponíveis na API do iPag. Veja a documentação completa da API em .

Status
------

[](#status)

[![Minimum PHP Version](https://camo.githubusercontent.com/59c540f407b20fe8daae2085276dd8f8268d94e5051217571d164084a62198bc/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344253230372e342d626c75652e7376673f7374796c653d666c61742d737175617265)](https://www.php.net/releases/7_4_0.php)[![Versão](https://camo.githubusercontent.com/868d4354c88d6e8771c729208e64fdd86db1e5719ec7466358b5cc19bfeab3f8/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f56657273696f6e2d312e302e302d627269676874677265656e)](https://github.com/ipagdevs/ipag-sdk-php/releases)[![Build Status](https://camo.githubusercontent.com/e3538fb7e5f4de4bca2a5e2eeb6c4a79b8a9cf76a1873331c6eebc90e0a2f695/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f69706167646576732f697061672d73646b2d7068702f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/ipagdevs/ipag-sdk-php/build-status/master)[![Code Intelligence Status](https://camo.githubusercontent.com/aebd585e0c90e823f3a520f2dc9142553932dc35d6b6d9f90381be9f0e95aa09/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f69706167646576732f697061672d73646b2d7068702f6261646765732f636f64652d696e74656c6c6967656e63652e7376673f623d6d6173746572)](https://scrutinizer-ci.com/code-intelligence)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/285071299928bd68f48744686adbe6b23b5d66e76ecfe2670911ca309f0d395f/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f69706167646576732f697061672d73646b2d7068702f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/ipagdevs/ipag-sdk-php/?branch=master)[![Maintainability](https://camo.githubusercontent.com/6a1f25440753f7468bc289e72bd93b4e65f366c900a7b9465e5a6e612033bdd1/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f34323431393062326138333333373638336461662f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/ipagdevs/ipag-sdk-php/maintainability)[![Test Coverage](https://camo.githubusercontent.com/c3e02f4fdd6c0e61c4b6908557a8ec2b3fa49c7af7071b5d65426713cb57d946/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f34323431393062326138333333373638336461662f746573745f636f766572616765)](https://codeclimate.com/github/ipagdevs/ipag-sdk-php/test_coverage)[![Licença](https://camo.githubusercontent.com/d6bc2b26794002c24d023acaab01b6dbb953c57ab9cb80ba5b8aa2f2bd5de99a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d626c7565)](https://github.com/ipagdevs/ipag-sdk-php/blob/master/LICENSE)[![Docs](https://camo.githubusercontent.com/5e24b543c46215b64f2a3fb245db99b99910e4c7b8d2f3134ff26c07c3be3d46/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2546302539462538432538452d415049253230446f63732d626c7565)](https://developers.ipag.com.br/)

**Índice**

- [iPag PHP client SDK](#ipag-php-client-sdk)
    - [Observação](#observa%C3%A7%C3%A3o)
    - [Status](#status)
- [Dependências](#depend%C3%AAncias)
- [Instalação](#instala%C3%A7%C3%A3o)
- [IpagClient](#ipagclient)
    - [Autenticação](#autentica%C3%A7%C3%A3o)
- [Pagamento (Payment)](#pagamento-payment)
    - [Criar Pagamento](#criar-pagamento)
    - [Consultar Pagamento](#consultar-pagamento)
    - [Capturar Pagamento](#capturar-pagamento)
    - [Cancelar Pagamento](#cancelar-pagamento)
- [Cliente (Customer)](#cliente-customer)
    - [Novo Cliente](#novo-cliente)
    - [Alterar Cliente](#alterar-cliente)
    - [Obter Cliente](#obter-cliente)
    - [Listar Clientes](#listar-clientes)
    - [Deletar Cliente](#deletar-cliente)
- [Plano de Assinatura (Subscription Plan)](#plano-de-assinatura-subscription-plan)
    - [Novo Plano de Assinatura](#novo-plano-de-assinatura)
    - [Alterar Plano de Assinatura](#alterar-plano-de-assinatura)
    - [Obter Plano de Assinatura](#obter-plano-de-assinatura)
    - [Listar Planos de Assinatura](#listar-planos-de-assinatura)
    - [Deletar Plano de Assinatura](#deletar-plano-de-assinatura)
- [Assinatura (Subscription)](#assinatura-subscription)
    - [Nova Assinatura](#nova-assinatura)
    - [Alterar Assinatura](#alterar-assinatura)
    - [Obter Assinatura](#obter-assinatura)
    - [Listar Assinaturas](#listar-assinaturas)
    - [Desvincular Token da Assinatura](#desvincular-token-da-assinatura)
    - [Quitar Parcela da Assinatura](#quitar-parcela-da-assinatura)
    - [Agendar Parcelamento da Assinatura](#agendar-parcelamento-da-assinatura)
- [Transação (Transaction)](#transa%C3%A7%C3%A3o-transaction)
    - [Obter Transação](#obter-transa%C3%A7%C3%A3o)
    - [Listar Transações](#listar-transa%C3%A7%C3%B5es)
    - [Liberar Recebíveis da Transação](#liberar-receb%C3%ADveis-da-transa%C3%A7%C3%A3o)
- [Token (Card Token)](#token-card-token)
    - [Novo Token](#novo-token)
    - [Obter Token](#obter-token)
- [Cobrança (Charge)](#cobran%C3%A7a-charge)
    - [Nova Cobrança](#nova-cobran%C3%A7a)
    - [Alterar Cobrança](#alterar-cobran%C3%A7a)
    - [Obter Cobrança](#obter-cobran%C3%A7a)
    - [Listar Cobranças](#listar-cobran%C3%A7as)
- [Estabelecimento (Establishment)](#estabelecimento-establishment)
    - [Novo Estabelecimento](#novo-estabelecimento)
    - [Alterar Estabelecimento](#alterar-estabelecimento)
    - [Obter Estabelecimento](#obter-estabelecimento)
    - [Listar Estabelecimentos](#listar-estabelecimentos)
    - [Transações (Transactions)](#transa%C3%A7%C3%B5es-transactions)
        - [Listar todas Transações dos Estabelecimentos](#listar-todas-transa%C3%A7%C3%B5es-dos-estabelecimentos)
        - [Listar Transações dos Estabelecimentos](#listar-transa%C3%A7%C3%B5es-dos-estabelecimentos)
        - [Obter Transação de um Estabelecimento](#obter-transa%C3%A7%C3%A3o-de-um-estabelecimento)
    - [Métodos de Pagamento (Payment Methods)](#m%C3%A9todos-de-pagamento-payment-methods)
        - [Configurar Métodos de Pagamento](#configurar-m%C3%A9todos-de-pagamento)
    - [Antifraudes (Antifraud)](#antifraudes-antifraud)
        - [Configurar Antifraudes](#configurar-antifraudes)
- [Regra de Split (Split Rules)](#regra-de-split-split-rules)
    - [Nova Regra de Split](#nova-regra-de-split)
    - [Obter Regra de Split](#obter-regra-de-split)
    - [Listar Regras de Split](#listar-regras-de-split)
    - [Deletar Regra de Split](#deletar-regra-de-split)
- [Vendedor (Seller)](#vendedor-seller)
    - [Novo Vendedor](#novo-vendedor)
    - [Alterar Vendedor](#alterar-vendedor)
    - [Obter Vendedor](#obter-vendedor)
    - [Listar Vendedores](#listar-vendedores)
- [Transferência (Transfer)](#transfer%C3%AAncia-transfer)
    - [Listar Transferências](#listar-transfer%C3%AAncias)
    - [Obter Transferência](#obter-transfer%C3%AAncia)
    - [Transferência dos Vendedores (Sellers Transfers)](#transfer%C3%AAncia-dos-vendedores-sellers-transfers)
        - [Listar Transferências dos Vendedores](#listar-transfer%C3%AAncias-dos-vendedores)
        - [Obter Transferência de Vendedor](#obter-transfer%C3%AAncia-de-vendedor)
    - [Lançamentos Futuros (Future Transfers)](#lan%C3%A7amentos-futuros-future-transfers)
        - [Listar Lançamentos Futuros](#listar-lan%C3%A7amentos-futuros)
        - [Listar Lançamentos Futuros de Vendedor (Por Id)](#listar-lan%C3%A7amentos-futuros-de-vendedor-por-id)
        - [Listar Lançamentos Futuros de Vendedor (Por CPF/CNPJ)](#listar-lan%C3%A7amentos-futuros-de-vendedor-por-cpfcnpj)
- [Link de Pagamento (Payment Links)](#link-de-pagamento-payment-links)
    - [Novo Link de Pagamento](#novo-link-de-pagamento)
    - [Alterar Link de Pagamento](#alterar-link-de-pagamento)
    - [Obter Link de Pagamento (Por Id)](#obter-link-de-pagamento-por-id)
    - [Obter Link de Pagamento (Por External Code)](#obter-link-de-pagamento-por-external-code)
- [Webhook](#webhook)
    - [Novo Webhook](#novo-webhook)
    - [Obter Webhook](#obter-webhook)
    - [Listar Webhooks](#listar-webhooks)
    - [Deletar Webhook](#deletar-webhook)
- [Checkout](#checkout)
    - [Novo Checkout](#novo-checkout)
- [Voucher](#voucher)
    - [Novo Voucher](#novo-voucher)
- [Helpers](#helpers)
    - [Credenciais dos Provedores de Antifraudes](#credenciais-dos-provedores-de-antifraudes)
        - [Clear Sale](#clear-sale)
        - [Konduto](#konduto)
        - [Red Shield](#red-shield)
    - [Credenciais dos Provedores de Meios de Pagamentos](#credenciais-dos-provedores-de-meios-de-pagamentos)
        - [Adiq](#adiq)
        - [Bin](#bin)
        - [Cielo](#cielo)
        - [Getnet](#getnet)
        - [Global Payments](#global-payments)
        - [Rede](#rede)
        - [Sipag](#sipag)
        - [Stone](#stone)
        - [Zoop](#zoop)
- [Testes](#testes)
- [Licença](#licen%C3%A7a)
- [Documentação](#documenta%C3%A7%C3%A3o)
- [Dúvidas & Sugestões](#d%C3%BAvidas--sugest%C3%B5es)

Dependências
============

[](#dependências)

**require**

- \[PHP >= 7.4\]
- \[guzzlehttp/guzzle\]
- \[kubinyete/assertation\]
- \[psr/log\]
- \[symfony/polyfill-php81\]
- \[symfony/polyfill-php80\]

**require-dev**

- \[phpunit/phpunit\]
- \[symfony/var-dumper\]
- \[fakerphp/faker\]

Instalação
==========

[](#instalação)

Execute em seu shell:

```
composer require webflixtec/sdk-php-ipag

```

IpagClient
==========

[](#ipagclient)

Classe responsável pela integração com a API do iPag. Através dela você consegue acessar todos os endpoints disponíveis na API.

> Para mais informações de como funciona a autenticação no Ipag, consulte: [Autenticação Ipag](https://developers.ipag.com.br/pt-br/auth)

### Autenticação

[](#autenticação)

```
$ipagClient = new \Ipag\Sdk\Core\IpagClient(
    'apiID',
    'apiKey',
    IpagEnvironment::SANDBOX
);
```

Pagamento (Payment)
===================

[](#pagamento-payment)

> Exemplo de Pagamento via Cartão de Crédito (Simples): [examples/payment/00-payment-create-card-simple.php](https://github.com/ipagdevs/ipag-sdk-php/blob/master/examples/payment/00-payment-create-card-simple.php)

> Exemplo de Pagamento via Cartão de Crédito (Completo): [examples/payment/01-payment-create-card-complete.php](https://github.com/ipagdevs/ipag-sdk-php/blob/master/examples/payment/01-payment-create-card-complete.php)

> Exemplo de Pagamento via Cartão de Crédito para Clientes Estrangeiros (Simples): [examples/payment/02-payment-create-card-foreign-customer.php](https://github.com/ipagdevs/ipag-sdk-php/blob/master/examples/payment/02-payment-create-card-foreign-customer.php)

> Exemplo de Pagamento via Cartão de Crédito para um Evento: [examples/payment/03-payment-create-card-for-event.php](https://github.com/ipagdevs/ipag-sdk-php/blob/master/examples/payment/03-payment-create-card-for-event.php)

> Exemplo de Pagamento via Boleto (Completo): [examples/payment/04-payment-create-bankslip.php](https://github.com/ipagdevs/ipag-sdk-php/blob/master/examples/payment/04-payment-create-bankslip.php)

> Exemplo de Pagamento com Tokenização do Cartão de Crédito: [examples/payment/05-payment-create-card-tokenization.php](https://github.com/ipagdevs/ipag-sdk-php/blob/master/examples/payment/05-payment-create-card-tokenization.php)

> Exemplo de Pagamento utilizando apenas o Token de Cartão: [examples/payment/06-payment-create-card-token.php](https://github.com/ipagdevs/ipag-sdk-php/blob/master/examples/payment/06-payment-create-card-token.php)

> Exemplo de Pagamento via Cartão de Crédito com Criação de Assinatura|Cobrança Recorrente: [examples/payment/07-payment-create-subscription-recurring-billing-card.php](https://github.com/ipagdevs/ipag-sdk-php/blob/master/examples/payment/07-payment-create-subscription-recurring-billing-card.php)

> Exemplo de Pagamento via Cartão de Crédito com Split de Pagamento: [examples/payment/08-payment-create-card-with-split.php](https://github.com/ipagdevs/ipag-sdk-php/blob/master/examples/payment/08-payment-create-card-with-split.php)

> Exemplo de Pagamento via Pix (Completo): [examples/payment/09-payment-create-pix.php](https://github.com/ipagdevs/ipag-sdk-php/blob/master/examples/payment/09-payment-create-pix.php)

```
$paymentTransaction = new \Ipag\Sdk\Model\PaymentTransaction(
    [
        'amount' => 100,
        'callback_url' => 'https://ipag-sdk.requestcatcher.com/callback',
        'order_id' => '12345679',
        'payment' => [
            'type' => Ipag\Sdk\Core\Enums\PaymentTypes::CARD,
            'method' => Ipag\Sdk\Core\Enums\Cards::VISA,
            'installments' => 4,
            'card' => [
                'holder' => 'Bruce Wayne',
                'number' => '4111 1111 1111 1111',
                'expiry_month' => '01',
                'expiry_year' => '2025',
                'cvv' => '123'
            ]
        ],
        'customer' => [
            'name' => 'Bruce Wayne',
            'cpf_cnpj' => '490.558.550-30'
        ]
    ]
);
```

ou

```
$paymentTransaction = (new \Ipag\Sdk\Model\PaymentTransaction())
    ->setAmount(100)
    ->setOrderId('123456')
    ->setCallbackUrl('https://ipag-sdk.requestcatcher.com/callback')
    ->setAntifraud(
        (new \Ipag\Sdk\Model\PaymentAntifraud())
            ->setFingerprint('123')
            ->setProvider('anti')
    )
    ->setPayment(
        (new \Ipag\Sdk\Model\Payment())
            ->setType(Ipag\Sdk\Core\Enums\PaymentTypes::CARD)
            ->setMethod(Ipag\Sdk\Core\Enums\Cards::VISA)
            ->setCard(
                (new \Ipag\Sdk\Model\PaymentCard())
                    ->setHolder('Bruce Wayne')
                    ->setNumber('4111 1111 1111 1111')
                    ->setCvv('123')
            )
    )
    ->setCustomer(
        (new \Ipag\Sdk\Model\Customer())
            ->setName('Bruce Wayne')
            ->setCpfCnpj('490.558.550-30')
            ->setBillingAddress(
                (new \Ipag\Sdk\Model\Address())
                    ->setStreet('Avenida Principal')
            )
            ->setShippingAddress(
                (new \Ipag\Sdk\Model\Address())
                    ->setStreet('Avenida Principal')
            )
    )
    ->setProducts([
        (new \Ipag\Sdk\Model\Product())
            ->setName('Smart TV LG 55 4K UHD'),
    ])
    ->addProduct(
        (new \Ipag\Sdk\Model\Product())
            ->setName('LED Android TV 4K UHD LED')
    )
    ->setSubscription(
        (new \Ipag\Sdk\Model\PaymentSubscription())
            ->setFrequency(1)
            ->setTrial(
                (new \Ipag\Sdk\Model\Trial())
                    ->setAmount(100)
            )
    )
    ->setSplitRules([
        (new \Ipag\Sdk\Model\PaymentSplitRules())
            ->setSellerId('vendedor1@mail.me')
            ->setAmount(15),
    ])
    ->addSplitRules(
        (new \Ipag\Sdk\Model\PaymentSplitRules())
            ->setSellerId('vendedor2@mail.me')
            ->setPercentage(20.0)
    );
```

### Criar Pagamento

[](#criar-pagamento)

```
$responsePayment = $ipagClient->payment()->create($paymentTransaction);
```

### Consultar Pagamento

[](#consultar-pagamento)

```
$responsePayment = $ipagClient->payment()->getById($transactionId);
```

```
$responsePayment = $ipagClient->payment()->getByUuid($transactionUuid);
```

```
$responsePayment = $ipagClient->payment()->getByUuid($transactionTid);
```

```
$responsePayment = $ipagClient->payment()->getByUuid($orderId);
```

### Capturar Pagamento

[](#capturar-pagamento)

```
$responsePayment = $ipagClient->payment()->captureById($transactionId, $amount);
```

ou

```
$responsePayment = $ipagClient->payment()->captureByUuid($transactionUuid, $amount);
```

ou

```
$responsePayment = $ipagClient->payment()->captureByUuid($transactionTid, $amount);
```

ou

```
$responsePayment = $ipagClient->payment()->captureByUuid($orderId, $amount);
```

### Cancelar Pagamento

[](#cancelar-pagamento)

```
$responsePayment = $ipagClient->payment()->cancelById($transactionId, $amount);
```

ou

```
$responsePayment = $ipagClient->payment()->cancelByUuid($transactionUuid, $amount);
```

ou

```
$responsePayment = $ipagClient->payment()->cancelByUuid($transactionTid, $amount);
```

ou

```
$responsePayment = $ipagClient->payment()->cancelByUuid($orderId, $amount);
```

> Todos os exemplos: [examples/payment/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/payment/)

Cliente (Customer)
==================

[](#cliente-customer)

```
$customer = new \Ipag\Sdk\Model\Customer([
    'name' => 'Bruce Wayne',
    'email' => 'brucewayne@email.com',
    'cpf_cnpj' => '490.558.550-30',
    'phone' => '(22) 2222-33333',
    'business_name' => 'Wayne Enterprises',
    'birthdate' => '1987-02-19',
    'address' => [
        'street' => 'Avenida Principal',
        'number' => '12345',
        'district' => 'São Paulo',
        'city' => 'São Paulo',
        'state' => 'SP',
        'zipcode' => '01310-000'
    ]
]);
```

ou

```
$customer = new \Ipag\Sdk\Model\Customer()
    ->setName('Bruce Wayne')
    ->setEmail('brucewayne@email.com')
    ->setCpfCnpj('490.558.550-30')
    ->setPhone('(22) 2222-33333')
    ->setBusinessName('Wayne Enterprises')
    ->setAddress(
        new \Ipag\Sdk\Model\Address()
            ->setStreet('Avenida Paulista')
            ->setNumber('12345')
            ->setDistrict('São Paulo')
            ->setCity('São Paulo')
            ->setState('SP')
            ->setZipcode('01310-000')
);
```

### Novo Cliente

[](#novo-cliente)

```
$responseCustomer = $ipagClient->customer()->create($customer);
```

### Alterar Cliente

[](#alterar-cliente)

```
$responseCustomer = $ipagClient->customer()->update($customer, $customerId);
```

### Obter Cliente

[](#obter-cliente)

```
$responseCustomer = $ipagClient->customer()->get($customerId);
```

### Listar Clientes

[](#listar-clientes)

```
$responseCustomer = $ipagClient->customer()->list([
    'name' => 'wayne'
]);
```

### Deletar Cliente

[](#deletar-cliente)

```
$responseCustomer = $ipagClient->customer()->delete($customerId);
```

> Todos os exemplos: [examples/customer/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/customer/)

Plano de Assinatura (Subscription Plan)
=======================================

[](#plano-de-assinatura-subscription-plan)

```
$subscriptionPlan = new \Ipag\Sdk\Model\SubscriptionPlan([
    'name' => 'PLANO GOLD',
    'description' => 'Plano Gold com até 4 treinos por semana',
    'amount' => 100,
    'frequency' => Ipag\Sdk\Core\Enums\Interval::MONTHLY,
    'interval' => 1,
    'cycles' => 0,
    'best_day' => true,
    'pro_rated_charge' => true,
    'grace_period' => 0,
    'callback_url' => 'https://ipag-sdk.requestcatcher.com/callback',
    'installments' => 1,
    'trial' => [
        'amount' => 0,
        'cycles' => 0
    ]
]);
```

ou

```
$subscriptionPlan = new \Ipag\Sdk\Model\SubscriptionPlan()
    ->setName("PLANO GOLD")
    ->setDescription("Plano Gold com até 4 treinos por semana")
    ->setAmount(100)
    ->setFrequency(Ipag\Sdk\Core\Enums\Interval::MONTHLY)
    ->setInterval(1)
    ->setCycles(0)
    ->setBestDay(true)
    ->setProRatedCharge(true)
    ->setGracePeriod(0)
    ->setCallbackUrl("https://ipag-sdk.requestcatcher.com/callback")
    ->setInstallments(1)
    ->setTrial(
        new \Ipag\Sdk\Model\Trial()
            ->setAmount(0)
            ->setCycles(0)
);
```

### Novo Plano de Assinatura

[](#novo-plano-de-assinatura)

```
$responseSubscriptionPlan = $ipagClient->subscriptionPlan()->create($subscriptionPlan);
```

### Alterar Plano de Assinatura

[](#alterar-plano-de-assinatura)

```
$responseSubscriptionPlan = $ipagClient->subscriptionPlan()->update($subscriptionPlan, $subscriptionPlanId);
```

### Obter Plano de Assinatura

[](#obter-plano-de-assinatura)

```
$responseSubscriptionPlan = $ipagClient->subscriptionPlan()->get($subscriptionPlanId);
```

### Listar Planos de Assinatura

[](#listar-planos-de-assinatura)

```
$responseSubscriptionPlan = $ipagClient->subscriptionPlan()->list([
    'name' => 'GOLD',
]);
```

### Deletar Plano de Assinatura

[](#deletar-plano-de-assinatura)

```
$ipagClient->subscriptionPlan()->delete($subscriptionPlanId);
```

> Todos os exemplos: [examples/subscription\_plan/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/subscription_plan/)

Assinatura (Subscription)
=========================

[](#assinatura-subscription)

```
$subscription = new \Ipag\Sdk\Model\Subscription([
    'is_active' => true,
    'profile_id' => 'SUB_01',
    'plan_id' => 1,
    'customer_id' => 100001,
    'starting_date' => '2021-07-11',
    'closing_date' => '2021-08-11',
    'callback_url' => 'https://ipag-sdk.requestcatcher.com/callback',
    'creditcard_token' => '123'
]);
```

ou

```
$subscription = new \Ipag\Sdk\Model\Subscription()
    ->setIsActive(true)
    ->setProfileId('SUB_001')
    ->setPlanId(1)
    ->setCustomerId(100001)
    ->setStartingDate('2021-07-11')
    ->setClosingDate('2021-08-11')
    ->setCallbackUrl('https://ipag-sdk.requestcatcher.com/callback')
    ->setCreditcardToken('123');
```

### Nova Assinatura

[](#nova-assinatura)

```
$responseSubscription = $ipagClient->subscription()->create($subscription);
```

### Alterar Assinatura

[](#alterar-assinatura)

```
$responseSubscription = $ipagClient->subscription()->update($subscription, $subscriptionId);
```

### Obter Assinatura

[](#obter-assinatura)

```
$responseSubscription = $ipagClient->subscription()->get($subscriptionId);
```

### Listar Assinaturas

[](#listar-assinaturas)

```
$responseSubscription = $ipagClient->subscription()->list([
    'is_active' => true,
]);
```

### Desvincular Token da Assinatura

[](#desvincular-token-da-assinatura)

```
$responseSubscription = $ipagClient->subscription()->unlinkToken($subscriptionId);
```

### Quitar Parcela da Assinatura

[](#quitar-parcela-da-assinatura)

```
$responseSubscription = $ipagClient->subscription()->payOffInstallment($subscriptionId, $invoiceNumber);
```

### Agendar Parcelamento da Assinatura

[](#agendar-parcelamento-da-assinatura)

```
$responseSubscription = $ipagClient->subscription()->scheduleInstallmentPayment($subscriptionId, $invoiceNumber);
```

> Todos os exemplos: [examples/subscription/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/subscription/)

Transação (Transaction)
=======================

[](#transação-transaction)

### Obter Transação

[](#obter-transação)

```
$responseTransaction = $ipagClient->transaction()->get($transactionId);
```

### Listar Transações

[](#listar-transações)

```
$responseTransaction = $ipagClient->transaction()->list([
    'order' => 'desc',
    'from_date' => '2023-08-29'
]);
```

### Liberar Recebíveis da Transação

[](#liberar-recebíveis-da-transação)

```
$responseTransaction = $client->transaction()->releaseReceivables($sellerId, $transactionId);
```

> Todos os exemplos: [examples/transaction/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/transaction/)

Token (Card Token)
==================

[](#token-card-token)

```
$token = new \Ipag\Sdk\Model\Token([
    'card' => [
        'holderName' => 'Bruce Wayne',
        'number' => '4111 1111 1111 1111',
        'expiryMonth' => '01',
        'expiryYear' => '2025',
        'cvv' => '123'
    ],
    'holder' => [
        'name' => 'Bruce Wayne',
        'cpfCnpj' => '490.558.550-30',
        'mobilePhone' => '(22) 2222-33333',
        'birthdate' => '1987-02-19',
        'address' => [
                'street' => 'Avenida Principal',
                'number' => '12345',
                'complement' => 'Sala 02',
                'district' => 'São Paulo',
                'city' => 'São Paulo',
                'state' => 'SP',
                'zipcode' => '01310-000'
            ]
    ]
]);
```

ou

```
$token = (new \Ipag\Sdk\Model\Token())
    ->setCard(
        (new \Ipag\Sdk\Model\Card())
            ->setHolderName('Bruce Wayne')
            ->setNumber('4111 1111 1111 1111')
            ->setExpiryMonth('01')
            ->setExpiryYear('2025')
            ->setCvv('123')
    )
    ->setHolder(
        (new \Ipag\Sdk\Model\Holder())
            ->setName('Bruce Wayne')
            ->setCpfCnpj('490.558.550-30')
            ->setMobilePhone('(22) 2222-33333')
            ->setBirthdate('1987-02-19')
            ->setAddress(
                new \Ipag\Sdk\Model\Address()
                    ->setStreet('Avenida Principal')
            )
    );
```

### Novo Token

[](#novo-token)

```
$responseToken = $ipagClient->token()->create($token);
```

### Obter Token

[](#obter-token)

```
$responseToken = $ipagClient->token()->get($tokenValue);
```

> Todos os exemplos: [examples/token/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/token/)

Cobrança (Charge)
=================

[](#cobrança-charge)

```
$charge = new \Ipag\Sdk\Model\Charge([
    'amount' => 100,
    'description' => 'Cobrança referente a negociação de débito pendente na Empresa X',
    'due_date' => '2020-10-30',
    'frequency' => 1,
    'interval' => Ipag\Sdk\Core\Enums\Interval::MONTH,
    'type' => 'charge',
    'last_charge_date' => '2020-10-30',
    'callback_url' => 'https://ipag-sdk.requestcatcher.com/callback',
    'auto_debit' => false,
    'installments' => 12,
    'is_active' => true,
    'products' => [1, 2, 3],
    'customer' => [
        'name' => 'Bruce Wayne',
    ],
    'checkout_settings' => [
        'max_installments' => 12,
    ]
]);
```

ou

```
$charge = (new \Ipag\Sdk\Model\Charge())
    ->setAmount(100)
    ->setDescription('Cobrança referente a negociação de débito pendente na Empresa X')
    ->setDueDate('2020-10-30')
    ->setFrequency(1)
    ->setInterval(Ipag\Sdk\Core\Enums\Interval::MONTH)
    ->setType('charge')
    ->setLastChargeDate('2020-10-30')
    ->setCallbackUrl('https://ipag-sdk.requestcatcher.com/callback')
    ->setAutoDebit(false)
    ->setInstallments(12)
    ->setIsActive(true)
    ->setProducts([1, 2, 3])
    ->setCustomer(
        (new \Ipag\Sdk\Model\Customer())
            ->setName('Bruce Wayne')
    )
    ->setCheckoutSettings(
        (new \Ipag\Sdk\Model\CheckoutSettings())
            ->setMaxInstallments(12)
    );
```

### Nova Cobrança

[](#nova-cobrança)

```
$responseCharge = $ipagClient->charge()->create($charge);
```

### Alterar Cobrança

[](#alterar-cobrança)

```
$responseCharge = $ipagClient->charge()->update($charge, $chargeId);
```

### Obter Cobrança

[](#obter-cobrança)

```
$responseCharge = $ipagClient->charge()->get($chargeId);
```

### Listar Cobranças

[](#listar-cobranças)

```
$responseCharge = $ipagClient->charge()->list([
    'is_active' => false,
]);
```

> Todos os exemplos: [examples/charge/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/charge/)

Estabelecimento (Establishment)
===============================

[](#estabelecimento-establishment)

```
$establishment = new \Ipag\Sdk\Model\Establishment([
    'name' => 'Bruce Wayne',
    'email' => 'brucewayne@email.com',
    'login' => 'wayne1',
    'password' => 'bat123',
    'document' => '490.558.550-30',
    'phone' => '(22) 2222-33333',
    'address' =>
        [
            'street' => 'Avenida Principal',
        ],
    'owner' => [
        'name' => 'Bruce Wayne',
    ],
    'bank' => [
        'code' => '999'
    ]
]);
```

ou

```
$establishment = (new \Ipag\Sdk\Model\Establishment())
    ->setName('Bruce Wayne')
    ->setEmail('brucewayne@email.com')
    ->setLogin('wayne1')
    ->setPassword('bat123')
    ->setPhone('(22) 2222-33333')
    ->setDocument('490.558.550-30')
    ->setAddress(new \Ipag\Sdk\Model\Address())
    ->setOwner(new \Ipag\Sdk\Model\Owner())
    ->setBank(new \Ipag\Sdk\Model\Bank());
```

### Novo Estabelecimento

[](#novo-estabelecimento)

```
$responseEstablishment = $ipagClient->establishment()->create($establishment);
```

### Alterar Estabelecimento

[](#alterar-estabelecimento)

```
$responseEstablishment = $ipagClient->establishment()->update($establishment, $establishmentTid);
```

### Obter Estabelecimento

[](#obter-estabelecimento)

```
$responseEstablishment = $ipagClient->establishment()->get($establishmentTid);
```

### Listar Estabelecimentos

[](#listar-estabelecimentos)

```
$responseEstablishment = $ipagClient->establishment()->list();
```

Transações (Transactions)
-------------------------

[](#transações-transactions)

### Listar todas Transações dos Estabelecimentos

[](#listar-todas-transações-dos-estabelecimentos)

```
$responseTransactions = $ipagClient->establishment()->transaction()->list();
```

### Listar Transações dos Estabelecimentos

[](#listar-transações-dos-estabelecimentos)

```
$responseTransactions = $ipagClient->establishment()->transaction()->listByEstablishment($establishmentTid);
```

### Obter Transação de um Estabelecimento

[](#obter-transação-de-um-estabelecimento)

```
$responseTransactions = $ipagClient->establishment()->transaction()->getByEstablishment($establishmentTid, $transactionTid);
```

Métodos de Pagamento (Payment Methods)
--------------------------------------

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

```
$paymentMethod = new \Ipag\Sdk\Model\PaymentMethod([
    'acquirer' => 'stone',
    'priority' => 100,
    'environment' => 'test',
    'capture' => true,
    'retry' => true,
    'credentials' =>
        (
            (new Ipag\Sdk\Support\Credentials\PaymentMethods\StoneCredentials())
                ->setStoneCode('xxxxx')
                ->setStoneSak('xxxxxx')
        )->jsonSerialize(),
]);
```

### Configurar Métodos de Pagamento

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

```
$responseConfig = $ipagClient
    ->establishment()
    ->paymentMethods()
    ->config($paymentMethod, $establishmentTid);
```

Antifraudes (Antifraud)
-----------------------

[](#antifraudes-antifraud)

```
$antifraud = new \Ipag\Sdk\Model\Antifraud(
    [
        'provider' => (
            new Ipag\Sdk\Support\Provider\Antifraudes\RedShieldProvider([
                'token' => 'xxxxxxxx',
                'entityId' => 'xxxxxxxx',
                'channelId' => 'xxxxxxxx',
                'serviceId' => 'xxxxxxxx'
            ])
        )->jsonSerialize(),
        'settings' => [
            'enable' => true,
            'environment' => 'test',
            'consult_mode' => 'auto',
            'capture_on_approval' => false,
            'cancel_on_refused' => true,
            'review_score_threshold' => 0.8
        ]
    ]
);
```

### Configurar Antifraudes

[](#configurar-antifraudes)

```
$responseConfig = $ipagClient
    ->establishment()
    ->antifraud()
    ->config($antifraud, $establishmentTid);
```

> Todos os exemplos: [examples/establishment/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/establishment/)

Regra de Split (Split Rules)
============================

[](#regra-de-split-split-rules)

```
$splitRules = new \Ipag\Sdk\Model\SplitRules([
    'receiver_id' => '1000000',
    'percentage' => 10.00
]);
```

ou

```
$splitRules = (new \Ipag\Sdk\Model\SplitRules())
    ->setReceiverId('1000000')
    ->setPercentage(10);
```

### Nova Regra de Split

[](#nova-regra-de-split)

```
$responseSplitRules = $ipagClient->splitRules()->create($splitRules, $transactionId);
```

### Obter Regra de Split

[](#obter-regra-de-split)

```
$responseSplitRules = $ipagClient->splitRules()->get($splitRuleId, $transactionId);
```

### Listar Regras de Split

[](#listar-regras-de-split)

```
$responseSplitRules = $ipagClient->splitRules()->list($transactionId);
```

### Deletar Regra de Split

[](#deletar-regra-de-split)

```
$responseSplitRules = $ipagClient->splitRules()->delete($splitRuleId, $transactionId);
```

> Todos os exemplos: [examples/split\_rules/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/split_rules/)

Vendedor (Seller)
=================

[](#vendedor-seller)

```
$seller = new \Ipag\Sdk\Model\Seller([
    'login' => 'jimgordon',
    'password' => 'jim123',
    'name' => 'Jim Gordon',
    'cpf_cnpj' => '168.853.290-02',
    'email' => 'jimgordon@email.com',
    'phone' => '(11) 3333-44444',
    'description' => '',
    'address' => [
        'street' => 'Avenida Principal',
        'number' => '12345',
        'district' => 'São Paulo',
        'city' => 'São Paulo',
        'state' => 'SP',
        'zipcode' => '01310-000'
    ],
    'owner' => [
        'name' => 'Bruce Wayne',
        'email' => 'brucewayne@email.com',
        'cpf' => '490.558.550-30',
        'phone' => '(22) 2222-33333',
        'birthdate' => '1987-02-19',
    ],
    'bank' => [
        'code' => '999',
        'agency' => '1234',
        'account' => '54321',
        'type' => 'checkings',
        'external_id' => '1',
    ]
]);
```

ou

```
$seller = (new \Ipag\Sdk\Model\Seller())
    ->setLogin('jimgordon')
    ->setPassword('jim123')
    ->setName('Jim Gordon')
    ->setCpfCnpj('168.853.290-02')
    ->setEmail('jimgordon@email.com')
    ->setPhone('(11) 3333-44444')
    ->setDescription('')
    ->setAddress(
        (new \Ipag\Sdk\Model\Address())
            ->setStreet('Avenida Principal')
    )
    ->setOwner(
        (new \Ipag\Sdk\Model\Owner())
            ->setName('Bruce Wayne')
    )
    ->setBank(
        (new \Ipag\Sdk\Model\Bank())
            ->setCode('999')
    );
```

### Novo Vendedor

[](#novo-vendedor)

```
$responseSeller = $ipagClient->seller()->create($seller);
```

### Alterar Vendedor

[](#alterar-vendedor)

```
$responseSeller = $ipagClient->seller()->update($seller, $sellerId);
```

### Obter Vendedor

[](#obter-vendedor)

```
$responseSeller = $ipagClient->seller()->get($sellerId);
```

### Listar Vendedores

[](#listar-vendedores)

```
$responseSellers = $ipagClient->seller()->list();
```

> Todos os exemplos: [examples/seller/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/seller/)

Transferência (Transfer)
========================

[](#transferência-transfer)

### Listar Transferências

[](#listar-transferências)

```
$responseTransfers = $ipagClient->transfer()->list();
```

### Obter Transferência

[](#obter-transferência)

```
$responseTransfers = $ipagClient->transfer()->get($transferId);
```

Transferência dos Vendedores (Sellers Transfers)
------------------------------------------------

[](#transferência-dos-vendedores-sellers-transfers)

### Listar Transferências dos Vendedores

[](#listar-transferências-dos-vendedores)

```
$responseTransfers = $ipagClient->transfer()->seller()->list();
```

### Obter Transferência de Vendedor

[](#obter-transferência-de-vendedor)

```
$responseTransfers = $ipagClient->transfer()->seller()->get($transferId);
```

Lançamentos Futuros (Future Transfers)
--------------------------------------

[](#lançamentos-futuros-future-transfers)

### Listar Lançamentos Futuros

[](#listar-lançamentos-futuros)

```
$responseTransfers = $ipagClient->transfer()->future()->list();
```

### Listar Lançamentos Futuros de Vendedor (Por Id)

[](#listar-lançamentos-futuros-de-vendedor-por-id)

```
$responseTransfers = $ipagClient->transfer()->future()->listBySellerId($sellerId);
```

### Listar Lançamentos Futuros de Vendedor (Por CPF/CNPJ)

[](#listar-lançamentos-futuros-de-vendedor-por-cpfcnpj)

```
$responseTransfers = $ipagClient->transfer()->future()->listBySellerCpfCnpj($sellerCpf);
```

> Todos os exemplos: [examples/transfer/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/transfer/)

Link de Pagamento (Payment Links)
=================================

[](#link-de-pagamento-payment-links)

```
$paymentLink = new \Ipag\Sdk\Model\PaymentLink([
    'externalCode' => '131',
    'amount' => 0,
    'description' => 'LINK DE PAGAMENTO SUPER BACANA',
    'expireAt' => '2020-12-30 23:00:00',
    'buttons' => [
        'enable' => false,
    ],
    'checkout_settings' => [
        'max_installments' => 12,
    ],
]);
```

ou

```
$paymentLink = (new \Ipag\Sdk\Model\PaymentLink())
    ->setExternalCode('131')
    ->setAmount(0)
    ->setDescription('LINK DE PAGAMENTO SUPER BACANA')
    ->setExpireAt('2020-12-30 23:00:00')
    ->setButtons(
        (new \Ipag\Sdk\Model\Buttons())
            ->setEnable(false)
    )
    ->setCheckoutSettings(
        (new \Ipag\Sdk\Model\CheckoutSettings())
            ->setMaxInstallments(12)
    );
```

### Novo Link de Pagamento

[](#novo-link-de-pagamento)

```
$responsePaymentLink = $ipagClient->paymentLinks()->create($paymentLink);
```

### Alterar Link de Pagamento

[](#alterar-link-de-pagamento)

```
$responsePaymentLink = $ipagClient->paymentLinks()->update($paymentLink, $paymentLinkId);
```

### Obter Link de Pagamento (Por Id)

[](#obter-link-de-pagamento-por-id)

```
$responsePaymentLink = $ipagClient->paymentLinks()->getById($paymentLinkId);
```

### Obter Link de Pagamento (Por External Code)

[](#obter-link-de-pagamento-por-external-code)

```
$responsePaymentLink = $ipagClient->paymentLinks()->getByExternalCode($externalCode);
```

> Todos os exemplos: [examples/payment\_links/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/payment_links/)

Webhook
=======

[](#webhook)

```
$webhook = new \Ipag\Sdk\Model\Webhook([
    'http_method' => 'POST',
    'url' => 'https://ipag-sdk.requestcatcher.com/webhook',
    'description' => 'Webhook para receber notificações de atualização das transações',
    'actions' => [
        \Ipag\Sdk\Core\Enums\Webhooks::PAYMENT_LINK_PAYMENT_SUCCEEDED,
        \Ipag\Sdk\Core\Enums\Webhooks::PAYMENT_LINK_PAYMENT_FAILED,
    ]
]);
```

ou

```
$webhook = (new \Ipag\Sdk\Model\Webhook())
    ->setHttpMethod('POST')
    ->setUrl('https://ipag-sdk.requestcatcher.com/webhook')
    ->setDescription('Webhook para receber notificações de atualização das transações')
    ->setActions([
        \Ipag\Sdk\Core\Enums\Webhooks::PAYMENT_LINK_PAYMENT_SUCCEEDED,
        \Ipag\Sdk\Core\Enums\Webhooks::PAYMENT_LINK_PAYMENT_FAILED,
    ]);
```

### Novo Webhook

[](#novo-webhook)

```
$responseWebhook = $ipagClient->webhook()->create($webhook);
```

### Obter Webhook

[](#obter-webhook)

```
$responseWebhook = $ipagClient->webhook()->get($webhookId);
```

### Listar Webhooks

[](#listar-webhooks)

```
$responseWebhook = $ipagClient->webhook()->list();
```

### Deletar Webhook

[](#deletar-webhook)

```
$ok = $ipagClient->webhook()->delete($webhookId);
```

> Todos os exemplos: [examples/webhook/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/webhook/)

Checkout
========

[](#checkout)

```
$checkout = new \Ipag\Sdk\Model\Checkout([
    'customer' => [
        'name' => 'Bruce Wayne',
        'tax_receipt' => '490.558.550-30',
        'email' => 'brucewayne@email.com',
        'phone' => '(22) 2222-33333',
        'birthdate' => '1987-02-19',
        'address' => [
            'street' => 'Avenida Principal',
            'number' => '12345',
            'district' => 'São Paulo',
            'city' => 'São Paulo',
            'state' => 'SP',
            'zipcode' => '01310-000'
        ]
    ],
    'installment_setting' => [
        'max_installments' => 12,
        'min_installment_value' => 5,
        'interest' => 0,
        'interest_free_installments' => 12
    ],
    'order' => [
        'order_id' => '100001',
        'amount' => '15.00',
        'return_url' => 'https://ipag-sdk.requestcatcher.com/callback',
        'return_type' => 'json'
    ],
    'products' => [
        [
            'name' => 'Smart TV LG 55 4K UHD',
            'unit_price' => 5000,
            'quantity' => 1,
            'sku' => 'LG123',
            'description' => 'Experiência cristalina em 4K.'
        ],
        [
            'name' => 'LED Android TV 4K UHD LED',
            'unit_price' => 5000,
            'quantity' => 1,
            'sku' => 'SAM123',
            'description' => 'Android TV de 126 cm (50).'
        ],
    ],
    'split_rules' => [
        [
            'receiver' => 'qwertyuiopasdfghjklzxcvbnm123456',
            'percentage' => '50',
            'charge_processing_fee' => true,
        ],
        [
            'receiver' => '654321mnbvcxzlkjhgfdsapoiuytrewq',
            'percentage' => '20'
        ]
    ],
    'sellerId' => '100014',
    'expires_in' => 60,
]);
```

ou

```
$checkout = (new \Ipag\Sdk\Model\Checkout())
    ->setCustomer(
        (new \Ipag\Sdk\Model\Customer())
            ->setName('Bruce Wayne')
    )
    ->setInstallmentSetting(
        (new \Ipag\Sdk\Model\InstallmentSetting())
            ->setMaxInstallments(12)
    )
    ->setOrder(
        (new \Ipag\Sdk\Model\Order())
            ->setOrderId('1000001')
    )
    ->addProduct(
        (new \Ipag\Sdk\Model\Product())
            ->setName('Smart TV LG 55 4K UHD')
    )
    ->addProduct(
        (new \Ipag\Sdk\Model\Product())
            ->setName('Smart TV 50" UHD 4K')
    )
    ->addSplitRule(
        (new \Ipag\Sdk\Model\SplitRules())
            ->setReceiverId('1000000')
    )
    ->addSplitRule(
        (new \Ipag\Sdk\Model\SplitRules())
            ->setReceiverId('1000001')
    )
    ->setSellerId('100014')
    ->setExpiresIn(60);
```

### Novo Checkout

[](#novo-checkout)

```
$responseCheckout = $ipagClient->checkout()->create($checkout);
```

> Todos os exemplos: [examples/checkout/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/checkout/)

Voucher
=======

[](#voucher)

```
$voucher = new \Ipag\Sdk\Model\Voucher([
    'order' => [
        'order_id' => '100015',
        'amount' => 100,
        'created_at' => '2020-08-04 21:45:10',
        'callback_url' => 'https://ipag-sdk.requestcatcher.com/callback'
    ],
    'seller' => [
        'cpf_cnpj' => '168.853.290-02',
    ],
    'customer' => [
        'name' => 'Jim Gordon',
        'cpf_cnpj' => '168.853.290-02',
        'email' => 'jimgordon@email.com',
        'phone' => '(11) 3333-44444',
        'birthdate' => '1990-10-10',
        'address' => [
            'street' => 'Avenida Principal',
            'number' => '12345',
            'district' => 'São Paulo',
            'city' => 'São Paulo',
            'state' => 'SP',
            'zipcode' => '01310-000'
        ]
    ]
]);
```

ou

```
$voucher = (new \Ipag\Sdk\Model\Voucher())
    ->setOrder(
        (new \Ipag\Sdk\Model\Order())
            ->setOrderId(
                '1000001'
            )
    )
    ->setSeller(
        (new \Ipag\Sdk\Model\Seller())
            ->setCpfCnpj(
                '168.853.290-02'
            )
    )
    ->setCustomer(
        (new \Ipag\Sdk\Model\Customer())
            ->setName(
                'Jim Gordon'
            )
            ->setAddress(
                (new \Ipag\Sdk\Model\Address())
                    ->setStreet('Avenida Principal')
            )
    );
```

### Novo Voucher

[](#novo-voucher)

```
$responseVoucher = $ipagClient->voucher()->create($voucher);
```

> Todos os exemplos: [examples/voucher/](https://github.com/ipagdevs/ipag-sdk-php/tree/master/examples/voucher/)

Helpers
=======

[](#helpers)

Credenciais dos Provedores de Antifraudes
-----------------------------------------

[](#credenciais-dos-provedores-de-antifraudes)

### Clear Sale

[](#clear-sale)

```
$clearSaleCredentials = (new \Ipag\Sdk\Support\Credentials\Antifraudes\ClearSaleCredentials())
    ->setName('XXXXX')
    ->setPassword('XXXXXXXX');
```

### Konduto

[](#konduto)

```
$kondutoCredentials = (new \Ipag\Sdk\Support\Credentials\Antifraudes\KondutoCredentials())
    ->setApiKey('XXXXX')
    ->setPublicKey('XXXXXXXX');
```

### Red Shield

[](#red-shield)

```
$redShieldCredentials = (new \Ipag\Sdk\Support\Credentials\Antifraudes\RedShieldCredentials())
    ->setToken('XXXXX')
    ->setEntityId('XXX')
    ->setChannelId('XXXXX')
    ->setServiceId('XX');
```

Credenciais dos Provedores de Meios de Pagamentos
-------------------------------------------------

[](#credenciais-dos-provedores-de-meios-de-pagamentos)

### Adiq

[](#adiq)

```
$adiqCredentials = (new \Ipag\Sdk\Support\Credentials\PaymentMethods\AdiqCredentials())
    ->setClientId('XXXXX')
    ->setClientSecret('XXXXXXXX');
```

### Bin

[](#bin)

```
$binCredentials = (new \Ipag\Sdk\Support\Credentials\PaymentMethods\BinCredentials())
    ->setStoreIdSubscription('XXXXX')
    ->setStoreId('XXXXXXXX');
```

### Cielo

[](#cielo)

```
$cieloCredentials = (new \Ipag\Sdk\Support\Credentials\PaymentMethods\CieloCredentials())
    ->setMerchantId('XXXXX')
    ->setMerchantKey('XXXXXXXX');
```

### Getnet

[](#getnet)

```
$getnetCredentials = (new \Ipag\Sdk\Support\Credentials\PaymentMethods\GetnetCredentials())
    ->setEstablishmentNumber('XXX')
    ->setKey('XXXXXXXX')
    ->setUser('XXX')
    ->setPassword('XXXXX');
```

### Global Payments

[](#global-payments)

```
$globalPaymentsCredentials = (new \Ipag\Sdk\Support\Credentials\PaymentMethods\GlobalPaymentsCredentials())
    ->setTerminal('XXXXX')
    ->setMerchantId('XXX')
    ->setMerchantKey('XXXXXXXX');
```

### Rede

[](#rede)

```
$redeCredentials = (new \Ipag\Sdk\Support\Credentials\PaymentMethods\RedeCredentials())
    ->setEredeKey('XXXXXXXX')
    ->setPv('XXXXX');
```

### Sipag

[](#sipag)

```
$sipagCredentials = (new \Ipag\Sdk\Support\Credentials\PaymentMethods\SipagCredentials())
    ->setStoreIdSubscription('XXXXXXXX')
    ->setStoreId('XXXXX');
```

### Stone

[](#stone)

```
$stoneCredentials = (new \Ipag\Sdk\Support\Credentials\PaymentMethods\StoneCredentials())
    ->setStoneCode('XXXXX')
    ->setStoneSak('XXXXXXXX');
```

### Zoop

[](#zoop)

```
$zoopCredentials = (new \Ipag\Sdk\Support\Credentials\PaymentMethods\ZoopCredentials())
    ->setMarketplaceId('XXX')
    ->setPublishableKey('XXXXXXXX')
    ->setSellerId('XXXXX');
```

Testes
======

[](#testes)

É necessário a instalação do PHPUnit para a realização dos testes.

Licença
=======

[](#licença)

[The MIT License](https://github.com/ipagdevs/ipag-sdk-php/blob/master/LICENSE)

Documentação
============

[](#documentação)

[Documentação Oficial](https://developers.ipag.com.br)

Dúvidas & Sugestões
=======================

[](#dúvidas--sugestões)

Em caso de dúvida ou sugestão para o SDK abra uma nova [Issue](https://github.com/ipagdevs/ipag-sdk-php/issues).

###  Health Score

30

—

LowBetter than 65% of packages

Maintenance50

Moderate activity, may be stable

Popularity9

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 85.3% 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 ~137 days

Total

4

Last Release

352d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/659c79a662c10f22ac99b45ae14661511ddf93c8e530e95cca2fbcd95365f0da?d=identicon)[webflixtec](/maintainers/webflixtec)

---

Top Contributors

[![lcsLucas](https://avatars.githubusercontent.com/u/28931052?v=4)](https://github.com/lcsLucas "lcsLucas (81 commits)")[![jhernandes](https://avatars.githubusercontent.com/u/6430761?v=4)](https://github.com/jhernandes "jhernandes (6 commits)")[![webflixtec](https://avatars.githubusercontent.com/u/154339257?v=4)](https://github.com/webflixtec "webflixtec (6 commits)")[![ceresaconsultoria](https://avatars.githubusercontent.com/u/56128744?v=4)](https://github.com/ceresaconsultoria "ceresaconsultoria (1 commits)")[![Kubinyete](https://avatars.githubusercontent.com/u/23388918?v=4)](https://github.com/Kubinyete "Kubinyete (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/webflixtec-sdk-php-ipag/health.svg)

```
[![Health](https://phpackages.com/badges/webflixtec-sdk-php-ipag/health.svg)](https://phpackages.com/packages/webflixtec-sdk-php-ipag)
```

###  Alternatives

[civicrm/civicrm-core

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

728272.9k17](/packages/civicrm-civicrm-core)[drupal/core

Drupal is an open source content management platform powering millions of websites and applications.

19462.3M1.3k](/packages/drupal-core)[theodo-group/llphant

LLPhant is a library to help you build Generative AI applications.

1.5k311.5k5](/packages/theodo-group-llphant)[tempest/framework

The PHP framework that gets out of your way.

2.1k23.1k9](/packages/tempest-framework)[akamai-open/edgegrid-client

Implements the Akamai {OPEN} EdgeGrid Authentication specified by https://developer.akamai.com/introduction/Client\_Auth.html

482.5M6](/packages/akamai-open-edgegrid-client)[rareloop/lumberjack-core

A powerful MVC framework for the modern WordPress developer. Write better, more expressive and easier to maintain code

42155.0k19](/packages/rareloop-lumberjack-core)

PHPackages © 2026

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