bluepay 1.0.1 → 1.0.2

data/test/rebills/cancel_rebill.rb

@@ -0,0 +1,96 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $0.00 Credit Card Auth transaction
+# against a customer using test payment information, sets up
+# a rebilling cycle, and also shows how to cancel that rebilling cycle.
+# See comments below on the details of the initial setup of the
+# rebilling cycle.
+##
+
+require "bluepay"
+
+$ACCOUNT_ID = "MERCHANT'S ACCOUNT ID HERE"
+$SECRET_KEY = "MERCHANT'S SECRET KEY HERE"
+$MODE = "TEST"
+
+# Merchant's Account ID
+# Merchant's Secret Key
+# Transaction Mode: TEST (can also be LIVE)
+payment = BluePay.new(
+  $ACCOUNT_ID,
+  $SECRET_KEY,
+  $MODE)
+
+# Card Number: 4111111111111111
+# Card Expire: 12/15
+# Card CVV2: 123
+payment.set_cc_information(
+  "4111111111111111",
+  "1215",
+  "123")
+
+# First Name: Bob
+# Last Name: Tester
+# Address1: 123 Test St.
+# Address2: Apt #500
+# City: Testville
+# State: IL
+# Zip: 54321
+# Country: USA
+payment.set_customer_information(
+  "Bob",
+  "Tester",
+  "123 Test St.",
+  "Testville",
+  "IL",
+  "54321",
+  "Apt #500",
+  "USA")
+
+# Rebill Start Date: Jan. 5, 2015
+# Rebill Frequency: 1 MONTH
+# Rebill # of Cycles: 5
+# Rebill Amount: $3.50
+payment.add_recurring_fields(
+  "2015-01-05",
+  "1 MONTH",
+  "5",
+  "3.50")
+
+# Phone #: 123-123-1234
+payment.set_phone("1231231234")
+
+# Email Address: test@bluepay.com
+payment.set_email("test@bluepay.com")
+
+# Auth Amount: $0.00
+payment.auth("0.00")
+
+response = payment.process()
+
+# If transaction was approved..
+if (payment.get_status() == "APPROVED") then
+  rebill_cancel = BluePay.new(
+    $ACCOUNT_ID,
+    $SECRET_KEY,
+    $MODE)
+
+  # Cancel rebilling cycle from above transaction
+  rebill_cancel.cancel_rebilling_cycle(payment.get_rebill_id())
+
+  rebill_cancel.process()
+ 
+  # Read response from BluePay
+  puts "REBILL STATUS: " + rebill_cancel.get_rebill_status()
+  puts "REBILL ID: " + rebill_cancel.get_reb_id()
+  puts "REBILL CREATION DATE: " + rebill_cancel.get_creation_date()
+  puts "REBILL NEXT DATE: " + rebill_cancel.get_next_date()
+  puts "REBILL LAST DATE: " + rebill_cancel.get_last_date()
+  puts "REBILL SCHEDULE EXPRESSION: " + rebill_cancel.get_sched_expression()
+  puts "REBILL CYCLES REMAINING: " + rebill_cancel.get_cycles_remaining()
+  puts "REBILL AMOUNT: " + rebill_cancel.get_rebill_amount()
+  puts "REBILL NEXT AMOUNT: " + rebill_cancel.get_next_amount()
+else
+  puts payment.get_message()
+end

data/test/rebills/create_rebill.rb

