A biblioteca PagSeguro em Ruby é um conjunto de classes de domínio que facilitam, para o desenvolvedor Ruby, a utilização das funcionalidades que o PagSeguro oferece na forma de APIs. Com a biblioteca instalada e configurada, você pode facilmente integrar funcionalidades como:
- Criar requisições de pagamentos
- Consultar transações por código
- Consultar transações por intervalo de datas
- Consultar transações abandonadas
- Receber notificações
- Ruby 1.9.3+
- Adicione a biblioteca ao seu Gemfile.
gem"pagseguro-oficial",git: "git://github.com/pagseguro/ruby.git"- Execute o comando
bundle install.
Para fazer a autenticação, você precisará configurar as credenciais do PagSeguro. Crie o arquivo config/initializers/pagseguro.rb com o conteúdo abaixo.
PagSeguro.configuredo |config|
config.token="seu token"config.email="seu e-mail"endO token de segurança está disponível em sua conta do PagSeguro.
Para iniciar uma requisição de pagamento, você precisa instanciar a classe PagSeguro::PaymentRequest. Isso normalmente será feito em seu controller de checkout.
classCheckoutController < ApplicationControllerdefcreate# O modo como você irá armazenar os produtos que estão sendo comprados# depende de você. Neste caso, temos um modelo Order que referência os# produtos que estão sendo comprados.order=Order.find(params[:id])payment=PagSeguro::PaymentRequest.newpayment.reference=order.idpayment.notification_url=notifications_urlpayment.redirect_url=processing_urlorder.products.eachdo |product|
payment.items << {id: product.id,description: product.title,amount: product.price,weight: product.weight}endresponse=payment.register# Caso o processo de checkout tenha dado errado, lança uma exceção.# Assim, um serviço de rastreamento de exceções ou até mesmo a gem# exception_notification poderá notificar sobre o ocorrido.## Se estiver tudo certo, redireciona o comprador para o PagSeguro.ifresponse.errors.any?raiseresponse.errors.join("\n")elseredirect_toresponse.urlendendendO PagSeguro irá notificar a URL informada no processo de checkout. Isso é feito através do método PagSeguro::PaymentRequest#notification_url. Esta URL irá receber o código da notificação e tipo de notificação. Com estas informações, podemos recuperar as informações detalhadas sobre o pagamento.
classNotificationsController < ApplicationControllerskip_before_filter:verify_authenticity_token,only: :createdefcreatetransaction=PagSeguro::Transaction.find_by_code(params[:notificationCode])iftransaction.errors.empty?# Processa a notificação. A melhor maneira de se fazer isso é realizar# o processamento em background. Uma boa alternativa para isso é a# biblioteca Sidekiq.endrendernothing: true,status: 200endendPara quantificar o número de transações abandonadas, você pode solicitar uma lista com histórico dessas transações.
report=PagSeguro::Transaction.find_abandonedwhilereport.next_page?report.next_page!puts"=> Page #{report.page}"abort"=> Errors: #{report.errors.join("\n")}"unlessreport.valid?puts"=> Report was created at: #{report.created_at}"putsreport.transactions.eachdo |transaction|
puts"=> Abandoned transaction"puts" created at: #{transaction.created_at}"puts" code: #{transaction.code}"puts" type_id: #{transaction.type_id}"puts" gross amount: #{transaction.gross_amount}"putsendendPara facilitar seu controle financeiro e seu estoque, você pode solicitar uma lista com histórico das transações da sua loja.
report=PagSeguro::Transaction.find_by_datewhilereport.next_page?report.next_page!puts"== Page #{report.page}"abort"=> Errors: #{report.errors.join("\n")}"unlessreport.valid?puts"Report created on #{report.created_at}"putsreport.transactions.eachdo |transaction|
puts"=> Transaction"puts" created_at: #{transaction.created_at}"puts" code: #{transaction.code}"puts" cancellation_source: #{transaction.cancellation_source}"puts" payment method: #{transaction.payment_method.type}"puts" gross amount: #{transaction.gross_amount}"puts" updated at: #{transaction.updated_at}"putsendendpayment.reference="ref1234"payment=PagSeguro::PaymentRequest.newpayment.shipping={type_name: "sedex",cost: 20.00,address: {street: "Av. Brig. Faria Lima",number: 1384,complement: "5 andar",district: "Jardim Paulistano",city: "São Paulo",state: "SP",postal_code: "01452002"}}shipping={type_name: "sedex",cost: 20.00,address: {street: "Av. Brig. Faria Lima",number: 1384,complement: "5 andar",district: "Jardim Paulistano",city: "São Paulo",state: "SP",postal_code: "01452002"}}payment.shipping=shippingpayment.sender={name: "John Doe",email: "john@example.org",cpf: "12345678901",phone: {area_code: "11",number: "123456789"}}payment.extra_amount=123.45# acréscimopayment.extra_amount= -123.45# desconto# URL de notificaçãopayment.notification_url="http://example.org/notifications"# URL de retornopayment.return_url="http://example.org/processando"payment.max_uses=100payment.max_age=3600# em segundos2.0.2
- Atualização dos tipos e códigos de meio de pagamento.
- Correção do exemplo payment_request.
2.0.1
- Classes de domínios que representam pagamentos, notificações e transações.
- Criação de checkouts via API.
- Tratamento de notificações de pagamento enviadas pelo PagSeguro.
- Consulta de transações.
Copyright 2013 PagSeguro Internet LTDA.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- O PagSeguro somente aceita pagamento utilizando a moeda Real brasileiro (BRL).
- Certifique-se que o email e o token informados estejam relacionados a uma conta que possua o perfil de vendedor ou empresarial.
- Certifique-se que tenha definido corretamente o charset de acordo com a codificação (ISO-8859-1 ou UTF-8) do seu sistema. Isso irá prevenir que as transações gerem possíveis erros ou quebras ou ainda que caracteres especiais possam ser apresentados de maneira diferente do habitual.
- Para que ocorra normalmente a geração de logs, certifique-se que o diretório e o arquivo de log tenham permissões de leitura e escrita.
Achou e corrigiu um bug ou tem alguma feature em mente e deseja contribuir?
- Faça um fork.
- Adicione sua feature ou correção de bug.
- Envie um pull request no GitHub.