pagseguro-oficial 2.5.0 → 2.6.0

data/examples/preapproval/create_preapproval_manual.rb

@@ -0,0 +1,58 @@
+require_relative '../boot'
+
+# Create a Subscription Plan (Manual charge)
+#
+# You need to set your AccountCredentials (EMAIL, TOKEN) in the application config
+#
+# P.S: See the boot file example for more details.
+
+email = 'EMAIL'
+token = 'TOKEN'
+
+plan = PagSeguro::SubscriptionPlan.new(
+  charge: 'manual', # Manual Subscription Plan must always use manual charge type.
+  redirect_url: 'http://www.lojateste.com.br/redirect',
+  review_url: 'http://www.lojateste.com.br/review',
+  reference: 'REFERENCE',
+
+  sender: {
+    name: 'Nome do Cliente',
+    email: 'client@example.com',
+    phone: { area_code: 11, number: 123456 },
+    address: {
+      street: 'Av Brigadeira Faria Lima',
+      number: '1384',
+      complement: '3 andar',
+      district: 'Jd Paulistano',
+      city: 'Sao Paulo',
+      state: 'SP',
+      country: 'BRA',
+      postal_code: '01452002'
+    }
+  },
+
+  name: 'Insurance',
+  details: 'Payment of 100.',
+  amount: 100.0,
+  period: 'Monthly',
+  max_payments_per_period: 2,
+  max_amount_per_period: 200.0,
+  initial_date: Time.new(2016, 4, 19, 0, 0),
+  final_date: Time.new(2017, 1, 1, 0, 0),
+  max_total_amount: 2_400.0
+)
+
+# Edit the lines above.
+
+plan.credentials = PagSeguro::AccountCredentials.new(email, token)
+plan.create
+
+if plan.errors.any?
+  puts '=> ERRORS'
+  puts plan.errors.join('\n')
+else
+  print '=> Subscription Plan correct created, its code is '
+  puts plan.code
+  puts '=> And your client can finish the subscription using this url:'
+  puts plan.url
+end

data/examples/preapproval/create_preapproval_transparent.rb

@@ -0,0 +1,41 @@
+require_relative '../boot'
+
+# Create a Subscription Plan (Transparent Checkout).
+#
+# You need to set your AccountCredentials (EMAIL, TOKEN) in the application config
+#
+# P.S: See the boot file example for more details.
+
+email = 'EMAIL'
+token = 'TOKEN'
+
+plan = PagSeguro::SubscriptionPlan.new(
+  charge: 'auto',
+
+  redirect_url: 'http://www.lojateste.com.br/redirect',
+  review_url: 'http://www.lojateste.com.br/review',
+
+  name: 'Test',
+  period: 'Monthly',
+  amount: 100.0,
+  max_total_amount: 2400.0,
+  final_date: Time.new(2017, 2, 28, 20, 20),
+  membership_fee: 150.0,
+  trial_duration: 28,
+)
+
+# Edit the lines above.
+
+plan.credentials = PagSeguro::AccountCredentials.new(email, token)
+plan.create
+
+if plan.errors.any?
+  puts '=> ERRORS'
+  puts plan.errors.join('\n')
+else
+  print '=> Subscription Plan correct created, its code is '
+  puts plan.code
+
+  puts %[=> Now you need to subscribe your client to this plan (see
+examples/preapproval/create_preapproval.rb).]
+end

data/examples/preapproval/preapproval_retry.rb

@@ -0,0 +1,29 @@
+require_relative "../boot"
+
+# Retry a subscription payment.
+#
+# P.S: Take a look at the boot file example for more details
+
+email = 'EMAIL'
+token = 'TOKEN'
+subscription_code = 'CODE'
+payment_order_code = 'PAYMENT'
+
+# Edit the lines above
+
+credentials = PagSeguro::AccountCredentials.new(email, token)
+
+subscription_retry = PagSeguro::SubscriptionRetry.new(
+  subscription_code: subscription_code,
+  payment_order_code: payment_order_code
+)
+subscription_retry.credentials = credentials
+subscription_retry.save
+
+if subscription_retry.errors.any?
+  puts "ERRORS: "
+  puts subscription_retry.errors.inspect
+else
+  puts "SUCCESS"
+  puts subscription_retry.inspect
+end

data/examples/preapproval/search/search_by_date_interval.rb