@@ -0,0 +1,84 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $0.00 Credit Card Auth transaction
+# against a customer using test payment information. See comments below
+# on the details of the initial setup of the rebilling cycle
+##
+
+require "bluepay"
+
+$ACCOUNT_ID = "MERCHANT'S ACCOUNT ID HERE"
+$SECRET_KEY = "MERCHANT'S SECRET KEY HERE"
+$MODE = "TEST"
+
+# Merchant's Account ID
+# Merchant's Secret Key
+# Transaction Mode: TEST (can also be LIVE)
+payment = BluePay.new(
+  $ACCOUNT_ID,
+  $SECRET_KEY,
+  $MODE)
+
+# Card Number: 4111111111111111
+# Card Expire: 12/15
+# Card CVV2: 123
+payment.set_cc_information(
+  "4111111111111111",
+  "1215",
+  "123")
+
+# First Name: Bob
+# Last Name: Tester
+# Address1: 123 Test St.
+# Address2: Apt #500
+# City: Testville
+# State: IL
+# Zip: 54321
+# Country: USA
+payment.set_customer_information(
+  "Bob",
+  "Tester",
+  "123 Test St.",
+  "Testville",
+  "IL",
+  "54321",
+  "Apt #500",
+  "USA")
+
+# Rebill Start Date: Jan. 5, 2015
+# Rebill Frequency: 1 MONTH
+# Rebill # of Cycles: 5
+# Rebill Amount: $3.50
+payment.add_recurring_fields(
+  "2015-01-05",
+  "1 MONTH",
+  "5",
+  "3.50")
+
+# Phone #: 123-123-1234
+payment.set_phone("1231231234")
+
+# Email Address: test@bluepay.com
+payment.set_email("test@bluepay.com")
+
+# Auth Amount: $0.00
+payment.auth("0.00")
+
+response = payment.process()
+
+# If transaction was approved..
+if (payment.get_status() == "APPROVED") then
+  # Read response from BluePay
+  puts "TRANSACTION STATUS: " + payment.get_status()
+  puts "TRANSACTION MESSAGE: " + payment.get_message()
+  puts "TRANSACTION ID: " + payment.get_trans_id()
+  puts "REBILL ID: " + payment.get_rebill_id()
+  puts "AVS RESPONSE: " + payment.get_avs_code()
+  puts "CVV2 RESPONSE: " + payment.get_cvv2_code()
+  puts "MASKED PAYMENT ACCOUNT: " + payment.get_masked_account()
+  puts "CARD TYPE: " + payment.get_card_type()
+  puts "AUTH CODE: " + payment.get_auth_code()
+else
+  puts payment.get_message()
+end

data/test/rebills/get_rebill.rb

@@ -0,0 +1,97 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $0.00 Credit Card Auth transaction
+# against a customer using test payment information.
+# Once the rebilling cycle is created, this sample shows how to
+# get information back on this rebilling cycle.
+# See comments below on the details of the initial setup of the
+# rebilling cycle.
+##
+
+require "bluepay"
+
+$ACCOUNT_ID = "MERCHANT'S ACCOUNT ID HERE"
+$SECRET_KEY = "MERCHANT'S SECRET KEY HERE"
+$MODE = "TEST"
+
+# Merchant's Account ID
+# Merchant's Secret Key
+# Transaction Mode: TEST (can also be LIVE)
+payment = BluePay.new(
+  $ACCOUNT_ID,
+  $SECRET_KEY,
+  $MODE)
+
+# Card Number: 4111111111111111
+# Card Expire: 12/15
+# Card CVV2: 123
+payment.set_cc_information(
+  "4111111111111111",
+  "1215",
+  "123")
+
+# First Name: Bob
+# Last Name: Tester
+# Address1: 123 Test St.
+# Address2: Apt #500
+# City: Testville
+# State: IL
+# Zip: 54321
+# Country: USA
+payment.set_customer_information(
+  "Bob",
+  "Tester",
+  "123 Test St.",
+  "Testville",
+  "IL",
+  "54321",
+  "Apt #500",
+  "USA")
+
+# Rebill Start Date: Jan. 5, 2015
+# Rebill Frequency: 1 MONTH
+# Rebill # of Cycles: 5
+# Rebill Amount: $3.50
+payment.add_recurring_fields(
+  "2015-01-05",
+  "1 MONTH",
+  "5",
+  "3.50")
+
+# Phone #: 123-123-1234
+payment.set_phone("1231231234")
+
+# Email Address: test@bluepay.com
+payment.set_email("test@bluepay.com")
+
+# Auth Amount: $0.00
+payment.auth("0.00")
+
+response = payment.process()
+
+# If transaction was approved..
+if (payment.get_status() == "APPROVED") then
+  rebill_status = BluePay.new(
+    $ACCOUNT_ID,
+    $SECRET_KEY,
+    $MODE)
+
+  # Cancel rebilling cycle from above transaction
+  rebill_status.get_rebilling_cycle_status(payment.get_rebill_id())
+
+  rebill_status.process()
+ 
+  # Read response from BluePay
+  puts "REBILL STATUS: " + rebill_status.get_rebill_status()
+  puts "REBILL ID: " + rebill_status.get_reb_id()
+  puts "REBILL CREATION DATE: " + rebill_status.get_creation_date()
+  puts "REBILL NEXT DATE: " + rebill_status.get_next_date()
+  puts "REBILL LAST DATE: " + rebill_status.get_last_date()
+  puts "REBILL SCHEDULE EXPRESSION: " + rebill_status.get_sched_expression()
+  puts "REBILL CYCLES REMAINING: " + rebill_status.get_cycles_remaining()
+  puts "REBILL AMOUNT: " + rebill_status.get_rebill_amount()
+  puts "REBILL NEXT AMOUNT: " + rebill_status.get_next_amount()
+else
+  puts payment.get_message()
+end

