bluepay 1.0.3 → 1.0.4

data/test/Rebill/Update_Recurring_Payment.rb

@@ -0,0 +1,111 @@
+##
+# 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_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: "1234 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: "5", # Rebill # of Cycles: 5
+  reb_amount: "3.50" # Rebill Amount: $3.50
+)
+
+rebill.auth(amount: "0.00") 
+
+# Makes the API Request to create a rebill
+rebill.process
+
+# If transaction was approved..
+if rebill.successful_response?
+
+  payment_information_update = BluePay.new(
+    account_id: ACCOUNT_ID,  
+    secret_key: SECRET_KEY,  
+    mode: MODE  
+  )
+
+  # Sets an updated credit card expiration date
+  payment_information_update.set_cc_information(
+    cc_expiration: "0121" # Card Expiration
+  )
+
+  # Stores new card expiration date
+  payment_information_update.auth(
+    amount: "0.00", 
+    trans_id: rebill.get_trans_id # the id of the rebill to update
+  )
+  
+  # Makes the API Request to update the payment information
+  payment_information_update.process
+
+  # Creates a request to update the rebill
+  rebill_update = BluePay.new(
+    account_id: ACCOUNT_ID,  
+    secret_key: SECRET_KEY,  
+    mode: MODE  
+  )
+
+  # Updates the rebill
+  rebill_update.update_rebill(
+    rebill_id: rebill.get_rebill_id, # The ID of the rebill to be updated.  
+    template_id: payment_information_update.get_trans_id, # Updates the payment information portion of the rebilling cycle with the new card expiration date entered above 
+    next_date: "2015-03-01", # Rebill Start Date: March 1, 2015
+    reb_expr: "1 MONTH", # Rebill Frequency: 1 MONTH
+    reb_cycles: "8", # Rebill # of Cycles: 8
+    reb_amount: "5.15", # Rebill Amount: $5.15
+    next_amount: "1.50" # Rebill Next Amount: $1.50
+  )
+  
+  # Makes the API Request to update the rebill
+  rebill_update.process
+
+  # Reads the response from BluePay
+  puts "REBILL STATUS: " + rebill_update.get_rebill_status
+  puts "REBILL ID: " + rebill_update.get_reb_id
+  puts "REBILL CREATION DATE: " + rebill_update.get_creation_date
+  puts "REBILL NEXT DATE: " + rebill_update.get_next_date
+  puts "REBILL LAST DATE: " + rebill_update.get_last_date
+  puts "REBILL SCHEDULE EXPRESSION: " + rebill_update.get_sched_expression
+  puts "REBILL CYCLES REMAINING: " + rebill_update.get_cycles_remaining
+  puts "REBILL AMOUNT: " + rebill_update.get_rebill_amount
+  puts "REBILL NEXT AMOUNT: " + rebill_update.get_next_amount
+else
+  puts rebill.get_message
+end

data/test/Transactions/Cancel_Transaction.rb

@@ -0,0 +1,74 @@
+##
+# 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_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")
+
+payment = BluePay.new(
+  account_id: acct_id,   
+  secret_key: sec_key,   
+  mode: trans_mode
+)
+
+payment.set_customer_information(
+  first_name: "Bob", 
+  last_name: "Tester",
+  address1: "1234 Test St.", 
+  address2: "Apt #500", 
+  city: "Testville", 
+  state: "IL", 
+  zip_code: "54321", 
+  country: "USA",
+  phone: "123-123-1234",  
+  email: "test@bluepay.com"  
+)
+
+payment.set_cc_information(
+  cc_number: "4111111111111111", # Customer Credit Card Number
+  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cvv2: "123" # Card CVV2
+)
+
+
+payment.sale(amount: "3.00") # Sale Amount: $3.00
+
+# Makes the API Request to create a sale 
+payment.process
+
+# If transaction was approved..
+if payment.successful_response?
+
+  payment_void = BluePay.new(
+    account_id: acct_id,  
+    secret_key: sec_key,  
+    mode: trans_mode
+  )
+
+  # Finds the previous payment by ID and attempts to void it
+  payment_void.void(payment.get_trans_id)
+  
+  # Makes the API Request to void the payment
+  payment_void.process
+
+  # Reads the response from BluePay
+  puts "TRANSACTION STATUS: " + payment_void.get_status
+  puts "TRANSACTION MESSAGE: " + payment_void.get_message
+  puts "TRANSACTION ID: " + payment_void.get_trans_id
+  puts "AVS RESPONSE: " + payment_void.get_avs_code
+  puts "CVV2 RESPONSE: " + payment_void.get_cvv2_code
+  puts "MASKED PAYMENT ACCOUNT: " + payment_void.get_masked_account
+  puts "CARD TYPE: " + payment_void.get_card_type
+  puts "AUTH CODE: " + payment_void.get_auth_code
+else
+  puts payment.get_message
+end

