bluepay 1.0.3 → 1.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (89) hide show
  1. checksums.yaml +7 -7
  2. data/Rakefile +1 -1
  3. data/bluepay.gemspec +3 -3
  4. data/lib/api_request.rb +125 -0
  5. data/lib/api_response.rb +150 -0
  6. data/lib/bluepay.rb +94 -332
  7. data/lib/cacert.pem +3860 -0
  8. data/test/Get_Data/Retrieve_Settlement_Data.rb +34 -0
  9. data/test/Get_Data/Retrieve_Transaction_Data.rb +33 -0
  10. data/test/Get_Data/Single_Transaction_Query.rb +42 -0
  11. data/test/Get_Data/Transaction_Notification.rb +61 -0
  12. data/test/Rebill/Cancel_Recurring_Payment.rb +82 -0
  13. data/test/Rebill/Create_Recurring_Payment_ACH.rb +60 -0
  14. data/test/Rebill/Create_Recurring_Payment_CC.rb +62 -0
  15. data/test/Rebill/Get_Recurring_Payment_Status.rb +82 -0
  16. data/test/Rebill/Update_Recurring_Payment.rb +111 -0
  17. data/test/Transactions/Cancel_Transaction.rb +74 -0
  18. data/test/Transactions/Charge_Customer_ACH.rb +54 -0
  19. data/test/Transactions/Charge_Customer_CC.rb +60 -0
  20. data/test/Transactions/Check_Customer_Credit.rb +58 -0
  21. data/test/Transactions/Customer_Defined_Data.rb +71 -0
  22. data/test/Transactions/How_To_Use_Token.rb +42 -0
  23. data/test/Transactions/Return_Funds.rb +77 -0
  24. data/test/Transactions/Store_Payment_Information.rb +58 -0
  25. metadata +42 -93
  26. data/doc/BluePay.html +0 -2699
  27. data/doc/README.html +0 -174
  28. data/doc/created.rid +0 -3
  29. data/doc/fonts.css +0 -167
  30. data/doc/fonts/Lato-Light.ttf +0 -0
  31. data/doc/fonts/Lato-LightItalic.ttf +0 -0
  32. data/doc/fonts/Lato-Regular.ttf +0 -0
  33. data/doc/fonts/Lato-RegularItalic.ttf +0 -0
  34. data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
  35. data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
  36. data/doc/images/add.png +0 -0
  37. data/doc/images/arrow_up.png +0 -0
  38. data/doc/images/brick.png +0 -0
  39. data/doc/images/brick_link.png +0 -0
  40. data/doc/images/bug.png +0 -0
  41. data/doc/images/bullet_black.png +0 -0
  42. data/doc/images/bullet_toggle_minus.png +0 -0
  43. data/doc/images/bullet_toggle_plus.png +0 -0
  44. data/doc/images/date.png +0 -0
  45. data/doc/images/delete.png +0 -0
  46. data/doc/images/find.png +0 -0
  47. data/doc/images/loadingAnimation.gif +0 -0
  48. data/doc/images/macFFBgHack.png +0 -0
  49. data/doc/images/package.png +0 -0
  50. data/doc/images/page_green.png +0 -0
  51. data/doc/images/page_white_text.png +0 -0
  52. data/doc/images/page_white_width.png +0 -0
  53. data/doc/images/plugin.png +0 -0
  54. data/doc/images/ruby.png +0 -0
  55. data/doc/images/tag_blue.png +0 -0
  56. data/doc/images/tag_green.png +0 -0
  57. data/doc/images/transparent.png +0 -0
  58. data/doc/images/wrench.png +0 -0
  59. data/doc/images/wrench_orange.png +0 -0
  60. data/doc/images/zoom.png +0 -0
  61. data/doc/index.html +0 -92
  62. data/doc/js/darkfish.js +0 -140
  63. data/doc/js/jquery.js +0 -18
  64. data/doc/js/navigation.js +0 -142
  65. data/doc/js/search.js +0 -109
  66. data/doc/js/search_index.js +0 -1
  67. data/doc/js/searcher.js +0 -228
  68. data/doc/rdoc.css +0 -580
  69. data/doc/table_of_contents.html +0 -405
  70. data/test/get_data/retrieve_settlement_data.rb +0 -39
  71. data/test/get_data/retrieve_transaction_data.rb +0 -37
  72. data/test/get_data/transaction_query.rb +0 -48
  73. data/test/getting_stuff_done/get_transaction_data.rb +0 -37
  74. data/test/getting_stuff_done/run_ach_payment.rb +0 -75
  75. data/test/getting_stuff_done/run_cc_payment.rb +0 -73
  76. data/test/getting_stuff_done/set_up_rebill_ach.rb +0 -85
  77. data/test/getting_stuff_done/set_up_rebill_cc.rb +0 -84
  78. data/test/rebills/cancel_rebill.rb +0 -96
  79. data/test/rebills/create_rebill.rb +0 -84
  80. data/test/rebills/get_rebill.rb +0 -97
  81. data/test/rebills/update_rebill.rb +0 -128
  82. data/test/transactions/cancel_transaction.rb +0 -85
  83. data/test/transactions/charge_customer.rb +0 -74
  84. data/test/transactions/check_customer_credit.rb +0 -74
  85. data/test/transactions/credit_customer.rb +0 -75
  86. data/test/transactions/customer_defined_data.rb +0 -99
  87. data/test/transactions/return_funds.rb +0 -86
  88. data/test/transactions/store_payment_information.rb +0 -74
  89. data/test/transactions/use_token.rb +0 -44
@@ -0,0 +1,77 @@
1
+ ##
2
+ # BluePay Ruby Sample code.
3
+ #
4
+ # This code sample runs a $3.00 Credit Card Sale transaction
5
+ # against a customer using test payment information. If
6
+ # approved, a 2nd transaction is run to partially refund the
7
+ # customer for $1.75 of the $3.00.
8
+ # If using TEST mode, odd dollar amounts will return
9
+ # an approval and even dollar amounts will return a decline.
10
+ ##
11
+
12
+ require_relative "../../lib/bluepay.rb"
13
+
14
+ acct_id = "Merchant's Account ID Here"
15
+ sec_key = "Merchant's Secret Key Here"
16
+ trans_mode = "TEST" # Transaction Mode (can also be "LIVE")
17
+
18
+ payment = BluePay.new(
19
+ account_id: acct_id,
20
+ secret_key: sec_key,
21
+ mode: trans_mode
22
+ )
23
+
24
+ payment.set_customer_information(
25
+ first_name: "Bob",
26
+ last_name: "Tester",
27
+ address1: "123 Test St.",
28
+ address2: "Apt #500",
29
+ city: "Testville",
30
+ state: "IL",
31
+ zip_code: "54321",
32
+ country: "USA",
33
+ phone: "123-123-1234",
34
+ email: "test@bluepay.com"
35
+ )
36
+
37
+ payment.set_cc_information(
38
+ cc_number: "4111111111111111", # Customer Credit Card Number
39
+ cc_expiration: "1216", # Card Expiration Date: MMYY
40
+ cvv2: "123" # Card CVV2
41
+ )
42
+
43
+ payment.sale(amount: "3.00") # Sale Amount: $3.00
44
+
45
+ # Makes the API Request for processing the sale
46
+ payment.process
47
+
48
+ # If transaction was approved..
49
+ if payment.successful_response?
50
+
51
+ payment_return = BluePay.new(
52
+ account_id: acct_id,
53
+ secret_key: sec_key,
54
+ mode: trans_mode
55
+ )
56
+
57
+ # Creates a refund transaction against previous sale
58
+ payment_return.refund(
59
+ trans_id: payment.get_trans_id, # id of previous transaction to refund
60
+ amount: "1.75" # partial refund of $1.75
61
+ )
62
+
63
+ # Makes the API Request to process refund
64
+ payment_return.process
65
+
66
+ # Reads the response from BluePay
67
+ puts "TRANSACTION STATUS: " + payment_return.get_status
68
+ puts "TRANSACTION MESSAGE: " + payment_return.get_message
69
+ puts "TRANSACTION ID: " + payment_return.get_trans_id
70
+ puts "AVS RESPONSE: " + payment_return.get_avs_code
71
+ puts "CVV2 RESPONSE: " + payment_return.get_cvv2_code
72
+ puts "MASKED PAYMENT ACCOUNT: " + payment_return.get_masked_account
73
+ puts "CARD TYPE: " + payment_return.get_card_type
74
+ puts "AUTH CODE: " + payment_return.get_auth_code
75
+ else
76
+ puts payment.get_message
77
+ end
@@ -0,0 +1,58 @@
1
+ ##
2
+ # BluePay Ruby Sample code.
3
+ #
4
+ # This code sample runs a $0.00 Credit Card Authorization.
5
+ # This stores the customer's payment information securely in
6
+ # BluePay to be used for further transactions.
7
+ ##
8
+
9
+ require_relative "../../lib/bluepay.rb"
10
+
11
+ acct_id = "Merchant's Account ID Here"
12
+ sec_key = "Merchant's Secret Key Here"
13
+ trans_mode = "TEST" # Transaction Mode (can also be "LIVE")
14
+
15
+ payment = BluePay.new(
16
+ account_id: acct_id,
17
+ secret_key: sec_key,
18
+ mode: trans_mode
19
+ )
20
+
21
+ payment.set_customer_information(
22
+ first_name: "Bob",
23
+ last_name: "Tester",
24
+ address1: "123 Test St.",
25
+ address2: "Apt #500",
26
+ city: "Testville",
27
+ state: "IL",
28
+ zip_code: "54321",
29
+ country: "USA",
30
+ phone: "123-123-1234",
31
+ email: "test@bluepay.com"
32
+ )
33
+
34
+ payment.set_cc_information(
35
+ cc_number: "4111111111111111", # Customer Credit Card Number
36
+ cc_expiration: "1215", # Card Expiration Date: MMYY
37
+ cvv2: "123" # Card CVV2
38
+ )
39
+
40
+ payment.auth(amount: "0.00") # Card Authorization amount: $0.00
41
+
42
+ # Makes the API request with BluePay
43
+ payment.process
44
+
45
+ # If transaction was successful
46
+ if payment.successful_response?
47
+ # Reads the response from BluePay
48
+ puts "TRANSACTION STATUS: " + payment.get_status
49
+ puts "TRANSACTION MESSAGE: " + payment.get_message
50
+ puts "TRANSACTION ID: " + payment.get_trans_id
51
+ puts "AVS RESPONSE: " + payment.get_avs_code
52
+ puts "CVV2 RESPONSE: " + payment.get_cvv2_code
53
+ puts "MASKED PAYMENT ACCOUNT: " + payment.get_masked_account
54
+ puts "CARD TYPE: " + payment.get_card_type
55
+ puts "AUTH CODE: " + payment.get_auth_code
56
+ else
57
+ puts payment.get_message
58
+ end
metadata CHANGED
@@ -1,120 +1,69 @@
1
- --- !ruby/object:Gem::Specification
1
+ --- !ruby/object:Gem::Specification
2
2
  name: bluepay
3
- version: !ruby/object:Gem::Version
4
- version: 1.0.3
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.4
5
5
  platform: ruby
6
- authors:
6
+ authors:
7
7
  - Justin Slingerland
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
-
12
- date: 2014-06-17 00:00:00 Z
11
+ date: 2015-11-30 00:00:00.000000000 Z
13
12
  dependencies: []
14
-
15
- description: This gem is intended to be used along with a BluePay gateway account to process credit card and ACH transactions
13
+ description: This gem is intended to be used along with a BluePay gateway account
14
+ to process credit card and ACH transactions
16
15
  email: jslingerland@bluepay.com
17
16
  executables: []
18
-
19
17
  extensions: []
20
-
21
18
  extra_rdoc_files: []
22
-
23
- files:
19
+ files:
24
20
  - README
25
21
  - Rakefile
26
22
  - bluepay.gemspec
