Class: CyberSourceMergedSpec::AmountDetails57

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

Overview

AmountDetails57 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, tax_amount: SKIP, authorized_amount: SKIP, settlement_amount: SKIP, settlement_currency: SKIP, refund_balance: SKIP, surcharge: SKIP, additional_properties: nil) ⇒ AmountDetails57

Returns a new instance of AmountDetails57.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 150

def initialize(total_amount: SKIP, currency: SKIP, tax_amount: SKIP,
               authorized_amount: SKIP, settlement_amount: SKIP,
               settlement_currency: SKIP, refund_balance: SKIP,
               surcharge: 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
  @tax_amount = tax_amount unless tax_amount == SKIP
  @authorized_amount = authorized_amount unless authorized_amount == SKIP
  @settlement_amount = settlement_amount unless settlement_amount == SKIP
  @settlement_currency = settlement_currency unless settlement_currency == SKIP
  @refund_balance = refund_balance unless refund_balance == SKIP
  @surcharge = surcharge unless surcharge == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#authorized_amount ⇒ String

Amount that was authorized. Returned by authorization service.

PIN debit

Amount of the purchase. Returned by PIN debit purchase.

Returns:

  • (String) 


94
95
96
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 94

def authorized_amount
  @authorized_amount
end

#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) 


82
83
84
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 82

def currency
  @currency
end

#refund_balance ⇒ String

The remaining amount which can be refunded.

Returns:

  • (String) 


111
112
113
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 111

def refund_balance
  @refund_balance
end

#settlement_amount ⇒ String

This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder’s account. This field is returned for OCT transactions.

Returns:

  • (String) 


100
101
102
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 100

def settlement_amount
  @settlement_amount
end

#settlement_currency ⇒ String

This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions.

Returns:

  • (String) 


107
108
109
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 107

def settlement_currency
  @settlement_currency
end

#surcharge ⇒ Surcharge1

The remaining amount which can be refunded.

Returns:



115
116
117
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 115

def surcharge
  @surcharge
end

#tax_amount ⇒ String

Total tax amount for all the items in the order.

Returns:

  • (String) 


86
87
88
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 86

def tax_amount
  @tax_amount
end

#total_amount ⇒ String

Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. Note For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. Important Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen.

Card Present

Required to include either this field or orderInformation.lineItems[].unitPrice for the order.

Invoicing / Pay By Link

Required for creating a new invoice or payment link.

PIN Debit

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. 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; however, for all other processors, these fields are required.

DCC with a Third-Party Provider

Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request.

DCC for First Data

Not used.

Returns:

  • (String) 


43
44
45
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 43

def total_amount
  @total_amount
end

Class Method Details

.from_element(root) ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 204

def self.from_element(root)
  total_amount = XmlUtilities.from_element(root, 'totalAmount', String)
  currency = XmlUtilities.from_element(root, 'currency', String)
  tax_amount = XmlUtilities.from_element(root, 'taxAmount', String)
  authorized_amount = XmlUtilities.from_element(root, 'authorizedAmount',
                                                String)
  settlement_amount = XmlUtilities.from_element(root, 'settlementAmount',
                                                String)
  settlement_currency = XmlUtilities.from_element(root,
                                                  'settlementCurrency',
                                                  String)
  refund_balance = XmlUtilities.from_element(root, 'refundBalance', String)
  surcharge = XmlUtilities.from_element(root, 'Surcharge1', Surcharge1)

  new(total_amount: total_amount,
      currency: currency,
      tax_amount: tax_amount,
      authorized_amount: authorized_amount,
      settlement_amount: settlement_amount,
      settlement_currency: settlement_currency,
      refund_balance: refund_balance,
      surcharge: surcharge,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 169

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
  tax_amount = hash.key?('taxAmount') ? hash['taxAmount'] : SKIP
  authorized_amount =
    hash.key?('authorizedAmount') ? hash['authorizedAmount'] : SKIP
  settlement_amount =
    hash.key?('settlementAmount') ? hash['settlementAmount'] : SKIP
  settlement_currency =
    hash.key?('settlementCurrency') ? hash['settlementCurrency'] : SKIP
  refund_balance = hash.key?('refundBalance') ? hash['refundBalance'] : SKIP
  surcharge = Surcharge1.from_hash(hash['surcharge']) if hash['surcharge']

  # 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.
  AmountDetails57.new(total_amount: total_amount,
                      currency: currency,
                      tax_amount: tax_amount,
                      authorized_amount: authorized_amount,
                      settlement_amount: settlement_amount,
                      settlement_currency: settlement_currency,
                      refund_balance: refund_balance,
                      surcharge: surcharge,
                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 118

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['total_amount'] = 'totalAmount'
  @_hash['currency'] = 'currency'
  @_hash['tax_amount'] = 'taxAmount'
  @_hash['authorized_amount'] = 'authorizedAmount'
  @_hash['settlement_amount'] = 'settlementAmount'
  @_hash['settlement_currency'] = 'settlementCurrency'
  @_hash['refund_balance'] = 'refundBalance'
  @_hash['surcharge'] = 'surcharge'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



146
147
148
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 146

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    total_amount
    currency
    tax_amount
    authorized_amount
    settlement_amount
    settlement_currency
    refund_balance
    surcharge
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



260
261
262
263
264
265
266
267
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 260

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} total_amount: #{@total_amount.inspect}, currency: #{@currency.inspect},"\
  " tax_amount: #{@tax_amount.inspect}, authorized_amount: #{@authorized_amount.inspect},"\
  " settlement_amount: #{@settlement_amount.inspect}, settlement_currency:"\
  " #{@settlement_currency.inspect}, refund_balance: #{@refund_balance.inspect}, surcharge:"\
  " #{@surcharge.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



250
251
252
253
254
255
256
257
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 250

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} total_amount: #{@total_amount}, currency: #{@currency}, tax_amount:"\
  " #{@tax_amount}, authorized_amount: #{@authorized_amount}, settlement_amount:"\
  " #{@settlement_amount}, settlement_currency: #{@settlement_currency}, refund_balance:"\
  " #{@refund_balance}, surcharge: #{@surcharge}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_xml_element(doc, root_name) ⇒ Object 



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/cyber_source_merged_spec/models/amount_details57.rb', line 229

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, 'taxAmount', tax_amount)
  XmlUtilities.add_as_subelement(doc, root, 'authorizedAmount',
                                 authorized_amount)
  XmlUtilities.add_as_subelement(doc, root, 'settlementAmount',
                                 settlement_amount)
  XmlUtilities.add_as_subelement(doc, root, 'settlementCurrency',
                                 settlement_currency)
  XmlUtilities.add_as_subelement(doc, root, 'refundBalance', refund_balance)
  XmlUtilities.add_as_subelement(doc, root, 'Surcharge1', surcharge)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end