Class: EwayRapid::Models::Transaction

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Transaction

Returns a new instance of Transaction.



329
330
331
 
# File 'lib/eway_rapid/models/models.rb', line 329

def initialize
  @capture = true
end

Instance Attribute Details

#amex_ec_data ⇒ Object

(v40+ only) A token used to configure AMEX Express Checkout



295
296
297
 
# File 'lib/eway_rapid/models/models.rb', line 295

def amex_ec_data
  @amex_ec_data
end

#auth_transaction_id ⇒ Object

The Transaction ID of an authorisation to capture



255
256
257
 
# File 'lib/eway_rapid/models/models.rb', line 255

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)



263
264
265
 
# File 'lib/eway_rapid/models/models.rb', line 263

def cancel_url
  @cancel_url
end

#capture ⇒ Object

Set to true to capture funds immediately, false to authorise only



225
226
227
 
# File 'lib/eway_rapid/models/models.rb', line 225

def capture
  @capture
end

#checkout_payment ⇒ Object Also known as: checkout_payment?

Setting this to true will process a PayPal Checkout payment.



266
267
268
 
# File 'lib/eway_rapid/models/models.rb', line 266

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)



270
271
272
 
# File 'lib/eway_rapid/models/models.rb', line 270

def checkout_url
  @checkout_url
end

#currency_code ⇒ Object

(v40+ query response only) The ISO 4217 numeric currency code (e.g. AUD = 036)



316
317
318
 
# File 'lib/eway_rapid/models/models.rb', line 316

def currency_code
  @currency_code
end

#custom_view ⇒ Object

Set the theme of the Responsive Shared Page from 12 available themes



273
274
275
 
# File 'lib/eway_rapid/models/models.rb', line 273

def custom_view
  @custom_view
end

#customer ⇒ Object

Customer details for the transaction



228
229
230
 
# File 'lib/eway_rapid/models/models.rb', line 228

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



283
284
285
 
# File 'lib/eway_rapid/models/models.rb', line 283

def customer_read_only
  @customer_read_only
end

#device_id ⇒ Object

The identification name/number for the device or application processing the transaction



243
244
245
 
# File 'lib/eway_rapid/models/models.rb', line 243

def device_id
  @device_id
end

#fraud_action ⇒ Object

(v40+ query response only) The fraud action that occurred if any. One of NotChallenged, Allow, Review, PreAuth, Processed, Approved, Block



313
314
315
 
# File 'lib/eway_rapid/models/models.rb', line 313

def fraud_action
  @fraud_action
end

#header_text ⇒ Object

Short text description to be placed under the logo on the Responsive Shared Page



276
277
278
 
# File 'lib/eway_rapid/models/models.rb', line 276

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)



280
281
282
 
# File 'lib/eway_rapid/models/models.rb', line 280

def language
  @language
end

#line_items ⇒ Object

Array of line items for the transaction



237
238
239
 
# File 'lib/eway_rapid/models/models.rb', line 237

def line_items
  @line_items
end

#logo_url ⇒ Object

The URL of the merchant's logo to display on the Responsive Shared Page



292
293
294
 
# File 'lib/eway_rapid/models/models.rb', line 292

def logo_url
  @logo_url
end

#max_refund ⇒ Object

(v40+ query response only) The maximum amount that could be refunded from this transaction



307
308
309
 
# File 'lib/eway_rapid/models/models.rb', line 307

def max_refund
  @max_refund
end

#options ⇒ Object

Array of options to pass to eWAY



240
241
242
 
# File 'lib/eway_rapid/models/models.rb', line 240

def options
  @options
end

#original_transaction_id ⇒ Object

(v40+ query response only) Contains the original transaction ID if the queried transaction is a refund



310
311
312
 
# File 'lib/eway_rapid/models/models.rb', line 310

def original_transaction_id
  @original_transaction_id
end

#partner_id ⇒ Object

The partner ID generated from an eWAY partner agreement



246
247
248
 
# File 'lib/eway_rapid/models/models.rb', line 246

def partner_id
  @partner_id
end

#payment_details ⇒ Object

Payment details for the transaction



234
235
236
 
# File 'lib/eway_rapid/models/models.rb', line 234

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)



259
260
261
 
# File 'lib/eway_rapid/models/models.rb', line 259

def redirect_url
  @redirect_url
end

#save_customer ⇒ Object

Set to true to create a token customer when the transaction is complete



319
320
321
 
# File 'lib/eway_rapid/models/models.rb', line 319

def save_customer
  @save_customer
end

#secured_card_data ⇒ Object

Card data ID, used for Secure Fields, Visa Checkout, AMEX Express Checkout and Android Pay



252
253
254
 
# File 'lib/eway_rapid/models/models.rb', line 252

def secured_card_data
  @secured_card_data
end

#shipping_details ⇒ Object

Shipping details fo the transaction



231
232
233
 
# File 'lib/eway_rapid/models/models.rb', line 231

def shipping_details
  @shipping_details
end

#source ⇒ Object

(v40+ query response only) Reserved for future use



304
305
306
 
# File 'lib/eway_rapid/models/models.rb', line 304

def source
  @source
end

#third_party_wallet_id ⇒ Object

Deprecated, use secured_card_data



249
250
251
 
# File 'lib/eway_rapid/models/models.rb', line 249

def third_party_wallet_id
  @third_party_wallet_id
end

#token_customer_id ⇒ Object

An eWAY-issued ID that represents the Token customer that was loaded or created for this transaction (if applicable)



322
323
324
 
# File 'lib/eway_rapid/models/models.rb', line 322

def token_customer_id
  @token_customer_id
end

#transaction_captured ⇒ Object

(v40+ query response only) True if funds were captured in the transaction



301
302
303
 
# File 'lib/eway_rapid/models/models.rb', line 301

def transaction_captured
  @transaction_captured
end

#transaction_date_time ⇒ Object

(v40+ query response only) The date and time the transaction took place



298
299
300
 
# File 'lib/eway_rapid/models/models.rb', line 298

def transaction_date_time
  @transaction_date_time
end

#transaction_type ⇒ Object

The type of transaction being performed - use Enums::TransactionType



222
223
224
 
# File 'lib/eway_rapid/models/models.rb', line 222

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



289
290
291
 
# File 'lib/eway_rapid/models/models.rb', line 289

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



286
287
288
 
# File 'lib/eway_rapid/models/models.rb', line 286

def verify_customer_phone
  @verify_customer_phone
end