bluepay 1.0.3 → 1.0.4

data/test/Get_Data/Retrieve_Settlement_Data.rb

@@ -0,0 +1,34 @@
+##
+# 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_relative "../../lib/bluepay.rb"
+
+acct_id = "Merchant's Account ID Here"
+sec_key = "Merchant's Secret Key Here"
+trans_mode = "TEST" # Transaction Mode (can also be "LIVE")
+
+report = BluePay.new(
+  account_id: acct_id, 
+  secret_key: sec_key, 
+  mode: trans_mode 
+)
+
+report.get_settled_transaction_report(
+	report_start_date: '2015-01-01', #YYYY-MM-DD
+	report_end_date: '2015-04-30', #YYYY-MM-DD
+	query_by_hierarchy: '1', # Also search subaccounts? Yes
+	do_not_escape: '1', # Output response without commas? Yes
+	exclude_errors: '1' # Do not include errored transactions? Yes
+)
+
+# Makes the API request with BluePay
+response = report.process
+
+# Reads the response from BluePay
+puts response

data/test/Get_Data/Retrieve_Transaction_Data.rb

@@ -0,0 +1,33 @@
+##
+# 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_relative "../../lib/bluepay.rb"
+
+acct_id = "Merchant's Account ID Here"
+sec_key = "Merchant's Secret Key Here"
+trans_mode = "TEST" # Transaction Mode (can also be "LIVE")
+
+report = BluePay.new(
+  account_id: acct_id,  
+  secret_key: sec_key,  
+  mode: trans_mode
+)
+
+report.get_transaction_report(
+  report_start_date: '2015-04-27', #YYYY-MM-DD
+  report_end_date: '2015-04-30', #YYYY-MM-DD
+  query_by_hierarchy: '1', # Also search subaccounts? Yes
+  do_not_escape: '1', # Output response without commas? Yes
+  exclude_errors: '1' # Do not include errored transactions? Yes
+)
+
+# Makes the API request with BluePay
+response = report.process
+
+# Reads the response from BluePay
+puts response

data/test/Get_Data/Single_Transaction_Query.rb

@@ -0,0 +1,42 @@
+##
+# 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_relative "../../lib/bluepay.rb"
+
+acct_id = "Merchant's Account ID Here"
+sec_key = "Merchant's Secret Key Here"
+trans_mode = "TEST" # Transaction Mode (can also be "LIVE")
+
+query = BluePay.new(
+  account_id: acct_id,  
+  secret_key: sec_key,  
+  mode: trans_mode
+)
+
+query.get_single_transaction_query(
+  transaction_id: "100012341234", # required
+  report_start_date: '2015-12-01', #YYYY-MM-DD; required
+  report_end_date: '2015-12-30', #YYYY-MM-DD; required
+  exclude_errors: '1' # Do not include errored transactions? Yes; optional
+)
+
+# Makes the API request with BluePay 
+response = query.process
+if query.get_id
+  # Reads the 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/Get_Data/Transaction_Notification.rb

@@ -0,0 +1,61 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample shows a very based approach
+# on handling data that is posted to a script running
+# a merchant's server after a transaction is processed
+# through their BluePay gateway account.
+##
+
+require_relative "../../lib/bluepay.rb"
+require "cgi"
+
+vars = CGI.new
+
+secret_key = "MERCHANT'S SECRET KEY HERE"
+
+# Assign values
+trans_id = vars["trans_id"]
+trans_status = vars["trans_status"]
+trans_type = vars["trans_type"]
+amount = vars["amount"]
+batch_id = vars["batch_id"]
+batch_status = vars["batch_status"]
+total_count = vars["total_count"]
+total_amount = vars["total_amount"]
+batch_upload_id = vars["batch_upload_id"]
+rebill_id = vars["rebill_id"]
+rebill_amount = vars["reb_amount"]
+rebill_status = vars["status"]
+
+# Calculate expected bp_stamp
+bp_stamp = BluePay.calc_trans_notify_tps(
+  secret_key,
+  trans_id,
+  trans_status,
+  trans_type,
+  amount,
+  batch_id,
+  batch_status,
+  total_count,
+  total_amount,
+  batch_upload_id,
+  rebill_id,
+  rebill_amount,
+  rebill_status
+)
+
+# check if expected bp_stamp = actual bp_stamp
+if bp_stamp == vars["bp_stamp"]
+
+  # Reads the response from BluePay
+  puts 'Transaction ID: ' + trans_id
+  puts 'Transaction Status: ' + trans_status
+  puts  'Transaction Type: ' + trans_type
+  puts  'Transaction Amount: ' + amount
+  puts  'Rebill ID: ' + rebill_id
+  puts  'Rebill Amount: ' + rebill_amount
+  puts  'Rebill Status: ' + rebill_status
+else
+  puts 'ERROR IN RECEIVING DATA FROM BLUEPAY'
+end

