Class: UltracartClient::TransactionGateway

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/transaction_gateway.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionGateway

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 351

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'arbitrary_html')
    self.arbitrary_html = attributes[:'arbitrary_html']
  end

  if attributes.has_key?(:'comment')
    self.comment = attributes[:'comment']
  end

  if attributes.has_key?(:'credit_card_capable')
    self.credit_card_capable = attributes[:'credit_card_capable']
  end

  if attributes.has_key?(:'echeck_capable')
    self.echeck_capable = attributes[:'echeck_capable']
  end

  if attributes.has_key?(:'echeck_supported')
    self.echeck_supported = attributes[:'echeck_supported']
  end

  if attributes.has_key?(:'enabled')
    self.enabled = attributes[:'enabled']
  end

  if attributes.has_key?(:'gateway_cert_pem')
    self.gateway_cert_pem = attributes[:'gateway_cert_pem']
  end

  if attributes.has_key?(:'gateway_cert_pem_label')
    self.gateway_cert_pem_label = attributes[:'gateway_cert_pem_label']
  end

  if attributes.has_key?(:'gateway_email')
    self.gateway_email = attributes[:'gateway_email']
  end

  if attributes.has_key?(:'gateway_email_label')
    self.gateway_email_label = attributes[:'gateway_email_label']
  end

  if attributes.has_key?(:'gateway_environment')
    self.gateway_environment = attributes[:'gateway_environment']
  end

  if attributes.has_key?(:'gateway_environment_label')
    self.gateway_environment_label = attributes[:'gateway_environment_label']
  end

  if attributes.has_key?(:'gateway_environments')
    if (value = attributes[:'gateway_environments']).is_a?(Array)
      self.gateway_environments = value
    end
  end

  if attributes.has_key?(:'gateway_header_back_color')
    self.gateway_header_back_color = attributes[:'gateway_header_back_color']
  end

  if attributes.has_key?(:'gateway_header_border_color')
    self.gateway_header_border_color = attributes[:'gateway_header_border_color']
  end

  if attributes.has_key?(:'gateway_header_image_url')
    self.gateway_header_image_url = attributes[:'gateway_header_image_url']
  end

  if attributes.has_key?(:'gateway_key')
    self.gateway_key = attributes[:'gateway_key']
  end

  if attributes.has_key?(:'gateway_key_label')
    self.gateway_key_label = attributes[:'gateway_key_label']
  end

  if attributes.has_key?(:'gateway_key_pem')
    self.gateway_key_pem = attributes[:'gateway_key_pem']
  end

  if attributes.has_key?(:'gateway_key_pem_label')
    self.gateway_key_pem_label = attributes[:'gateway_key_pem_label']
  end

  if attributes.has_key?(:'gateway_landing_page')
    self.gateway_landing_page = attributes[:'gateway_landing_page']
  end

  if attributes.has_key?(:'gateway_merchant_id')
    self.gateway_merchant_id = attributes[:'gateway_merchant_id']
  end

  if attributes.has_key?(:'gateway_merchant_id_label')
    self.gateway_merchant_id_label = attributes[:'gateway_merchant_id_label']
  end

  if attributes.has_key?(:'gateway_mode')
    self.gateway_mode = attributes[:'gateway_mode']
  end

  if attributes.has_key?(:'gateway_mode_label')
    self.gateway_mode_label = attributes[:'gateway_mode_label']
  end

  if attributes.has_key?(:'gateway_modes')
    if (value = attributes[:'gateway_modes']).is_a?(Array)
      self.gateway_modes = value
    end
  end

  if attributes.has_key?(:'gateway_page_style')
    self.gateway_page_style = attributes[:'gateway_page_style']
  end

  if attributes.has_key?(:'gateway_page_style_label')
    self.gateway_page_style_label = attributes[:'gateway_page_style_label']
  end

  if attributes.has_key?(:'gateway_page_styles')
    if (value = attributes[:'gateway_page_styles']).is_a?(Array)
      self.gateway_page_styles = value
    end
  end

  if attributes.has_key?(:'gateway_partner')
    self.gateway_partner = attributes[:'gateway_partner']
  end

  if attributes.has_key?(:'gateway_partner_label')
    self.gateway_partner_label = attributes[:'gateway_partner_label']
  end

  if attributes.has_key?(:'gateway_password')
    self.gateway_password = attributes[:'gateway_password']
  end

  if attributes.has_key?(:'gateway_password_label')
    self.gateway_password_label = attributes[:'gateway_password_label']
  end

  if attributes.has_key?(:'gateway_payflow_color')
    self.gateway_payflow_color = attributes[:'gateway_payflow_color']
  end

  if attributes.has_key?(:'gateway_private_key_password')
    self.gateway_private_key_password = attributes[:'gateway_private_key_password']
  end

  if attributes.has_key?(:'gateway_private_key_password_label')
    self.gateway_private_key_password_label = attributes[:'gateway_private_key_password_label']
  end

  if attributes.has_key?(:'gateway_solution_type')
    self.gateway_solution_type = attributes[:'gateway_solution_type']
  end

  if attributes.has_key?(:'gateway_solution_type_label')
    self.gateway_solution_type_label = attributes[:'gateway_solution_type_label']
  end

  if attributes.has_key?(:'gateway_solution_types')
    if (value = attributes[:'gateway_solution_types']).is_a?(Array)
      self.gateway_solution_types = value
    end
  end

  if attributes.has_key?(:'gateway_url')
    self.gateway_url = attributes[:'gateway_url']
  end

  if attributes.has_key?(:'gateway_url_label')
    self.gateway_url_label = attributes[:'gateway_url_label']
  end

  if attributes.has_key?(:'gateway_username')
    self.gateway_username = attributes[:'gateway_username']
  end

  if attributes.has_key?(:'gateway_username_label')
    self.gateway_username_label = attributes[:'gateway_username_label']
  end

  if attributes.has_key?(:'merchant_account_profile_amex')
    self. = attributes[:'merchant_account_profile_amex']
  end

  if attributes.has_key?(:'merchant_account_profile_diners_club')
    self. = attributes[:'merchant_account_profile_diners_club']
  end

  if attributes.has_key?(:'merchant_account_profile_discover')
    self. = attributes[:'merchant_account_profile_discover']
  end

  if attributes.has_key?(:'merchant_account_profile_jcb')
    self. = attributes[:'merchant_account_profile_jcb']
  end

  if attributes.has_key?(:'merchant_account_profile_mastercard')
    self. = attributes[:'merchant_account_profile_mastercard']
  end

  if attributes.has_key?(:'merchant_account_profile_visa')
    self. = attributes[:'merchant_account_profile_visa']
  end

  if attributes.has_key?(:'merchant_id')
    self.merchant_id = attributes[:'merchant_id']
  end

  if attributes.has_key?(:'multi_currency_details')
    self.multi_currency_details = attributes[:'multi_currency_details']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'refund_supported')
    self.refund_supported = attributes[:'refund_supported']
  end

  if attributes.has_key?(:'require_echeck_tax_id_or_drivers_license')
    self.require_echeck_tax_id_or_drivers_license = attributes[:'require_echeck_tax_id_or_drivers_license']
  end

  if attributes.has_key?(:'support_vbv_3ds')
    self.support_vbv_3ds = attributes[:'support_vbv_3ds']
  end

  if attributes.has_key?(:'supports_amex')
    self.supports_amex = attributes[:'supports_amex']
  end

  if attributes.has_key?(:'supports_diners_club')
    self.supports_diners_club = attributes[:'supports_diners_club']
  end

  if attributes.has_key?(:'supports_discover')
    self.supports_discover = attributes[:'supports_discover']
  end

  if attributes.has_key?(:'supports_echeck')
    self.supports_echeck = attributes[:'supports_echeck']
  end

  if attributes.has_key?(:'supports_electronic_gift_card')
    self.supports_electronic_gift_card = attributes[:'supports_electronic_gift_card']
  end

  if attributes.has_key?(:'supports_jcb')
    self.supports_jcb = attributes[:'supports_jcb']
  end

  if attributes.has_key?(:'supports_mastercard')
    self.supports_mastercard = attributes[:'supports_mastercard']
  end

  if attributes.has_key?(:'supports_visa')
    self.supports_visa = attributes[:'supports_visa']
  end

  if attributes.has_key?(:'third_party')
    self.third_party = attributes[:'third_party']
  end