@@ -0,0 +1,45 @@
+require_relative '../../boot'
+
+# Search Subscriptions by date interval
+#
+# You need to give AccountCredentials (EMAIL, TOKEN) and some date interval
+#
+# P.S: See the boot file example for more details.
+
+email = 'user@example.com'
+token = 'TOKEN'
+
+credentials = PagSeguro::AccountCredentials.new(email, token)
+options = {
+  credentials: credentials,
+  starts_at: Time.new(2016,3,15),
+  ends_at: Time.new(2016,3,24),
+  per_page: 10
+}
+report = PagSeguro::Subscription.search_by_date_interval(options)
+
+if report.valid?
+  puts "====== Report ======"
+
+  while report.next_page?
+    report.next_page!
+
+    puts "=> Page #{report.page}/#{report.total_pages}"
+    report.subscriptions.each_with_index do |subscription, index|
+      puts "Subscription #{index+1}/#{report.results}:"
+      puts "  code: #{subscription.code}"
+      puts "  name: #{subscription.name}"
+      puts "  date: #{subscription.date}"
+      puts "  tracker: #{subscription.tracker}"
+      puts "  status: #{subscription.status}"
+      puts "  last event date: #{subscription.last_event_date}"
+      puts "  charge: #{subscription.charge}"
+      puts "  reference: #{subscription.reference}"
+    end
+  end
+
+  puts "- End page"
+else
+  puts "Errors:"
+  puts report.errors.join("\n")
+end

data/examples/preapproval/search/search_by_days_interval.rb

@@ -0,0 +1,46 @@
+require_relative '../../boot'
+
+# Search Subscriptions by days interval
+# PS: Since it has receipt some notification in the interval
+#
+# You need to give AccountCredentials (EMAIL, TOKEN) and some days interval
+#
+# P.S: See the boot file example for more details.
+
+email = 'user@example.com'
+token = 'TOKEN'
+interval = 30
+
+credentials = PagSeguro::AccountCredentials.new('user@example.com', 'TOKEN')
+options = {
+  credentials: credentials,
+  interval: interval
+}
+report = PagSeguro::Subscription.search_by_days_interval(options)
+
+if report.valid?
+  puts "====== Report ======"
+
+  while report.next_page?
+    report.next_page!
+
+    puts "=> Page #{report.page}/#{report.total_pages}"
+    report.subscriptions.each_with_index do |subscription, index|
+      puts "Subscription #{index+1}/#{report.results}:"
+      puts "  code: #{subscription.code}"
+      puts "  name: #{subscription.name}"
+      puts "  date: #{subscription.date}"
+      puts "  tracker: #{subscription.tracker}"
+      puts "  status: #{subscription.status}"
+      puts "  last event date: #{subscription.last_event_date}"
+      puts "  charge: #{subscription.charge}"
+      puts "  reference: #{subscription.reference}"
+    end
+
+    puts "- End page "
+  end
+  puts " - End report"
+else
+  puts "Errors:"
+  puts report.errors.join("\n")
+end

data/examples/preapproval/search/search_by_notification_code.rb

@@ -0,0 +1,50 @@
+require_relative '../../boot'
+
+# Find a Subscription by notification code
+#
+# You need to give AccountCredentials (EMAIL, TOKEN) and the notification code
+#
+# P.S: See the boot file example for more details.
+
+email = 'user@example.com'
+token = 'TOKEN'
+code = 'NOTIFICATION_CODE'
+
+credentials = PagSeguro::AccountCredentials.new(email, token)
+subscription = PagSeguro::Subscription.find_by_notification_code(code, credentials: credentials)
+
+if subscription.errors.empty?
+  puts "Subscription:"
+  puts "  code: #{subscription.code}"
+  puts "  name: #{subscription.name}"
+  puts "  date: #{subscription.date}"
+  puts "  tracker: #{subscription.tracker}"
+  puts "  status: #{subscription.status}"
+  puts "  reference: #{subscription.reference}"
+  puts "  last event date: #{subscription.last_event_date}"
+  puts "  charge: #{subscription.charge}"
+
+  if subscription.sender
+    puts "  sender.name: #{subscription.sender.name}"
+    puts "  sender.email: #{subscription.sender.email}"
+
+    if subscription.sender.phone
+      puts "  sender.phone.area_code: #{subscription.sender.phone.area_code}"
+      puts "  sender.phone.number: #{subscription.sender.phone.number}"
+    end
+
+    if subscription.sender.address
+      puts "  sender.address.street: #{subscription.sender.address.street}"
+      puts "  sender.address.number: #{subscription.sender.address.number}"
+      puts "  sender.address.complement: #{subscription.sender.address.complement}"
+      puts "  sender.address.district: #{subscription.sender.address.district}"
+      puts "  sender.address.city: #{subscription.sender.address.city}"
+      puts "  sender.address.state: #{subscription.sender.address.state}"
+      puts "  sender.address.postal_code: #{subscription.sender.address.postal_code}"
+      puts "  sender.address.country: #{subscription.sender.address.country}"
+    end
+  end
+else
+  puts "Errors:"
+  puts subscription.errors.join("\n")
+end