27
- - doc/BluePay.html
28
- - doc/README.html
29
- - doc/created.rid
30
- - doc/fonts.css
31
- - doc/fonts/Lato-Light.ttf
32
- - doc/fonts/Lato-LightItalic.ttf
33
- - doc/fonts/Lato-Regular.ttf
34
- - doc/fonts/Lato-RegularItalic.ttf
35
- - doc/fonts/SourceCodePro-Bold.ttf
36
- - doc/fonts/SourceCodePro-Regular.ttf
37
- - doc/images/add.png
38
- - doc/images/arrow_up.png
39
- - doc/images/brick.png
40
- - doc/images/brick_link.png
41
- - doc/images/bug.png
42
- - doc/images/bullet_black.png
43
- - doc/images/bullet_toggle_minus.png
44
- - doc/images/bullet_toggle_plus.png
45
- - doc/images/date.png
46
- - doc/images/delete.png
47
- - doc/images/find.png
48
- - doc/images/loadingAnimation.gif
49
- - doc/images/macFFBgHack.png
50
- - doc/images/package.png
51
- - doc/images/page_green.png
52
- - doc/images/page_white_text.png
53
- - doc/images/page_white_width.png
54
- - doc/images/plugin.png
55
- - doc/images/ruby.png
56
- - doc/images/tag_blue.png
57
- - doc/images/tag_green.png
58
- - doc/images/transparent.png
59
- - doc/images/wrench.png
60
- - doc/images/wrench_orange.png
61
- - doc/images/zoom.png
62
- - doc/index.html
63
- - doc/js/darkfish.js
64
- - doc/js/jquery.js
65
- - doc/js/navigation.js
66
- - doc/js/search.js
67
- - doc/js/search_index.js
68
- - doc/js/searcher.js
69
- - doc/rdoc.css
70
- - doc/table_of_contents.html
23
+ - lib/api_request.rb
24
+ - lib/api_response.rb
71
25
  - lib/bluepay.rb
72
- - test/get_data/retrieve_settlement_data.rb
73
- - test/get_data/retrieve_transaction_data.rb
74
- - test/get_data/transaction_query.rb
75
- - test/getting_stuff_done/get_transaction_data.rb
76
- - test/getting_stuff_done/run_ach_payment.rb
77
- - test/getting_stuff_done/run_cc_payment.rb
78
- - test/getting_stuff_done/set_up_rebill_ach.rb
79
- - test/getting_stuff_done/set_up_rebill_cc.rb
80
- - test/rebills/cancel_rebill.rb
81
- - test/rebills/create_rebill.rb
82
- - test/rebills/get_rebill.rb
83
- - test/rebills/update_rebill.rb
84
- - test/transactions/cancel_transaction.rb
85
- - test/transactions/charge_customer.rb
86
- - test/transactions/check_customer_credit.rb
87
- - test/transactions/credit_customer.rb
88
- - test/transactions/customer_defined_data.rb
89
- - test/transactions/return_funds.rb
90
- - test/transactions/store_payment_information.rb
91
- - test/transactions/use_token.rb
26
+ - lib/cacert.pem
27
+ - test/Get_Data/Retrieve_Settlement_Data.rb
28
+ - test/Get_Data/Retrieve_Transaction_Data.rb
29
+ - test/Get_Data/Single_Transaction_Query.rb
30
+ - test/Get_Data/Transaction_Notification.rb
31
+ - test/Rebill/Cancel_Recurring_Payment.rb
32
+ - test/Rebill/Create_Recurring_Payment_ACH.rb
33
+ - test/Rebill/Create_Recurring_Payment_CC.rb
34
+ - test/Rebill/Get_Recurring_Payment_Status.rb
35
+ - test/Rebill/Update_Recurring_Payment.rb
36
+ - test/Transactions/Cancel_Transaction.rb
37
+ - test/Transactions/Charge_Customer_ACH.rb
38
+ - test/Transactions/Charge_Customer_CC.rb
39
+ - test/Transactions/Check_Customer_Credit.rb
40
+ - test/Transactions/Customer_Defined_Data.rb
41
+ - test/Transactions/How_To_Use_Token.rb
42
+ - test/Transactions/Return_Funds.rb
43
+ - test/Transactions/Store_Payment_Information.rb
92
44
  homepage: http://www.bluepay.com
93
- licenses:
45
+ licenses:
94
46
  - GPL
95
47
  metadata: {}
96
-
97
48
  post_install_message:
98
49
  rdoc_options: []
99
-
100
- require_paths:
50
+ require_paths:
101
51
  - lib
102
- required_ruby_version: !ruby/object:Gem::Requirement
103
- requirements:
104
- - &id001
105
- - ">="
106
- - !ruby/object:Gem::Version
107
- version: "0"
108
- required_rubygems_version: !ruby/object:Gem::Requirement
109
- requirements:
110
- - *id001
52
+ required_ruby_version: !ruby/object:Gem::Requirement
53
+ requirements:
54
+ - - '>='
55
+ - !ruby/object:Gem::Version
56
+ version: '0'
57
+ required_rubygems_version: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - '>='
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
111
62
  requirements: []
112
-
113
63
  rubyforge_project:
114
- rubygems_version: 2.3.0
64
+ rubygems_version: 2.4.5
115
65
  signing_key:
116
66
  specification_version: 4
117
- summary: BluePay gateway rubygem.
67
+ summary: BluePay gateway rubygem
118
68
  test_files: []
119
-
120
69
  has_rdoc: true