end

Instance Attribute Details

#arbitrary_html ⇒ Object

Additional html to display for this transaction gateway. This html will include instructions and connection links



18
19
20
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 18

def arbitrary_html
  @arbitrary_html
end

#comment ⇒ Object

Additional comments



21
22
23
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 21

def comment
  @comment
end

#credit_card_capable ⇒ Object

True if this gateway supports credit cards



24
25
26
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 24

def credit_card_capable
  @credit_card_capable
end

#echeck_capable ⇒ Object

True if this gateway supports eChecks



27
28
29
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 27

def echeck_capable
  @echeck_capable
end

#echeck_supported ⇒ Object

True if this gateway supports eChecks



30
31
32
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 30

def echeck_supported
  @echeck_supported
end

#enabled ⇒ Object

True if this transaction gateway is the currently active gateway.



33
34
35
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 33

def enabled
  @enabled
end

#gateway_cert_pem ⇒ Object

Cryptographic public certificate allowing UltraCart to communicate securely with this gateway.



36
37
38
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 36

def gateway_cert_pem
  @gateway_cert_pem
end

#gateway_cert_pem_label ⇒ Object

The label for the gateway certificate pem. The actual value stored may vary by gateway, so the label will vary too.



39
40
41
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 39

def gateway_cert_pem_label
  @gateway_cert_pem_label
