Class: CyberSourceMergedSpec::AmountDetails10

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/cyber_source_merged_spec/models/amount_details10.rb

Overview

AmountDetails10 Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(total_amount: SKIP, currency: SKIP, processor_transaction_fee: SKIP, additional_properties: nil) ⇒ AmountDetails10

Returns a new instance of AmountDetails10.



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/cyber_source_merged_spec/models/amount_details10.rb', line 82

def initialize(total_amount: SKIP, currency: SKIP,
               processor_transaction_fee: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @total_amount = total_amount unless total_amount == SKIP
  @currency = currency unless currency == SKIP
  unless processor_transaction_fee == SKIP
    @processor_transaction_fee =
      processor_transaction_fee
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#currency ⇒ String

Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/cur rencies.pdf)

Used by

Authorization Required field. Authorization Reversal For an authorization reversal (reversalInformation) or a capture (processingOptions.capture is set to true), you must use the same currency that you used in your payment authorization request.

PIN Debit

Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickre f/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickre f/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests.

GPX

This field is optional for reversing an authorization or credit.

DCC for First Data

Your local currency.

Tax Calculation

Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.

Returns:

  • (String) 


53
54
55
 
# File 'lib/cyber_source_merged_spec/models/amount_details10.rb', line 53

def currency
  @currency
end

#processor_transaction_fee ⇒ String

The fee decided by the PSP/Processor per transaction.

Returns:

  • (String) 


57
58
59
 
# File 'lib/cyber_source_merged_spec/models/amount_details10.rb', line 57

def processor_transaction_fee
  @processor_transaction_fee
end

#total_amount ⇒ String

Amount you requested for the capture.

Returns:

  • (String) 


14
15
16
 
# File 'lib/cyber_source_merged_spec/models/amount_details10.rb', line 14

def total_amount
  @total_amount
end

Class Method Details

.from_element(root) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/cyber_source_merged_spec/models/amount_details10.rb', line 120

def self.from_element(root)
  total_amount = XmlUtilities.from_element(root, 'totalAmount', String)
  currency = XmlUtilities.from_element(root, 'currency', String)
  processor_transaction_fee = XmlUtilities.from_element(
    root, 'processorTransactionFee', String
  )

  new(total_amount: total_amount,
      currency: currency,
      processor_transaction_fee: processor_transaction_fee,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/cyber_source_merged_spec/models/amount_details10.rb', line 97

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  total_amount = hash.key?('totalAmount') ? hash['totalAmount'] : SKIP
  currency = hash.key?('currency') ? hash['currency'] : SKIP
  processor_transaction_fee =
    hash.key?('processorTransactionFee') ? hash['processorTransactionFee'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  AmountDetails10.new(total_amount: total_amount,
                      currency: currency,
                      processor_transaction_fee: processor_transaction_fee,
                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



60
61
62
63
64
65
66
 
# File 'lib/cyber_source_merged_spec/models/amount_details10.rb', line 60

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['total_amount'] = 'totalAmount'
  @_hash['currency'] = 'currency'
  @_hash['processor_transaction_fee'] = 'processorTransactionFee'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



78
79
80
 
# File 'lib/cyber_source_merged_spec/models/amount_details10.rb', line 78

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



69
70
71
72
73
74
75
 
# File 'lib/cyber_source_merged_spec/models/amount_details10.rb', line 69

def self.optionals
  %w[
    total_amount
    currency
    processor_transaction_fee
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



155
156
157
158
159
160
 
# File 'lib/cyber_source_merged_spec/models/amount_details10.rb', line 155

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} total_amount: #{@total_amount.inspect}, currency: #{@currency.inspect},"\
  " processor_transaction_fee: #{@processor_transaction_fee.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



147
148
149
150
151
152
 
# File 'lib/cyber_source_merged_spec/models/amount_details10.rb', line 147

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} total_amount: #{@total_amount}, currency: #{@currency},"\
  " processor_transaction_fee: #{@processor_transaction_fee}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_xml_element(doc, root_name) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/cyber_source_merged_spec/models/amount_details10.rb', line 133

def to_xml_element(doc, root_name)
  root = doc.create_element(root_name)

  XmlUtilities.add_as_subelement(doc, root, 'totalAmount', total_amount)
  XmlUtilities.add_as_subelement(doc, root, 'currency', currency)
  XmlUtilities.add_as_subelement(doc, root, 'processorTransactionFee',
                                 processor_transaction_fee)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end