data/doc/BluePay.html DELETED
@@ -1,2699 +0,0 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <meta charset="UTF-8">
6
-
7
- <title>class BluePay - Ruby Merchant Bluepay</title>
8
-
9
- <link href="./fonts.css" rel="stylesheet">
10
- <link href="./rdoc.css" rel="stylesheet">
11
-
12
- <script type="text/javascript">
13
- var rdoc_rel_prefix = "./";
14
- </script>
15
-
16
- <script src="./js/jquery.js"></script>
17
- <script src="./js/navigation.js"></script>
18
- <script src="./js/search_index.js"></script>
19
- <script src="./js/search.js"></script>
20
- <script src="./js/searcher.js"></script>
21
- <script src="./js/darkfish.js"></script>
22
-
23
-
24
- <body id="top" role="document" class="class">
25
- <nav role="navigation">
26
- <div id="project-navigation">
27
- <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
- <h2>
29
- <a href="./index.html" rel="home">Home</a>
30
- </h2>
31
-
32
- <div id="table-of-contents-navigation">
33
- <a href="./table_of_contents.html#pages">Pages</a>
34
- <a href="./table_of_contents.html#classes">Classes</a>
35
- <a href="./table_of_contents.html#methods">Methods</a>
36
- </div>
37
- </div>
38
-
39
- <div id="search-section" role="search" class="project-section initially-hidden">
40
- <form action="#" method="get" accept-charset="utf-8">
41
- <div id="search-field-wrapper">
42
- <input id="search-field" role="combobox" aria-label="Search"
43
- aria-autocomplete="list" aria-controls="search-results"
44
- type="text" name="search" placeholder="Search" spellcheck="false"
45
- title="Type to search, Up and Down to navigate, Enter to load">
46
- </div>
47
-
48
- <ul id="search-results" aria-label="Search Results"
49
- aria-busy="false" aria-expanded="false"
50
- aria-atomic="false" class="initially-hidden"></ul>
51
- </form>
52
- </div>
53
-
54
- </div>
55
-
56
-
57
-
58
- <div id="class-metadata">
59
-
60
- <div id="parent-class-section" class="nav-section">
61
- <h3>Parent</h3>
62
-
63
-
64
- <p class="link">Object
65
-
66
- </div>
67
-
68
-
69
-
70
- <!-- Method Quickref -->
71
- <div id="method-list-section" class="nav-section">
72
- <h3>Methods</h3>
73
-
74
- <ul class="link-list" role="directory">
75
-
76
- <li ><a href="#method-c-calc_trans_notify_tps">::calc_trans_notify_tps</a>
77
-
78
- <li ><a href="#method-c-new">::new</a>
79
-
80
- <li ><a href="#method-i-add_recurring_fields">#add_recurring_fields</a>
81
-
82
- <li ><a href="#method-i-auth">#auth</a>
83
-
84
- <li ><a href="#method-i-calc_rebill_tps">#calc_rebill_tps</a>
85
-
86
- <li ><a href="#method-i-calc_report_tps">#calc_report_tps</a>
87
-
88
- <li ><a href="#method-i-calc_tps">#calc_tps</a>
89
-
90
- <li ><a href="#method-i-cancel_rebilling_cycle">#cancel_rebilling_cycle</a>
91
-
92
- <li ><a href="#method-i-capture">#capture</a>
93
-
94
- <li ><a href="#method-i-credit">#credit</a>
95
-
96
- <li ><a href="#method-i-get_amount">#get_amount</a>
97
-
98
- <li ><a href="#method-i-get_auth_code">#get_auth_code</a>
99
-
100
- <li ><a href="#method-i-get_avs_code">#get_avs_code</a>
101
-
102
- <li ><a href="#method-i-get_bank_name">#get_bank_name</a>
103
-
104
- <li ><a href="#method-i-get_card_type">#get_card_type</a>
105
-
106
- <li ><a href="#method-i-get_creation_date">#get_creation_date</a>
107
-
108
- <li ><a href="#method-i-get_cvv2_code">#get_cvv2_code</a>
109
-
110
- <li ><a href="#method-i-get_cycles_remaining">#get_cycles_remaining</a>
111
-
112
- <li ><a href="#method-i-get_id">#get_id</a>
113
-
114
- <li ><a href="#method-i-get_last_date">#get_last_date</a>
115
-
116
- <li ><a href="#method-i-get_masked_account">#get_masked_account</a>
117
-
118
- <li ><a href="#method-i-get_message">#get_message</a>
119
-
120
- <li ><a href="#method-i-get_name1">#get_name1</a>
121
-
122
- <li ><a href="#method-i-get_name2">#get_name2</a>
123
-
124
- <li ><a href="#method-i-get_next_amount">#get_next_amount</a>
125
-
126
- <li ><a href="#method-i-get_next_date">#get_next_date</a>
127
-
128
- <li ><a href="#method-i-get_payment_type">#get_payment_type</a>
129
-
130
- <li ><a href="#method-i-get_reb_id">#get_reb_id</a>
131
-
132
- <li ><a href="#method-i-get_rebill_amount">#get_rebill_amount</a>
133
-
134
- <li ><a href="#method-i-get_rebill_id">#get_rebill_id</a>
135
-
136
- <li ><a href="#method-i-get_rebill_status">#get_rebill_status</a>
137
-
138
- <li ><a href="#method-i-get_rebilling_cycle_status">#get_rebilling_cycle_status</a>
139
-
140
- <li ><a href="#method-i-get_response">#get_response</a>
141
-
142
- <li ><a href="#method-i-get_sched_expression">#get_sched_expression</a>
143
-
144
- <li ><a href="#method-i-get_settled_transaction_report">#get_settled_transaction_report</a>
145
-
146
- <li ><a href="#method-i-get_single_trans_query">#get_single_trans_query</a>
147
-
148
- <li ><a href="#method-i-get_status">#get_status</a>
149
-
150
- <li ><a href="#method-i-get_template_id">#get_template_id</a>
151
-
152
- <li ><a href="#method-i-get_trans_id">#get_trans_id</a>
153
-
154
- <li ><a href="#method-i-get_trans_type">#get_trans_type</a>
155
-
156
- <li ><a href="#method-i-get_transaction_report">#get_transaction_report</a>
157
-
158
- <li ><a href="#method-i-process">#process</a>
159
-
160
- <li ><a href="#method-i-query_by_amount">#query_by_amount</a>
161
-
162
- <li ><a href="#method-i-query_by_name1">#query_by_name1</a>
163
-
164
- <li ><a href="#method-i-query_by_name2">#query_by_name2</a>
165
-
166
- <li ><a href="#method-i-query_by_payment_type">#query_by_payment_type</a>
167
-
168
- <li ><a href="#method-i-query_by_trans_type">#query_by_trans_type</a>
169
-
170
- <li ><a href="#method-i-query_by_transaction_id">#query_by_transaction_id</a>
171
-
172
- <li ><a href="#method-i-refund">#refund</a>
173
-
174
- <li ><a href="#method-i-sale">#sale</a>
175
-
176
- <li ><a href="#method-i-set_ach_information">#set_ach_information</a>
177
-
178
- <li ><a href="#method-i-set_amount_food">#set_amount_food</a>
179
-
180
- <li ><a href="#method-i-set_amount_misc">#set_amount_misc</a>
181
-
182
- <li ><a href="#method-i-set_amount_tax">#set_amount_tax</a>
183
-
184
- <li ><a href="#method-i-set_amount_tip">#set_amount_tip</a>
185
-
186
- <li ><a href="#method-i-set_cc_information">#set_cc_information</a>
187
-
188
- <li ><a href="#method-i-set_custom_id1">#set_custom_id1</a>
189
-
190
- <li ><a href="#method-i-set_custom_id2">#set_custom_id2</a>
191
-
192
- <li ><a href="#method-i-set_customer_information">#set_customer_information</a>
193
-
194
- <li ><a href="#method-i-set_email">#set_email</a>
195
-
196
- <li ><a href="#method-i-set_invoice_id">#set_invoice_id</a>
197
-
198
- <li ><a href="#method-i-set_memo">#set_memo</a>
199
-
200
- <li ><a href="#method-i-set_order_id">#set_order_id</a>
201
-
202
- <li ><a href="#method-i-set_param">#set_param</a>
203
-
204
- <li ><a href="#method-i-set_phone">#set_phone</a>
205
-
206
- <li ><a href="#method-i-update_rebilling_cycle">#update_rebilling_cycle</a>
207
-
208
- <li ><a href="#method-i-update_rebilling_payment_information">#update_rebilling_payment_information</a>
209
-
210
- <li ><a href="#method-i-uri_query">#uri_query</a>
211
-
212
- <li ><a href="#method-i-void">#void</a>
213
-
214
- </ul>
215
- </div>
216
-
217
- </div>
218
- </nav>
219
-
220
- <main role="main" aria-labelledby="class-BluePay">
221
- <h1 id="class-BluePay" class="class">
222
- class BluePay
223
- </h1>
224
-
225
- <section class="description">
226
-
227
- </section>
228
-
229
-
230
-
231
-
232
- <section id="5Buntitled-5D" class="documentation-section">
233
-
234
-
235
-
236
-
237
-
238
- <section class="constants-list">
239
- <header>
240
- <h3>Constants</h3>
241
- </header>
242
- <dl>
243
-
244
- <dt id="RootCA">RootCA
245
-
246
- <dd><p>Make sure this is the correct path to your CA certificates directory</p>
247
-
248
-
249
- <dt id="SERVER">SERVER
250
-
251
- <dd>
252
-
253
-
254
- </dl>
255
- </section>
256
-
257
-
258
-
259
-
260
-
261
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
262
- <header>
263
- <h3>Public Instance Methods</h3>
264
- </header>
265
-
266
-
267
- <div id="method-i-add_recurring_fields" class="method-detail ">
268
-
269
- <div class="method-heading">
270
- <span class="method-name">add_recurring_fields</span><span
271
- class="method-args">(rebill_first_date, rebill_expr, reb_cycles, reb_amount)</span>
272
-
273
- <span class="method-click-advice">click to toggle source</span>
274
-
275
- </div>
276
-
277
-
278
- <div class="method-description">
279
-
280
- <p>Set fields for a recurring payment</p>
281
-
282
-
283
-
284
-
285
- <div class="method-source-code" id="add_recurring_fields-source">
286
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 156</span>
287
- <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>)
288
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REBILLING'</span>] = <span class="ruby-string">'1'</span>
289
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_FIRST_DATE'</span>] = <span class="ruby-identifier">rebill_first_date</span>
290
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_EXPR'</span>] = <span class="ruby-identifier">rebill_expr</span>
291
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_CYCLES'</span>] = <span class="ruby-identifier">reb_cycles</span>
292
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_AMOUNT'</span>] = <span class="ruby-identifier">reb_amount</span>
293
- <span class="ruby-keyword">end</span></pre>
294
- </div>
295
-
296
- </div>
297
-
298
-
299
-
300
-
301
- </div>
302
-
303
-
304
- <div id="method-i-auth" class="method-detail ">
305
-
306
- <div class="method-heading">
307
- <span class="method-name">auth</span><span
308
- class="method-args">(amount, trans_id='')</span>
309
-
310
- <span class="method-click-advice">click to toggle source</span>
311
-
312
- </div>
313
-
314
-
315
- <div class="method-description">
316
-
317
- <p>Set up an Auth</p>
318
-
319
-
320
-
321
-
322
- <div class="method-source-code" id="auth-source">
323
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 54</span>
324
- <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>)
325
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANSACTION_TYPE'</span>] = <span class="ruby-string">'AUTH'</span>
326
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT'</span>] = <span class="ruby-identifier">amount</span>
327
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'RRNO'</span>] = <span class="ruby-identifier">trans_id</span>
328
- <span class="ruby-keyword">end</span></pre>
329
- </div>
330
-
331
- </div>
332
-
333
-
334
-
335
-
336
- </div>
337
-
338
-
339
- <div id="method-i-calc_rebill_tps" class="method-detail ">
340
-
341
- <div class="method-heading">
342
- <span class="method-name">calc_rebill_tps</span><span
343
- class="method-args">()</span>
344
-
345
- <span class="method-click-advice">click to toggle source</span>
346
-
347
- </div>
348
-
349
-
350
- <div class="method-description">
351
-
352
- <p>Sets TAMPER_PROOF_SEAL in @PARAM_HASH for rebadmin API</p>
353
-
354
-
355
-
356
-
357
- <div class="method-source-code" id="calc_rebill_tps-source">
358
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 267</span>
359
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">calc_rebill_tps</span>()
360
- <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>
361
- <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>])
362
- <span class="ruby-keyword">end</span></pre>
363
- </div>
364
-
365
- </div>
366
-
367
-
368
-
369
-
370
- </div>
371
-
372
-
373
- <div id="method-i-calc_report_tps" class="method-detail ">
374
-
375
- <div class="method-heading">
376
- <span class="method-name">calc_report_tps</span><span
377
- class="method-args">()</span>
378
-
379
- <span class="method-click-advice">click to toggle source</span>
380
-
381
- </div>
382
-
383
-
384
- <div class="method-description">
385
-
386
- <p>Sets TAMPER_PROOF_SEAL in @PARAM_HASH for bpdailyreport2 API</p>
387
-
388
-
389
-
390
-
391
- <div class="method-source-code" id="calc_report_tps-source">
392
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 273</span>
393
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">calc_report_tps</span>()
394
- <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>
395
- <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>])
396
- <span class="ruby-keyword">end</span></pre>
397
- </div>
398
-
399
- </div>
400
-
401
-
402
-
403
-
404
- </div>
405
-
406
-
407
- <div id="method-i-calc_tps" class="method-detail ">
408
-
409
- <div class="method-heading">
410
- <span class="method-name">calc_tps</span><span
411
- class="method-args">()</span>
412
-
413
- <span class="method-click-advice">click to toggle source</span>
414
-
415
- </div>
416
-
417
-
418
- <div class="method-description">
419
-
420
- <p>Sets TAMPER_PROOF_SEAL in @PARAM_HASH</p>
421
-
422
-
423
-
424
-
425
- <div class="method-source-code" id="calc_tps-source">
426
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 259</span>
427
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">calc_tps</span>()
428
- <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>
429
- (<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>
430
- (<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>
431
- (<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>])
432
- <span class="ruby-keyword">end</span></pre>
433
- </div>
434
-
435
- </div>
436
-
437
-
438
-
439
-
440
- </div>
441
-
442
-
443
- <div id="method-i-cancel_rebilling_cycle" class="method-detail ">
444
-
445
- <div class="method-heading">
446
- <span class="method-name">cancel_rebilling_cycle</span><span
447
- class="method-args">(rebill_id)</span>
448
-
449
- <span class="method-click-advice">click to toggle source</span>
450
-
451
- </div>
452
-
453
-
454
- <div class="method-description">
455
-
456
- <p>Set fields to cancel an existing rebilling cycle</p>
457
-
458
-
459
-
460
-
461
- <div class="method-source-code" id="cancel_rebilling_cycle-source">
462
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 177</span>
463
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">cancel_rebilling_cycle</span>(<span class="ruby-identifier">rebill_id</span>)
464
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;TRANS_TYPE&quot;</span>] = <span class="ruby-string">&quot;SET&quot;</span>
465
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;STATUS&quot;</span>] = <span class="ruby-string">&quot;stopped&quot;</span>
466
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REBILL_ID&quot;</span>] = <span class="ruby-identifier">rebill_id</span>
467
- <span class="ruby-keyword">end</span></pre>
468
- </div>
469
-
470
- </div>
471
-
472
-
473
-
474
-
475
- </div>
476
-
477
-
478
- <div id="method-i-capture" class="method-detail ">
479
-
480
- <div class="method-heading">
481
- <span class="method-name">capture</span><span
482
- class="method-args">(trans_id, amount='')</span>
483
-
484
- <span class="method-click-advice">click to toggle source</span>
485
-
486
- </div>
487
-
488
-
489
- <div class="method-description">
490
-
491
- <p>Capture an Auth</p>
492
-
493
-
494
-
495
-
496
- <div class="method-source-code" id="capture-source">
497
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 68</span>
498
- <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>)
499
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANSACTION_TYPE'</span>] = <span class="ruby-string">'CAPTURE'</span>
500
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT'</span>] = <span class="ruby-identifier">amount</span>
501
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'RRNO'</span>] = <span class="ruby-identifier">trans_id</span>
502
- <span class="ruby-keyword">end</span></pre>
503
- </div>
504
-
505
- </div>
506
-
507
-
508
-
509
-
510
- </div>
511
-
512
-
513
- <div id="method-i-credit" class="method-detail ">
514
-
515
- <div class="method-heading">
516
- <span class="method-name">credit</span><span
517
- class="method-args">(amount, trans_id='')</span>
518
-
519
- <span class="method-click-advice">click to toggle source</span>
520
-
521
- </div>
522
-
523
-
524
- <div class="method-description">
525
-
526
- <p>Credit</p>
527
-
528
-
529
-
530
-
531
- <div class="method-source-code" id="credit-source">
532
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 61</span>
533
- <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>)
534
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANSACTION_TYPE'</span>] = <span class="ruby-string">'CREDIT'</span>
535
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT'</span>] = <span class="ruby-identifier">amount</span>
536
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'RRNO'</span>] = <span class="ruby-identifier">trans_id</span>
537
- <span class="ruby-keyword">end</span></pre>
538
- </div>
539
-
540
- </div>
541
-
542
-
543
-
544
-
545
- </div>
546
-
547
-
548
- <div id="method-i-get_amount" class="method-detail ">
549
-
550
- <div class="method-heading">
551
- <span class="method-name">get_amount</span><span
552
- class="method-args">()</span>
553
-
554
- <span class="method-click-advice">click to toggle source</span>
555
-
556
- </div>
557
-
558
-
559
- <div class="method-description">
560
-
561
- <p>Amount associated with the transaction</p>
562
-
563
-
564
-
565
-
566
- <div class="method-source-code" id="get_amount-source">
567
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 484</span>
568
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_amount</span>()
569
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'amount'</span>]
570
- <span class="ruby-keyword">end</span></pre>
571
- </div>
572
-
573
- </div>
574
-
575
-
576
-
577
-
578
- </div>
579
-
580
-
581
- <div id="method-i-get_auth_code" class="method-detail ">
582
-
583
- <div class="method-heading">
584
- <span class="method-name">get_auth_code</span><span
585
- class="method-args">()</span>
586
-
587
- <span class="method-click-advice">click to toggle source</span>
588
-
589
- </div>
590
-
591
-
592
- <div class="method-description">
593
-
594
- <p>In the case of an approved transaction, contains the 6-character
595
- authorization code from the processing network. In the case of a decline or
596
- error, the contents may be junk.</p>
597
-
598
-
599
-
600
-
601
- <div class="method-source-code" id="get_auth_code-source">
602
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 379</span>
603
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_auth_code</span>()
604
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'AUTH_CODE'</span>]
605
- <span class="ruby-keyword">end</span></pre>
606
- </div>
607
-
608
- </div>
609
-
610
-
611
-
612
-
613
- </div>
614
-
615
-
616
- <div id="method-i-get_avs_code" class="method-detail ">
617
-
618
- <div class="method-heading">
619
- <span class="method-name">get_avs_code</span><span
620
- class="method-args">()</span>
621
-
622
- <span class="method-click-advice">click to toggle source</span>
623
-
624
- </div>
625
-
626
-
627
- <div class="method-description">
628
-
629
- <p>Returns the single-character AVS response from the Card Issuing Bank</p>
630
-
631
-
632
-
633
-
634
- <div class="method-source-code" id="get_avs_code-source">
635
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 366</span>
636
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_avs_code</span>()
637
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'AVS'</span>]
638
- <span class="ruby-keyword">end</span></pre>
639
- </div>
640
-
641
- </div>
642
-
643
-
644
-
645
-
646
- </div>
647
-
648
-
649
- <div id="method-i-get_bank_name" class="method-detail ">
650
-
651
- <div class="method-heading">
652
- <span class="method-name">get_bank_name</span><span
653
- class="method-args">()</span>
654
-
655
- <span class="method-click-advice">click to toggle source</span>
656
-
657
- </div>
658
-
659
-
660
- <div class="method-description">
661
-
662
- <p>Bank account used in transaction</p>
663
-
664
-
665
-
666
-
667
- <div class="method-source-code" id="get_bank_name-source">
668
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 404</span>
669
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_bank_name</span>()
670
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'BANK_NAME'</span>]
671
- <span class="ruby-keyword">end</span></pre>
672
- </div>
673
-
674
- </div>
675
-
676
-
677
-
678
-
679
- </div>
680
-
681
-
682
- <div id="method-i-get_card_type" class="method-detail ">
683
-
684
- <div class="method-heading">
685
- <span class="method-name">get_card_type</span><span
686
- class="method-args">()</span>
687
-
688
- <span class="method-click-advice">click to toggle source</span>
689
-
690
- </div>
691
-
692
-
693
- <div class="method-description">
694
-
695
- <p>Card type used in transaction</p>
696
-
697
-
698
-
699
-
700
- <div class="method-source-code" id="get_card_type-source">
701
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 399</span>
702
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_card_type</span>()
703
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'CARD_TYPE'</span>]
704
- <span class="ruby-keyword">end</span></pre>
705
- </div>
706
-
707
- </div>
708
-
709
-
710
-
711
-
712
- </div>
713
-
714
-
715
- <div id="method-i-get_creation_date" class="method-detail ">
716
-
717
- <div class="method-heading">
718
- <span class="method-name">get_creation_date</span><span
719
- class="method-args">()</span>
720
-
721
- <span class="method-click-advice">click to toggle source</span>
722
-
723
- </div>
724
-
725
-
726
- <div class="method-description">
727
-
728
- <p>Creation date of rebilling</p>
729
-
730
-
731
-
732
-
733
- <div class="method-source-code" id="get_creation_date-source">
734
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 424</span>
735
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_creation_date</span>()
736
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'creation_date'</span>]
737
- <span class="ruby-keyword">end</span></pre>
738
- </div>
739
-
740
- </div>
741
-
742
-
743
-
744
-
745
- </div>
746
-
747
-
748
- <div id="method-i-get_cvv2_code" class="method-detail ">
749
-
750
- <div class="method-heading">
751
- <span class="method-name">get_cvv2_code</span><span
752
- class="method-args">()</span>
753
-
754
- <span class="method-click-advice">click to toggle source</span>
755
-
756
- </div>
757
-
758
-
759
- <div class="method-description">
760
-
761
- <p>Same as avs_code, but for CVV2</p>
762
-
763
-
764
-
765
-
766
- <div class="method-source-code" id="get_cvv2_code-source">
767
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 372</span>
768
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_cvv2_code</span>()
769
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'CVV2'</span>]
770
- <span class="ruby-keyword">end</span></pre>
771
- </div>
772
-
773
- </div>
774
-
775
-
776
-
777
-
778
- </div>
779
-
780
-
781
- <div id="method-i-get_cycles_remaining" class="method-detail ">
782
-
783
- <div class="method-heading">
784
- <span class="method-name">get_cycles_remaining</span><span
785
- class="method-args">()</span>
786
-
787
- <span class="method-click-advice">click to toggle source</span>
788
-
789
- </div>
790
-
791
-
792
- <div class="method-description">
793
-
794
- <p>Number of cycles remaining on rebilling</p>
795
-
796
-
797
-
798
-
799
- <div class="method-source-code" id="get_cycles_remaining-source">
800
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 444</span>
801
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_cycles_remaining</span>()
802
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'cycles_remain'</span>]
803
- <span class="ruby-keyword">end</span></pre>
804
- </div>
805
-
806
- </div>
807
-
808
-
809
-
810
-
811
- </div>
812
-
813
-
814
- <div id="method-i-get_id" class="method-detail ">
815
-
816
- <div class="method-heading">
817
- <span class="method-name">get_id</span><span
818
- class="method-args">()</span>
819
-
820
- <span class="method-click-advice">click to toggle source</span>
821
-
822
- </div>
823
-
824
-
825
- <div class="method-description">
826
-
827
- <p>Transaction ID used with stq API</p>
828
-
829
-
830
-
831
-
832
- <div class="method-source-code" id="get_id-source">
833
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 459</span>
834
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_id</span>()
835
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'id'</span>]
836
- <span class="ruby-keyword">end</span></pre>
837
- </div>
838
-
839
- </div>
840
-
841
-
842
-
843
-
844
- </div>
845
-
846
-
847
- <div id="method-i-get_last_date" class="method-detail ">
848
-
849
- <div class="method-heading">
850
- <span class="method-name">get_last_date</span><span
851
- class="method-args">()</span>
852
-
853
- <span class="method-click-advice">click to toggle source</span>
854
-
855
- </div>
856
-
857
-
858
- <div class="method-description">
859
-
860
- <p>Last date that the rebilling fired off on</p>
861
-
862
-
863
-
864
-
865
- <div class="method-source-code" id="get_last_date-source">
866
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 434</span>
867
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_last_date</span>()
868
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'last_date'</span>]
869
- <span class="ruby-keyword">end</span></pre>
870
- </div>
871
-
872
- </div>
873
-
874
-
875
-
876
-
877
- </div>
878
-
879
-
880
- <div id="method-i-get_masked_account" class="method-detail ">
881
-
882
- <div class="method-heading">
883
- <span class="method-name">get_masked_account</span><span
884
- class="method-args">()</span>
885
-
886
- <span class="method-click-advice">click to toggle source</span>
887
-
888
- </div>
889
-
890
-
891
- <div class="method-description">
892
-
893
- <p>Masked credit card or ACH account</p>
894
-
895
-
896
-
897
-
898
- <div class="method-source-code" id="get_masked_account-source">
899
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 394</span>
900
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_masked_account</span>()
901
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'PAYMENT_ACCOUNT'</span>]
902
- <span class="ruby-keyword">end</span></pre>
903
- </div>
904
-
905
- </div>
906
-
907
-
908
-
909
-
910
- </div>
911
-
912
-
913
- <div id="method-i-get_message" class="method-detail ">
914
-
915
- <div class="method-heading">
916
- <span class="method-name">get_message</span><span
917
- class="method-args">()</span>
918
-
919
- <span class="method-click-advice">click to toggle source</span>
920
-
921
- </div>
922
-
923
-
924
- <div class="method-description">
925
-
926
- <p>Returns the human-readable response from Bluepay. Or a nasty error.</p>
927
-
928
-
929
-
930
-
931
- <div class="method-source-code" id="get_message-source">
932
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 356</span>
933
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_message</span>()
934
- <span class="ruby-identifier">m</span> = <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'MESSAGE'</span>]
935
- <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>)
936
- <span class="ruby-keyword">return</span> <span class="ruby-string">&quot;ERROR - NO MESSAGE FROM BLUEPAY&quot;</span>
937
- <span class="ruby-keyword">end</span>
938
- <span class="ruby-keyword">return</span> <span class="ruby-identifier">m</span>
939
- <span class="ruby-keyword">end</span></pre>
940
- </div>
941
-
942
- </div>
943
-
944
-
945
-
946
-
947
- </div>
948
-
949
-
950
- <div id="method-i-get_name1" class="method-detail ">
951
-
952
- <div class="method-heading">
953
- <span class="method-name">get_name1</span><span
954
- class="method-args">()</span>
955
-
956
- <span class="method-click-advice">click to toggle source</span>
957
-
958
- </div>
959
-
960
-
961
- <div class="method-description">
962
-
963
- <p>First name associated with the transaction</p>
964
-
965
-
966
-
967
-
968
- <div class="method-source-code" id="get_name1-source">
969
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 464</span>
970
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_name1</span>()
971
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'name1'</span>]
972
- <span class="ruby-keyword">end</span></pre>
973
- </div>
974
-
975
- </div>
976
-
977
-
978
-
979
-
980
- </div>
981
-
982
-
983
- <div id="method-i-get_name2" class="method-detail ">
984
-
985
- <div class="method-heading">
986
- <span class="method-name">get_name2</span><span
987
- class="method-args">()</span>
988
-
989
- <span class="method-click-advice">click to toggle source</span>
990
-
991
- </div>
992
-
993
-
994
- <div class="method-description">
995
-
996
- <p>Last name associated with the transaction</p>
997
-
998
-
999
-
1000
-
1001
- <div class="method-source-code" id="get_name2-source">
1002
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 469</span>
1003
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_name2</span>()
1004
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'name2'</span>]
1005
- <span class="ruby-keyword">end</span></pre>
1006
- </div>
1007
-
1008
- </div>
1009
-
1010
-
1011
-
1012
-
1013
- </div>
1014
-
1015
-
1016
- <div id="method-i-get_next_amount" class="method-detail ">
1017
-
1018
- <div class="method-heading">
1019
- <span class="method-name">get_next_amount</span><span
1020
- class="method-args">()</span>
1021
-
1022
- <span class="method-click-advice">click to toggle source</span>
1023
-
1024
- </div>
1025
-
1026
-
1027
- <div class="method-description">
1028
-
1029
- <p>Next amount to charge when rebilling fires off</p>
1030
-
1031
-
1032
-
1033
-
1034
- <div class="method-source-code" id="get_next_amount-source">
1035
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 454</span>
1036
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_next_amount</span>()
1037
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'next_amount'</span>]
1038
- <span class="ruby-keyword">end</span></pre>
1039
- </div>
1040
-
1041
- </div>
1042
-
1043
-
1044
-
1045
-
1046
- </div>
1047
-
1048
-
1049
- <div id="method-i-get_next_date" class="method-detail ">
1050
-
1051
- <div class="method-heading">
1052
- <span class="method-name">get_next_date</span><span
1053
- class="method-args">()</span>
1054
-
1055
- <span class="method-click-advice">click to toggle source</span>
1056
-
1057
- </div>
1058
-
1059
-
1060
- <div class="method-description">
1061
-
1062
- <p>Next date that the rebilling is set to fire off on</p>
1063
-
1064
-
1065
-
1066
-
1067
- <div class="method-source-code" id="get_next_date-source">
1068
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 429</span>
1069
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_next_date</span>()
1070
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'next_date'</span>]
1071
- <span class="ruby-keyword">end</span></pre>
1072
- </div>
1073
-
1074
- </div>
1075
-
1076
-
1077
-
1078
-
1079
- </div>
1080
-
1081
-
1082
- <div id="method-i-get_payment_type" class="method-detail ">
1083
-
1084
- <div class="method-heading">
1085
- <span class="method-name">get_payment_type</span><span
1086
- class="method-args">()</span>
1087
-
1088
- <span class="method-click-advice">click to toggle source</span>
1089
-
1090
- </div>
1091
-
1092
-
1093
- <div class="method-description">
1094
-
1095
- <p>Payment type associated with the transaction</p>
1096
-
1097
-
1098
-
1099
-
1100
- <div class="method-source-code" id="get_payment_type-source">
1101
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 474</span>
1102
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_payment_type</span>()
1103
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'payment_type'</span>]
1104
- <span class="ruby-keyword">end</span></pre>
1105
- </div>
1106
-
1107
- </div>
1108
-
1109
-
1110
-
1111
-
1112
- </div>
1113
-
1114
-
1115
- <div id="method-i-get_reb_id" class="method-detail ">
1116
-
1117
- <div class="method-heading">
1118
- <span class="method-name">get_reb_id</span><span
1119
- class="method-args">()</span>
1120
-
1121
- <span class="method-click-advice">click to toggle source</span>
1122
-
1123
- </div>
1124
-
1125
-
1126
- <div class="method-description">
1127
-
1128
- <p>Rebill ID from bprebadmin API</p>
1129
-
1130
-
1131
-
1132
-
1133
- <div class="method-source-code" id="get_reb_id-source">
1134
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 409</span>
1135
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_reb_id</span>()
1136
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'rebill_id'</span>]
1137
- <span class="ruby-keyword">end</span></pre>
1138
- </div>
1139
-
1140
- </div>
1141
-
1142
-
1143
-
1144
-
1145
- </div>
1146
-
1147
-
1148
- <div id="method-i-get_rebill_amount" class="method-detail ">
1149
-
1150
- <div class="method-heading">
1151
- <span class="method-name">get_rebill_amount</span><span
1152
- class="method-args">()</span>
1153
-
1154
- <span class="method-click-advice">click to toggle source</span>
1155
-
1156
- </div>
1157
-
1158
-
1159
- <div class="method-description">
1160
-
1161
- <p>Amount to charge when rebilling fires off</p>
1162
-
1163
-
1164
-
1165
-
1166
- <div class="method-source-code" id="get_rebill_amount-source">
1167
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 449</span>
1168
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_rebill_amount</span>()
1169
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'reb_amount'</span>]
1170
- <span class="ruby-keyword">end</span></pre>
1171
- </div>
1172
-
1173
- </div>
1174
-
1175
-
1176
-
1177
-
1178
- </div>
1179
-
1180
-
1181
- <div id="method-i-get_rebill_id" class="method-detail ">
1182
-
1183
- <div class="method-heading">
1184
- <span class="method-name">get_rebill_id</span><span
1185
- class="method-args">()</span>
1186
-
1187
- <span class="method-click-advice">click to toggle source</span>
1188
-
1189
- </div>
1190
-
1191
-
1192
- <div class="method-description">
1193
-
1194
- <p>If you set up a rebilling, this’ll get its ID.</p>
1195
-
1196
-
1197
-
1198
-
1199
- <div class="method-source-code" id="get_rebill_id-source">
1200
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 389</span>
1201
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_rebill_id</span>()
1202
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'REBID'</span>]
1203
- <span class="ruby-keyword">end</span></pre>
1204
- </div>
1205
-
1206
- </div>
1207
-
1208
-
1209
-
1210
-
1211
- </div>
1212
-
1213
-
1214
- <div id="method-i-get_rebill_status" class="method-detail ">
1215
-
1216
- <div class="method-heading">
1217
- <span class="method-name">get_rebill_status</span><span
1218
- class="method-args">()</span>
1219
-
1220
- <span class="method-click-advice">click to toggle source</span>
1221
-
1222
- </div>
1223
-
1224
-
1225
- <div class="method-description">
1226
-
1227
- <p>Status of rebilling</p>
1228
-
1229
-
1230
-
1231
-
1232
- <div class="method-source-code" id="get_rebill_status-source">
1233
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 419</span>
1234
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_rebill_status</span>()
1235
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'status'</span>]
1236
- <span class="ruby-keyword">end</span></pre>
1237
- </div>
1238
-
1239
- </div>
1240
-
1241
-
1242
-
1243
-
1244
- </div>
1245
-
1246
-
1247
- <div id="method-i-get_rebilling_cycle_status" class="method-detail ">
1248
-
1249
- <div class="method-heading">
1250
- <span class="method-name">get_rebilling_cycle_status</span><span
1251
- class="method-args">(rebill_id)</span>
1252
-
1253
- <span class="method-click-advice">click to toggle source</span>
1254
-
1255
- </div>
1256
-
1257
-
1258
- <div class="method-description">
1259
-
1260
- <p>Set fields to get the status of an existing rebilling cycle</p>
1261
-
1262
-
1263
-
1264
-
1265
- <div class="method-source-code" id="get_rebilling_cycle_status-source">
1266
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 184</span>
1267
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_rebilling_cycle_status</span>(<span class="ruby-identifier">rebill_id</span>)
1268
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;TRANS_TYPE&quot;</span>] = <span class="ruby-string">&quot;GET&quot;</span>
1269
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REBILL_ID&quot;</span>] = <span class="ruby-identifier">rebill_id</span>
1270
- <span class="ruby-keyword">end</span></pre>
1271
- </div>
1272
-
1273
- </div>
1274
-
1275
-
1276
-
1277
-
1278
- </div>
1279
-
1280
-
1281
- <div id="method-i-get_response" class="method-detail ">
1282
-
1283
- <div class="method-heading">
1284
- <span class="method-name">get_response</span><span
1285
- class="method-args">()</span>
1286
-
1287
- <span class="method-click-advice">click to toggle source</span>
1288
-
1289
- </div>
1290
-
1291
-
1292
- <div class="method-description">
1293
-
1294
-
1295
-
1296
-
1297
-
1298
-
1299
- <div class="method-source-code" id="get_response-source">
1300
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 345</span>
1301
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_response</span>()
1302
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>
1303
- <span class="ruby-keyword">end</span></pre>
1304
- </div>
1305
-
1306
- </div>
1307
-
1308
-
1309
-
1310
-
1311
- </div>
1312
-
1313
-
1314
- <div id="method-i-get_sched_expression" class="method-detail ">
1315
-
1316
- <div class="method-heading">
1317
- <span class="method-name">get_sched_expression</span><span
1318
- class="method-args">()</span>
1319
-
1320
- <span class="method-click-advice">click to toggle source</span>
1321
-
1322
- </div>
1323
-
1324
-
1325
- <div class="method-description">
1326
-
1327
- <p>Rebilling expression</p>
1328
-
1329
-
1330
-
1331
-
1332
- <div class="method-source-code" id="get_sched_expression-source">
1333
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 439</span>
1334
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_sched_expression</span>()
1335
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'sched_expr'</span>]
1336
- <span class="ruby-keyword">end</span></pre>
1337
- </div>
1338
-
1339
- </div>
1340
-
1341
-
1342
-
1343
-
1344
- </div>
1345
-
1346
-
1347
- <div id="method-i-get_settled_transaction_report" class="method-detail ">
1348
-
1349
- <div class="method-heading">
1350
- <span class="method-name">get_settled_transaction_report</span><span
1351
- class="method-args">(report_start, report_end, subaccounts_searched, do_not_escape = '', errors = '')</span>
1352
-
1353
- <span class="method-click-advice">click to toggle source</span>
1354
-
1355
- </div>
1356
-
1357
-
1358
- <div class="method-description">
1359
-
1360
- <p>Gets a report on all settled transactions within a specified date range</p>
1361
-
1362
-
1363
-
1364
-
1365
- <div class="method-source-code" id="get_settled_transaction_report-source">
1366
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 205</span>
1367
- <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>)
1368
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;QUERY_BY_SETTLEMENT&quot;</span>] = <span class="ruby-string">'1'</span>
1369
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_START_DATE&quot;</span>] = <span class="ruby-identifier">report_start</span>
1370
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_END_DATE&quot;</span>] = <span class="ruby-identifier">report_end</span>
1371
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;QUERY_BY_HIERARCHY&quot;</span>] = <span class="ruby-identifier">subaccounts_searched</span>
1372
- <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>
1373
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;EXCLUDE_ERRORS&quot;</span>] = <span class="ruby-identifier">errors</span>
1374
- <span class="ruby-keyword">end</span></pre>
1375
- </div>
1376
-
1377
- </div>
1378
-
1379
-
1380
-
1381
-
1382
- </div>
1383
-
1384
-
1385
- <div id="method-i-get_single_trans_query" class="method-detail ">
1386
-
1387
- <div class="method-heading">
1388
- <span class="method-name">get_single_trans_query</span><span
1389
- class="method-args">(report_start, report_end, errors = "")</span>
1390
-
1391
- <span class="method-click-advice">click to toggle source</span>
1392
-
1393
- </div>
1394
-
1395
-
1396
- <div class="method-description">
1397
-
1398
- <p>Gets data on a specific transaction</p>
1399
-
1400
-
1401
-
1402
-
1403
- <div class="method-source-code" id="get_single_trans_query-source">
1404
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 215</span>
1405
- <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>)
1406
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_START_DATE&quot;</span>] = <span class="ruby-identifier">report_start</span>
1407
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_END_DATE&quot;</span>] = <span class="ruby-identifier">report_end</span>
1408
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;EXCLUDE_ERRORS&quot;</span>] = <span class="ruby-identifier">errors</span>
1409
- <span class="ruby-keyword">end</span></pre>
1410
- </div>
1411
-
1412
- </div>
1413
-
1414
-
1415
-
1416
-
1417
- </div>
1418
-
1419
-
1420
- <div id="method-i-get_status" class="method-detail ">
1421
-
1422
- <div class="method-heading">
1423
- <span class="method-name">get_status</span><span
1424
- class="method-args">()</span>
1425
-
1426
- <span class="method-click-advice">click to toggle source</span>
1427
-
1428
- </div>
1429
-
1430
-
1431
- <div class="method-description">
1432
-
1433
- <p>Returns E for Error, 1 for Approved, 0 for Decline</p>
1434
-
1435
-
1436
-
1437
-
1438
- <div class="method-source-code" id="get_status-source">
1439
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 350</span>
1440
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_status</span>()
1441
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'Result'</span>]
1442
- <span class="ruby-keyword">end</span></pre>
1443
- </div>
1444
-
1445
- </div>
1446
-
1447
-
1448
-
1449
-
1450
- </div>
1451
-
1452
-
1453
- <div id="method-i-get_template_id" class="method-detail ">
1454
-
1455
- <div class="method-heading">
1456
- <span class="method-name">get_template_id</span><span
1457
- class="method-args">()</span>
1458
-
1459
- <span class="method-click-advice">click to toggle source</span>
1460
-
1461
- </div>
1462
-
1463
-
1464
- <div class="method-description">
1465
-
1466
- <p>Template ID of rebilling</p>
1467
-
1468
-
1469
-
1470
-
1471
- <div class="method-source-code" id="get_template_id-source">
1472
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 414</span>
1473
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_template_id</span>()
1474
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'template_id'</span>]
1475
- <span class="ruby-keyword">end</span></pre>
1476
- </div>
1477
-
1478
- </div>
1479
-
1480
-
1481
-
1482
-
1483
- </div>
1484
-
1485
-
1486
- <div id="method-i-get_trans_id" class="method-detail ">
1487
-
1488
- <div class="method-heading">
1489
- <span class="method-name">get_trans_id</span><span
1490
- class="method-args">()</span>
1491
-
1492
- <span class="method-click-advice">click to toggle source</span>
1493
-
1494
- </div>
1495
-
1496
-
1497
- <div class="method-description">
1498
-
1499
- <p>The all-important transaction ID.</p>
1500
-
1501
-
1502
-
1503
-
1504
- <div class="method-source-code" id="get_trans_id-source">
1505
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 384</span>
1506
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_trans_id</span>()
1507
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'RRNO'</span>]
1508
- <span class="ruby-keyword">end</span></pre>
1509
- </div>
1510
-
1511
- </div>
1512
-
1513
-
1514
-
1515
-
1516
- </div>
1517
-
1518
-
1519
- <div id="method-i-get_trans_type" class="method-detail ">
1520
-
1521
- <div class="method-heading">
1522
- <span class="method-name">get_trans_type</span><span
1523
- class="method-args">()</span>
1524
-
1525
- <span class="method-click-advice">click to toggle source</span>
1526
-
1527
- </div>
1528
-
1529
-
1530
- <div class="method-description">
1531
-
1532
- <p>Transaction type associated with the transaction</p>
1533
-
1534
-
1535
-
1536
-
1537
- <div class="method-source-code" id="get_trans_type-source">
1538
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 479</span>
1539
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">get_trans_type</span>()
1540
- <span class="ruby-keyword">return</span> <span class="ruby-ivar">@RESPONSE_HASH</span>[<span class="ruby-string">'trans_type'</span>]
1541
- <span class="ruby-keyword">end</span></pre>
1542
- </div>
1543
-
1544
- </div>
1545
-
1546
-
1547
-
1548
-
1549
- </div>
1550
-
1551
-
1552
- <div id="method-i-get_transaction_report" class="method-detail ">
1553
-
1554
- <div class="method-heading">
1555
- <span class="method-name">get_transaction_report</span><span
1556
- class="method-args">(report_start, report_end, subaccounts_searched, do_not_escape = '', errors = '')</span>
1557
-
1558
- <span class="method-click-advice">click to toggle source</span>
1559
-
1560
- </div>
1561
-
1562
-
1563
- <div class="method-description">
1564
-
1565
- <p>Gets a report on all transactions within a specified date range</p>
1566
-
1567
-
1568
-
1569
-
1570
- <div class="method-source-code" id="get_transaction_report-source">
1571
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 195</span>
1572
- <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>)
1573
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;QUERY_BY_SETTLEMENT&quot;</span>] = <span class="ruby-string">'0'</span>
1574
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_START_DATE&quot;</span>] = <span class="ruby-identifier">report_start</span>
1575
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;REPORT_END_DATE&quot;</span>] = <span class="ruby-identifier">report_end</span>
1576
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;QUERY_BY_HIERARCHY&quot;</span>] = <span class="ruby-identifier">subaccounts_searched</span>
1577
- <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>
1578
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;EXCLUDE_ERRORS&quot;</span>] = <span class="ruby-identifier">errors</span>
1579
- <span class="ruby-keyword">end</span></pre>
1580
- </div>
1581
-
1582
- </div>
1583
-
1584
-
1585
-
1586
-
1587
- </div>
1588
-
1589
-
1590
- <div id="method-i-process" class="method-detail ">
1591
-
1592
- <div class="method-heading">
1593
- <span class="method-name">process</span><span
1594
- class="method-args">()</span>
1595
-
1596
- <span class="method-click-advice">click to toggle source</span>
1597
-
1598
- </div>
1599
-
1600
-
1601
- <div class="method-description">
1602
-
1603
- <p>sends HTTPS POST to <a href="BluePay.html">BluePay</a> gateway for
1604
- processing</p>
1605
-
1606
-
1607
-
1608
-
1609
- <div class="method-source-code" id="process-source">
1610
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 286</span>
1611
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">process</span>()
1612
- <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>)
1613
- <span class="ruby-identifier">ua</span>.<span class="ruby-identifier">use_ssl</span> = <span class="ruby-keyword">true</span>
1614
- <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span> <span class="ruby-constant">RootCA</span>
1615
- <span class="ruby-identifier">ua</span>.<span class="ruby-identifier">ca_path</span> = <span class="ruby-constant">RootCA</span>
1616
- <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>
1617
- <span class="ruby-identifier">ua</span>.<span class="ruby-identifier">verify_depth</span> = <span class="ruby-value">3</span>
1618
- <span class="ruby-keyword">else</span>
1619
- <span class="ruby-identifier">puts</span> <span class="ruby-string">&quot;Invalid CA certificates directory. Exiting...&quot;</span>
1620
- <span class="ruby-identifier">exit</span>
1621
- <span class="ruby-keyword">end</span>
1622
- <span class="ruby-keyword">begin</span>
1623
- <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>]
1624
- <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span>
1625
- <span class="ruby-keyword">end</span>
1626
- <span class="ruby-comment"># Generate the query string and headers
1627
- <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>))
1628
- <span class="ruby-identifier">calc_report_tps</span>()
1629
- <span class="ruby-identifier">path</span> = <span class="ruby-string">&quot;/interfaces/bpdailyreport2&quot;</span>
1630
- <span class="ruby-identifier">query</span> = <span class="ruby-node">&quot;ACCOUNT_ID=#{@ACCOUNT_ID}&amp;&quot;</span>
1631
- <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>)
1632
- <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>))
1633
- <span class="ruby-identifier">calc_report_tps</span>()
1634
- <span class="ruby-identifier">path</span> = <span class="ruby-string">&quot;/interfaces/stq&quot;</span>
1635
- <span class="ruby-identifier">query</span> = <span class="ruby-node">&quot;ACCOUNT_ID=#{@ACCOUNT_ID}&amp;&quot;</span>
1636
- <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>)
1637
- <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>)
1638
- <span class="ruby-identifier">calc_tps</span>()
1639
- <span class="ruby-identifier">path</span> = <span class="ruby-string">&quot;/interfaces/bp10emu&quot;</span>
1640
- <span class="ruby-identifier">query</span> = <span class="ruby-node">&quot;MERCHANT=#{@ACCOUNT_ID}&amp;&quot;</span>
1641
- <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>)
1642
- <span class="ruby-keyword">else</span>
1643
- <span class="ruby-identifier">calc_rebill_tps</span>()
1644
- <span class="ruby-identifier">path</span> = <span class="ruby-string">&quot;/interfaces/bp20rebadmin&quot;</span>
1645
- <span class="ruby-identifier">query</span> = <span class="ruby-node">&quot;ACCOUNT_ID=#{@ACCOUNT_ID}&amp;&quot;</span>
1646
- <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>)
1647
- <span class="ruby-keyword">end</span>
1648
-
1649
- <span class="ruby-identifier">queryheaders</span> = {
1650
- <span class="ruby-string">'User-Agent'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'Bluepay Ruby Client'</span>,
1651
- <span class="ruby-string">'Content-Type'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'application/x-www-form-urlencoded'</span>
1652
- }
1653
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;VERSION&quot;</span>] = <span class="ruby-string">'3'</span>
1654
- <span class="ruby-comment"># Post parameters to BluePay gateway
1655
- <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>)
1656
- <span class="ruby-comment"># Split the response into the response hash.
1657
- <span class="ruby-ivar">@RESPONSE_HASH</span> = {}
1658
- <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>
1659
- <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>]
1660
- <span class="ruby-keyword">else</span>
1661
- <span class="ruby-identifier">response</span> = <span class="ruby-identifier">headers</span>.<span class="ruby-identifier">body</span>
1662
- <span class="ruby-keyword">end</span>
1663
- <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>
1664
- (<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>)
1665
- <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>)
1666
- <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>)
1667
- }
1668
- <span class="ruby-keyword">end</span></pre>
1669
- </div>
1670
-
1671
- </div>
1672
-
1673
-
1674
-
1675
-
1676
- </div>
1677
-
1678
-
1679
- <div id="method-i-query_by_amount" class="method-detail ">
1680
-
1681
- <div class="method-heading">
1682
- <span class="method-name">query_by_amount</span><span
1683
- class="method-args">(amount)</span>
1684
-
1685
- <span class="method-click-advice">click to toggle source</span>
1686
-
1687
- </div>
1688
-
1689
-
1690
- <div class="method-description">
1691
-
1692
- <p>Queries by a specific Transaction Amount. To be used with <a
1693
- href="BluePay.html#method-i-get_single_trans_query">#get_single_trans_query</a></p>
1694
-
1695
-
1696
-
1697
-
1698
- <div class="method-source-code" id="query_by_amount-source">
1699
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 237</span>
1700
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">query_by_amount</span>(<span class="ruby-identifier">amount</span>)
1701
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;amount&quot;</span>] = <span class="ruby-identifier">amount</span>
1702
- <span class="ruby-keyword">end</span></pre>
1703
- </div>
1704
-
1705
- </div>
1706
-
1707
-
1708
-
1709
-
1710
- </div>
1711
-
1712
-
1713
- <div id="method-i-query_by_name1" class="method-detail ">
1714
-
1715
- <div class="method-heading">
1716
- <span class="method-name">query_by_name1</span><span
1717
- class="method-args">(name1)</span>
1718
-
1719
- <span class="method-click-advice">click to toggle source</span>
1720
-
1721
- </div>
1722
-
1723
-
1724
- <div class="method-description">
1725
-
1726
- <p>Queries by a specific First Name. To be used with <a
1727
- href="BluePay.html#method-i-get_single_trans_query">#get_single_trans_query</a></p>
1728
-
1729
-
1730
-
1731
-
1732
- <div class="method-source-code" id="query_by_name1-source">
1733
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 242</span>
1734
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">query_by_name1</span>(<span class="ruby-identifier">name1</span>)
1735
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;name1&quot;</span>] = <span class="ruby-identifier">name1</span>
1736
- <span class="ruby-keyword">end</span></pre>
1737
- </div>
1738
-
1739
- </div>
1740
-
1741
-
1742
-
1743
-
1744
- </div>
1745
-
1746
-
1747
- <div id="method-i-query_by_name2" class="method-detail ">
1748
-
1749
- <div class="method-heading">
1750
- <span class="method-name">query_by_name2</span><span
1751
- class="method-args">(name2)</span>
1752
-
1753
- <span class="method-click-advice">click to toggle source</span>
1754
-
1755
- </div>
1756
-
1757
-
1758
- <div class="method-description">
1759
-
1760
- <p>Queries by a specific Last Name. To be used with <a
1761
- href="BluePay.html#method-i-get_single_trans_query">#get_single_trans_query</a></p>
1762
-
1763
-
1764
-
1765
-
1766
- <div class="method-source-code" id="query_by_name2-source">
1767
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 247</span>
1768
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">query_by_name2</span>(<span class="ruby-identifier">name2</span>)
1769
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;name2&quot;</span>] = <span class="ruby-identifier">name2</span>
1770
- <span class="ruby-keyword">end</span></pre>
1771
- </div>
1772
-
1773
- </div>
1774
-
1775
-
1776
-
1777
-
1778
- </div>
1779
-
1780
-
1781
- <div id="method-i-query_by_payment_type" class="method-detail ">
1782
-
1783
- <div class="method-heading">
1784
- <span class="method-name">query_by_payment_type</span><span
1785
- class="method-args">(pay_type)</span>
1786
-
1787
- <span class="method-click-advice">click to toggle source</span>
1788
-
1789
- </div>
1790
-
1791
-
1792
- <div class="method-description">
1793
-
1794
- <p>Queries by a specific Payment Type. To be used with <a
1795
- href="BluePay.html#method-i-get_single_trans_query">#get_single_trans_query</a></p>
1796
-
1797
-
1798
-
1799
-
1800
- <div class="method-source-code" id="query_by_payment_type-source">
1801
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 227</span>
1802
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">query_by_payment_type</span>(<span class="ruby-identifier">pay_type</span>)
1803
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;payment_type&quot;</span>] = <span class="ruby-identifier">payment_type</span>
1804
- <span class="ruby-keyword">end</span></pre>
1805
- </div>
1806
-
1807
- </div>
1808
-
1809
-
1810
-
1811
-
1812
- </div>
1813
-
1814
-
1815
- <div id="method-i-query_by_trans_type" class="method-detail ">
1816
-
1817
- <div class="method-heading">
1818
- <span class="method-name">query_by_trans_type</span><span
1819
- class="method-args">(trans_type)</span>
1820
-
1821
- <span class="method-click-advice">click to toggle source</span>
1822
-
1823
- </div>
1824
-
1825
-
1826
- <div class="method-description">
1827
-
1828
- <p>Queries by a specific Transaction Type. To be used with <a
1829
- href="BluePay.html#method-i-get_single_trans_query">#get_single_trans_query</a></p>
1830
-
1831
-
1832
-
1833
-
1834
- <div class="method-source-code" id="query_by_trans_type-source">
1835
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 232</span>
1836
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">query_by_trans_type</span>(<span class="ruby-identifier">trans_type</span>)
1837
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;trans_type&quot;</span>] = <span class="ruby-identifier">trans_type</span>
1838
- <span class="ruby-keyword">end</span></pre>
1839
- </div>
1840
-
1841
- </div>
1842
-
1843
-
1844
-
1845
-
1846
- </div>
1847
-
1848
-
1849
- <div id="method-i-query_by_transaction_id" class="method-detail ">
1850
-
1851
- <div class="method-heading">
1852
- <span class="method-name">query_by_transaction_id</span><span
1853
- class="method-args">(trans_id)</span>
1854
-
1855
- <span class="method-click-advice">click to toggle source</span>
1856
-
1857
- </div>
1858
-
1859
-
1860
- <div class="method-description">
1861
-
1862
- <p>Queries by a specific Transaction ID. To be used with <a
1863
- href="BluePay.html#method-i-get_single_trans_query">#get_single_trans_query</a></p>
1864
-
1865
-
1866
-
1867
-
1868
- <div class="method-source-code" id="query_by_transaction_id-source">
1869
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 222</span>
1870
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">query_by_transaction_id</span>(<span class="ruby-identifier">trans_id</span>)
1871
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;id&quot;</span>] = <span class="ruby-identifier">trans_id</span>;
1872
- <span class="ruby-keyword">end</span></pre>
1873
- </div>
1874
-
1875
- </div>
1876
-
1877
-
1878
-
1879
-
1880
- </div>
1881
-
1882
-
1883
- <div id="method-i-refund" class="method-detail ">
1884
-
1885
- <div class="method-heading">
1886
- <span class="method-name">refund</span><span
1887
- class="method-args">(trans_id, amount='')</span>
1888
-
1889
- <span class="method-click-advice">click to toggle source</span>
1890
-
1891
- </div>
1892
-
1893
-
1894
- <div class="method-description">
1895
-
1896
- <p>Refund</p>
1897
-
1898
-
1899
-
1900
-
1901
- <div class="method-source-code" id="refund-source">
1902
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 75</span>
1903
- <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>)
1904
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANSACTION_TYPE'</span>] = <span class="ruby-string">'REFUND'</span>
1905
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'RRNO'</span>] = <span class="ruby-identifier">trans_id</span>
1906
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT'</span>] = <span class="ruby-identifier">amount</span>
1907
- <span class="ruby-keyword">end</span></pre>
1908
- </div>
1909
-
1910
- </div>
1911
-
1912
-
1913
-
1914
-
1915
- </div>
1916
-
1917
-
1918
- <div id="method-i-sale" class="method-detail ">
1919
-
1920
- <div class="method-heading">
1921
- <span class="method-name">sale</span><span
1922
- class="method-args">(amount, trans_id='')</span>
1923
-
1924
- <span class="method-click-advice">click to toggle source</span>
1925
-
1926
- </div>
1927
-
1928
-
1929
- <div class="method-description">
1930
-
1931
- <p>Set up a sale</p>
1932
-
1933
-
1934
-
1935
-
1936
- <div class="method-source-code" id="sale-source">
1937
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 47</span>
1938
- <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>)
1939
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANSACTION_TYPE'</span>] = <span class="ruby-string">'SALE'</span>
1940
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT'</span>] = <span class="ruby-identifier">amount</span>
1941
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'RRNO'</span>] = <span class="ruby-identifier">trans_id</span>
1942
- <span class="ruby-keyword">end</span></pre>
1943
- </div>
1944
-
1945
- </div>
1946
-
1947
-
1948
-
1949
-
1950
- </div>
1951
-
1952
-
1953
- <div id="method-i-set_ach_information" class="method-detail ">
1954
-
1955
- <div class="method-heading">
1956
- <span class="method-name">set_ach_information</span><span
1957
- class="method-args">(routing, account, acc_type, doc_type='')</span>
1958
-
1959
- <span class="method-click-advice">click to toggle source</span>
1960
-
1961
- </div>
1962
-
1963
-
1964
- <div class="method-description">
1965
-
1966
- <p>Set up an ACH transaction. Expects: acc_type: C for Checking, S for
1967
- Savings routing: Bank routing number account: Customer’s checking or
1968
- savings account number doc_type: WEB, TEL, ARC, etc – see docs.
1969
- Optional. REMEMBER: Ach requires some other fields, such as address and
1970
- phone</p>
1971
-
1972
-
1973
-
1974
-
1975
- <div class="method-source-code" id="set_ach_information-source">
1976
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 38</span>
1977
- <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>)
1978
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'PAYMENT_TYPE'</span>] = <span class="ruby-string">'ACH'</span>
1979
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ACH_ROUTING'</span>] = <span class="ruby-identifier">routing</span>
1980
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ACH_ACCOUNT'</span>] = <span class="ruby-identifier">account</span>
1981
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ACH_ACCOUNT_TYPE'</span>] = <span class="ruby-identifier">acc_type</span>
1982
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'DOC_TYPE'</span>] = <span class="ruby-identifier">doc_type</span>
1983
- <span class="ruby-keyword">end</span></pre>
1984
- </div>
1985
-
1986
- </div>
1987
-
1988
-
1989
-
1990
-
1991
- </div>
1992
-
1993
-
1994
- <div id="method-i-set_amount_food" class="method-detail ">
1995
-
1996
- <div class="method-heading">
1997
- <span class="method-name">set_amount_food</span><span
1998
- class="method-args">(amount_food)</span>
1999
-
2000
- <span class="method-click-advice">click to toggle source</span>
2001
-
2002
- </div>
2003
-
2004
-
2005
- <div class="method-description">
2006
-
2007
- <p>Set AMOUNT_FOOD field</p>
2008
-
2009
-
2010
-
2011
-
2012
- <div class="method-source-code" id="set_amount_food-source">
2013
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 146</span>
2014
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">set_amount_food</span>(<span class="ruby-identifier">amount_food</span>)
2015
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT_FOOD'</span>] = <span class="ruby-identifier">amount_food</span>
2016
- <span class="ruby-keyword">end</span></pre>
2017
- </div>
2018
-
2019
- </div>
2020
-
2021
-
2022
-
2023
-
2024
- </div>
2025
-
2026
-
2027
- <div id="method-i-set_amount_misc" class="method-detail ">
2028
-
2029
- <div class="method-heading">
2030
- <span class="method-name">set_amount_misc</span><span
2031
- class="method-args">(amount_misc)</span>
2032
-
2033
- <span class="method-click-advice">click to toggle source</span>
2034
-
2035
- </div>
2036
-
2037
-
2038
- <div class="method-description">
2039
-
2040
- <p>Set AMOUNT_MISC field</p>
2041
-
2042
-
2043
-
2044
-
2045
- <div class="method-source-code" id="set_amount_misc-source">
2046
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 151</span>
2047
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">set_amount_misc</span>(<span class="ruby-identifier">amount_misc</span>)
2048
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT_MISC'</span>] = <span class="ruby-identifier">amount_misc</span>
2049
- <span class="ruby-keyword">end</span></pre>
2050
- </div>
2051
-
2052
- </div>
2053
-
2054
-
2055
-
2056
-
2057
- </div>
2058
-
2059
-
2060
- <div id="method-i-set_amount_tax" class="method-detail ">
2061
-
2062
- <div class="method-heading">
2063
- <span class="method-name">set_amount_tax</span><span
2064
- class="method-args">(amount_tax)</span>
2065
-
2066
- <span class="method-click-advice">click to toggle source</span>
2067
-
2068
- </div>
2069
-
2070
-
2071
- <div class="method-description">
2072
-
2073
- <p>Set AMOUNT_TAX field</p>
2074
-
2075
-
2076
-
2077
-
2078
- <div class="method-source-code" id="set_amount_tax-source">
2079
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 141</span>
2080
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">set_amount_tax</span>(<span class="ruby-identifier">amount_tax</span>)
2081
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT_TAX'</span>] = <span class="ruby-identifier">amount_tax</span>
2082
- <span class="ruby-keyword">end</span></pre>
2083
- </div>
2084
-
2085
- </div>
2086
-
2087
-
2088
-
2089
-
2090
- </div>
2091
-
2092
-
2093
- <div id="method-i-set_amount_tip" class="method-detail ">
2094
-
2095
- <div class="method-heading">
2096
- <span class="method-name">set_amount_tip</span><span
2097
- class="method-args">(amount_tip)</span>
2098
-
2099
- <span class="method-click-advice">click to toggle source</span>
2100
-
2101
- </div>
2102
-
2103
-
2104
- <div class="method-description">
2105
-
2106
- <p>Set AMOUNT_TIP field</p>
2107
-
2108
-
2109
-
2110
-
2111
- <div class="method-source-code" id="set_amount_tip-source">
2112
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 136</span>
2113
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">set_amount_tip</span>(<span class="ruby-identifier">amount_tip</span>)
2114
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT_TIP'</span>] = <span class="ruby-identifier">amount_tip</span>
2115
- <span class="ruby-keyword">end</span></pre>
2116
- </div>
2117
-
2118
- </div>
2119
-
2120
-
2121
-
2122
-
2123
- </div>
2124
-
2125
-
2126
- <div id="method-i-set_cc_information" class="method-detail ">
2127
-
2128
- <div class="method-heading">
2129
- <span class="method-name">set_cc_information</span><span
2130
- class="method-args">(account, expire, cvv='')</span>
2131
-
2132
- <span class="method-click-advice">click to toggle source</span>
2133
-
2134
- </div>
2135
-
2136
-
2137
- <div class="method-description">
2138
-
2139
- <p>Set up a credit card payment.</p>
2140
-
2141
-
2142
-
2143
-
2144
- <div class="method-source-code" id="set_cc_information-source">
2145
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 24</span>
2146
- <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>)
2147
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'PAYMENT_TYPE'</span>] = <span class="ruby-string">'CREDIT'</span>
2148
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'CC_NUM'</span>] = <span class="ruby-identifier">account</span>
2149
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'CC_EXPIRES'</span>] = <span class="ruby-identifier">expire</span>
2150
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'CVCVV2'</span>] = <span class="ruby-identifier">cvv</span>
2151
- <span class="ruby-keyword">end</span></pre>
2152
- </div>
2153
-
2154
- </div>
2155
-
2156
-
2157
-
2158
-
2159
- </div>
2160
-
2161
-
2162
- <div id="method-i-set_custom_id1" class="method-detail ">
2163
-
2164
- <div class="method-heading">
2165
- <span class="method-name">set_custom_id1</span><span
2166
- class="method-args">(custom_id1)</span>
2167
-
2168
- <span class="method-click-advice">click to toggle source</span>
2169
-
2170
- </div>
2171
-
2172
-
2173
- <div class="method-description">
2174
-
2175
- <p>Set CUSTOM_ID field</p>
2176
-
2177
-
2178
-
2179
-
2180
- <div class="method-source-code" id="set_custom_id1-source">
2181
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 116</span>
2182
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">set_custom_id1</span>(<span class="ruby-identifier">custom_id1</span>)
2183
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'CUSTOM_ID'</span>] = <span class="ruby-identifier">custom_id1</span>
2184
- <span class="ruby-keyword">end</span></pre>
2185
- </div>
2186
-
2187
- </div>
2188
-
2189
-
2190
-
2191
-
2192
- </div>
2193
-
2194
-
2195
- <div id="method-i-set_custom_id2" class="method-detail ">
2196
-
2197
- <div class="method-heading">
2198
- <span class="method-name">set_custom_id2</span><span
2199
- class="method-args">(custom_id2)</span>
2200
-
2201
- <span class="method-click-advice">click to toggle source</span>
2202
-
2203
- </div>
2204
-
2205
-
2206
- <div class="method-description">
2207
-
2208
- <p>Set CUSTOM_ID2 field</p>
2209
-
2210
-
2211
-
2212
-
2213
- <div class="method-source-code" id="set_custom_id2-source">
2214
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 121</span>
2215
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">set_custom_id2</span>(<span class="ruby-identifier">custom_id2</span>)
2216
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'CUSTOM_ID2'</span>] = <span class="ruby-identifier">custom_id2</span>
2217
- <span class="ruby-keyword">end</span></pre>
2218
- </div>
2219
-
2220
- </div>
2221
-
2222
-
2223
-
2224
-
2225
- </div>
2226
-
2227
-
2228
- <div id="method-i-set_customer_information" class="method-detail ">
2229
-
2230
- <div class="method-heading">
2231
- <span class="method-name">set_customer_information</span><span
2232
- class="method-args">(name1, name2, addr1, city, state, zip, addr2='', country='')</span>
2233
-
2234
- <span class="method-click-advice">click to toggle source</span>
2235
-
2236
- </div>
2237
-
2238
-
2239
- <div class="method-description">
2240
-
2241
- <p>Sets customer information for the transaction</p>
2242
-
2243
-
2244
-
2245
-
2246
- <div class="method-source-code" id="set_customer_information-source">
2247
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 89</span>
2248
- <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>)
2249
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'NAME1'</span>] = <span class="ruby-identifier">name1</span>
2250
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'NAME2'</span>] = <span class="ruby-identifier">name2</span>
2251
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ADDR1'</span>] = <span class="ruby-identifier">addr1</span>
2252
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'CITY'</span>] = <span class="ruby-identifier">city</span>
2253
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'STATE'</span>] = <span class="ruby-identifier">state</span>
2254
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ZIPCODE'</span>] = <span class="ruby-identifier">zip</span>
2255
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ADDR2'</span>] = <span class="ruby-identifier">addr2</span>
2256
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'COUNTRY'</span>] = <span class="ruby-identifier">country</span>
2257
- <span class="ruby-keyword">end</span></pre>
2258
- </div>
2259
-
2260
- </div>
2261
-
2262
-
2263
-
2264
-
2265
- </div>
2266
-
2267
-
2268
- <div id="method-i-set_email" class="method-detail ">
2269
-
2270
- <div class="method-heading">
2271
- <span class="method-name">set_email</span><span
2272
- class="method-args">(email)</span>
2273
-
2274
- <span class="method-click-advice">click to toggle source</span>
2275
-
2276
- </div>
2277
-
2278
-
2279
- <div class="method-description">
2280
-
2281
- <p>Set customer E-mail address</p>
2282
-
2283
-
2284
-
2285
-
2286
- <div class="method-source-code" id="set_email-source">
2287
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 106</span>
2288
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">set_email</span>(<span class="ruby-identifier">email</span>)
2289
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'EMAIL'</span>] = <span class="ruby-identifier">email</span>
2290
- <span class="ruby-keyword">end</span></pre>
2291
- </div>
2292
-
2293
- </div>
2294
-
2295
-
2296
-
2297
-
2298
- </div>
2299
-
2300
-
2301
- <div id="method-i-set_invoice_id" class="method-detail ">
2302
-
2303
- <div class="method-heading">
2304
- <span class="method-name">set_invoice_id</span><span
2305
- class="method-args">(invoice_id)</span>
2306
-
2307
- <span class="method-click-advice">click to toggle source</span>
2308
-
2309
- </div>
2310
-
2311
-
2312
- <div class="method-description">
2313
-
2314
- <p>Set INVOICE_ID field</p>
2315
-
2316
-
2317
-
2318
-
2319
- <div class="method-source-code" id="set_invoice_id-source">
2320
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 126</span>
2321
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">set_invoice_id</span>(<span class="ruby-identifier">invoice_id</span>)
2322
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'INVOICE_ID'</span>] = <span class="ruby-identifier">invoice_id</span>
2323
- <span class="ruby-keyword">end</span></pre>
2324
- </div>
2325
-
2326
- </div>
2327
-
2328
-
2329
-
2330
-
2331
- </div>
2332
-
2333
-
2334
- <div id="method-i-set_memo" class="method-detail ">
2335
-
2336
- <div class="method-heading">
2337
- <span class="method-name">set_memo</span><span
2338
- class="method-args">(memo)</span>
2339
-
2340
- <span class="method-click-advice">click to toggle source</span>
2341
-
2342
- </div>
2343
-
2344
-
2345
- <div class="method-description">
2346
-
2347
- <p>Set MEMO field</p>
2348
-
2349
-
2350
-
2351
-
2352
- <div class="method-source-code" id="set_memo-source">
2353
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 111</span>
2354
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">set_memo</span>(<span class="ruby-identifier">memo</span>)
2355
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'COMMENT'</span>] = <span class="ruby-identifier">memo</span>
2356
- <span class="ruby-keyword">end</span></pre>
2357
- </div>
2358
-
2359
- </div>
2360
-
2361
-
2362
-
2363
-
2364
- </div>
2365
-
2366
-
2367
- <div id="method-i-set_order_id" class="method-detail ">
2368
-
2369
- <div class="method-heading">
2370
- <span class="method-name">set_order_id</span><span
2371
- class="method-args">(order_id)</span>
2372
-
2373
- <span class="method-click-advice">click to toggle source</span>
2374
-
2375
- </div>
2376
-
2377
-
2378
- <div class="method-description">
2379
-
2380
- <p>Set ORDER_ID field</p>
2381
-
2382
-
2383
-
2384
-
2385
- <div class="method-source-code" id="set_order_id-source">
2386
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 131</span>
2387
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">set_order_id</span>(<span class="ruby-identifier">order_id</span>)
2388
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'ORDER_ID'</span>] = <span class="ruby-identifier">order_id</span>
2389
- <span class="ruby-keyword">end</span></pre>
2390
- </div>
2391
-
2392
- </div>
2393
-
2394
-
2395
-
2396
-
2397
- </div>
2398
-
2399
-
2400
- <div id="method-i-set_param" class="method-detail ">
2401
-
2402
- <div class="method-heading">
2403
- <span class="method-name">set_param</span><span
2404
- class="method-args">(key, val)</span>
2405
-
2406
- <span class="method-click-advice">click to toggle source</span>
2407
-
2408
- </div>
2409
-
2410
-
2411
- <div class="method-description">
2412
-
2413
-
2414
-
2415
-
2416
-
2417
-
2418
- <div class="method-source-code" id="set_param-source">
2419
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 19</span>
2420
- <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>)
2421
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">val</span>
2422
- <span class="ruby-keyword">end</span></pre>
2423
- </div>
2424
-
2425
- </div>
2426
-
2427
-
2428
-
2429
-
2430
- </div>
2431
-
2432
-
2433
- <div id="method-i-set_phone" class="method-detail ">
2434
-
2435
- <div class="method-heading">
2436
- <span class="method-name">set_phone</span><span
2437
- class="method-args">(phone)</span>
2438
-
2439
- <span class="method-click-advice">click to toggle source</span>
2440
-
2441
- </div>
2442
-
2443
-
2444
- <div class="method-description">
2445
-
2446
- <p>Set customer phone #</p>
2447
-
2448
-
2449
-
2450
-
2451
- <div class="method-source-code" id="set_phone-source">
2452
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 101</span>
2453
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">set_phone</span>(<span class="ruby-identifier">phone</span>)
2454
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'PHONE'</span>] = <span class="ruby-identifier">phone</span>
2455
- <span class="ruby-keyword">end</span></pre>
2456
- </div>
2457
-
2458
- </div>
2459
-
2460
-
2461
-
2462
-
2463
- </div>
2464
-
2465
-
2466
- <div id="method-i-update_rebilling_cycle" class="method-detail ">
2467
-
2468
- <div class="method-heading">
2469
- <span class="method-name">update_rebilling_cycle</span><span
2470
- class="method-args">(rebill_id, rebill_next_date, rebill_expr, rebill_cycles, rebill_amount, rebill_next_amount)</span>
2471
-
2472
- <span class="method-click-advice">click to toggle source</span>
2473
-
2474
- </div>
2475
-
2476
-
2477
- <div class="method-description">
2478
-
2479
- <p>Set fields to do an update on an existing rebilling cycle</p>
2480
-
2481
-
2482
-
2483
-
2484
- <div class="method-source-code" id="update_rebilling_cycle-source">
2485
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 165</span>
2486
- <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>,
2487
- <span class="ruby-identifier">rebill_next_amount</span>)
2488
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANS_TYPE'</span>] = <span class="ruby-string">&quot;SET&quot;</span>
2489
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REBILL_ID'</span>] = <span class="ruby-identifier">rebill_id</span>
2490
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'NEXT_DATE'</span>] = <span class="ruby-identifier">rebill_next_date</span>
2491
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_EXPR'</span>] = <span class="ruby-identifier">rebill_expr</span>
2492
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_CYCLES'</span>] = <span class="ruby-identifier">rebill_cycles</span>
2493
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'REB_AMOUNT'</span>] = <span class="ruby-identifier">rebill_amount</span>
2494
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'NEXT_AMOUNT'</span>] = <span class="ruby-identifier">rebill_next_amount</span>
2495
- <span class="ruby-keyword">end</span></pre>
2496
- </div>
2497
-
2498
- </div>
2499
-
2500
-
2501
-
2502
-
2503
- </div>
2504
-
2505
-
2506
- <div id="method-i-update_rebilling_payment_information" class="method-detail ">
2507
-
2508
- <div class="method-heading">
2509
- <span class="method-name">update_rebilling_payment_information</span><span
2510
- class="method-args">(template_id)</span>
2511
-
2512
- <span class="method-click-advice">click to toggle source</span>
2513
-
2514
- </div>
2515
-
2516
-
2517
- <div class="method-description">
2518
-
2519
- <p>Updates an existing rebilling cycle’s payment information.</p>
2520
-
2521
-
2522
-
2523
-
2524
- <div class="method-source-code" id="update_rebilling_payment_information-source">
2525
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 190</span>
2526
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">update_rebilling_payment_information</span>(<span class="ruby-identifier">template_id</span>)
2527
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">&quot;TEMPLATE_ID&quot;</span>] = <span class="ruby-identifier">template_id</span>
2528
- <span class="ruby-keyword">end</span></pre>
2529
- </div>
2530
-
2531
- </div>
2532
-
2533
-
2534
-
2535
-
2536
- </div>
2537
-
2538
-
2539
- <div id="method-i-uri_query" class="method-detail ">
2540
-
2541
- <div class="method-heading">
2542
- <span class="method-name">uri_query</span><span
2543
- class="method-args">(h)</span>
2544
-
2545
- <span class="method-click-advice">click to toggle source</span>
2546
-
2547
- </div>
2548
-
2549
-
2550
- <div class="method-description">
2551
-
2552
- <p>Turns a hash into a nvp style string</p>
2553
-
2554
-
2555
-
2556
-
2557
- <div class="method-source-code" id="uri_query-source">
2558
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 252</span>
2559
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">uri_query</span>(<span class="ruby-identifier">h</span>)
2560
- <span class="ruby-identifier">a</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>()
2561
- <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>)) }
2562
- <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>)
2563
- <span class="ruby-keyword">end</span></pre>
2564
- </div>
2565
-
2566
- </div>
2567
-
2568
-
2569
-
2570
-
2571
- </div>
2572
-
2573
-
2574
- <div id="method-i-void" class="method-detail ">
2575
-
2576
- <div class="method-heading">
2577
- <span class="method-name">void</span><span
2578
- class="method-args">(trans_id)</span>
2579
-
2580
- <span class="method-click-advice">click to toggle source</span>
2581
-
2582
- </div>
2583
-
2584
-
2585
- <div class="method-description">
2586
-
2587
- <p>Void</p>
2588
-
2589
-
2590
-
2591
-
2592
- <div class="method-source-code" id="void-source">
2593
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 82</span>
2594
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">void</span>(<span class="ruby-identifier">trans_id</span>)
2595
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'TRANSACTION_TYPE'</span>] = <span class="ruby-string">'VOID'</span>
2596
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'AMOUNT'</span>] = <span class="ruby-string">''</span>
2597
- <span class="ruby-ivar">@PARAM_HASH</span>[<span class="ruby-string">'RRNO'</span>] = <span class="ruby-identifier">trans_id</span>
2598
- <span class="ruby-keyword">end</span></pre>
2599
- </div>
2600
-
2601
- </div>
2602
-
2603
-
2604
-
2605
-
2606
- </div>
2607
-
2608
-
2609
- </section>
2610
-
2611
- <section id="public-class-5Buntitled-5D-method-details" class="method-section">
2612
- <header>
2613
- <h3>Public Class Methods</h3>
2614
- </header>
2615
-
2616
-
2617
- <div id="method-c-calc_trans_notify_tps" class="method-detail ">
2618
-
2619
- <div class="method-heading">
2620
- <span class="method-name">calc_trans_notify_tps</span><span
2621
- 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>
2622
-
2623
- <span class="method-click-advice">click to toggle source</span>
2624
-
2625
- </div>
2626
-
2627
-
2628
- <div class="method-description">
2629
-
2630
- <p>Calculates TAMPER_PROOF_SEAL to be used with Trans Notify API</p>
2631
-
2632
-
2633
-
2634
-
2635
- <div class="method-source-code" id="calc_trans_notify_tps-source">
2636
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 279</span>
2637
- <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>,
2638
- <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>)
2639
- <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>
2640
- <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>)
2641
- <span class="ruby-keyword">end</span></pre>
2642
- </div>
2643
-
2644
- </div>
2645
-
2646
-
2647
-
2648
-
2649
- </div>
2650
-
2651
-
2652
- <div id="method-c-new" class="method-detail ">
2653
-
2654
- <div class="method-heading">
2655
- <span class="method-name">new</span><span
2656
- class="method-args">(account,key,mode='TEST')</span>
2657
-
2658
- <span class="method-click-advice">click to toggle source</span>
2659
-
2660
- </div>
2661
-
2662
-
2663
- <div class="method-description">
2664
-
2665
-
2666
-
2667
-
2668
-
2669
-
2670
- <div class="method-source-code" id="new-source">
2671
- <pre><span class="ruby-comment"># File lib/bluepay.rb, line 12</span>
2672
- <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>)
2673
- <span class="ruby-ivar">@ACCOUNT_ID</span> = <span class="ruby-identifier">account</span>
2674
- <span class="ruby-ivar">@SECRET_KEY</span> = <span class="ruby-identifier">key</span>
2675
- <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> }
2676
- <span class="ruby-ivar">@RETURN_HASH</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>()
2677
- <span class="ruby-keyword">end</span></pre>
2678
- </div>
2679
-
2680
- </div>
2681
-
2682
-
2683
-
2684
-
2685
- </div>
2686
-
2687
-
2688
- </section>
2689
-
2690
- </section>
2691
- </main>
2692
-
2693
-
2694
- <footer id="validator-badges" role="contentinfo">
2695
- <p><a href="http://validator.w3.org/check/referer">Validate</a>
2696
- <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.1.
2697
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
2698
- </footer>
2699
-