README

Package que permitie a utilização da API do PagSeguro. Ideal para quem deseja integrar sua aplicação de forma "transparente" para o usuário.

OBS: Esse package abstrai a API do backend, na hora de enviar sua requisição para o PagSeguro. Porém, a integração exige algumas configurações feita em JavaScript. Para ver a documentação completa, use o link abaixo:

Manual completo para a integração.

http://download.uol.com.br/pagseguro/docs/pagseguro-checkout-transparente.pdf

A partir da página 6 começam as instruções para o Browser. Você não precisa se preocupar em salvar os links para os arquivos de Produção e Homologação, uma vez que eles já estão configurados no package como você verá mais adiante. A única coisa que vcê precisa fazer é usar o seguinte código no seu front-end:

<script type="text/javascript" src="{{PagSeguro::getPagSeguroData()->getJavascriptURL()}}"></script>
<script type="text/javascript">
    PagSeguroDirectPayment.setSessionId('{{PagSeguro::printSessionId()}}');
</script>

Instalando

Laravel 4.2

Adicione o repositório no seu arquivo composer.json.

"require-dev": {
	"cassioalmeida/pagsegurotransparente" : "1.0.*@dev"
}

Em seguida, atualize com o comando abaixo:

composer update

Após o package ser baixado, você precisa adicionar o 'service provider'. Abra o arquivo app/config/app.php, e adicione um novo índice ao array existente com a seguinte linha.

'Cassioalmeida\Pagsegurotransparente\PagsegurotransparenteServiceProvider'

Ainda no arquivo app/config/app.php, adicione um aliases para o package:

'PagSeguro'     =>     'Cassioalmeida\Pagsegurotransparente\Facades\PagSeguro'

Por último, mas não menos importante, digite o comando abaixo para que o arquivo de configuração do package seja criado:

php artisan config:publish cassioalmeida/pagsegurotransparente

Esse comando irá criar o arquivo de configuração na pasta: app/config/packages/cassioalmeida/pagsegurotransparente, com o nome de 'environment.php'.

Configurando

Depois dos passos anteriores, você deverá possuir o arquivo de configuração assim:

<?php
/**
* Arquivo de configuração para o package;
* Preencha corretamente os dados para não correr o risco de ter problemas com configuração de ambientes;
*/
return array(

  //Ambiente de sandbox? True para Sanbox | False para Produção;
  'sandbox'   =>  true,


  //Dados para ambiente SANDBOX!
  //O package usará esses dados automaticamente de acordo com a configuração do indice anterior;
  'sandboxData'   =>  array(
    'credentials'  =>   array(
      'email'     =>  'seu-email',//E-mail a conta PagSeguro;
      'token'     =>  'seu-token',//Token da conta PagSeguro;
    ),
    'sessionURL' => "https://ws.sandbox.pagseguro.uol.com.br/v2/sessions", //URL de Sessões
    'transactionsURL' => "https://ws.sandbox.pagseguro.uol.com.br/v2/transactions", // URL para transações;
    'javascriptURL' => "https://stc.sandbox.pagseguro.uol.com.br/pagseguro/api/v2/checkout/pagseguro.directpayment.js",//URL 	para javascript;
    'notificationURL' => 'https://ws.sandbox.pagseguro.uol.com.br/v2/transactions/notifications/' //URL para buscar notificacoes no PagSeguro;
    ),


    //Dados para ambiente PRODUÇÃO!
    //O package usará esses dados automaticamente de acordo com a configuração do indice anterior;
    'productionData'    =>  array(
      'credentials'  =>   array(
        'email'     =>  'seu-email',//E-mail a conta PagSeguro;
        'token'     =>  'seu-token',//Token da conta PagSeguro;
      ),
      'sessionURL' => "https://ws.pagseguro.uol.com.br/v2/sessions",
      'transactionsURL' => "https://ws.pagseguro.uol.com.br/v2/transactions",
      'javascriptURL' => "https://stc.pagseguro.uol.com.br/pagseguro/api/v2/checkout/pagseguro.directpayment.js",
      'notificationURL' => 'https://ws.pagseguro.uol.com.br/v2/transactions/notifications/'
      )

  );

Basicamente você irá editar o a flag sandbox para true OU false para indicar se o ambiente é de produção ou homologação. Por padrão o package usa a flag sandbox => true. Além disso, tanto o indice sandboxData como productionData possuem as credenciais do usuário, sendo email e token. Esses dados você consegue nas configurações da conta no painel do PagSeguro. Os demais indices são URL's fornecidas pela própria documentação do PagSeguro.