data/test/Transactions/Charge_Customer_ACH.rb

@@ -0,0 +1,54 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $3.00 ACH sales transaction
+# against a customer using test payment information.
+##
+
+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")
+
+payment = BluePay.new(
+  account_id: acct_id,
+  secret_key: sec_key,
+  mode: trans_mode
+)
+
+payment.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"  
+)
+
+payment.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
+)
+
+payment.sale(amount: "3.00") # Sale Amount: $3.00
+
+# Makes the API Request with BluePay
+payment.process
+
+# Reads the response from BluePay
+if payment.successful_response?
+  puts "TRANSACTION ID: " + payment.get_trans_id
+  puts "TRANSACTION STATUS: " + payment.get_status
+  puts "TRANSACTION MESSAGE: " + payment.get_message
+  puts "MASKED PAYMENT ACCOUNT: " + payment.get_masked_account
+  puts "CUSTOMER BANK NAME: " + payment.get_bank_name
+else
+  puts payment.get_message
+end

data/test/Transactions/Charge_Customer_CC.rb

@@ -0,0 +1,60 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $3.00 Credit Card sales 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_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")
+
+payment = BluePay.new(
+  account_id: acct_id,
+  secret_key: sec_key,
+  mode: trans_mode
+)
+
+payment.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"  
+)
+
+payment.set_cc_information(
+  cc_number: "4111111111111111", # Customer Credit Card Number
+  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cvv2: "123" # Card CVV2
+)
+
+payment.sale(amount: "3.00") # Sale Amount: $3.00
+
+# Makes the API Request with BluePay
+payment.process
+
+# If transaction was successful
+if payment.successful_response?  
+  # Reads the 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/Transactions/Check_Customer_Credit.rb

@@ -0,0 +1,58 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $3.00 Credit Card Authorization 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_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")
+
+payment = BluePay.new(
+  account_id: acct_id,
+  secret_key: sec_key,
+  mode: trans_mode
+)
+
+payment.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"  
+)
+
+payment.set_cc_information(
+  cc_number: "4111111111111111", # Customer Credit Card Number
+  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cvv2: "123" # Card CVV2
+)
+
+payment.auth(amount: "3.00") # Card authorization amount: $3.00
+
+# Makes the API Request for a credit card authorization
+payment.process
+
+# If transaction was approved..
+if payment.successful_response?
+  # Reads the 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/Transactions/Customer_Defined_Data.rb

@@ -0,0 +1,71 @@
+##
+# BluePay Ruby Sample code.
+#
+# This code sample runs a $25.00 Credit Card Sale transaction
+# against a customer using test payment information.
+# Optional transaction data is also sent.
+# If using TEST mode, odd dollar amounts will return
+# an approval and even dollar amounts will return a decline.
+##
+
+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")
+
+payment = BluePay.new(
+  account_id: acct_id,   
+  secret_key: sec_key,   
+  mode: trans_mode
+)
+
+payment.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"  
+)
+
+payment.set_cc_information(
+  cc_number: "4111111111111111", # Customer Credit Card Number
+  cc_expiration: "1215", # Card Expiration Date: MMYY
+  cvv2: "123" # Card CVV2
+)
+
+# Optional fields users can set
+payment.custom_id1 = "12345" # Custom ID1: 12345
+payment.custom_id2 = "09866" # Custom ID2: 09866
+payment.invoice_id = "500000" # Invoice ID: 50000
+payment.order_id = "10023145" # Order ID: 10023145
+payment.amount_tip = "6.00" # Tip Amount: $6.00
+payment.amount_tax = "3.50" # Tax Amount: $3.50
+payment.amount_food = "3.11" # Food Amount: $3.11
+payment.amount_misc = "5.00" # Miscellaneous Amount: $5.00
+payment.memo = "Enter any comments about the transaction here." # Comments
+
+payment.sale(amount: "25.00") # Sale Amount: $25.00
+
+# Makes the API request with BluePay
+payment.process
+
+# If transaction was approved..
+if payment.successful_response?
+  # Reads the 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/Transactions/How_To_Use_Token.rb

@@ -0,0 +1,42 @@
+##
+# BluePay Ruby Sample code.
+#
+# Charges a customer $3.00 using the payment and customer information from a previous transaction. 
+# If using TEST mode, odd dollar amounts will return
+# an approval and even dollar amounts will return a decline.
+##
+
+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")
+token = "100012341234" # Transaction ID of previous auth or sale here
+
+payment = BluePay.new(
+  account_id: acct_id,
+  secret_key: sec_key,
+  mode: trans_mode
+)
+
+payment.sale(
+  amount: "3.00", 
+  trans_id: token # The transaction ID of a previous sale
+) 
+
+# Makes the API Request
+payment.process
+
+if payment.successful_response?
+  # Reads the 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