Class: CyberSource::Ptsv2paymentsidcapturesOrderInformationAmountDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsidcapturesOrderInformationAmountDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
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
203
204
205
206
207
208
209
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
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 154

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?(:'totalAmount')
    self.total_amount = attributes[:'totalAmount']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amex_additional_amountsObject

Returns the value of attribute amex_additional_amounts.



61
62
63
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 61

def amex_additional_amounts
  @amex_additional_amounts
end

#cashback_amountObject

Cashback amount in the acquirer’s currency. If a cashback amount is included in the request, it must be included in the ‘orderInformation.amountDetails.totalAmount` value. This field is supported only on CyberSource through VisaNet. #### Used by Authorization Optional. **Authorization Reversal** Optional. #### PIN debit Optional field for PIN debit purchase, PIN debit credit or PIN debit reversal.



72
73
74
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 72

def cashback_amount
  @cashback_amount
end

#currencyObject

Currency used for the order. Use the three-character [ISO Standard Currency Codes.](apps.cybersource.com/library/documentation/sbc/quickref/currencies.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](developer.cybersource.com/library/documentation/sbc/quickref/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](developer.cybersource.com/library/documentation/sbc/quickref/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.



20
21
22
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 20

def currency
  @currency
end

#discount_amountObject

Total discount amount applied to the order.



23
24
25
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 23

def discount_amount
  @discount_amount
end

#duty_amountObject

Total charges for any import or export duties included in the order.



26
27
28
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 26

def duty_amount
  @duty_amount
end

#exchange_rateObject

Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.



56
57
58
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 56

def exchange_rate
  @exchange_rate
end

#exchange_rate_time_stampObject

Time stamp for the exchange rate. This value is returned by the DCC service. Format: ‘YYYYMMDD~HH:MM` where ~ denotes a space.



59
60
61
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 59

def exchange_rate_time_stamp
  @exchange_rate_time_stamp
end

#foreign_amountObject

Set this field to the converted amount that was returned by the DCC provider.



50
51
52
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 50

def foreign_amount
  @foreign_amount
end

#foreign_currencyObject

Set this field to the converted amount that was returned by the DCC provider.



53
54
55
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 53

def foreign_currency
  @foreign_currency
end

#freight_amountObject

Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the totalAmount field.



47
48
49
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 47

def freight_amount
  @freight_amount
end

#gratuity_amountObject

Gratuity or tip amount for restaurants. Allowed only when industryDatatype=restaurant. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. Used by Capture Optional field. #### CyberSource through VisaNet Restaurant data is supported only on CyberSource through VisaNet when card is present.



29
30
31
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 29

def gratuity_amount
  @gratuity_amount
end

#national_tax_includedObject

Flag that indicates whether a national tax is included in the order total. Possible values: - 0: national tax not included - 1: national tax included



35
36
37
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 35

def national_tax_included
  @national_tax_included
end

#original_currencyObject

Your local pricing currency code. For the possible values, see the [ISO Standard Currency Codes.](apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)



69
70
71
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 69

def original_currency
  @original_currency
end

#service_fee_amountObject

Service fee. Required for service fee transactions.



66
67
68
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 66

def service_fee_amount
  @service_fee_amount
end

#tax_amountObject

Total tax amount for all the items in the order.



32
33
34
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 32

def tax_amount
  @tax_amount
end

#tax_applied_after_discountObject

Flag that indicates how the merchant manages discounts. Possible values: - 0: no invoice level discount included - 1: tax calculated on the postdiscount invoice total - 2: tax calculated on the prediscount invoice total



38
39
40
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 38

def tax_applied_after_discount
  @tax_applied_after_discount
end

#tax_applied_levelObject

Flag that indicates how you calculate tax. Possible values: - 0: net prices with tax calculated at line item level - 1: net prices with tax calculated at invoice level - 2: gross prices with tax provided at line item level - 3: gross prices with tax provided at invoice level - 4: no tax applies on the invoice for the transaction



41
42
43
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 41

def tax_applied_level
  @tax_applied_level
end

#tax_detailsObject

Returns the value of attribute tax_details.



63
64
65
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 63

def tax_details
  @tax_details
end

#tax_type_codeObject

For tax amounts that can be categorized as one tax type. This field contains the tax type code that corresponds to the entry in the lineItems.taxAmount field. Possible values: - 056: sales tax (U.S only) - **TX~**: all taxes (Canada only) Note ~ = space.



44
45
46
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 44

def tax_type_code
  @tax_type_code
end

#total_amountObject

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 Required for creating a new invoice. #### 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.



17
18
19
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 17

def total_amount
  @total_amount
end

Class Method Details

.attribute_mapObject

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 75

