bluepay 1.0.1 → 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  metadata.gz: 6ac6f5977bf61ba07a7f932d220c2df6475936de25a560003f99fe9aa1b38d6bd4c3b0ab94a3fe6c17790a40729e9d543533d75da07394028b61a980e14f172c
+  data.tar.gz: e65a2e185d9be311e07af34906e8a66ea51a0b79e9a39504f6c15bcde6d92c7478534afb10bd9c845a21cc3604704890e09659e97dd316475e3d00b14dc469d5
+SHA1: 
+  metadata.gz: 67e239782645fc2fb85f1edfbcee03fe47a9d79c
+  data.tar.gz: 1cc9b33754ffa647f6279bad1083986212b7da02

data/README

@@ -1,28 +1,60 @@
 == Welcome to Bluepay
 
-Bluepay is used to process credit cards and ach transactions using the BluePay 2.0 Gateway.
+Bluepay is used to process credit cards and ach transactions using the BluePay Gateway.
 
-BluePay, Inc. is a merchant account provider and payment gateway.  The BluePay 2.0 Gateway processes credit card and
+BluePay, Inc. is a merchant account provider and payment gateway.  The BluePay Gateway processes credit card and
 ACH transactions through a virtual terminal and various API/SDK/Payment Interfaces.
 
 To apply for a BluePay merchant account and payment gateway, visit http://www.bluepay.com.
 
 == Example
 
-    require "Bluepay"
-
-    tob = Bluepay.new("123123123123", "ABCDabcdABCDabcdABCDabcdABCDabcd")
-    tob.easy_sale("1.00")
-    tob.use_card("4111111111111111", "1109", "123")
-    tob.process()
-    puts "Status: " + tob.get_status()
-    puts "Message: " + tob.get_message()
-    puts "Transaction ID: " + tob.get_trans_id()
+require "bluepay_payment"
+
+$ACCOUNT_ID = "MERCHANT'S ACCOUNT ID HERE"
+$SECRET_KEY = "MERCHANT'S SECRET KEY HERE"
+$MODE = "TEST"
+
+payment = BluePayPayment.new(
+  $ACCOUNT_ID,
+  $SECRET_KEY,
+  $MODE)
+
+payment.set_cc_information(
+  "4111111111111111",
+  "1215",
+  "123")
+
+payment.set_customer_information(
+  "Bob",
+  "Tester",
+  "123 Test St.",
+  "Testville",
+  "IL",
+  "54321",
+  "Apt #500",
+  "USA")
+
+payment.sale("3.00")
+
+response = payment.process()
+
+if (payment.get_status() == "APPROVED") then
+  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
 
 == About
 
-Author::    Chris Jansen
-ReadmeDoc:: Christopher Kois
-Copyright:: Copyright (c) 2008 BluePay, Inc.
+Author::    Justin Slingerland
+ReadmeDoc:: Justin Slingerland
+Copyright:: Copyright (c) 2014 BluePay, Inc.
 License::   GPL - GNU General Public License - http://www.gnu.org/licenses/gpl.html
-

data/Rakefile

@@ -1,31 +1,21 @@
-require 'rubygems'
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/gempackagetask'
+require 'rdoc/task'
+require 'rubygems/package_task'
 require 'rake/contrib/rubyforgepublisher'
 
-PKG_VERSION = "1.0.1"
-
-PKG_FILES = FileList[
-    "lib/**/*", "bin/*", "test/**/*", "[A-Z]*", "Rakefile", "doc/**/*"
-]
-
-desc "Default Task"
 task :default => [ :test ]
 
-# Run the unit tests
-desc "Run all unit tests"
-Rake::TestTask.new("test") { |t|
-  t.libs << "lib"
-  t.pattern = 'test/*/*_test.rb'
-  t.verbose = true
-}
+# Build gem
+task :build do
+  system "gem build bluepay.gemspec"
+end
 
-# Make a console, useful when working on tests
-desc "Generate a test console"
-task :console do
-   verbose( false ) { sh "irb -I lib/ -r 'bluepay'" }
+# Runs tests
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*/*.rb']
+  t.verbose = true
 end
 
 # Genereate the RDoc documentation
@@ -37,47 +27,6 @@ Rake::RDocTask.new("doc") { |rdoc|
   rdoc.rdoc_files.include('lib/*.rb')
 }
 
-# Genereate the package
-spec = Gem::Specification.new do |s|
-
-  #### Basic information.
-
-  s.name = 'bluepay'
-  s.version = PKG_VERSION
-  s.summary = <<-EOF
-    Bluepay is used to process credit card and ach transactions through the BluePay 2.0 Gateway.
-  EOF
-  s.description = <<-EOF
-    This package allows a user to run credit card and ach transactions through the BluePay 2.0
-    Gateway.  BluePay is a merchant account provider and payment gateway.  BluePay, Inc. is a
-    one-stop shop merchant services provider.  For more information, visit: http://www.bluepay.com
-  EOF
-
-  #### Which files are to be included in this gem?  Everything!  (Except SVN directories.)
-
-  s.files = PKG_FILES
-
-  #### Load-time details: library and application (you will need one or both).
-
-  s.require_path = 'lib'
-  s.autorequire = 'bluepay'
-
-  #### Documentation and testing.
-
-  s.has_rdoc = true
-
-  #### Author and project details.
-
-  s.author = "Chris Jansen"
-  s.email = "cjansen@bluepay.com"
-  s.homepage = "http://www.bluepay.com/"
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
-end
-
 desc "Report code statistics (KLOCs, etc) from the application"
 task :stats do
   require 'code_statistics'
@@ -86,4 +35,3 @@ task :stats do
     ["Units", "test"]
   ).to_s
 end
-

data/bluepay.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = 'bluepay'
+  s.version     = '1.0.2'
+  s.date        = '2014-06-16'
+  s.summary     = "BluePay gateway rubygem."
+  s.description = "This gem is intended to be used along with a BluePay gateway account to test credit card and ACH transaction processing"
+  s.authors     = ["Justin Slingerland"]
+  s.email       = 'jslingerland@blueapy.com'
+  s.has_rdoc    = true
+  s.files       = Dir.glob("{lib,test,doc}/**/*") + %w(bluepay.gemspec Rakefile README)
+  s.homepage    = 'http://www.bluepay.com'
+  s.license     = 'GPL'
+end