data/test/rebills/update_rebill.rb

@@ -0,0 +1,128 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $0.00 Credit Card Auth transaction
+# against a customer using test payment information.
+# Once the rebilling cycle is created, this sample shows how to
+# update the rebilling cycle. See comments below
+# on the details of the initial setup of the rebilling cycle as well as the
+# updated rebilling cycle.
+##
+
+require "bluepay"
+
+$ACCOUNT_ID = "MERCHANT'S ACCOUNT ID HERE"
+$SECRET_KEY = "MERCHANT'S SECRET KEY HERE"
+$MODE = "TEST"
+
+# Merchant's Account ID
+# Merchant's Secret Key
+# Transaction Mode: TEST (can also be LIVE)
+payment = BluePay.new(
+  $ACCOUNT_ID,
+  $SECRET_KEY,
+  $MODE)
+
+# Card Number: 4111111111111111
+# Card Expire: 12/15
+# Card CVV2: 123
+payment.set_cc_information(
+  "4111111111111111",
+  "1215",
+  "123")
+
+# First Name: Bob
+# Last Name: Tester
+# Address1: 123 Test St.
+# Address2: Apt #500
+# City: Testville
+# State: IL
+# Zip: 54321
+# Country: USA
+payment.set_customer_information(
+  "Bob",
+  "Tester",
+  "123 Test St.",
+  "Testville",
+  "IL",
+  "54321",
+  "Apt #500",
+  "USA")
+
+# Rebill Start Date: Jan. 5, 2015
+# Rebill Frequency: 1 MONTH
+# Rebill # of Cycles: 5
+# Rebill Amount: $3.50
+payment.add_recurring_fields(
+  "2015-01-05",
+  "1 MONTH",
+  "5",
+  "3.50")
+
+# Phone #: 123-123-1234
+payment.set_phone("1231231234")
+
+# Email Address: test@bluepay.com
+payment.set_email("test@bluepay.com")
+
+# Auth Amount: $0.00
+payment.auth("0.00")
+
+response = payment.process()
+
+# If transaction was approved..
+if (payment.get_status() == "APPROVED") then
+  update_payment_information = BluePay.new(
+    $ACCOUNT_ID,
+    $SECRET_KEY,
+    $MODE)
+
+  # Card Number: 4111111111111111
+  # Card Expire: 01/21
+  update_payment_information.set_cc_information(
+    "4111111111111111",
+    "0121")
+
+  # Stores new card expiration date
+  update_payment_information.auth("0.00", payment.get_trans_id())
+
+  update_payment_information.process()
+
+  update_rebill = BluePay.new(
+    $ACCOUNT_ID,
+    $SECRET_KEY,
+    $MODE)
+
+  # Attempts to cancel rebill using Rebill ID token returned
+  # Rebill Start Date: March 1, 2015
+  # Rebill Frequency: 1 MONTH
+  # Rebill # of Cycles: 8
+  # Rebill Amount: $5.15
+  # Rebill Next Amount: $1.50
+  update_rebill.update_rebilling_cycle(
+    payment.get_rebill_id(),
+    "2015-03-01",
+    "1 MONTH",
+    "8",
+    "5.15",
+    "1.50")
+
+  # Updates the payment information portion of the rebilling cycle to the
+  # new card expiration date entered above
+  update_rebill.update_rebilling_payment_information(update_payment_information.get_trans_id())
+
+  update_rebill.process()
+
+  # Read response from BluePay
+  puts "REBILL STATUS: " + update_rebill.get_rebill_status()
+  puts "REBILL ID: " + update_rebill.get_reb_id()
+  puts "REBILL CREATION DATE: " + update_rebill.get_creation_date()
+  puts "REBILL NEXT DATE: " + update_rebill.get_next_date()
+  puts "REBILL LAST DATE: " + update_rebill.get_last_date()
+  puts "REBILL SCHEDULE EXPRESSION: " + update_rebill.get_sched_expression()
+  puts "REBILL CYCLES REMAINING: " + update_rebill.get_cycles_remaining()
+  puts "REBILL AMOUNT: " + update_rebill.get_rebill_amount()
+  puts "REBILL NEXT AMOUNT: " + update_rebill.get_next_amount()
+else
+  puts payment.get_message()
+end

