PHPackages jhernandes/ipag-sdk-php - 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. jhernandes/ipag-sdk-php ActiveLibrary jhernandes/ipag-sdk-php ======================= Pacote de integração para o iPag 1.0 em PHP v1.2.0(5mo ago)719.8k↑257.1%41MITPHPPHP >=5.6CI failing Since Jan 10Pushed 5mo ago1 watchersCompare [ Source](https://github.com/jhernandes/ipag-sdk-php)[ Packagist](https://packagist.org/packages/jhernandes/ipag-sdk-php)[ Docs](https://github.com/jhernandes/ipag-sdk-php)[ RSS](/packages/jhernandes-ipag-sdk-php/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (2)Versions (34)Used By (1) iPag PHP client SDK =================== [](#ipag-php-client-sdk) AVISO - SDK Abandonado ---------------------- [](#aviso---sdk-abandonado) Este SDK foi abandonado e não será mais mantido. Para utilizar o iPag em sua loja, utilize através do projeto oficial do iPag: [ipag-sdk-php](https://github.com/ipagdevs/ipag-sdk-php). Não há necessidade de migrar seu projeto atual para o novo SDK, pois este ainda ficará disponível para uso. Mas se for iniciar um novo projeto, utilize o SDK oficial. ### SDK Status [](#sdk-status) [![Scrutinizer Code Quality](https://camo.githubusercontent.com/5f648d0d3fd91f1cae51c39554734be37cdd17ce174c5074ecb3d909e84f30f8/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6a6865726e616e6465732f697061672d73646b2d7068702f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/jhernandes/ipag-sdk-php/?branch=master)[![Maintainability](https://camo.githubusercontent.com/6645e9170951218cbf38566a969d210e247c7055e6788c7f6ad1e052d403edb4/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f61326361376637393761633666313038343132392f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/jhernandes/ipag-sdk-php/maintainability) [![Build Status](https://camo.githubusercontent.com/b3699e4e4872a4b2af3adb96978a52ce49c21de18c1c2a67fc08482c4b6ca1e2/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6a6865726e616e6465732f697061672d73646b2d7068702f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/jhernandes/ipag-sdk-php/build-status/master) ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [](#) **Índice** - [iPag PHP client SDK](#ipag-php-client-sdk) - [AVISO - SDK Abandonado](#aviso---sdk-abandonado) - [SDK Status](#sdk-status) - [](#) - [Dependências](#depend%C3%AAncias) - [Instalação](#instala%C3%A7%C3%A3o) - [Autenticação](#autentica%C3%A7%C3%A3o) - [Por Basic Auth](#por-basic-auth) - [Cliente](#cliente) - [Dados do Cliente](#dados-do-cliente) - [Cartão de Crédito/Débito](#cart%C3%A3o-de-cr%C3%A9ditod%C3%A9bito) - [Dados do Cartão de Crédito/Débito](#dados-do-cart%C3%A3o-de-cr%C3%A9ditod%C3%A9bito) - [Carrinho](#carrinho) - [Adicionando Produtos](#adicionando-produtos) - [Transação (Pagamento)](#transa%C3%A7%C3%A3o-pagamento) - [Transação com Cartão de Crédito](#transa%C3%A7%C3%A3o-com-cart%C3%A3o-de-cr%C3%A9dito) - [Transação com Token de Cartão de Crédito](#transa%C3%A7%C3%A3o-com-token-de-cart%C3%A3o-de-cr%C3%A9dito) - [Transação com Boleto](#transa%C3%A7%C3%A3o-com-boleto) - [Transação com Pix](#transa%C3%A7%C3%A3o-com-pix) - [Consulta](#consulta) - [Captura](#captura) - [Captura Parcial](#captura-parcial) - [Cancelamento](#cancelamento) - [Cancelamento Parcial](#cancelamento-parcial) - [Assinatura](#assinatura) - [Criando uma Assinatura](#criando-uma-assinatura) - [Exemplo de Transação Completa](#exemplo-de-transa%C3%A7%C3%A3o-completa) - [Exemplo via Cartão de Crédito](#exemplo-via-cart%C3%A3o-de-cr%C3%A9dito) - [Exemplo de Transação com Regra de Split](#exemplo-de-transa%C3%A7%C3%A3o-com-regra-de-split) - [Exemplo via Cartão de Crédito](#exemplo-via-cart%C3%A3o-de-cr%C3%A9dito-1) - [Exemplo via Boleto](#exemplo-via-boleto) - [Exemplo de Página de Callback](#exemplo-de-p%C3%A1gina-de-callback) - [Resposta](#resposta) - [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 >= 5.6\] **require-dev** - \[phpunit/phpunit\] - \[codacy/coverage\] Instalação ---------- [](#instalação) Execute em seu shell: ``` composer require jhernandes/ipag-sdk-php ``` Autenticação ------------ [](#autenticação) ### Por Basic Auth [](#por-basic-auth) ``` require 'vendor/autoload.php'; use Ipag\Ipag; use Ipag\Classes\Authentication; use Ipag\Classes\Endpoint; $ipag = new Ipag(new Authentication('my_id_ipag', 'my_ipag_key'), Endpoint::SANDBOX); ``` Cliente ------- [](#cliente) ### Dados do Cliente [](#dados-do-cliente) ``` $customer = $ipag->customer() ->setName('Fulano da Silva') ->setTaxpayerId('799.993.388-01') ->setPhone('11', '98888-3333') ->setEmail('fulanodasilva@gmail.com') ->setBirthdate('1989-03-28') ->setAddress($ipag->address() ->setStreet('Rua Júlio Gonzalez') ->setNumber('1000') ->setNeighborhood('Barra Funda') ->setCity('São Paulo') ->setState('SP') ->setZipCode('01156-060') ); ``` Cartão de Crédito/Débito ------------------------ [](#cartão-de-créditodébito) ### Dados do Cartão de Crédito/Débito [](#dados-do-cartão-de-créditodébito) ``` $creditCard = $ipag->creditCard() ->setNumber('4066553613548107') ->setHolder('FULANO') ->setExpiryMonth('10') ->setExpiryYear('2025') ->setCvc('123') ->setSave(true); //True para gerar o token do cartão (one-click-buy) ``` Carrinho -------- [](#carrinho) ### Adicionando Produtos [](#adicionando-produtos) ``` // ... $products = [ // Nome do Produto, Valor Unitário, Quantidade, SKU (Código do Produto) ['Produto 1', 5.00, 1, 'ABDC1'], ['Produto 2', 3.50, 2, 'ABDC2'], ['Produto 3', 5.50, 1, 'ABDC3'], ['Produto 4', 8.50, 5, 'ABDC4'] ]; // Deve-se usar o `splat operator` $cart = $ipag->cart(...$products); // ... ``` Transação (Pagamento) --------------------- [](#transação-pagamento) ### Transação com Cartão de Crédito [](#transação-com-cartão-de-crédito) ``` $transaction = $ipag->transaction(); $transaction->getOrder() ->setOrderId($orderId) ->setCallbackUrl('https://minha_loja.com.br/ipag/callback') ->setAmount(10.00) ->setInstallments(1) ->setPayment($ipag->payment() ->setMethod(Method::VISA) ->setCreditCard($creditCard) )->setCustomer($customer) ); $response = $transaction->execute(); ``` ### Transação com Token de Cartão de Crédito [](#transação-com-token-de-cartão-de-crédito) ``` $transaction = $ipag->transaction(); $transaction->getOrder() ->setOrderId($orderId) ->setCallbackUrl('https://minha_loja.com.br/ipag/callback') ->setAmount(10.00) ->setInstallments(1) ->setPayment($ipag->payment() ->setMethod(Method::VISA) ->setCreditCard($ipag->creditCard() ->setToken('ABDC-ABCD-ABCD-ABDC') ) )->setCustomer($customer) ); $response = $transaction->execute(); ``` ### Transação com Boleto [](#transação-com-boleto) ``` $transaction = $ipag->transaction(); $transaction->getOrder() ->setOrderId($orderId) ->setCallbackUrl('https://minha_loja.com.br/ipag/callback') ->setAmount(10.00) ->setInstallments(1) ->setExpiry('10/10/2017') ->setPayment($ipag->payment() ->setMethod(Method::BANKSLIP_ZOOP) )->setCustomer($customer) ); $response = $transaction->execute(); ``` ### Transação com Pix [](#transação-com-pix) ``` $transaction = $ipag->transaction(); $transaction->getOrder() ->setOrderId($orderId) ->setCallbackUrl('https://minha_loja.com.br/ipag/callback') ->setAmount(10.00) ->setInstallments(1) ->setPayment($ipag->payment() ->setMethod(Method::PIX) ->setPixExpiresIn(60) )->setCustomer($customer) ); $response = $transaction->execute(); // PIX LINK DE PAGAMENTO (Usando o Checkout do iPag para finalizar) $linkDePagamento = $response->pix->link; // PIX Copia e Cola | QRCode (Utilizar a string retornada ou gerar um QrCode) $qrCodeString = $response->pix->qrCode; ``` ### Consulta [](#consulta) ``` $response = $ipag->transaction()->setTid('123456789')->consult(); ``` ### Captura [](#captura) ``` $response = $ipag->transaction()->setTid('123456789')->capture(); ``` ### Captura Parcial [](#captura-parcial) ``` $response = $ipag->transaction()->setTid('123456789')->setAmount(1.00)->capture(); ``` ### Cancelamento [](#cancelamento) ``` $response = $ipag->transaction()->setTid('123456789')->cancel(); ``` ### Cancelamento Parcial [](#cancelamento-parcial) ``` $response = $ipag->transaction()->setTid('123456789')->setAmount(1.00)->cancel(); ``` Assinatura ---------- [](#assinatura) ### Criando uma Assinatura [](#criando-uma-assinatura) ``` $transaction = $ipag->transaction(); $transaction->getOrder() ->setOrderId($orderId) ->setCallbackUrl(getenv('CALLBACK_URL')) ->setAmount(10.00) ->setInstallments(1) ->setPayment($ipag->payment() ->setMethod(Method::VISA) ->setCreditCard($creditCard) )->setCustomer($customer) )->setSubscription($ipag->subscription() ->setProfileId('1000000') ->setFrequency(1) ->setInterval('month') ->setStart('10/10/2018') ); $response = $transaction->execute(); ``` Exemplo de Transação Completa ----------------------------- [](#exemplo-de-transação-completa) ### Exemplo via Cartão de Crédito [](#exemplo-via-cartão-de-crédito) ```