end

#gateway_email ⇒ Object

Gateway Email



42
43
44
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 42

def gateway_email
  @gateway_email
end

#gateway_email_label ⇒ Object

The label for the gateway email. The actual value stored may vary by gateway, so the label will vary too.



45
46
47
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 45

def gateway_email_label
  @gateway_email_label
end

#gateway_environment ⇒ Object

Gateway Environment to indicate sandbox versus production environments



48
49
50
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 48

def gateway_environment
  @gateway_environment
end

#gateway_environment_label ⇒ Object

The label for the gateway environment. The actual value stored may vary by gateway, so the label will vary too.



51
52
53
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 51

def gateway_environment_label
  @gateway_environment_label
end

#gateway_environments ⇒ Object

Used to populate drop down lists for the gateway environment. Varies by gateway.



54
55
56
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 54

def gateway_environments
  @gateway_environments
end

#gateway_header_back_color ⇒ Object

Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS



57
58
59
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 57

def gateway_header_back_color
  @gateway_header_back_color
end

#gateway_header_border_color ⇒ Object

Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS



60
61
62
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 60

def gateway_header_border_color
  @gateway_header_border_color
end

#gateway_header_image_url ⇒ Object

Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS



63
64
65
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 63

def gateway_header_image_url
  @gateway_header_image_url
end

#gateway_key ⇒ Object

Gateway Key



66
67
68
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 66

def gateway_key
  @gateway_key
end

#gateway_key_label ⇒ Object

The label for the gateway key. The actual value stored may vary by gateway, so the label will vary too.



69
70
71
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 69

def gateway_key_label
  @gateway_key_label
end

#gateway_key_pem ⇒ Object

Cryptographic private key allowing UltraCart to communicate securely with this gateway.



72
73
74
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 72

def gateway_key_pem
  @gateway_key_pem
end

#gateway_key_pem_label ⇒ Object

The label for the gateway key pem. The actual value stored may vary by gateway, so the label will vary too.



75
76
77
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 75

def gateway_key_pem_label
  @gateway_key_pem_label
end

