bluepay 1.0.1 → 1.0.2

data/test/get_data/retrieve_settlement_data.rb

@@ -0,0 +1,39 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a report that grabs data from the
+# BluePay gateway based on certain criteria. This will ONLY return
+# transactions that have already settled. See comments below
+# on the details of the report.
+# If using TEST mode, only TEST transactions will be returned.
+##
+
+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)
+report = BluePay.new(
+  $ACCOUNT_ID,
+  $SECRET_KEY,
+  $MODE)
+
+# Report Start Date: Jan. 1, 2013
+# Report End Date: Jan. 15, 2013
+# Also search subaccounts? Yes
+# Output response without commas? Yes
+# Do not include errored transactions? Yes
+report.get_settled_transaction_report(
+  '2013-01-01',
+  '2013-01-15',
+  '1',
+  '1',
+  '1')
+report.process()
+
+# Read response from BluePay
+puts report.get_response()

data/test/get_data/retrieve_transaction_data.rb

@@ -0,0 +1,37 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a report that grabs data from the
+# BluePay gateway based on certain criteria.
+# If using TEST mode, only TEST transactions will be returned.
+##
+
+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)
+report = BluePay.new(
+  $ACCOUNT_ID,
+  $SECRET_KEY,
+  $MODE)
+
+# Report Start Date: Jan. 1, 2013
+# Report End Date: Jan. 15, 2013
+# Also search subaccounts? Yes
+# Output response without commas? Yes
+# Do not include errored transactions? Yes
+report.get_transaction_report(
+  '2013-01-01',
+  '2013-01-15',
+  '1',
+  '1',
+  '1')
+report.process()
+
+# Read response from BluePay
+puts report.get_response()

data/test/get_data/transaction_query.rb

@@ -0,0 +1,48 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a report that grabs a single transaction
+# from the BluePay gateway based on certain criteria.
+# See comments below on the details of the report.
+# If using TEST mode, only TEST transactions will be returned.
+##
+
+require "bluepay"
+
+$ACCOUNT_ID = "MERCHANT'S ACCOUNT ID HERE"
+$SECRET_KEY = "MERCHANT'S SECRET KEY HERE"
+$MODE = "TEST"
+$TRANSACTION_ID = "ENTER A TRANSACTION ID HERE"
+
+# Merchant's Account ID
+# Merchant's Secret Key
+# Transaction Mode: TEST (can also be LIVE)
+query = BluePay.new(
+  $ACCOUNT_ID,
+  $SECRET_KEY,
+  $MODE)
+
+# Query Start Date: Jan. 1, 2013
+# Query End Date: Jan. 15, 2013
+# Do not include errored transactions? Yes
+query.get_single_trans_query(
+  '2013-01-01',
+  '2013-01-15',
+  '1')
+
+# Query by a specific Transaction ID
+query.query_by_transaction_id($TRANSACTION_ID)
+
+response = query.process()
+
+if (query.get_id()) then
+  # Read response from BluePay
+  puts 'Transaction ID: ' + query.get_id()
+  puts 'First Name: ' + query.get_name1()
+  puts 'Last Name: ' + query.get_name2()
+  puts 'Payment Type: ' + query.get_payment_type()
+  puts 'Transaction Type: ' + query.get_trans_type()
+  puts 'Amount: ' + query.get_amount()
+else
+  puts response
+end

data/test/getting_stuff_done/get_transaction_data.rb

@@ -0,0 +1,37 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a report that grabs data from the
+# BluePay gateway based on certain criteria.
+# If using TEST mode, only TEST transactions will be returned.
+##
+
+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)
+report = BluePay.new(
+  $ACCOUNT_ID,
+  $SECRET_KEY,
+  $MODE)
+
+# Report Start Date: Jan. 1, 2013
+# Report End Date: Jan. 15, 2013
+# Also search subaccounts? Yes
+# Output response without commas? Yes
+# Do not include errored transactions? Yes
+report.get_transaction_report(
+  '2013-01-01',
+  '2013-01-15',
+  '1',
+  '1',
+  '1')
+report.process()
+
+# Read response from BluePay
+puts report.get_response()

data/test/getting_stuff_done/run_ach_payment.rb

@@ -0,0 +1,75 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $3.00 ACH Sale transaction
+# against a customer using test payment information.
+
+##
+
+require "test/unit"
+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)
+
+# Routing Number: 123123123
+# Account Number: 123456789
+# Account Type: Checking
+# ACH Document Type: WEB
+payment.set_ach_information(
+  "123123123",
+  "123456789",
+  'C',
+  "WEB")
+
+# 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 (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 "AVS RESPONSE: " + payment.get_avs_code()
+  puts "CVV2 RESPONSE: " + payment.get_cvv2_code()
+  puts "MASKED PAYMENT ACCOUNT: " + payment.get_masked_account()
+  puts "CUSTOMER BANK NAME: " + payment.get_bank_name()
+  puts "AUTH CODE: " + payment.get_auth_code()
+else
+  puts payment.get_message()
+end

data/test/getting_stuff_done/run_cc_payment.rb

@@ -0,0 +1,73 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $3.00 Credit Card Sale transaction
+# against a customer using test payment information.
+# 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 (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 "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/getting_stuff_done/set_up_rebill_ach.rb

@@ -0,0 +1,85 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $3.00 ACH Sale 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)
+
+# Routing Number: 123123123
+# Account Number: 123456789
+# Account Type: Checking
+# ACH Document Type: WEB
+payment.set_ach_information(
+  "123123123",
+  "123456789",
+  'C',
+  "WEB")
+
+# 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")
+
+# Sale Amount: $3.00
+payment.sale("3.00")
+
+response = payment.process()
+
+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 "CUSTOMER BANK NAME: " + payment.get_bank_name()
+  puts "AUTH CODE: " + payment.get_auth_code()
+else
+  puts payment.get_message()
+end

data/test/getting_stuff_done/set_up_rebill_cc.rb

@@ -0,0 +1,84 @@
+#
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $3.00 Credit Card Sale transaction
+# against a customer using test payment information.
+# 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")
+
+# 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")
+
+# Sale Amount: $3.00
+payment.sale("3.00")
+
+response = payment.process()
+
+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