Utilizando

Depois de todos os passos anteriores, veja um exemplo de como utilizar o Package:

BOLETO BANCÁRIO

$params = array(
	'paymentMethod' => 'boleto',
	'senderEmail' => 'email do cliente',
	'senderName' => 'nome do cliente',
	'senderCPF' => 'cpf do cliente sem traço ou ponto',
	'senderAreaCode' => 'ddd do cliente',
	'senderPhone' => 'telefone do cliente',
	'shippingAddressPostalCode' => 'CEP do endereço de entrega',
	'shippingAddressStreet' => 'Rua do endereço de entrega',
	'shippingAddressNumber' => 'Número do endereço de entrega',
	'shippingAddressComplement' => 'Complemento do endereço de entrga',
	'shippingAddressDistrict' => 'Bairro do endereço de entrega',
	'shippingAddressCity' => 'Cidade do endereço de entrega',
	'shippingAddressState' => 'Estado do endereço de entrega, exemplo : SP',
	"shippingAddressCountry" => "BRA",
	'senderHash' => 'Sender HASH', // Verificar no tópico abaixo
	'currency' => 'BRL',
	'shippingType'  =>  3, //Tipo de frete 1 – PAC, 2 – SEDEX, 3 - Desconhecido
	'shippingCost'  =>  'Valor do frete', // Decimal, com duas casas decimais separadas por ponto (ex 1234.56) maior que 0.00 e menor ou igual a 9999999.00;
	'itemId1' =>  'ID ou SKU do seu produto',
        'itemDescription1' =>  'Descrição do produto',
        'itemAmount1' =>  'Preço do produto', //Decimal com duas casas decimais separadas por ponto (ex1234.56) maior que 0.00 e menor ou igual a 9999999.00;
        'itemQuantity1' =>  'Qty do produto' // Um número inteiro maior ou igual a 1 e menor ou igual a 999
);

//Requisitando a API.

$pagSeguroReturn = PagSeguro::doPayment($params);

CARTÃO DE CRÉDITO

$params = array(
	'paymentMethod' =>  'creditCard',
        'currency'  =>  'BRL', //Padrão, já que o PagSeguro só aceita REAL
        'senderName'    =>  'nome do cliente',
        'senderCPF'     =>  'CPF do cliente sem traço ou ponto',
        'senderAreaCode'    =>  'DDD do telefone do cliente',
        'senderPhone'   =>  'Telefone do Cliente',
        'senderEmail'   =>  'email do cliente',
        'senderHash'    =>  'sender hash', // Verificar no tópico abaixo
        'shippingAddressPostalCode' => 'CEP do endereço de entrega',
        'shippingAddressStreet' => 'Rua do endereço de entrega',
        'shippingAddressNumber' => 'Número do endereço de entrega',
        'shippingAddressComplement' => 'Complemento do endereço de entrega',
        'shippingAddressDistrict' => 'Bairro do endereço de entrega',
        'shippingAddressCity' => 'Cidade do endereço de entrega',
        'shippingAddressState' => 'Estado do endereço de entrega', // Ex: SP
        "shippingAddressCountry" => "BRA", //Padrão
        'shippingType'  =>  3, //Tipo de frete 1 – PAC, 2 – SEDEX, 3 - Desconhecido
        'shippingCost'  =>  'Valor do frete',
        'creditCardToken'   =>  'Token do cartão de crédito', //Consulte e página 10 do manual de integração;
        'installmentQuantity'   =>  'Nº de parcelas',
        'installmentValue'  =>      'Valor de cada parcela',
        'noInterestInstallmentQuantity' => 5,//Valor setado no metodo getInstallments se alterar aqui tem que alterar lá e vice versa. Consultar a página 11 do manual para detalhes.
        'creditCardHolderName'  => 'Nome do cartão de crédito',
        'creditCardHolderCPF'   =>  'CPF do titular do cartão', //Sem pontos ou traços;
        'creditCardHolderBirthDate' =>  'Data de nascimento do titular do cartão', //No formato 99/99/9999
        'creditCardHolderAreaCode'  =>  'DDD do telefone do titular',
        'creditCardHolderPhone'     =>  'Telefone do titular',
        'billingAddressStreet'  =>  'Rua do endereço de COBRANÇA',
        'billingAddressNumber'  =>  'Número do endereço de COBRANÇA',
        'billingAddressComplement' => 'Complemento do endereço de COBRANÇA',
        'billingAddressDistrict'    =>  'Bairro do endereço de COBRANÇA',
        'billingAddressPostalCode'  =>  'CEP do endereço de COBRANÇA',
        'billingAddressCity'    =>  'Cidade do endereço de COBRANÇA',
        'billingAddressState'   =>  'Estado do endereço de COBRANÇA', // Ex: SP
        'billingAddressCountry' =>  'BRA',
        'itemId1' =>  'ID ou SKU do seu produto',
        'itemDescription1' =>  'Descrição do produto',
        'itemAmount1' =>  'Preço do produto', //Decimal com duas casas decimais separadas por ponto (ex1234.56) maior que 0.00 e menor ou igual a 9999999.00;
        'itemQuantity1' =>  'Qty do produto' // Um número inteiro maior ou igual a 1 e menor ou igual a 999
);