#gateway_landing_page ⇒ Object

Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS



78
79
80
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 78

def gateway_landing_page
  @gateway_landing_page
end

#gateway_merchant_id ⇒ Object

Gateway Merchant ID



81
82
83
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 81

def gateway_merchant_id
  @gateway_merchant_id
end

#gateway_merchant_id_label ⇒ Object

The label for the gateway merchant id. The actual value stored may vary by gateway, so the label will vary too.



84
85
86
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 84

def gateway_merchant_id_label
  @gateway_merchant_id_label
end

#gateway_mode ⇒ Object

Gateway Mode



87
88
89
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 87

def gateway_mode
  @gateway_mode
end

#gateway_mode_label ⇒ Object

The label for the gateway mode. The actual value stored may vary by gateway, so the label will vary too.



90
91
92
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 90

def gateway_mode_label
  @gateway_mode_label
end

#gateway_modes ⇒ Object

Used to populate drop down lists for gateway modes



93
94
95
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 93

def gateway_modes
  @gateway_modes
end

#gateway_page_style ⇒ Object

Gateway Page Style



96
97
98
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 96

def gateway_page_style
  @gateway_page_style
end

#gateway_page_style_label ⇒ Object

Gateway page style label



99
100
101
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 99

def gateway_page_style_label
  @gateway_page_style_label
end

#gateway_page_styles ⇒ Object

Used to populate drop down lists for gateway page style



102
103
104
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 102

def gateway_page_styles
  @gateway_page_styles
end

#gateway_partner ⇒ Object

Gateway Partner



105
106
107
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 105

def gateway_partner
  @gateway_partner
end

#gateway_partner_label ⇒ Object

The label for the gateway partner. The actual value stored may vary by gateway, so the label will vary too.



108
109
110
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 108

def gateway_partner_label
  @gateway_partner_label
end

#gateway_password ⇒ Object

Gateway Password



111
112
113
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 111

def gateway_password
  @gateway_password
end

#gateway_password_label ⇒ Object

The label for the gateway password. The actual value stored may vary by gateway, so the label will vary too.



114
115
116
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 114

def gateway_password_label
  @gateway_password_label
end

#gateway_payflow_color ⇒ Object

Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS



117
118
119
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 117

def gateway_payflow_color
  @gateway_payflow_color
end

#gateway_private_key_password ⇒ Object

Gateway private key password



120
121
122
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 120

def gateway_private_key_password
  @gateway_private_key_password
end

#gateway_private_key_password_label ⇒ Object

The label for the gateway private key password. The actual value stored may vary by gateway, so the label will vary too.



123
124
125
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 123

def gateway_private_key_password_label
  @gateway_private_key_password_label
end

#gateway_solution_type ⇒ Object

Optional Look and feel setting for Verified-by-VISA. Only needed if you are using 3DS



126
127
128
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 126

def gateway_solution_type
  @gateway_solution_type
end

#gateway_solution_type_label ⇒ Object

The label for the gateway solution type. The actual value stored may vary by gateway, so the label will vary too.



129
130
131
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 129

def gateway_solution_type_label
  @gateway_solution_type_label
end

#gateway_solution_types ⇒ Object

Used to populate drop down lists for gateway solution types



132
133
134
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 132

def gateway_solution_types
  @gateway_solution_types
end

#gateway_url ⇒ Object

Gateway URL



135
136
137
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 135

def gateway_url
  @gateway_url
end

#gateway_url_label ⇒ Object

The label for the gateway url. The actual value stored may vary by gateway, so the label will vary too.



138
139
140
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 138

def gateway_url_label
  @gateway_url_label
end

#gateway_username ⇒ Object

Gateway Username



141
142
143
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 141

def gateway_username
  @gateway_username
end

#gateway_username_label ⇒ Object

The label for the gateway username. The actual value stored may vary by gateway, so the label will vary too.



144
145
146
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 144

def gateway_username_label
  @gateway_username_label
end

#merchant_account_profile_amex ⇒ Object