data/test/Rebill/Cancel_Recurring_Payment.rb

@@ -0,0 +1,82 @@
+##
+# 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_relative "../../lib/bluepay.rb"
+
+ACCOUNT_ID = "Merchant's Account ID Here"
+SECRET_KEY = "Merchant's Secret Key Here"
+MODE = "TEST" # Transaction Mode (can also be "LIVE")
+
+rebill = BluePay.new(
+  account_id: ACCOUNT_ID,  
+  secret_key: SECRET_KEY,  
+  mode: MODE
+)
+
+# Set Customer Information
+rebill.set_customer_information(
+  first_name: "Bob", 
+  last_name: "Tester",
+  address1: "123 Test St.", 
+  address2: "Apt #500", 
+  city: "Testville", 
+  state: "IL", 
+  zip_code: "54321", 
+  country: "USA",
+  phone: "123-123-1234",  
+  email: "test@bluepay.com"  
+)
+
+# Set Credit Card Information
+rebill.set_cc_information(
+  cc_number: "4111111111111111", # Customer Credit Card Number
+  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cvv2: "123" # Card CVV2
+)
+
+rebill.set_recurring_payment(
+  reb_first_date: "2015-01-01", # Rebill Start Date: Jan. 1, 2015
+  reb_expr: "1 MONTH", # Rebill Frequency: 1 MONTH
+  reb_cycles: "12", # Rebill # of Cycles: 12
+  reb_amount: "15.00" # Rebill Amount: $15.00
+)
+
+rebill.auth(amount: "0.00") 
+
+# Makes the API Request to create a rebill
+rebill.process
+
+# If transaction was approved..
+if rebill.successful_response?
+  
+  rebill_cancel = BluePay.new(
+    account_id: ACCOUNT_ID,  
+    secret_key: SECRET_KEY,  
+    mode: MODE
+  )
+
+  # Find rebill by id and cancel rebilling cycle 
+  rebill_cancel.cancel_rebilling_cycle(rebill.get_rebill_id)
+
+  # Makes the API request to cancel the rebill
+  rebill_cancel.process
+
+  # Reads the 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 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 rebill.get_message
+end

data/test/Rebill/Create_Recurring_Payment_ACH.rb

@@ -0,0 +1,60 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample creates a recurring payment charging $15.00 per month for one year.
+
+require_relative "../../lib/bluepay.rb"
+
+acct_id = "Merchant's Account ID Here"
+sec_key = "Merchant's Secret Key Here"
+trans_mode = "TEST" # Transaction Mode (can also be "LIVE")
+
+rebill = BluePay.new(
+  account_id: acct_id,   
+  secret_key: sec_key,   
+  mode: trans_mode
+)
+
+rebill.set_customer_information(
+  first_name: "Bob", 
+  last_name: "Tester",
+  address1: "123 Test St.", 
+  address2: "Apt #500", 
+  city: "Testville", 
+  state: "IL", 
+  zip_code: "54321", 
+  country: "USA",
+  phone: "123-123-1234",  
+  email: "test@bluepay.com"  
+)
+
+rebill.set_ach_information(
+  ach_routing: "123123123", # Routing Number: 123123123
+  ach_account: "123456789", # Account Number: 123456789
+  ach_account_type: 'C', # Account Type: Checking
+  doc_type: "WEB" # ACH Document Type: WEB
+)
+
+rebill.set_recurring_payment(
+  reb_first_date: "2015-01-01", # Rebill Start Date: Jan. 1, 2015
+  reb_expr: "1 MONTH", # Rebill Frequency: 1 MONTH
+  reb_cycles: "12", # Rebill # of Cycles: 12
+  reb_amount: "15.00" # Rebill Amount: $15.00
+)
+
+rebill.auth(amount: "0.00") 
+
+# Makes the API Request with BluePay
+rebill.process
+
+# if transaction was successful
+if rebill.successful_response?
+  # Reads the response from BluePay
+  puts "TRANSACTION ID: " + rebill.get_trans_id
+  puts "REBILL ID: " + rebill.get_rebill_id
+  puts "TRANSACTION STATUS: " + rebill.get_status
+  puts "MASKED PAYMENT ACCOUNT: " + rebill.get_masked_account
+  puts "CUSTOMER BANK NAME: " + rebill.get_bank_name
+else
+  puts rebill.get_message
+end