data/doc/BluePay.html

@@ -0,0 +1,2699 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class BluePay - Ruby Merchant Bluepay</title>
+
+<link href="./fonts.css" rel="stylesheet">
+<link href="./rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+
+<script src="./js/jquery.js"></script>
+<script src="./js/navigation.js"></script>
+<script src="./js/search_index.js"></script>
+<script src="./js/search.js"></script>
+<script src="./js/searcher.js"></script>
+<script src="./js/darkfish.js"></script>
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    <div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  
+  <p class="link">Object
+  
+</div>
+
+    
+    
+    <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+
+  <ul class="link-list" role="directory">
+    
+    <li ><a href="#method-c-calc_trans_notify_tps">::calc_trans_notify_tps</a>
+    
+    <li ><a href="#method-c-new">::new</a>
+    
+    <li ><a href="#method-i-add_recurring_fields">#add_recurring_fields</a>
+    
+    <li ><a href="#method-i-auth">#auth</a>
+    
+    <li ><a href="#method-i-calc_rebill_tps">#calc_rebill_tps</a>
+    
+    <li ><a href="#method-i-calc_report_tps">#calc_report_tps</a>
+    
+    <li ><a href="#method-i-calc_tps">#calc_tps</a>
+    
+    <li ><a href="#method-i-cancel_rebilling_cycle">#cancel_rebilling_cycle</a>
+    
+    <li ><a href="#method-i-capture">#capture</a>
+    
+    <li ><a href="#method-i-credit">#credit</a>
+    
+    <li ><a href="#method-i-get_amount">#get_amount</a>
+    
+    <li ><a href="#method-i-get_auth_code">#get_auth_code</a>
+    
+    <li ><a href="#method-i-get_avs_code">#get_avs_code</a>
+    
+    <li ><a href="#method-i-get_bank_name">#get_bank_name</a>
+    
+    <li ><a href="#method-i-get_card_type">#get_card_type</a>
+    
+    <li ><a href="#method-i-get_creation_date">#get_creation_date</a>
+    
+    <li ><a href="#method-i-get_cvv2_code">#get_cvv2_code</a>
+    
+    <li ><a href="#method-i-get_cycles_remaining">#get_cycles_remaining</a>
+    
+    <li ><a href="#method-i-get_id">#get_id</a>
+    
+    <li ><a href="#method-i-get_last_date">#get_last_date</a>
+    
+    <li ><a href="#method-i-get_masked_account">#get_masked_account</a>
+    
+    <li ><a href="#method-i-get_message">#get_message</a>
+    
+    <li ><a href="#method-i-get_name1">#get_name1</a>
+    
+    <li ><a href="#method-i-get_name2">#get_name2</a>
+    
+    <li ><a href="#method-i-get_next_amount">#get_next_amount</a>
+    
+    <li ><a href="#method-i-get_next_date">#get_next_date</a>
+    
+    <li ><a href="#method-i-get_payment_type">#get_payment_type</a>
+    
+    <li ><a href="#method-i-get_reb_id">#get_reb_id</a>
+    
+    <li ><a href="#method-i-get_rebill_amount">#get_rebill_amount</a>
+    
+    <li ><a href="#method-i-get_rebill_id">#get_rebill_id</a>
+    
+    <li ><a href="#method-i-get_rebill_status">#get_rebill_status</a>
+    
+    <li ><a href="#method-i-get_rebilling_cycle_status">#get_rebilling_cycle_status</a>
+    
+    <li ><a href="#method-i-get_response">#get_response</a>
+    
+    <li ><a href="#method-i-get_sched_expression">#get_sched_expression</a>
+    
+    <li ><a href="#method-i-get_settled_transaction_report">#get_settled_transaction_report</a>
+    
+    <li ><a href="#method-i-get_single_trans_query">#get_single_trans_query</a>
+    
+    <li ><a href="#method-i-get_status">#get_status</a>
+    
+    <li ><a href="#method-i-get_template_id">#get_template_id</a>
+    
+    <li ><a href="#method-i-get_trans_id">#get_trans_id</a>
+    
+    <li ><a href="#method-i-get_trans_type">#get_trans_type</a>
+    
+    <li ><a href="#method-i-get_transaction_report">#get_transaction_report</a>
+    
+    <li ><a href="#method-i-process">#process</a>
+    
+    <li ><a href="#method-i-query_by_amount">#query_by_amount</a>
+    
+    <li ><a href="#method-i-query_by_name1">#query_by_name1</a>
+    
+    <li ><a href="#method-i-query_by_name2">#query_by_name2</a>
+    
+    <li ><a href="#method-i-query_by_payment_type">#query_by_payment_type</a>
+    
+    <li ><a href="#method-i-query_by_trans_type">#query_by_trans_type</a>
+    
+    <li ><a href="#method-i-query_by_transaction_id">#query_by_transaction_id</a>
+    
+    <li ><a href="#method-i-refund">#refund</a>
+    
+    <li ><a href="#method-i-sale">#sale</a>
+    
+    <li ><a href="#method-i-set_ach_information">#set_ach_information</a>
+    
+    <li ><a href="#method-i-set_amount_food">#set_amount_food</a>
+    
+    <li ><a href="#method-i-set_amount_misc">#set_amount_misc</a>
+    
+    <li ><a href="#method-i-set_amount_tax">#set_amount_tax</a>
+    
+    <li ><a href="#method-i-set_amount_tip">#set_amount_tip</a>
+    
+    <li ><a href="#method-i-set_cc_information">#set_cc_information</a>
+    
+    <li ><a href="#method-i-set_custom_id1">#set_custom_id1</a>
+    
+    <li ><a href="#method-i-set_custom_id2">#set_custom_id2</a>
+    
+    <li ><a href="#method-i-set_customer_information">#set_customer_information</a>
+    
+    <li ><a href="#method-i-set_email">#set_email</a>
+    
+    <li ><a href="#method-i-set_invoice_id">#set_invoice_id</a>
+    
+    <li ><a href="#method-i-set_memo">#set_memo</a>
+    
+    <li ><a href="#method-i-set_order_id">#set_order_id</a>
+    
+    <li ><a href="#method-i-set_param">#set_param</a>
+    
+    <li ><a href="#method-i-set_phone">#set_phone</a>
+    
+    <li ><a href="#method-i-update_rebilling_cycle">#update_rebilling_cycle</a>
+    
+    <li ><a href="#method-i-update_rebilling_payment_information">#update_rebilling_payment_information</a>
+    
+    <li ><a href="#method-i-uri_query">#uri_query</a>
+    
+    <li ><a href="#method-i-void">#void</a>
+    
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-BluePay">
+  <h1 id="class-BluePay" class="class">
+    class BluePay
+  </h1>
+
+  <section class="description">
+    
+  </section>
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+    <section class="constants-list">
+      <header>
+        <h3>Constants</h3>
+      </header>
+      <dl>
+      
+        <dt id="RootCA">RootCA
+        
+        <dd><p>Make sure this is the correct path to your CA certificates directory</p>
+        
+      
+        <dt id="SERVER">SERVER
+        
+        <dd>
+        
+      
+      </dl>
+    </section>
+    
+
+    
+
+    
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Instance Methods</h3>
+       </header>
+
+    
+      <div id="method-i-add_recurring_fields" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">add_recurring_fields</span><span
+            class="method-args">(rebill_first_date, rebill_expr, reb_cycles, reb_amount)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set fields for a recurring payment</p>
+          
+          
+
+          
+          <div class="method-source-code" id="add_recurring_fields-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 156</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_recurring_fields</span>(<span class="ruby-identifier">rebill_first_date</span>, <span class="ruby-identifier">rebill_expr</span>, <span class="ruby-identifier">reb_cycles</span>, <span class="ruby-identifier">reb_amount</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REBILLING'</span>] = <span class="ruby-string">'1'</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_FIRST_DATE'</span>] = <span class="ruby-identifier">rebill_first_date</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_EXPR'</span>] = <span class="ruby-identifier">rebill_expr</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_CYCLES'</span>] = <span class="ruby-identifier">reb_cycles</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_AMOUNT'</span>] = <span class="ruby-identifier">reb_amount</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-auth" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">auth</span><span
+            class="method-args">(amount, trans_id='')</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set up an Auth</p>
+          
+          
+
+          
+          <div class="method-source-code" id="auth-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 54</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">auth</span>(<span class="ruby-identifier">amount</span>, <span class="ruby-identifier">trans_id</span>=<span class="ruby-string">''</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANSACTION_TYPE'</span>] = <span class="ruby-string">'AUTH'</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT'</span>] = <span class="ruby-identifier">amount</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'RRNO'</span>] = <span class="ruby-identifier">trans_id</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-calc_rebill_tps" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">calc_rebill_tps</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Sets TAMPER_PROOF_SEAL in @PARAM_HASH for rebadmin API</p>
+          
+          
+
+          
+          <div class="method-source-code" id="calc_rebill_tps-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 267</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">calc_rebill_tps</span>()
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;TAMPER_PROOF_SEAL&quot;</span>] = <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-ivar">@SECRET_KEY</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@ACCOUNT_ID</span> <span class="ruby-operator">+</span>
+    <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;TRANS_TYPE&quot;</span>] <span class="ruby-operator">+</span> <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REBILL_ID&quot;</span>])
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-calc_report_tps" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">calc_report_tps</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Sets TAMPER_PROOF_SEAL in @PARAM_HASH for bpdailyreport2 API</p>
+          
+          
+
+          
+          <div class="method-source-code" id="calc_report_tps-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 273</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">calc_report_tps</span>()
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;TAMPER_PROOF_SEAL&quot;</span>] = <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-ivar">@SECRET_KEY</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@ACCOUNT_ID</span> <span class="ruby-operator">+</span> 
+    <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_START_DATE&quot;</span>] <span class="ruby-operator">+</span> <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_END_DATE&quot;</span>])
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-calc_tps" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">calc_tps</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Sets TAMPER_PROOF_SEAL in @PARAM_HASH</p>
+          
+          
+
+          
+          <div class="method-source-code" id="calc_tps-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 259</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">calc_tps</span>()
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;TAMPER_PROOF_SEAL&quot;</span>] = <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-ivar">@SECRET_KEY</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@ACCOUNT_ID</span> <span class="ruby-operator">+</span>
+    (<span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;TRANSACTION_TYPE&quot;</span>] <span class="ruby-operator">||</span> <span class="ruby-string">''</span>) <span class="ruby-operator">+</span> <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;AMOUNT&quot;</span>] <span class="ruby-operator">+</span> (<span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REBILLING&quot;</span>] <span class="ruby-operator">||</span> <span class="ruby-string">''</span>) <span class="ruby-operator">+</span>
+    (<span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REB_FIRST_DATE&quot;</span>] <span class="ruby-operator">||</span> <span class="ruby-string">''</span>) <span class="ruby-operator">+</span> (<span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REB_EXPR&quot;</span>] <span class="ruby-operator">||</span> <span class="ruby-string">''</span>) <span class="ruby-operator">+</span> (<span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REB_CYCLES&quot;</span>] <span class="ruby-operator">||</span> <span class="ruby-string">''</span>) <span class="ruby-operator">+</span>
+    (<span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REB_AMOUNT&quot;</span>] <span class="ruby-operator">||</span> <span class="ruby-string">''</span>) <span class="ruby-operator">+</span> (<span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;RRNO&quot;</span>] <span class="ruby-operator">||</span> <span class="ruby-string">''</span>) <span class="ruby-operator">+</span> <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;MODE&quot;</span>])
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-cancel_rebilling_cycle" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">cancel_rebilling_cycle</span><span
+            class="method-args">(rebill_id)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set fields to cancel an existing rebilling cycle</p>
+          
+          
+
+          
+          <div class="method-source-code" id="cancel_rebilling_cycle-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 177</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">cancel_rebilling_cycle</span>(<span class="ruby-identifier">rebill_id</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;TRANS_TYPE&quot;</span>] = <span class="ruby-string">&quot;SET&quot;</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;STATUS&quot;</span>] = <span class="ruby-string">&quot;stopped&quot;</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REBILL_ID&quot;</span>] = <span class="ruby-identifier">rebill_id</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-capture" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">capture</span><span
+            class="method-args">(trans_id, amount='')</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Capture an Auth</p>
+          
+          
+
+          
+          <div class="method-source-code" id="capture-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 68</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">capture</span>(<span class="ruby-identifier">trans_id</span>, <span class="ruby-identifier">amount</span>=<span class="ruby-string">''</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANSACTION_TYPE'</span>] = <span class="ruby-string">'CAPTURE'</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT'</span>] = <span class="ruby-identifier">amount</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'RRNO'</span>] = <span class="ruby-identifier">trans_id</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-credit" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">credit</span><span
+            class="method-args">(amount, trans_id='')</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Credit</p>
+          
+          
+
+          
+          <div class="method-source-code" id="credit-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 61</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">credit</span>(<span class="ruby-identifier">amount</span>, <span class="ruby-identifier">trans_id</span>=<span class="ruby-string">''</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANSACTION_TYPE'</span>] = <span class="ruby-string">'CREDIT'</span>
+      <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT'</span>] = <span class="ruby-identifier">amount</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'RRNO'</span>] = <span class="ruby-identifier">trans_id</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_amount" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_amount</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Amount associated with the transaction</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_amount-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 484</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_amount</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'amount'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_auth_code" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_auth_code</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>In the case of an approved transaction, contains the 6-character
+authorization code from the processing network. In the case of a decline or
+error, the contents may be junk.</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_auth_code-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 379</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_auth_code</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'AUTH_CODE'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_avs_code" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_avs_code</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Returns the single-character AVS response from the  Card Issuing Bank</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_avs_code-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 366</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_avs_code</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'AVS'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_bank_name" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_bank_name</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Bank account used in transaction</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_bank_name-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 404</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_bank_name</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'BANK_NAME'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_card_type" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_card_type</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Card type used in transaction</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_card_type-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 399</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_card_type</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'CARD_TYPE'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_creation_date" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_creation_date</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Creation date of rebilling</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_creation_date-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 424</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_creation_date</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'creation_date'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_cvv2_code" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_cvv2_code</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Same as avs_code, but for CVV2</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_cvv2_code-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 372</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_cvv2_code</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'CVV2'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_cycles_remaining" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_cycles_remaining</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Number of cycles remaining on rebilling</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_cycles_remaining-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 444</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_cycles_remaining</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'cycles_remain'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_id" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_id</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Transaction ID used with stq API</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_id-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 459</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_id</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'id'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_last_date" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_last_date</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Last date that the rebilling fired off on</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_last_date-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 434</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_last_date</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'last_date'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_masked_account" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_masked_account</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Masked credit card or ACH account</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_masked_account-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 394</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_masked_account</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'PAYMENT_ACCOUNT'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_message" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_message</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Returns the human-readable response from Bluepay. Or a nasty error.</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_message-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 356</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_message</span>()
+  <span class="ruby-identifier">m</span> = <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'MESSAGE'</span>]
+  <span class="ruby-keyword">if</span> (<span class="ruby-identifier">m</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">m</span> <span class="ruby-operator">==</span> <span class="ruby-string">&quot;&quot;</span>)
+    <span class="ruby-keyword">return</span> <span class="ruby-string">&quot;ERROR - NO MESSAGE FROM BLUEPAY&quot;</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-keyword">return</span> <span class="ruby-identifier">m</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_name1" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_name1</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>First name associated with the transaction</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_name1-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 464</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_name1</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'name1'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_name2" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_name2</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Last name associated with the transaction</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_name2-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 469</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_name2</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'name2'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_next_amount" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_next_amount</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Next amount to charge when rebilling fires off</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_next_amount-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 454</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_next_amount</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'next_amount'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_next_date" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_next_date</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Next date that the rebilling is set to fire off on</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_next_date-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 429</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_next_date</span>()
+    <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'next_date'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_payment_type" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_payment_type</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Payment type associated with the transaction</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_payment_type-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 474</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_payment_type</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'payment_type'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_reb_id" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_reb_id</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Rebill ID from bprebadmin API</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_reb_id-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 409</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_reb_id</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'rebill_id'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_rebill_amount" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_rebill_amount</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Amount to charge when rebilling fires off</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_rebill_amount-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 449</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_rebill_amount</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'reb_amount'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_rebill_id" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_rebill_id</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>If you set up a rebilling, this’ll get its ID.</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_rebill_id-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 389</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_rebill_id</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'REBID'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_rebill_status" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_rebill_status</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Status of rebilling</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_rebill_status-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 419</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_rebill_status</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'status'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_rebilling_cycle_status" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_rebilling_cycle_status</span><span
+            class="method-args">(rebill_id)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set fields to get the status of an existing rebilling cycle</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_rebilling_cycle_status-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 184</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_rebilling_cycle_status</span>(<span class="ruby-identifier">rebill_id</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;TRANS_TYPE&quot;</span>] = <span class="ruby-string">&quot;GET&quot;</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REBILL_ID&quot;</span>] = <span class="ruby-identifier">rebill_id</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_response" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_response</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+          <div class="method-source-code" id="get_response-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 345</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_response</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_sched_expression" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_sched_expression</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Rebilling expression</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_sched_expression-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 439</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_sched_expression</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'sched_expr'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_settled_transaction_report" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_settled_transaction_report</span><span
+            class="method-args">(report_start, report_end, subaccounts_searched, do_not_escape = '', errors = '')</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Gets a report on all settled transactions within a specified date range</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_settled_transaction_report-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 205</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_settled_transaction_report</span>(<span class="ruby-identifier">report_start</span>, <span class="ruby-identifier">report_end</span>, <span class="ruby-identifier">subaccounts_searched</span>, <span class="ruby-identifier">do_not_escape</span> = <span class="ruby-string">''</span>, <span class="ruby-identifier">errors</span> = <span class="ruby-string">''</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;QUERY_BY_SETTLEMENT&quot;</span>] = <span class="ruby-string">'1'</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_START_DATE&quot;</span>] = <span class="ruby-identifier">report_start</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_END_DATE&quot;</span>] = <span class="ruby-identifier">report_end</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;QUERY_BY_HIERARCHY&quot;</span>] = <span class="ruby-identifier">subaccounts_searched</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;DO_NOT_ESCAPE&quot;</span>] = <span class="ruby-identifier">do_not_escape</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;EXCLUDE_ERRORS&quot;</span>] = <span class="ruby-identifier">errors</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_single_trans_query" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_single_trans_query</span><span
+            class="method-args">(report_start, report_end, errors = "")</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Gets data on a specific transaction</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_single_trans_query-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 215</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_single_trans_query</span>(<span class="ruby-identifier">report_start</span>, <span class="ruby-identifier">report_end</span>, <span class="ruby-identifier">errors</span> = <span class="ruby-string">&quot;&quot;</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_START_DATE&quot;</span>] = <span class="ruby-identifier">report_start</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_END_DATE&quot;</span>] = <span class="ruby-identifier">report_end</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;EXCLUDE_ERRORS&quot;</span>] = <span class="ruby-identifier">errors</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_status" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_status</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Returns E for Error, 1 for Approved, 0 for Decline</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_status-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 350</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_status</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'Result'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_template_id" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_template_id</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Template ID of rebilling</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_template_id-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 414</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_template_id</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'template_id'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_trans_id" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_trans_id</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>The all-important transaction ID.</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_trans_id-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 384</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_trans_id</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'RRNO'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_trans_type" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_trans_type</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Transaction type associated with the transaction</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_trans_type-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 479</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_trans_type</span>()
+  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'trans_type'</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-get_transaction_report" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">get_transaction_report</span><span
+            class="method-args">(report_start, report_end, subaccounts_searched, do_not_escape = '', errors = '')</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Gets a report on all transactions within a specified date range</p>
+          
+          
+
+          
+          <div class="method-source-code" id="get_transaction_report-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 195</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_transaction_report</span>(<span class="ruby-identifier">report_start</span>, <span class="ruby-identifier">report_end</span>, <span class="ruby-identifier">subaccounts_searched</span>, <span class="ruby-identifier">do_not_escape</span> = <span class="ruby-string">''</span>, <span class="ruby-identifier">errors</span> = <span class="ruby-string">''</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;QUERY_BY_SETTLEMENT&quot;</span>] = <span class="ruby-string">'0'</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_START_DATE&quot;</span>] = <span class="ruby-identifier">report_start</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_END_DATE&quot;</span>] = <span class="ruby-identifier">report_end</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;QUERY_BY_HIERARCHY&quot;</span>] = <span class="ruby-identifier">subaccounts_searched</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;DO_NOT_ESCAPE&quot;</span>] = <span class="ruby-identifier">do_not_escape</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;EXCLUDE_ERRORS&quot;</span>] = <span class="ruby-identifier">errors</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-process" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">process</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>sends HTTPS POST to <a href="BluePay.html">BluePay</a> gateway for
+processing</p>
+          
+          
+
+          
+          <div class="method-source-code" id="process-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 286</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">process</span>()
+  <span class="ruby-identifier">ua</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">SERVER</span>, <span class="ruby-value">443</span>)
+  <span class="ruby-identifier">ua</span>.<span class="ruby-identifier">use_ssl</span> = <span class="ruby-keyword">true</span>
+  <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span> <span class="ruby-constant">RootCA</span>
+    <span class="ruby-identifier">ua</span>.<span class="ruby-identifier">ca_path</span> = <span class="ruby-constant">RootCA</span>
+    <span class="ruby-identifier">ua</span>.<span class="ruby-identifier">verify_mode</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>
+    <span class="ruby-identifier">ua</span>.<span class="ruby-identifier">verify_depth</span> = <span class="ruby-value">3</span>
+  <span class="ruby-keyword">else</span>
+    <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;Invalid CA certificates directory. Exiting...&quot;</span>
+    <span class="ruby-identifier">exit</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-keyword">begin</span>
+      <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REMOTE_IP&quot;</span>] = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">env</span>[<span class="ruby-string">'REMOTE_ADDR'</span>]
+  <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-comment"># Generate the query string and headers
+  <span class="ruby-keyword">if</span> (<span class="ruby-ivar">@PARAM_HASH</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">&quot;QUERY_BY_HIERARCHY&quot;</span>))
+    <span class="ruby-identifier">calc_report_tps</span>()
+    <span class="ruby-identifier">path</span> = <span class="ruby-string">&quot;/interfaces/bpdailyreport2&quot;</span>
+    <span class="ruby-identifier">query</span> = <span class="ruby-node">&quot;ACCOUNT_ID=#{@ACCOUNT_ID}&amp;&quot;</span>
+    <span class="ruby-identifier">query</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">uri_query</span>(<span class="ruby-ivar">@PARAM_HASH</span>)
+  <span class="ruby-keyword">elsif</span> (<span class="ruby-ivar">@PARAM_HASH</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-string">&quot;REPORT_START_DATE&quot;</span>))
+    <span class="ruby-identifier">calc_report_tps</span>()
+    <span class="ruby-identifier">path</span> = <span class="ruby-string">&quot;/interfaces/stq&quot;</span>
+    <span class="ruby-identifier">query</span> = <span class="ruby-node">&quot;ACCOUNT_ID=#{@ACCOUNT_ID}&amp;&quot;</span>
+    <span class="ruby-identifier">query</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">uri_query</span>(<span class="ruby-ivar">@PARAM_HASH</span>)
+  <span class="ruby-keyword">elsif</span> (<span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;TRANS_TYPE&quot;</span>] <span class="ruby-operator">!=</span> <span class="ruby-string">&quot;SET&quot;</span> <span class="ruby-keyword">and</span> <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;TRANS_TYPE&quot;</span>] <span class="ruby-operator">!=</span> <span class="ruby-string">&quot;GET&quot;</span>)
+    <span class="ruby-identifier">calc_tps</span>()
+    <span class="ruby-identifier">path</span> = <span class="ruby-string">&quot;/interfaces/bp10emu&quot;</span>
+    <span class="ruby-identifier">query</span> = <span class="ruby-node">&quot;MERCHANT=#{@ACCOUNT_ID}&amp;&quot;</span>
+    <span class="ruby-identifier">query</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">uri_query</span>(<span class="ruby-ivar">@PARAM_HASH</span>)
+  <span class="ruby-keyword">else</span>
+    <span class="ruby-identifier">calc_rebill_tps</span>()
+    <span class="ruby-identifier">path</span> = <span class="ruby-string">&quot;/interfaces/bp20rebadmin&quot;</span>
+    <span class="ruby-identifier">query</span> = <span class="ruby-node">&quot;ACCOUNT_ID=#{@ACCOUNT_ID}&amp;&quot;</span>
+    <span class="ruby-identifier">query</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">uri_query</span>(<span class="ruby-ivar">@PARAM_HASH</span>)
+  <span class="ruby-keyword">end</span>
+
+  <span class="ruby-identifier">queryheaders</span> = {
+    <span class="ruby-string">'User-Agent'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'Bluepay Ruby Client'</span>,
+    <span class="ruby-string">'Content-Type'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'application/x-www-form-urlencoded'</span>
+  }
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;VERSION&quot;</span>] = <span class="ruby-string">'3'</span>
+  <span class="ruby-comment"># Post parameters to BluePay gateway
+  <span class="ruby-identifier">headers</span>, <span class="ruby-identifier">body</span> = <span class="ruby-identifier">ua</span>.<span class="ruby-identifier">post</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">query</span>, <span class="ruby-identifier">queryheaders</span>)
+  <span class="ruby-comment"># Split the response into the response hash.
+  <span class="ruby-ivar">@RESPONSE_HASH</span> = {}
+  <span class="ruby-keyword">if</span> <span class="ruby-identifier">path</span> <span class="ruby-operator">==</span> <span class="ruby-string">&quot;/interfaces/bp10emu&quot;</span>
+    <span class="ruby-identifier">response</span> = <span class="ruby-identifier">headers</span>[<span class="ruby-string">&quot;Location&quot;</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">&quot;?&quot;</span>)[<span class="ruby-value">1</span>]
+  <span class="ruby-keyword">else</span>
+    <span class="ruby-identifier">response</span> = <span class="ruby-identifier">headers</span>.<span class="ruby-identifier">body</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-identifier">response</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&quot;&amp;&quot;</span>).<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">pair</span><span class="ruby-operator">|</span> 
+  (<span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span>) = <span class="ruby-identifier">pair</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&quot;=&quot;</span>)
+  <span class="ruby-identifier">val</span> = <span class="ruby-string">&quot;&quot;</span> <span class="ruby-keyword">if</span>(<span class="ruby-identifier">val</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span>)
+  <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-constant">URI</span>.<span class="ruby-identifier">unescape</span>(<span class="ruby-identifier">key</span>)] = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">unescape</span>(<span class="ruby-identifier">val</span>) 
+  }
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-query_by_amount" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">query_by_amount</span><span
+            class="method-args">(amount)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Queries by a specific Transaction Amount. To be used with <a
+href="BluePay.html#method-i-get_single_trans_query">#get_single_trans_query</a></p>
+          
+          
+
+          
+          <div class="method-source-code" id="query_by_amount-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 237</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">query_by_amount</span>(<span class="ruby-identifier">amount</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;amount&quot;</span>] = <span class="ruby-identifier">amount</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-query_by_name1" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">query_by_name1</span><span
+            class="method-args">(name1)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Queries by a specific First Name. To be used with <a
+href="BluePay.html#method-i-get_single_trans_query">#get_single_trans_query</a></p>
+          
+          
+
+          
+          <div class="method-source-code" id="query_by_name1-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 242</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">query_by_name1</span>(<span class="ruby-identifier">name1</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;name1&quot;</span>] = <span class="ruby-identifier">name1</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-query_by_name2" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">query_by_name2</span><span
+            class="method-args">(name2)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Queries by a specific Last Name. To be used with <a
+href="BluePay.html#method-i-get_single_trans_query">#get_single_trans_query</a></p>
+          
+          
+
+          
+          <div class="method-source-code" id="query_by_name2-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 247</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">query_by_name2</span>(<span class="ruby-identifier">name2</span>) 
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;name2&quot;</span>] = <span class="ruby-identifier">name2</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-query_by_payment_type" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">query_by_payment_type</span><span
+            class="method-args">(pay_type)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Queries by a specific Payment Type. To be used with <a
+href="BluePay.html#method-i-get_single_trans_query">#get_single_trans_query</a></p>
+          
+          
+
+          
+          <div class="method-source-code" id="query_by_payment_type-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 227</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">query_by_payment_type</span>(<span class="ruby-identifier">pay_type</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;payment_type&quot;</span>] = <span class="ruby-identifier">payment_type</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-query_by_trans_type" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">query_by_trans_type</span><span
+            class="method-args">(trans_type)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Queries by a specific Transaction Type. To be used with <a
+href="BluePay.html#method-i-get_single_trans_query">#get_single_trans_query</a></p>
+          
+          
+
+          
+          <div class="method-source-code" id="query_by_trans_type-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 232</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">query_by_trans_type</span>(<span class="ruby-identifier">trans_type</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;trans_type&quot;</span>] = <span class="ruby-identifier">trans_type</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-query_by_transaction_id" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">query_by_transaction_id</span><span
+            class="method-args">(trans_id)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Queries by a specific Transaction ID. To be used with <a
+href="BluePay.html#method-i-get_single_trans_query">#get_single_trans_query</a></p>
+          
+          
+
+          
+          <div class="method-source-code" id="query_by_transaction_id-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 222</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">query_by_transaction_id</span>(<span class="ruby-identifier">trans_id</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;id&quot;</span>] = <span class="ruby-identifier">trans_id</span>;
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-refund" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">refund</span><span
+            class="method-args">(trans_id, amount='')</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Refund</p>
+          
+          
+
+          
+          <div class="method-source-code" id="refund-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 75</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">refund</span>(<span class="ruby-identifier">trans_id</span>, <span class="ruby-identifier">amount</span>=<span class="ruby-string">''</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANSACTION_TYPE'</span>] = <span class="ruby-string">'REFUND'</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'RRNO'</span>] = <span class="ruby-identifier">trans_id</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT'</span>] = <span class="ruby-identifier">amount</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-sale" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">sale</span><span
+            class="method-args">(amount, trans_id='')</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set up a sale</p>
+          
+          
+
+          
+          <div class="method-source-code" id="sale-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 47</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">sale</span>(<span class="ruby-identifier">amount</span>, <span class="ruby-identifier">trans_id</span>=<span class="ruby-string">''</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANSACTION_TYPE'</span>] = <span class="ruby-string">'SALE'</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT'</span>] = <span class="ruby-identifier">amount</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'RRNO'</span>] = <span class="ruby-identifier">trans_id</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_ach_information" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_ach_information</span><span
+            class="method-args">(routing, account, acc_type, doc_type='')</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set up an ACH transaction.  Expects: acc_type: C for Checking, S for
+Savings routing: Bank routing number account: Customer’s checking or
+savings account number doc_type: WEB, TEL, ARC, etc – see docs. 
+Optional. REMEMBER: Ach requires some other fields, such as address and
+phone</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_ach_information-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 38</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_ach_information</span>(<span class="ruby-identifier">routing</span>, <span class="ruby-identifier">account</span>, <span class="ruby-identifier">acc_type</span>, <span class="ruby-identifier">doc_type</span>=<span class="ruby-string">''</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'PAYMENT_TYPE'</span>] = <span class="ruby-string">'ACH'</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ACH_ROUTING'</span>] = <span class="ruby-identifier">routing</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ACH_ACCOUNT'</span>] = <span class="ruby-identifier">account</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ACH_ACCOUNT_TYPE'</span>] = <span class="ruby-identifier">acc_type</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'DOC_TYPE'</span>] = <span class="ruby-identifier">doc_type</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_amount_food" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_amount_food</span><span
+            class="method-args">(amount_food)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set AMOUNT_FOOD field</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_amount_food-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 146</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_amount_food</span>(<span class="ruby-identifier">amount_food</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT_FOOD'</span>] = <span class="ruby-identifier">amount_food</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_amount_misc" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_amount_misc</span><span
+            class="method-args">(amount_misc)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set AMOUNT_MISC field</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_amount_misc-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 151</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_amount_misc</span>(<span class="ruby-identifier">amount_misc</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT_MISC'</span>] = <span class="ruby-identifier">amount_misc</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_amount_tax" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_amount_tax</span><span
+            class="method-args">(amount_tax)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set AMOUNT_TAX field</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_amount_tax-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 141</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_amount_tax</span>(<span class="ruby-identifier">amount_tax</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT_TAX'</span>] = <span class="ruby-identifier">amount_tax</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_amount_tip" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_amount_tip</span><span
+            class="method-args">(amount_tip)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set AMOUNT_TIP field</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_amount_tip-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 136</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_amount_tip</span>(<span class="ruby-identifier">amount_tip</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT_TIP'</span>] = <span class="ruby-identifier">amount_tip</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_cc_information" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_cc_information</span><span
+            class="method-args">(account, expire, cvv='')</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set up a credit card payment.</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_cc_information-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 24</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_cc_information</span>(<span class="ruby-identifier">account</span>, <span class="ruby-identifier">expire</span>, <span class="ruby-identifier">cvv</span>=<span class="ruby-string">''</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'PAYMENT_TYPE'</span>] = <span class="ruby-string">'CREDIT'</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'CC_NUM'</span>] = <span class="ruby-identifier">account</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'CC_EXPIRES'</span>] = <span class="ruby-identifier">expire</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'CVCVV2'</span>] = <span class="ruby-identifier">cvv</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_custom_id1" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_custom_id1</span><span
+            class="method-args">(custom_id1)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set CUSTOM_ID field</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_custom_id1-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 116</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_custom_id1</span>(<span class="ruby-identifier">custom_id1</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'CUSTOM_ID'</span>] = <span class="ruby-identifier">custom_id1</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_custom_id2" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_custom_id2</span><span
+            class="method-args">(custom_id2)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set CUSTOM_ID2 field</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_custom_id2-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 121</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_custom_id2</span>(<span class="ruby-identifier">custom_id2</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'CUSTOM_ID2'</span>] = <span class="ruby-identifier">custom_id2</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_customer_information" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_customer_information</span><span
+            class="method-args">(name1, name2, addr1, city, state, zip, addr2='', country='')</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Sets customer information for the transaction</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_customer_information-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 89</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_customer_information</span>(<span class="ruby-identifier">name1</span>, <span class="ruby-identifier">name2</span>, <span class="ruby-identifier">addr1</span>, <span class="ruby-identifier">city</span>, <span class="ruby-identifier">state</span>, <span class="ruby-identifier">zip</span>, <span class="ruby-identifier">addr2</span>=<span class="ruby-string">''</span>, <span class="ruby-identifier">country</span>=<span class="ruby-string">''</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'NAME1'</span>] = <span class="ruby-identifier">name1</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'NAME2'</span>] = <span class="ruby-identifier">name2</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ADDR1'</span>] = <span class="ruby-identifier">addr1</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'CITY'</span>] = <span class="ruby-identifier">city</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'STATE'</span>] = <span class="ruby-identifier">state</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ZIPCODE'</span>] = <span class="ruby-identifier">zip</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ADDR2'</span>] = <span class="ruby-identifier">addr2</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'COUNTRY'</span>] = <span class="ruby-identifier">country</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_email" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_email</span><span
+            class="method-args">(email)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set customer E-mail address</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_email-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 106</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_email</span>(<span class="ruby-identifier">email</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'EMAIL'</span>] = <span class="ruby-identifier">email</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_invoice_id" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_invoice_id</span><span
+            class="method-args">(invoice_id)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set INVOICE_ID field</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_invoice_id-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 126</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_invoice_id</span>(<span class="ruby-identifier">invoice_id</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'INVOICE_ID'</span>] = <span class="ruby-identifier">invoice_id</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_memo" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_memo</span><span
+            class="method-args">(memo)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set MEMO field</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_memo-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 111</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_memo</span>(<span class="ruby-identifier">memo</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'COMMENT'</span>] = <span class="ruby-identifier">memo</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_order_id" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_order_id</span><span
+            class="method-args">(order_id)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set ORDER_ID field</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_order_id-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 131</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_order_id</span>(<span class="ruby-identifier">order_id</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ORDER_ID'</span>] = <span class="ruby-identifier">order_id</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_param" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_param</span><span
+            class="method-args">(key, val)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+          <div class="method-source-code" id="set_param-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 19</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_param</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">val</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-set_phone" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">set_phone</span><span
+            class="method-args">(phone)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set customer phone #</p>
+          
+          
+
+          
+          <div class="method-source-code" id="set_phone-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 101</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_phone</span>(<span class="ruby-identifier">phone</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'PHONE'</span>] = <span class="ruby-identifier">phone</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-update_rebilling_cycle" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">update_rebilling_cycle</span><span
+            class="method-args">(rebill_id, rebill_next_date, rebill_expr, rebill_cycles, rebill_amount, rebill_next_amount)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Set fields to do an update on an existing rebilling cycle</p>
+          
+          
+
+          
+          <div class="method-source-code" id="update_rebilling_cycle-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 165</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_rebilling_cycle</span>(<span class="ruby-identifier">rebill_id</span>, <span class="ruby-identifier">rebill_next_date</span>, <span class="ruby-identifier">rebill_expr</span>, <span class="ruby-identifier">rebill_cycles</span>, <span class="ruby-identifier">rebill_amount</span>,
+  <span class="ruby-identifier">rebill_next_amount</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANS_TYPE'</span>] = <span class="ruby-string">&quot;SET&quot;</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REBILL_ID'</span>] = <span class="ruby-identifier">rebill_id</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'NEXT_DATE'</span>] = <span class="ruby-identifier">rebill_next_date</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_EXPR'</span>] = <span class="ruby-identifier">rebill_expr</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_CYCLES'</span>] = <span class="ruby-identifier">rebill_cycles</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_AMOUNT'</span>] = <span class="ruby-identifier">rebill_amount</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'NEXT_AMOUNT'</span>] = <span class="ruby-identifier">rebill_next_amount</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-update_rebilling_payment_information" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">update_rebilling_payment_information</span><span
+            class="method-args">(template_id)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Updates an existing rebilling cycle’s payment information.</p>
+          
+          
+
+          
+          <div class="method-source-code" id="update_rebilling_payment_information-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 190</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_rebilling_payment_information</span>(<span class="ruby-identifier">template_id</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;TEMPLATE_ID&quot;</span>] = <span class="ruby-identifier">template_id</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-uri_query" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">uri_query</span><span
+            class="method-args">(h)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Turns a hash into a nvp style string</p>
+          
+          
+
+          
+          <div class="method-source-code" id="uri_query-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 252</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">uri_query</span>(<span class="ruby-identifier">h</span>)
+  <span class="ruby-identifier">a</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>()
+  <span class="ruby-identifier">h</span>.<span class="ruby-identifier">each_pair</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">push</span>(<span class="ruby-constant">URI</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-identifier">key</span>) <span class="ruby-operator">+</span> <span class="ruby-string">&quot;=&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-constant">URI</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-identifier">val</span>)) }
+  <span class="ruby-keyword">return</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot;&amp;&quot;</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-i-void" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">void</span><span
+            class="method-args">(trans_id)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Void</p>
+          
+          
+
+          
+          <div class="method-source-code" id="void-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 82</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">void</span>(<span class="ruby-identifier">trans_id</span>)
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANSACTION_TYPE'</span>] = <span class="ruby-string">'VOID'</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT'</span>] = <span class="ruby-string">''</span>
+  <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'RRNO'</span>] = <span class="ruby-identifier">trans_id</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+    </section>
+  
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Class Methods</h3>
+       </header>
+
+    
+      <div id="method-c-calc_trans_notify_tps" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">calc_trans_notify_tps</span><span
+            class="method-args">(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)</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Calculates TAMPER_PROOF_SEAL to be used with Trans Notify API</p>
+          
+          
+
+          
+          <div class="method-source-code" id="calc_trans_notify_tps-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 279</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">calc_trans_notify_tps</span>(<span class="ruby-identifier">secret_key</span>, <span class="ruby-identifier">trans_id</span>, <span class="ruby-identifier">trans_status</span>, <span class="ruby-identifier">trans_type</span>, <span class="ruby-identifier">amount</span>, <span class="ruby-identifier">batch_id</span>, <span class="ruby-identifier">batch_status</span>,
+  <span class="ruby-identifier">total_count</span>, <span class="ruby-identifier">total_amount</span>, <span class="ruby-identifier">batch_upload_id</span>, <span class="ruby-identifier">rebill_id</span>, <span class="ruby-identifier">rebill_amount</span>, <span class="ruby-identifier">rebill_status</span>)
+  <span class="ruby-keyword">return</span> <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-ivar">@SECRET_KEY</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">trans_id</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">trans_status</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">transtype</span> <span class="ruby-operator">+</span> 
+    <span class="ruby-identifier">amount</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">batch_id</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">batch_status</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">total_count</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">total_amount</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">batch_upload_id</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">rebill_id</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">rebill_amount</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">rebill_status</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+      <div id="method-c-new" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">new</span><span
+            class="method-args">(account,key,mode='TEST')</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+          
+
+          
+          <div class="method-source-code" id="new-source">
+            <pre><span class="ruby-comment"># File lib/bluepay.rb, line 12</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">account</span>,<span class="ruby-identifier">key</span>,<span class="ruby-identifier">mode</span>=<span class="ruby-string">'TEST'</span>)
+  <span class="ruby-ivar">@ACCOUNT_ID</span> = <span class="ruby-identifier">account</span>
+  <span class="ruby-ivar">@SECRET_KEY</span> = <span class="ruby-identifier">key</span>
+  <span class="ruby-ivar">@PARAM_HASH</span> = { <span class="ruby-string">'MODE'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">mode</span> }
+  <span class="ruby-ivar">@RETURN_HASH</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>()
+<span class="ruby-keyword">end</span></pre>
+          </div>
+          
+        </div>
+
+        
+
+        
+      </div>
+
+    
+    </section>
+  
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="http://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.1.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+