If a merchant has multiple card processing accounts, this is the one to use for American Express cards.



147
148
149
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 147

def 
  @merchant_account_profile_amex
end

#merchant_account_profile_diners_club ⇒ Object

If a merchant has multiple card processing accounts, this is the one to use for Diners Club cards.



150
151
152
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 150

def 
  @merchant_account_profile_diners_club
end

#merchant_account_profile_discover ⇒ Object

If a merchant has multiple card processing accounts, this is the one to use for Discover cards.



153
154
155
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 153

def 
  @merchant_account_profile_discover
end

#merchant_account_profile_jcb ⇒ Object

If a merchant has multiple card processing accounts, this is the one to use for JCB cards.



156
157
158
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 156

def 
  @merchant_account_profile_jcb
end

#merchant_account_profile_mastercard ⇒ Object

If a merchant has multiple card processing accounts, this is the one to use for MasterCard cards.



159
160
161
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 159

def 
  @merchant_account_profile_mastercard
end

#merchant_account_profile_visa ⇒ Object

If a merchant has multiple card processing accounts, this is the one to use for VISA cards.



162
163
164
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 162

def 
  @merchant_account_profile_visa
end

#merchant_id ⇒ Object

UltraCart Merchant ID



165
166
167
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 165

def merchant_id
  @merchant_id
end

#multi_currency_details ⇒ Object

True if this gateway provides details for multiple currency transactions



168
169
170
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 168

def multi_currency_details
  @multi_currency_details
end

#name ⇒ Object

Name of this transaction gateway



171
172
173
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 171

def name
  @name
end

#refund_supported ⇒ Object

True if this gateway supports refunds



174
175
176
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 174

def refund_supported
  @refund_supported
end

#require_echeck_tax_id_or_drivers_license ⇒ Object

If true, e-Check transaction will require either a Tax ID or a Driver License



177
178
179
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 177

def require_echeck_tax_id_or_drivers_license
  @require_echeck_tax_id_or_drivers_license
end

#support_vbv_3ds ⇒ Object

True if this gateway supported Verified-by-VISA 3D Secure



180
181
182
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 180

def support_vbv_3ds
  @support_vbv_3ds
end

#supports_amex ⇒ Object

If true, this gateway will attempt to process American Express transactions. If false, the customer will not be allowed to use this type of Credit Card.



183
184
185
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 183

def supports_amex
  @supports_amex
end

#supports_diners_club ⇒ Object

If true, this gateway will attempt to process Diners Club transactions. If false, the customer will not be allowed to use this type of Credit Card.



186
187
188
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 186

def supports_diners_club
  @supports_diners_club
end

#supports_discover ⇒ Object

If true, this gateway will attempt to process Discover transactions. If false, the customer will not be allowed to use this type of Credit Card.



189
190
191
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 189

def supports_discover
  @supports_discover
end

#supports_echeck ⇒ Object

If true, this gateway will attempt to process e-Check transactions. If false, the customer will not be allowed to use e-Checks.



192
193
194
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 192

def supports_echeck
  @supports_echeck
end

#supports_electronic_gift_card ⇒ Object

if true, this gateway will attempt to process electronic gift cards.



195
196
197
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 195

def supports_electronic_gift_card
  @supports_electronic_gift_card
end

#supports_jcb ⇒ Object

If true, this gateway will attempt to process JCB transactions. If false, the customer will not be allowed to use this type of Credit Card.



198
199
200
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 198

def supports_jcb
  @supports_jcb
end

#supports_mastercard ⇒ Object

If true, this gateway will attempt to process MasterCard transactions. If false, the customer will not be allowed to use this type of Credit Card.



201
202
203
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 201

def supports_mastercard
  @supports_mastercard
end

#supports_visa ⇒ Object

If true, this gateway will attempt to process VISA transactions. If false, the customer will not be allowed to use this type of Credit Card.



204
205
206
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 204

def supports_visa
  @supports_visa
end

#third_party ⇒ Object