data/test/Rebill/Create_Recurring_Payment_CC.rb

@@ -0,0 +1,62 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample creates a recurring payment charging $15.00 per month for one year.
+
+require_relative "../../lib/bluepay.rb"
+
+acct_id = "Merchant's Account ID Here"
+sec_key = "Merchant's Secret Key Here"
+trans_mode = "TEST" # Transaction Mode (can also be "LIVE")
+
+rebill = BluePay.new(
+  account_id: acct_id,   
+  secret_key: sec_key,   
+  mode: trans_mode
+)
+
+rebill.set_customer_information(
+  first_name: "Bob", 
+  last_name: "Tester",
+  address1: "123 Test St.", 
+  address2: "Apt #500", 
+  city: "Testville", 
+  state: "IL", 
+  zip_code: "54321", 
+  country: "USA",
+  phone: "123-123-1234",  
+  email: "test@bluepay.com"  
+)
+
+rebill.set_cc_information(
+  cc_number: "4111111111111111", # Customer Credit Card Number
+  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cvv2: "123" # Card CVV2
+)
+
+rebill.set_recurring_payment(
+  reb_first_date: "2015-01-01", # Rebill Start Date: Jan. 1, 2015
+  reb_expr: "1 MONTH", # Rebill Frequency: 1 MONTH
+  reb_cycles: "12", # Rebill # of Cycles: 12
+  reb_amount: "15.00" # Rebill Amount: $15.00
+)
+
+rebill.auth(amount: "0.00") 
+
+# Makes the API Request
+rebill.process
+
+# if transaction was successful
+if rebill.successful_response?
+  # Reads the response from BluePay
+  puts "TRANSACTION ID: " + rebill.get_trans_id
+  puts "REBILL ID: " + rebill.get_rebill_id
+  puts "TRANSACTION STATUS: " + rebill.get_status
+  puts "AVS RESPONSE: " + rebill.get_avs_code
+  puts "CVV2 RESPONSE: " + rebill.get_cvv2_code
+  puts "MASKED PAYMENT ACCOUNT: " + rebill.get_masked_account
+  puts "CARD TYPE: " + rebill.get_card_type
+  puts "AUTH CODE: " + rebill.get_auth_code
+else
+  puts rebill.get_message
+end

data/test/Rebill/Get_Recurring_Payment_Status.rb

@@ -0,0 +1,82 @@
+##
+# 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_relative "../../lib/bluepay.rb"
+
+acct_id = "Merchant's Account ID Here"
+sec_key = "Merchant's Secret Key Here"
+trans_mode = "TEST" # Transaction Mode (can also be "LIVE")
+
+rebill = BluePay.new(
+  account_id: acct_id,   
+  secret_key: sec_key,   
+  mode: trans_mode
+)
+
+rebill.set_customer_information(
+  first_name: "Bob", 
+  last_name: "Tester",
+  address1: "123 Test St.", 
+  address2: "Apt #500", 
+  city: "Testville", 
+  state: "IL", 
+  zip_code: "54321", 
+  country: "USA",
+  phone: "123-123-1234",  
+  email: "test@bluepay.com"
+)  
+
+rebill.set_cc_information(
+  cc_number: "4111111111111111", # Customer Credit Card Number
+  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cvv2: "123" # Card CVV2
+)
+
+rebill.set_recurring_payment(
+  reb_first_date: "2015-01-05", # Rebill Start Date: Jan. 5, 2015
+  reb_expr: "1 MONTH", # Rebill Frequency: 1 MONTH
+  reb_cycles: "11", # Rebill # of Cycles: 11
+  reb_amount: "15.00" # Rebill Amount: $15.00
+)
+
+rebill.auth(amount: "0.00") 
+
+# Makes the API Request to create a recurring payment
+rebill.process
+
+# If transaction was successful..
+if rebill.successful_response?
+  
+  rebill_status = BluePay.new(
+    account_id: ACCOUNT_ID,  
+    secret_key: SECRET_KEY,  
+    mode: MODE
+  )
+
+  # Find the rebill by ID and get rebill status 
+  rebill_status.get_rebilling_cycle_status(rebill.get_rebill_id)
+
+  # Makes the API Request to get the rebill status
+  rebill_status.process
+
+  # Reads the 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 rebill.get_message
+end