def self.attribute_map
  {
    :'total_amount' => :'totalAmount',
    :'currency' => :'currency',
    :'discount_amount' => :'discountAmount',
    :'duty_amount' => :'dutyAmount',
    :'gratuity_amount' => :'gratuityAmount',
    :'tax_amount' => :'taxAmount',
    :'national_tax_included' => :'nationalTaxIncluded',
    :'tax_applied_after_discount' => :'taxAppliedAfterDiscount',
    :'tax_applied_level' => :'taxAppliedLevel',
    :'tax_type_code' => :'taxTypeCode',
    :'freight_amount' => :'freightAmount',
    :'foreign_amount' => :'foreignAmount',
    :'foreign_currency' => :'foreignCurrency',
    :'exchange_rate' => :'exchangeRate',
    :'exchange_rate_time_stamp' => :'exchangeRateTimeStamp',
    :'amex_additional_amounts' => :'amexAdditionalAmounts',
    :'tax_details' => :'taxDetails',
    :'service_fee_amount' => :'serviceFeeAmount',
    :'original_currency' => :'originalCurrency',
    :'cashback_amount' => :'cashbackAmount'
  }
end

.json_mapObject

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 101

def self.json_map
  {
    :'total_amount' => :'total_amount',
    :'currency' => :'currency',
    :'discount_amount' => :'discount_amount',
    :'duty_amount' => :'duty_amount',
    :'gratuity_amount' => :'gratuity_amount',
    :'tax_amount' => :'tax_amount',
    :'national_tax_included' => :'national_tax_included',
    :'tax_applied_after_discount' => :'tax_applied_after_discount',
    :'tax_applied_level' => :'tax_applied_level',
    :'tax_type_code' => :'tax_type_code',
    :'freight_amount' => :'freight_amount',
    :'foreign_amount' => :'foreign_amount',
    :'foreign_currency' => :'foreign_currency',
    :'exchange_rate' => :'exchange_rate',
    :'exchange_rate_time_stamp' => :'exchange_rate_time_stamp',
    :'amex_additional_amounts' => :'amex_additional_amounts',
    :'tax_details' => :'tax_details',
    :'service_fee_amount' => :'service_fee_amount',
    :'original_currency' => :'original_currency',
    :'cashback_amount' => :'cashback_amount'
  }
end

.swagger_typesObject

Attribute type mapping.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 127

def self.swagger_types
  {
    :'total_amount' => :'String',
    :'currency' => :'String',
    :'discount_amount' => :'String',
    :'duty_amount' => :'String',
    :'gratuity_amount' => :'String',
    :'tax_amount' => :'String',
    :'national_tax_included' => :'String',
    :'tax_applied_after_discount' => :'String',
    :'tax_applied_level' => :'String',
    :'tax_type_code' => :'String',
    :'freight_amount' => :'String',
    :'foreign_amount' => :'String',
    :'foreign_currency' => :'String',
    :'exchange_rate' => :'String',
    :'exchange_rate_time_stamp' => :'String',
    :'amex_additional_amounts' => :'Array<Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts>',
    :'tax_details' => :'Array<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails>',
    :'service_fee_amount' => :'String',
    :'original_currency' => :'String',
    :'cashback_amount' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 368

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total_amount == o.total_amount &&
      currency == o.currency &&
      discount_amount == o.discount_amount &&
      duty_amount == o.duty_amount &&
      gratuity_amount == o.gratuity_amount &&
      tax_amount == o.tax_amount &&
      national_tax_included == o.national_tax_included &&
      tax_applied_after_discount == o.tax_applied_after_discount &&
      tax_applied_level == o.tax_applied_level &&
      tax_type_code == o.tax_type_code &&
      freight_amount == o.freight_amount &&
      foreign_amount == o.foreign_amount &&
      foreign_currency == o.foreign_currency &&
      exchange_rate == o.exchange_rate &&
      exchange_rate_time_stamp == o.exchange_rate_time_stamp &&
      amex_additional_amounts == o.amex_additional_amounts &&
      tax_details == o.tax_details &&
      service_fee_amount == o.service_fee_amount &&
      original_currency == o.original_currency &&
      cashback_amount == o.cashback_amount
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



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
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 429

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 = CyberSource.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



495
496
497
498
499
500
501
502
503
504
505
506
507
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 495

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



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 408

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 the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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


395
396
397
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 395

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



401
402
403
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 401

def hash
  [total_amount, currency, discount_amount, duty_amount, gratuity_amount, tax_amount, national_tax_included, tax_applied_after_discount, tax_applied_level, tax_type_code, freight_amount, foreign_amount, foreign_currency, exchange_rate, exchange_rate_time_stamp, amex_additional_amounts, tax_details, service_fee_amount, original_currency, cashback_amount].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



247
248
249
250
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 247

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



475
476
477
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 475

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



481
482
483
484
485
486
487
488
489
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 481

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



469
470
471
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 469

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



254
255
256
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 254

def valid?
  true
end