data/examples/preapproval/search/search_by_subscription_code.rb

@@ -0,0 +1,50 @@
+require_relative '../../boot'
+
+# Find a Subscription by code
+#
+# You need to give AccountCredentials (EMAIL, TOKEN) and the subscription code
+#
+# P.S: See the boot file example for more details.
+
+email = 'user@example.com'
+token = 'TOKEN'
+code = 'CODE'
+
+credentials = PagSeguro::AccountCredentials.new(email, token)
+subscription = PagSeguro::Subscription.find_by_code(code, credentials: credentials)
+
+if subscription.errors.empty?
+  puts "Subscription:"
+  puts "  code: #{subscription.code}"
+  puts "  name: #{subscription.name}"
+  puts "  date: #{subscription.date}"
+  puts "  tracker: #{subscription.tracker}"
+  puts "  status: #{subscription.status}"
+  puts "  reference: #{subscription.reference}"
+  puts "  last event date: #{subscription.last_event_date}"
+  puts "  charge: #{subscription.charge}"
+
+  if subscription.sender
+    puts "  sender.name: #{subscription.sender.name}"
+    puts "  sender.email: #{subscription.sender.email}"
+
+    if subscription.sender.phone
+      puts "  sender.phone.area_code: #{subscription.sender.phone.area_code}"
+      puts "  sender.phone.number: #{subscription.sender.phone.number}"
+    end
+
+    if subscription.sender.address
+      puts "  sender.address.street: #{subscription.sender.address.street}"
+      puts "  sender.address.number: #{subscription.sender.address.number}"
+      puts "  sender.address.complement: #{subscription.sender.address.complement}"
+      puts "  sender.address.district: #{subscription.sender.address.district}"
+      puts "  sender.address.city: #{subscription.sender.address.city}"
+      puts "  sender.address.state: #{subscription.sender.address.state}"
+      puts "  sender.address.postal_code: #{subscription.sender.address.postal_code}"
+      puts "  sender.address.country: #{subscription.sender.address.country}"
+    end
+  end
+else
+  puts "Errors:"
+  puts subscription.errors.join("\n")
+end

data/examples/preapproval/search/search_subscription_payment_orders.rb

@@ -0,0 +1,53 @@
+require_relative '../../boot'
+
+code = 'CODE'
+status = :processing # Availables: [ :scheduled, :processing, :not_processed, :suspended, :paid, :not_paid ]
+email = 'EMAIL'
+token = 'TOKEN'
+
+credentials = PagSeguro::AccountCredentials.new(email, token)
+
+options = { credentials: credentials }
+
+report = PagSeguro::SubscriptionSearchPaymentOrders.new(code, status, options)
+
+if report.valid?
+  puts "====== Report ======"
+
+  while report.next_page?
+    report.next_page!
+
+    puts "=> Page #{report.page}/#{report.total_pages}"
+    report.payment_orders.each_with_index do |order, index|
+      puts "Payment Order #{index}:"
+      puts "  Code: #{order.code}"
+      puts "  Status: #{order.status}"
+      puts "  Amount: #{order.amount}"
+      puts "  Gross amount: #{order.gross_amount}"
+      puts "  Last event date: #{order.last_event_date}"
+      puts "  Scheduling date: #{order.scheduling_date}"
+
+      if order.discount
+        puts "Discount:"
+        puts "  Discount: #{order.discount.type}"
+        puts "  Discount: #{order.discount.value}"
+        puts "  Discount: #{order.discount.code}"
+      end
+
+      if order.transactions.any?
+        order.transactions.each_with_index do |transaction, index|
+          puts "Transaction #{index+1}/#{order.transactions.size}"
+          puts "  Transaction code: #{transaction.code}"
+          puts "  Transaction status: #{transaction.status}"
+          puts "  Transaction date: #{transaction.date}"
+        end
+      end
+    end
+    puts "- End page"
+    puts
+  end
+
+else
+  puts "Errors:"
+  puts report.errors.join("\n")
+end

data/examples/split_payment/create_payment_request.rb