True if this gateway supports third parties



207
208
209
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 207

def third_party
  @third_party
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 210

def self.attribute_map
  {
    :'arbitrary_html' => :'arbitrary_html',
    :'comment' => :'comment',
    :'credit_card_capable' => :'credit_card_capable',
    :'echeck_capable' => :'echeck_capable',
    :'echeck_supported' => :'echeck_supported',
    :'enabled' => :'enabled',
    :'gateway_cert_pem' => :'gateway_cert_pem',
    :'gateway_cert_pem_label' => :'gateway_cert_pem_label',
    :'gateway_email' => :'gateway_email',
    :'gateway_email_label' => :'gateway_email_label',
    :'gateway_environment' => :'gateway_environment',
    :'gateway_environment_label' => :'gateway_environment_label',
    :'gateway_environments' => :'gateway_environments',
    :'gateway_header_back_color' => :'gateway_header_back_color',
    :'gateway_header_border_color' => :'gateway_header_border_color',
    :'gateway_header_image_url' => :'gateway_header_image_url',
    :'gateway_key' => :'gateway_key',
    :'gateway_key_label' => :'gateway_key_label',
    :'gateway_key_pem' => :'gateway_key_pem',
    :'gateway_key_pem_label' => :'gateway_key_pem_label',
    :'gateway_landing_page' => :'gateway_landing_page',
    :'gateway_merchant_id' => :'gateway_merchant_id',
    :'gateway_merchant_id_label' => :'gateway_merchant_id_label',
    :'gateway_mode' => :'gateway_mode',
    :'gateway_mode_label' => :'gateway_mode_label',
    :'gateway_modes' => :'gateway_modes',
    :'gateway_page_style' => :'gateway_page_style',
    :'gateway_page_style_label' => :'gateway_page_style_label',
    :'gateway_page_styles' => :'gateway_page_styles',
    :'gateway_partner' => :'gateway_partner',
    :'gateway_partner_label' => :'gateway_partner_label',
    :'gateway_password' => :'gateway_password',
    :'gateway_password_label' => :'gateway_password_label',
    :'gateway_payflow_color' => :'gateway_payflow_color',
    :'gateway_private_key_password' => :'gateway_private_key_password',
    :'gateway_private_key_password_label' => :'gateway_private_key_password_label',
    :'gateway_solution_type' => :'gateway_solution_type',
    :'gateway_solution_type_label' => :'gateway_solution_type_label',
    :'gateway_solution_types' => :'gateway_solution_types',
    :'gateway_url' => :'gateway_url',
    :'gateway_url_label' => :'gateway_url_label',
    :'gateway_username' => :'gateway_username',
    :'gateway_username_label' => :'gateway_username_label',
    :'merchant_account_profile_amex' => :'merchant_account_profile_amex',
    :'merchant_account_profile_diners_club' => :'merchant_account_profile_diners_club',
    :'merchant_account_profile_discover' => :'merchant_account_profile_discover',
    :'merchant_account_profile_jcb' => :'merchant_account_profile_jcb',
    :'merchant_account_profile_mastercard' => :'merchant_account_profile_mastercard',
    :'merchant_account_profile_visa' => :'merchant_account_profile_visa',
    :'merchant_id' => :'merchant_id',
    :'multi_currency_details' => :'multi_currency_details',
    :'name' => :'name',
    :'refund_supported' => :'refund_supported',
    :'require_echeck_tax_id_or_drivers_license' => :'require_echeck_tax_id_or_drivers_license',
    :'support_vbv_3ds' => :'support_vbv_3ds',
    :'supports_amex' => :'supports_amex',
    :'supports_diners_club' => :'supports_diners_club',
    :'supports_discover' => :'supports_discover',
    :'supports_echeck' => :'supports_echeck',
    :'supports_electronic_gift_card' => :'supports_electronic_gift_card',
    :'supports_jcb' => :'supports_jcb',
    :'supports_mastercard' => :'supports_mastercard',
    :'supports_visa' => :'supports_visa',
    :'third_party' => :'third_party'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 280

def self.swagger_types
  {
    :'arbitrary_html' => :'String',
    :'comment' => :'String',
    :'credit_card_capable' => :'BOOLEAN',
    :'echeck_capable' => :'BOOLEAN',
    :'echeck_supported' => :'String',
    :'enabled' => :'BOOLEAN',
    :'gateway_cert_pem' => :'String',
    :'gateway_cert_pem_label' => :'String',
    :'gateway_email' => :'String',
    :'gateway_email_label' => :'String',
    :'gateway_environment' => :'String',
    :'gateway_environment_label' => :'String',
    :'gateway_environments' => :'Array<String>',
    :'gateway_header_back_color' => :'String',
    :'gateway_header_border_color' => :'String',
    :'gateway_header_image_url' => :'String',
    :'gateway_key' => :'String',
    :'gateway_key_label' => :'String',
    :'gateway_key_pem' => :'String',
    :'gateway_key_pem_label' => :'String',
    :'gateway_landing_page' => :'String',
    :'gateway_merchant_id' => :'String',
    :'gateway_merchant_id_label' => :'String',
    :'gateway_mode' => :'String',
    :'gateway_mode_label' => :'String',
    :'gateway_modes' => :'Array<String>',
    :'gateway_page_style' => :'String',
    :'gateway_page_style_label' => :'String',
    :'gateway_page_styles' => :'Array<String>',
    :'gateway_partner' => :'String',
    :'gateway_partner_label' => :'String',
    :'gateway_password' => :'String',
    :'gateway_password_label' => :'String',
    :'gateway_payflow_color' => :'String',
    :'gateway_private_key_password' => :'String',
    :'gateway_private_key_password_label' => :'String',
    :'gateway_solution_type' => :'String',
    :'gateway_solution_type_label' => :'String',
    :'gateway_solution_types' => :'Array<String>',
    :'gateway_url' => :'String',
    :'gateway_url_label' => :'String',
    :'gateway_username' => :'String',
    :'gateway_username_label' => :'String',
    :'merchant_account_profile_amex' => :'String',
    :'merchant_account_profile_diners_club' => :'String',
    :'merchant_account_profile_discover' => :'String',
    :'merchant_account_profile_jcb' => :'String',
    :'merchant_account_profile_mastercard' => :'String',
    :'merchant_account_profile_visa' => :'String',
    :'merchant_id' => :'String',
    :'multi_currency_details' => :'BOOLEAN',
    :'name' => :'String',
    :'refund_supported' => :'BOOLEAN',
    :'require_echeck_tax_id_or_drivers_license' => :'BOOLEAN',
    :'support_vbv_3ds' => :'BOOLEAN',
    :'supports_amex' => :'BOOLEAN',
    :'supports_diners_club' => :'BOOLEAN',
    :'supports_discover' => :'BOOLEAN',
    :'supports_echeck' => :'BOOLEAN',
    :'supports_electronic_gift_card' => :'BOOLEAN',
    :'supports_jcb' => :'BOOLEAN',
    :'supports_mastercard' => :'BOOLEAN',
    :'supports_visa' => :'BOOLEAN',
    :'third_party' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 637

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      arbitrary_html == o.arbitrary_html &&
      comment == o.comment &&
      credit_card_capable == o.credit_card_capable &&
      echeck_capable == o.echeck_capable &&
      echeck_supported == o.echeck_supported &&
      enabled == o.enabled &&
      gateway_cert_pem == o.gateway_cert_pem &&
      gateway_cert_pem_label == o.gateway_cert_pem_label &&
      gateway_email == o.gateway_email &&
      gateway_email_label == o.gateway_email_label &&
      gateway_environment == o.gateway_environment &&
      gateway_environment_label == o.gateway_environment_label &&
      gateway_environments == o.gateway_environments &&
      gateway_header_back_color == o.gateway_header_back_color &&
      gateway_header_border_color == o.gateway_header_border_color &&
      gateway_header_image_url == o.gateway_header_image_url &&
      gateway_key == o.gateway_key &&
      gateway_key_label == o.gateway_key_label &&
      gateway_key_pem == o.gateway_key_pem &&
      gateway_key_pem_label == o.gateway_key_pem_label &&
      gateway_landing_page == o.gateway_landing_page &&
      gateway_merchant_id == o.gateway_merchant_id &&
      gateway_merchant_id_label == o.gateway_merchant_id_label &&
      gateway_mode == o.gateway_mode &&
      gateway_mode_label == o.gateway_mode_label &&
      gateway_modes == o.gateway_modes &&
      gateway_page_style == o.gateway_page_style &&
      gateway_page_style_label == o.gateway_page_style_label &&
      gateway_page_styles == o.gateway_page_styles &&
      gateway_partner == o.gateway_partner &&
      gateway_partner_label == o.gateway_partner_label &&
      gateway_password == o.gateway_password &&
      gateway_password_label == o.gateway_password_label &&
      gateway_payflow_color == o.gateway_payflow_color &&
      gateway_private_key_password == o.gateway_private_key_password &&
      gateway_private_key_password_label == o.gateway_private_key_password_label &&
      gateway_solution_type == o.gateway_solution_type &&
      gateway_solution_type_label == o.gateway_solution_type_label &&
      gateway_solution_types == o.gateway_solution_types &&
      gateway_url == o.gateway_url &&
      gateway_url_label == o.gateway_url_label &&
      gateway_username == o.gateway_username &&
      gateway_username_label == o.gateway_username_label &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
      merchant_id == o.merchant_id &&
      multi_currency_details == o.multi_currency_details &&
      name == o.name &&
      refund_supported == o.refund_supported &&
      require_echeck_tax_id_or_drivers_license == o.require_echeck_tax_id_or_drivers_license &&
      support_vbv_3ds == o.support_vbv_3ds &&
      supports_amex == o.supports_amex &&
      supports_diners_club == o.supports_diners_club &&
      supports_discover == o.supports_discover &&
      supports_echeck == o.supports_echeck &&
      supports_electronic_gift_card == o.supports_electronic_gift_card &&
      supports_jcb == o.supports_jcb &&
      supports_mastercard == o.supports_mastercard &&
      supports_visa == o.supports_visa &&
      third_party == o.third_party
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 742

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 808

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 721

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


708
709
710
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 708

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



714
715
716
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 714

def hash
  [arbitrary_html, comment, credit_card_capable, echeck_capable, echeck_supported, enabled, gateway_cert_pem, gateway_cert_pem_label, gateway_email, gateway_email_label, gateway_environment, gateway_environment_label, gateway_environments, gateway_header_back_color, gateway_header_border_color, gateway_header_image_url, gateway_key, gateway_key_label, gateway_key_pem, gateway_key_pem_label, gateway_landing_page, gateway_merchant_id, gateway_merchant_id_label, gateway_mode, gateway_mode_label, gateway_modes, gateway_page_style, gateway_page_style_label, gateway_page_styles, gateway_partner, gateway_partner_label, gateway_password, gateway_password_label, gateway_payflow_color, gateway_private_key_password, gateway_private_key_password_label, gateway_solution_type, gateway_solution_type_label, gateway_solution_types, gateway_url, gateway_url_label, gateway_username, gateway_username_label, , , , , , , merchant_id, multi_currency_details, name, refund_supported, require_echeck_tax_id_or_drivers_license, support_vbv_3ds, supports_amex, supports_diners_club, supports_discover, supports_echeck, supports_electronic_gift_card, supports_jcb, supports_mastercard, supports_visa, third_party].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



624
625
626
627
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 624

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



788
789
790
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 788

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



794
795
796
797
798
799
800
801
802
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 794

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



782
783
784
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 782

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



631
632
633
 
# File 'lib/ultracart_api/models/transaction_gateway.rb', line 631

def valid?
  true
end