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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
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
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 124

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
end

Instance Attribute Details

#amex_additional_amounts ⇒ Object

Returns the value of attribute amex_additional_amounts.



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

def amex_additional_amounts
  @amex_additional_amounts
end

#currency ⇒ Object

Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see "Features for Debit Cards and Prepaid Cards" in the [Credit Card Services Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).



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

def currency
  @currency
end

#discount_amount ⇒ Object

Total discount amount applied to the order. For processor-specific information, see the order_discount_amount field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



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

def discount_amount
  @discount_amount
end

#duty_amount ⇒ Object

Total charges for any import or export duties included in the order. For processor-specific information, see the duty_amount field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



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

def duty_amount
  @duty_amount
end

#exchange_rate ⇒ Object

Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see ‘exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf) For processor-specific information, see the `exchange_rate` request-level field description in [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def exchange_rate
  @exchange_rate
end

#exchange_rate_time_stamp ⇒ Object

Time stamp for the exchange rate. This value is returned by the DCC service. Format: ‘YYYYMMDD~HH:MM` where ~ denotes a space. For processor-specific information, see the `exchange_rate_timestamp` request-level field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def exchange_rate_time_stamp
  @exchange_rate_time_stamp
end

#foreign_amount ⇒ Object

Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the ‘foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



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

def foreign_amount
  @foreign_amount
end

#foreign_currency ⇒ Object

Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the ‘foreign_amount` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



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

def foreign_currency
  @foreign_currency
end

#freight_amount ⇒ Object

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. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



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

def freight_amount
  @freight_amount
end

#gratuity_amount ⇒ Object

Gratuity or tip amount for restaurants when the card is present. 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. For information about partial authorizations, see Credit Card Services Using the SCMP API. Restaurant data is supported only on CyberSource through VisaNet.



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

def gratuity_amount
  @gratuity_amount
end

#national_tax_included ⇒ Object

Flag that indicates whether a national tax is included in the order total. Possible values: - 0: national tax not included - 1: national tax included For processor-specific information, see the national_tax_indicator field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



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

def national_tax_included
  @national_tax_included
end

#original_currency ⇒ Object

Your local pricing currency code. For the possible values, see the [ISO Standard Currency Codes.](apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details, see ‘original_currency` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For details about converting a foreign cardholder’s purchase from your local pricing currency to the cardholder’s billing currency, see the [Dynamic Currency Conversion with a Third Party Provider Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).



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

def original_currency
  @original_currency
end

#service_fee_amount ⇒ Object

Service fee. Required for service fee transactions.



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

def service_fee_amount
  @service_fee_amount
end

#tax_amount ⇒ Object

Total tax amount for all the items in the order. For processor-specific information, see the total_tax_amount field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



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

def tax_amount
  @tax_amount
end

#tax_applied_after_discount ⇒ Object

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 For processor-specific information, see the order_discount_management_indicator field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



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

def tax_applied_after_discount
  @tax_applied_after_discount
end

#tax_applied_level ⇒ Object

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 For processor-specific information, see the tax_management_indicator field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



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

def tax_applied_level
  @tax_applied_level
end

#tax_details ⇒ Object

Returns the value of attribute tax_details.



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

def tax_details
  @tax_details
end

#tax_type_code ⇒ Object

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. For processor-specific information, see the total_tax_type_code field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



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

def tax_type_code
  @tax_type_code
end

#total_amount ⇒ Object

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. For details, see: - "Authorization Information for Specific Processors" in the [Credit Card Services Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - "Capture Information for Specific Processors" in the [Credit Card Services Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - "Credit Information for Specific Processors" in the [Credit Card Services Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see "Zero Amount Authorizations," "Credit Information for Specific Processors" in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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. For details, see ‘grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in "Authorization Information for Specific Processors" of the [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice.



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

def total_amount
  @total_amount
end

Class Method Details

.attribute_map ⇒ Object

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



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

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'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 481

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



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

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



607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 607

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



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 520

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("#{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


507
508
509
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 507

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



513
514
515
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 513

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].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



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
278
279
280
281
282
283
284
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 213

def list_invalid_properties
  invalid_properties = Array.new
  if !@total_amount.nil? && @total_amount.to_s.length > 19
    invalid_properties.push('invalid value for "total_amount", the character length must be smaller than or equal to 19.')
  end

  if !@currency.nil? && @currency.to_s.length > 3
    invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
  end

  if !@discount_amount.nil? && @discount_amount.to_s.length > 15
    invalid_properties.push('invalid value for "discount_amount", the character length must be smaller than or equal to 15.')
  end

  if !@duty_amount.nil? && @duty_amount.to_s.length > 15
    invalid_properties.push('invalid value for "duty_amount", the character length must be smaller than or equal to 15.')
  end

  if !@gratuity_amount.nil? && @gratuity_amount.to_s.length > 13
    invalid_properties.push('invalid value for "gratuity_amount", the character length must be smaller than or equal to 13.')
  end

  if !@tax_amount.nil? && @tax_amount.to_s.length > 12
    invalid_properties.push('invalid value for "tax_amount", the character length must be smaller than or equal to 12.')
  end

  if !@national_tax_included.nil? && @national_tax_included.to_s.length > 1
    invalid_properties.push('invalid value for "national_tax_included", the character length must be smaller than or equal to 1.')
  end

  if !@tax_applied_after_discount.nil? && @tax_applied_after_discount.to_s.length > 1
    invalid_properties.push('invalid value for "tax_applied_after_discount", the character length must be smaller than or equal to 1.')
  end

  if !@tax_applied_level.nil? && @tax_applied_level.to_s.length > 1
    invalid_properties.push('invalid value for "tax_applied_level", the character length must be smaller than or equal to 1.')
  end

  if !@tax_type_code.nil? && @tax_type_code.to_s.length > 3
    invalid_properties.push('invalid value for "tax_type_code", the character length must be smaller than or equal to 3.')
  end

  if !@freight_amount.nil? && @freight_amount.to_s.length > 13
    invalid_properties.push('invalid value for "freight_amount", the character length must be smaller than or equal to 13.')
  end

  if !@foreign_amount.nil? && @foreign_amount.to_s.length > 15
    invalid_properties.push('invalid value for "foreign_amount", the character length must be smaller than or equal to 15.')
  end

  if !@foreign_currency.nil? && @foreign_currency.to_s.length > 5
    invalid_properties.push('invalid value for "foreign_currency", the character length must be smaller than or equal to 5.')
  end

  if !@exchange_rate.nil? && @exchange_rate.to_s.length > 13
    invalid_properties.push('invalid value for "exchange_rate", the character length must be smaller than or equal to 13.')
  end

  if !@exchange_rate_time_stamp.nil? && @exchange_rate_time_stamp.to_s.length > 14
    invalid_properties.push('invalid value for "exchange_rate_time_stamp", the character length must be smaller than or equal to 14.')
  end

  if !@service_fee_amount.nil? && @service_fee_amount.to_s.length > 15
    invalid_properties.push('invalid value for "service_fee_amount", the character length must be smaller than or equal to 15.')
  end

  if !@original_currency.nil? && @original_currency.to_s.length > 15
    invalid_properties.push('invalid value for "original_currency", the character length must be smaller than or equal to 15.')
  end

  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



587
588
589
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 587

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



593
594
595
596
597
598
599
600
601
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 593

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



581
582
583
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 581

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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb', line 288

def valid?
  return false if !@total_amount.nil? && @total_amount.to_s.length > 19
  return false if !@currency.nil? && @currency.to_s.length > 3
  return false if !@discount_amount.nil? && @discount_amount.to_s.length > 15
  return false if !@duty_amount.nil? && @duty_amount.to_s.length > 15
  return false if !@gratuity_amount.nil? && @gratuity_amount.to_s.length > 13
  return false if !@tax_amount.nil? && @tax_amount.to_s.length > 12
  return false if !@national_tax_included.nil? && @national_tax_included.to_s.length > 1
  return false if !@tax_applied_after_discount.nil? && @tax_applied_after_discount.to_s.length > 1
  return false if !@tax_applied_level.nil? && @tax_applied_level.to_s.length > 1
  return false if !@tax_type_code.nil? && @tax_type_code.to_s.length > 3
  return false if !@freight_amount.nil? && @freight_amount.to_s.length > 13
  return false if !@foreign_amount.nil? && @foreign_amount.to_s.length > 15
  return false if !@foreign_currency.nil? && @foreign_currency.to_s.length > 5
  return false if !@exchange_rate.nil? && @exchange_rate.to_s.length > 13
  return false if !@exchange_rate_time_stamp.nil? && @exchange_rate_time_stamp.to_s.length > 14
  return false if !@service_fee_amount.nil? && @service_fee_amount.to_s.length > 15
  return false if !@original_currency.nil? && @original_currency.to_s.length > 15
  true
end