//Requisitando a API.

$pagSeguroReturn = PagSeguro::doPayment($params);

Repare que, tanto para boleto quanto para cartão de crédito você deve adicionar os itens seguidos pelo numero. No exemplo, temos apenas um produto para ser enviado, portanto temos os indices itemId1, itemDescription1, itemAmount1, itemQuantity1, caso haja mais de um, você deve acrescentar o número na frente dos indices, por exemplo:

$params = array(

        'itemId2' =>  'ID ou SKU do seu produto',
        'itemDescription2' =>  'Descrição do produto',
        'itemAmount2' =>  'Preço do produto', //Decimal com duas casas decimais separadas por ponto (ex1234.56) maior que 0.00 e menor ou igual a 9999999.00;
        'itemQuantity2' =>  'Qty do produto', // Um número inteiro maior ou igual a 1 e menor ou igual a 999

        'itemId3' =>  'ID ou SKU do seu produto',
        'itemDescription3' =>  'Descrição do produto',
        'itemAmount3' =>  'Preço do produto', //Decimal com duas casas decimais separadas por ponto (ex1234.56) maior que 0.00 e menor ou igual a 9999999.00;
        'itemQuantity3' =>  'Qty do produto' // Um número inteiro maior ou igual a 1 e menor ou igual a 999
);

Caso exista algum erro nas informações, a variável $pagSeguroReturn terá um indice errors. Verifique seu retorno para descobrir o que houve de errado. Em caso de SUCESSO na requisição a variável $pagSeguroReturn terá um indice transaction com seus respectivos dados como código de transação, paymentLink (no caso de boleto) entre outros. Consulte a página 16 do manual para todos os dados retornados.

SenderHash

O método PagSeguroDirectPayment.getSenderHash() é responsável por retornar o seu código SenderHash, no caso, na view. Esse Hash deve ser enviado para a chamada da API no indice senderHash

<script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
<script type="text/javascript" src="{{PagSeguro::getPagSeguroData()->getJavascriptURL()}}"></script>

<script>
	console.log(PagSeguroDirectPayment.getSenderHash());
</script>

RECEBENDO UMA NOTIFICAÇÃO SOBRE ALTERAÇÃO EM TRANSAÇÕES

Como você já deve saber, o PagSeguro irá enviar para uma URL pré-definida as informações sobre alterações de Status para suas transações (Essa URL você define no painel da sua conta PagSeguro).

A ordem de chamada é a seguinte. O PagSeguro te envia uma variável chamada de notificationCode. Com esse código, você vai realizar a chamada na API, veja:

$pagSeguroReturn = PagSeguro::paymentOrderConsult($notificationCode);
$transaction = $pagSeguroReturn['transaction'];

Observe que a variável notificationCode é passada para o método paymentOrderConsult. Com isso, o indice transaction irá retornar os dados da compra de acordo com o PagSeguro, se foir paga, cancelada e etc. Abaixo uma tabela com os códigos e o seu significado

1 - Aguardando pagamento: o comprador iniciou a transação, mas até o momento o PagSeguro não recebeu nenhuma informação sobre o pagamento.

2 -Em análise: o comprador optou por pagar com um cartão de crédito e o PagSeguro está analisando o risco da transação.

3 - Paga: a transação foi paga pelo comprador e o PagSeguro já recebeu uma confirmação da instituição financeira responsável pelo processamento.

4 - Disponível: a transação foi paga e chegou ao final de seu prazo de liberação sem ter sido retornada e sem que haja nenhuma disputa aberta.

5 - Em disputa: o comprador, dentro do prazo de liberação da transação, abriu uma disputa.

6 - Devolvida: o valor da transação foi devolvido para o comprador.

7 - Cancelada: a transação foi cancelada sem ter sido finalizada.

cassioalmeida / pagsegurotransparente

Maintainers

Details