data/test/transactions/cancel_transaction.rb

@@ -0,0 +1,85 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $3.00 Credit Card Sale transaction
+# against a customer using test payment information.
+# If approved, a 2nd transaction is run to cancel this transaction.
+# If using TEST mode, odd dollar amounts will return
+# an approval and even dollar amounts will return a decline.
+##
+
+require "bluepay"
+
+$ACCOUNT_ID = "MERCHANT'S ACCOUNT ID HERE"
+$SECRET_KEY = "MERCHANT'S SECRET KEY HERE"
+$MODE = "TEST"
+
+# Merchant's Account ID
+# Merchant's Secret Key
+# Transaction Mode: TEST (can also be LIVE)
+payment = BluePay.new(
+  $ACCOUNT_ID,
+  $SECRET_KEY,
+  $MODE)
+
+# Card Number: 4111111111111111
+# Card Expire: 12/15
+# Card CVV2: 123
+payment.set_cc_information(
+  "4111111111111111",
+  "1215",
+  "123")
+
+# First Name: Bob
+# Last Name: Tester
+# Address1: 123 Test St.
+# Address2: Apt #500
+# City: Testville
+# State: IL
+# Zip: 54321
+# Country: USA
+payment.set_customer_information(
+  "Bob",
+  "Tester",
+  "123 Test St.",
+  "Testville",
+  "IL",
+  "54321",
+  "Apt #500",
+  "USA")
+
+# Phone #: 123-123-1234
+payment.set_phone("1231231234")
+
+# Email Address: test@bluepay.com
+payment.set_email("test@bluepay.com")
+
+# Sale Amount: $3.00
+payment.sale("3.00")
+
+response = payment.process()
+
+# If transaction was approved..
+if (payment.get_status() == "APPROVED") then
+  payment_void = BluePay.new(
+    $ACCOUNT_ID,
+    $SECRET_KEY,
+    $MODE)
+
+  # Attempts to void above Sale transaction
+  payment_void.void(payment.get_trans_id())
+
+  payment_void.process()
+
+  # Read response from BluePay
+  puts "TRANSACTION STATUS: " + payment.get_status()
+  puts "TRANSACTION MESSAGE: " + payment.get_message()
+  puts "TRANSACTION ID: " + payment.get_trans_id()
+  puts "AVS RESPONSE: " + payment.get_avs_code()
+  puts "CVV2 RESPONSE: " + payment.get_cvv2_code()
+  puts "MASKED PAYMENT ACCOUNT: " + payment.get_masked_account()
+  puts "CARD TYPE: " + payment.get_card_type()
+  puts "AUTH CODE: " + payment.get_auth_code()
+else
+  puts payment.get_message()
+end