Class: EwayRapid::Models::Transaction
- Inherits:
-
Object
- Object
- EwayRapid::Models::Transaction
- Defined in:
- lib/eway_rapid/models/models.rb
Overview
The details of a transaction that will be processed either via the responsive shared page, by transparent redirect, by Direct, or one that is captured from a previous Authorisation transaction
Instance Attribute Summary collapse
-
#auth_transaction_id ⇒ Object
The Transaction ID of an authorisation to capture.
-
#cancel_url ⇒ Object
The URL that the shared page redirects to if a customer cancels the transaction (responsive shared page only).
-
#capture ⇒ Object
Set to true to capture funds immediately, false to authorise only.
-
#checkout_payment ⇒ Object
(also: #checkout_payment?)
Setting this to
true
will process a PayPal Checkout payment. -
#checkout_url ⇒ Object
The URL that the customer is to be returned to after logging in to their PayPal account.
-
#custom_view ⇒ Object
Set the theme of the Responsive Shared Page from 12 available themes.
-
#customer ⇒ Object
Customer details for the transaction.
-
#customer_read_only ⇒ Object
(also: #customer_read_only?)
When set to false, cardholders will be able to edit the information on the Responsive Shared Page.
-
#device_id ⇒ Object
The identification name/number for the device or application processing the transaction.
-
#header_text ⇒ Object
Short text description to be placed under the logo on the Responsive Shared Page.
-
#language ⇒ Object
Language code determines the language that the shared page will be displayed in.
-
#line_items ⇒ Object
Array of line items for the transaction.
-
#logo_url ⇒ Object
The URL of the merchant’s logo to display on the Responsive Shared Page.
-
#options ⇒ Object
Array of options to pass to eWAY.
-
#partner_id ⇒ Object
The partner ID generated from an eWAY partner agreement.
-
#payment_details ⇒ Object
Payment details for the transaction.
-
#redirect_url ⇒ Object
The URL that the shared page redirects to after a payment is processed (transparent redirect & responsive shared page only).
-
#secured_card_data ⇒ Object
Card data ID, used for Secure Fields, Visa Checkout, AMEX Express Checkout and Android Pay.
-
#shipping_details ⇒ Object
Shipping details fo the transaction.
-
#third_party_wallet_id ⇒ Object
Deprecated, use secured_card_data.
-
#transaction_type ⇒ Object
The type of transaction being performed - use Enums::TransactionType.
-
#verify_customer_email ⇒ Object
(also: #verify_customer_email?)
Set whether the customer’s email should be confirmed using Beagle Verify.
-
#verify_customer_phone ⇒ Object
(also: #verify_customer_phone?)
Set whether the customer’s phone number should be confirmed using Beagle Verify.
Instance Method Summary collapse
-
#initialize ⇒ Transaction
constructor
A new instance of Transaction.
Constructor Details
#initialize ⇒ Transaction
Returns a new instance of Transaction.
298 299 300 |
# File 'lib/eway_rapid/models/models.rb', line 298 def initialize @capture = true end |
Instance Attribute Details
#auth_transaction_id ⇒ Object
The Transaction ID of an authorisation to capture
254 255 256 |
# File 'lib/eway_rapid/models/models.rb', line 254 def auth_transaction_id @auth_transaction_id end |
#cancel_url ⇒ Object
The URL that the shared page redirects to if a customer cancels the transaction (responsive shared page only)
262 263 264 |
# File 'lib/eway_rapid/models/models.rb', line 262 def cancel_url @cancel_url end |
#capture ⇒ Object
Set to true to capture funds immediately, false to authorise only
224 225 226 |
# File 'lib/eway_rapid/models/models.rb', line 224 def capture @capture end |
#checkout_payment ⇒ Object Also known as: checkout_payment?
Setting this to true
will process a PayPal Checkout payment.
265 266 267 |
# File 'lib/eway_rapid/models/models.rb', line 265 def checkout_payment @checkout_payment end |
#checkout_url ⇒ Object
The URL that the customer is to be returned to after logging in to their PayPal account. (transparent redirect & responsive shared page with PayPal Checkout only)
269 270 271 |
# File 'lib/eway_rapid/models/models.rb', line 269 def checkout_url @checkout_url end |
#custom_view ⇒ Object
Set the theme of the Responsive Shared Page from 12 available themes
272 273 274 |
# File 'lib/eway_rapid/models/models.rb', line 272 def custom_view @custom_view end |
#customer ⇒ Object
Customer details for the transaction
227 228 229 |
# File 'lib/eway_rapid/models/models.rb', line 227 def customer @customer end |
#customer_read_only ⇒ Object Also known as: customer_read_only?
When set to false, cardholders will be able to edit the information on the Responsive Shared Page
282 283 284 |
# File 'lib/eway_rapid/models/models.rb', line 282 def customer_read_only @customer_read_only end |
#device_id ⇒ Object
The identification name/number for the device or application processing the transaction
242 243 244 |
# File 'lib/eway_rapid/models/models.rb', line 242 def device_id @device_id end |
#header_text ⇒ Object
Short text description to be placed under the logo on the Responsive Shared Page
275 276 277 |
# File 'lib/eway_rapid/models/models.rb', line 275 def header_text @header_text end |
#language ⇒ Object
Language code determines the language that the shared page will be displayed in. One of: EN (English, default), ES (Spanish)
279 280 281 |
# File 'lib/eway_rapid/models/models.rb', line 279 def language @language end |
#line_items ⇒ Object
Array of line items for the transaction
236 237 238 |
# File 'lib/eway_rapid/models/models.rb', line 236 def line_items @line_items end |
#logo_url ⇒ Object
The URL of the merchant’s logo to display on the Responsive Shared Page
291 292 293 |
# File 'lib/eway_rapid/models/models.rb', line 291 def logo_url @logo_url end |
#options ⇒ Object
Array of options to pass to eWAY
239 240 241 |
# File 'lib/eway_rapid/models/models.rb', line 239 def @options end |
#partner_id ⇒ Object
The partner ID generated from an eWAY partner agreement
245 246 247 |
# File 'lib/eway_rapid/models/models.rb', line 245 def partner_id @partner_id end |
#payment_details ⇒ Object
Payment details for the transaction
233 234 235 |
# File 'lib/eway_rapid/models/models.rb', line 233 def payment_details @payment_details end |
#redirect_url ⇒ Object
The URL that the shared page redirects to after a payment is processed (transparent redirect & responsive shared page only)
258 259 260 |
# File 'lib/eway_rapid/models/models.rb', line 258 def redirect_url @redirect_url end |
#secured_card_data ⇒ Object
Card data ID, used for Secure Fields, Visa Checkout, AMEX Express Checkout and Android Pay
251 252 253 |
# File 'lib/eway_rapid/models/models.rb', line 251 def secured_card_data @secured_card_data end |
#shipping_details ⇒ Object
Shipping details fo the transaction
230 231 232 |
# File 'lib/eway_rapid/models/models.rb', line 230 def shipping_details @shipping_details end |
#third_party_wallet_id ⇒ Object
Deprecated, use secured_card_data
248 249 250 |
# File 'lib/eway_rapid/models/models.rb', line 248 def third_party_wallet_id @third_party_wallet_id end |
#transaction_type ⇒ Object
The type of transaction being performed - use Enums::TransactionType
221 222 223 |
# File 'lib/eway_rapid/models/models.rb', line 221 def transaction_type @transaction_type end |
#verify_customer_email ⇒ Object Also known as: verify_customer_email?
Set whether the customer’s email should be confirmed using Beagle Verify
288 289 290 |
# File 'lib/eway_rapid/models/models.rb', line 288 def verify_customer_email @verify_customer_email end |
#verify_customer_phone ⇒ Object Also known as: verify_customer_phone?
Set whether the customer’s phone number should be confirmed using Beagle Verify
285 286 287 |
# File 'lib/eway_rapid/models/models.rb', line 285 def verify_customer_phone @verify_customer_phone end |