@@ -39,7 +39,7 @@ payment.reference = "REF1234"
 payment.sender = {
   name: "Sender One",
   email: "sender@example.com",
-  cpf: "21639716866",
+  document: { type: "CPF", value: "75073461100" },
   phone: {
     area_code: 11,
     number: "12345678"

data/examples/split_payment/create_transaction_using_boleto.rb

@@ -0,0 +1,118 @@
+require_relative "../boot"
+
+# Create Transaction Using Boleto and Split Payment
+#
+# You need to set your AccountCredentials (EMAIL, TOKEN) in the application config
+#
+# P.S: See the boot file example for more details
+
+payment = PagSeguro::BoletoTransactionRequest.new
+payment.notification_url = "http://www.example.com/notification"
+payment.payment_mode = "default"
+payment.credentials = PagSeguro::ApplicationCredentials.new("APP_ID", "APP_KEY")
+
+payment.items << {
+  id: 1234,
+  description: %[Televisão 19" Sony],
+  amount: 50.0,
+  weight: 0
+}
+
+payment.reference = "REF1234-boleto"
+payment.sender = {
+  hash: "32fb09327a27b0a09a194a21d00be6d922fba5cfcdba03f15b3408029b56d41a",
+  name: "Joao Comprador",
+  email: "joao.comprador@sandbox.pagseguro.com.br",
+  document: { type: "CPF", value: "75073461100" },
+  phone: {
+    area_code: 11,
+    number: "12345678"
+  }
+}
+
+payment.shipping = {
+  type_name: "sedex",
+  address: {
+    street: "Av. Brig. Faria Lima",
+    number: "1384",
+    complement: "5º andar",
+    city: "São Paulo",
+    state: "SP",
+    district: "Jardim Paulistano",
+    postal_code: "01452002"
+  }
+}
+
+payment.receivers = [
+  {
+    public_key: 'PUBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+    split: {
+      amount: 20.0,
+      rate_percent: 50.0,
+      fee_percent: 50.0
+    }
+  }
+]
+
+# Add extras params to request
+# payment.extra_params << { paramName: 'paramValue' }
+# payment.extra_params << { senderBirthDate: '07/05/1981' }
+
+puts "=> REQUEST"
+puts PagSeguro::TransactionRequest::RequestSerializer.new(payment).to_params
+puts
+
+payment.create
+
+if payment.errors.any?
+  puts "=> ERRORS"
+  puts payment.errors.join("\n")
+else
+  puts "=> Transaction"
+  puts "  code: #{payment.code}"
+  puts "  reference: #{payment.reference}"
+  puts "  type: #{payment.type_id}"
+  puts "  payment link: #{payment.payment_link}"
+  puts "  status: #{payment.status}"
+  puts "  payment method type: #{payment.payment_method}"
+  puts "  created at: #{payment.created_at}"
+  puts "  updated at: #{payment.updated_at}"
+  puts "  gross amount: #{payment.gross_amount.to_f}"
+  puts "  discount amount: #{payment.discount_amount.to_f}"
+  puts "  net amount: #{payment.net_amount.to_f}"
+  puts "  extra amount: #{payment.extra_amount.to_f}"
+  puts "  installment count: #{payment.installment_count}"
+
+  puts "    => Items"
+  puts "      items count: #{payment.items.size}"
+  payment.items.each do |item|
+    puts "      item id: #{item.id}"
+    puts "      description: #{item.description}"
+    puts "      quantity: #{item.quantity}"
+    puts "      amount: #{item.amount.to_f}"
+  end
+
+  puts "    => Receivers"
+  puts "      receivers count: #{payment.receivers.size}"
+  payment.receivers.each do |receiver|
+    puts "      email: #{receiver.email}"
+    puts "      amount: #{receiver.split.amount}"
+  end
+
+  puts "    => Sender"
+  puts "      name: #{payment.sender.name}"
+  puts "      email: #{payment.sender.email}"
+  puts "      phone: (#{payment.sender.phone.area_code}) #{payment.sender.phone.number}"
+  puts "      document: #{payment.sender.document}"
+
+  puts "    => Shipping"
+  puts "      street: #{payment.shipping.address.street}, #{payment.shipping.address.number}"
+  puts "      complement: #{payment.shipping.address.complement}"
+  puts "      postal code: #{payment.shipping.address.postal_code}"
+  puts "      district: #{payment.shipping.address.district}"
+  puts "      city: #{payment.shipping.address.city}"
+  puts "      state: #{payment.shipping.address.state}"
+  puts "      country: #{payment.shipping.address.country}"
+  puts "      type: #{payment.shipping.type_name}"
+  puts "      cost: #{payment.shipping.cost}"
+end