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:
gem "pagseguro-oficial", "~> 2.5.0"
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.configure do |config|
config.token = "seu token"
config.email = "seu e-mail"
config.environment = :production # ou :sandbox. O padrão é production.
config.encoding = "UTF-8" # ou ISO-8859-1. O padrão é UTF-8.
end
O 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.
class CheckoutController < ApplicationController
def create
# 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.new
# Você também pode fazer o request de pagamento usando credenciais
# diferentes, como no exemplo abaixo
payment = PagSeguro::PaymentRequest.new(email: 'abc@email', token: 'token')
payment.reference = order.id
payment.notification_url = notifications_url
payment.redirect_url = processing_url
order.products.each do |product|
payment.items << {
id: product.id,
description: product.title,
amount: product.price,
weight: product.weight
}
end
# Caso você precise passar parâmetros para a api que ainda não foram
# mapeados na gem, você pode fazer de maneira dinâmica utilizando um
# simples hash.
payment.extra_params << { paramName: 'paramValue' }
payment.extra_params << { senderBirthDate: '07/05/1981' }
payment.extra_params << { extraAmount: '-15.00' }
response = 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.
if response.errors.any?
raise response.errors.join("\n")
else
redirect_to response.url
end
end
end
O 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.
class NotificationsController < ApplicationController
skip_before_filter :verify_authenticity_token, only: :create
def create
transaction = PagSeguro::Transaction.find_by_notification_code(params[:notificationCode])
if transaction.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.
end
render nothing: true, status: 200
end
end
Para quantificar o número de transações abandonadas, você pode solicitar uma lista com histórico dessas transações.
report = PagSeguro::Transaction.find_abandoned
while report.next_page?
report.next_page!
puts "=> Page #{report.page}"
abort "=> Errors: #{report.errors.join("\n")}" unless report.valid?
puts "=> Report was created at: #{report.created_at}"
puts
report.transactions.each do |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}"
puts
end
end
Para 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_date
while report.next_page?
report.next_page!
puts "== Page #{report.page}"
abort "=> Errors: #{report.errors.join("\n")}" unless report.valid?
puts "Report created on #{report.created_at}"
puts
report.transactions.each do |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}"
puts
end
end
É possível consultar o histórico de mudanças de status em transações
response = PagSeguro::Transaction.find_status_history("transaction_code")
response.each do |status|
puts "STATUS:"
puts " code: #{status.code}"
puts " date: #{status.date}"
puts " notification_code: #{status.notification_code}"
end
Você pode consultar as opções de parcelamento para um determinado valor.
installments = PagSeguro::Installment.find("100.00")
puts "=> INSTALLMENTS"
puts
installments.each do |installment|
puts installment.inspect
end
visa_installments = PagSeguro::Installment.find("100.00", "visa")
puts
puts "=> VISA INSTALLMENTS"
puts
visa_installments.each do |installment|
puts installment.inspect
end
options = {
credentials: PagSeguro::ApplicationCredentials.new("app4521929942", "1D47384E6565EBE664DAEF9AD690438B"),
permissions: [:searches, :notifications],
notification_url: 'foo.com.br',
redirect_url: 'bar.com.br'
}
response = PagSeguro::Authorization.new(options).authorize
Em seguida, acesse o link para confirmar as autorizações
response.url
Você pode estornar pagamentos que as transações estiverem com status: Paga (3), Disponível (4), Em disputa (5).
refund = PagSeguro::TransactionRefund.new
refund.transaction_code = "D5D5BE444148407891E497B421975599"
response = refund.register
if response.errors.any?
puts response.errors.join("\n")
else
puts "=> REFUND RESPONSE"
puts response.result
end
Você pode cancelar transações que estiverem com status: Aguardando pagamento ou Em análise.
cancellation = PagSeguro::TransactionCancellation.new
cancellation.transaction_code = "AFB8FCF29496401681257C1ECE3A98FF"
cancellation.register
if cancellation.errors.any?
puts cancellation.errors.join("\n")
else
puts "=> CANCELLATION RESPONSE"
puts cancellation.result
end
payment.reference = "ref1234"
payment = PagSeguro::PaymentRequest.new
payment.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"
}
}
PagSeguro::Shippingshipping_options = {
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 = PagSeguro::Shipping.new(shipping_options)
payment.sender = {
name: "John Doe",
email: "john@example.org",
cpf: "12345678901",
phone: {
area_code: "11",
number: "123456789"
}
}
payment.extra_amount = 123.45 # acréscimo
payment.extra_amount = -123.45 # desconto
# URL de notificação
payment.notification_url = "http://example.org/notifications"
# URL de retorno
payment.return_url = "http://example.org/processando"
payment.max_uses = 100
payment.max_age = 3600 # em segundos
PagSeguro.encoding = "UTF-8" # UTF-8 ou ISO-8859-1
Encontre toda a documentação necessária para o checkout transparente aqui: https://github.com/pagseguro/ruby/blob/master/docs/transparent_checkout.md
Docker é uma ferramenta open-source que cria uma camada de abstração e automação da virtualização do kernel do GNU/Linux*.
Primeiro certifique-se de que o Docker está instalado e configurado corretamente, em seguida construa a imagem:
% docker build -t pagseguro .
E para entrar na imagem:
% docker run --rm -it -v ${PWD}:/app pagseguro
root@5c480dd6e22a:/app#
Ou se preferir você pode usar o docker-compose:
% docker-compose run script
root@c6697abac095:/app#
Caso tenha dúvidas ou precise de suporte, acesse nosso fórum.
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.
Achou e corrigiu um bug ou tem alguma feature em mente e deseja contribuir?
git checkout -b my-new-feature)git commit -am 'Added some feature')git push origin my-new-feature)O código, os commits e os comentários devem ser em inglês. Adicione exemplos para sua nova feature. Se seu Pull Request for relacionado a uma versão específica, o Pull Request não deve ser enviado para o branch master e sim para o branch correspondente a versão.
FAQs
Unknown package
We found that pagseguro-sdk demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.