class CyberSource::V2paymentsOrderInformationAmountDetails
Attributes
Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.
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)
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)
Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For processor-specific information, see the exchange_rate
field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
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 field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
Converted amount returned by the DCC service. For processor-specific information, see the foreign_amount
field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
Billing currency returned by the DCC service. For processor-specific information, see the foreign_currency
field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
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)
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)
This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder’s account.
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.
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)
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)
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)
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)
Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource
truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 72 def self.attribute_map { :'total_amount' => :'totalAmount', :'currency' => :'currency', :'discount_amount' => :'discountAmount', :'duty_amount' => :'dutyAmount', :'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', :'surcharge' => :'surcharge', :'settlement_amount' => :'settlementAmount', :'settlement_currency' => :'settlementCurrency', :'amex_additional_amounts' => :'amexAdditionalAmounts', :'tax_details' => :'taxDetails' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 123 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?(:'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?(:'surcharge') self.surcharge = attributes[:'surcharge'] end if attributes.has_key?(:'settlementAmount') self.settlement_amount = attributes[:'settlementAmount'] end if attributes.has_key?(:'settlementCurrency') self.settlement_currency = attributes[:'settlementCurrency'] 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 end
Attribute type mapping.
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 97 def self.swagger_types { :'total_amount' => :'String', :'currency' => :'String', :'discount_amount' => :'String', :'duty_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', :'surcharge' => :'V2paymentsOrderInformationAmountDetailsSurcharge', :'settlement_amount' => :'String', :'settlement_currency' => :'String', :'amex_additional_amounts' => :'Array<V2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts>', :'tax_details' => :'Array<V2paymentsOrderInformationAmountDetailsTaxDetails>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 465 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 && 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 && surcharge == o.surcharge && settlement_amount == o.settlement_amount && settlement_currency == o.settlement_currency && amex_additional_amounts == o.amex_additional_amounts && tax_details == o.tax_details end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 525 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 591 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 504 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
Custom attribute writer method with validation @param [Object] currency Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 315 def currency=(currency) if !currency.nil? && currency.to_s.length > 3 fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.' end @currency = currency end
Custom attribute writer method with validation @param [Object] discount_amount
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 325 def discount_amount=(discount_amount) if !discount_amount.nil? && discount_amount.to_s.length > 15 fail ArgumentError, 'invalid value for "discount_amount", the character length must be smaller than or equal to 15.' end @discount_amount = discount_amount end
Custom attribute writer method with validation @param [Object] duty_amount
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 335 def duty_amount=(duty_amount) if !duty_amount.nil? && duty_amount.to_s.length > 15 fail ArgumentError, 'invalid value for "duty_amount", the character length must be smaller than or equal to 15.' end @duty_amount = duty_amount end
@see the `==` method @param [Object] Object to be compared
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 491 def eql?(o) self == o end
Custom attribute writer method with validation @param [Object] exchange_rate
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 425 def exchange_rate=(exchange_rate) if !exchange_rate.nil? && exchange_rate.to_s.length > 13 fail ArgumentError, 'invalid value for "exchange_rate", the character length must be smaller than or equal to 13.' end @exchange_rate = exchange_rate end
Custom attribute writer method with validation @param [Object] exchange_rate_time_stamp
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 435 def exchange_rate_time_stamp=(exchange_rate_time_stamp) if !exchange_rate_time_stamp.nil? && exchange_rate_time_stamp.to_s.length > 14 fail ArgumentError, 'invalid value for "exchange_rate_time_stamp", the character length must be smaller than or equal to 14.' end @exchange_rate_time_stamp = exchange_rate_time_stamp end
Custom attribute writer method with validation @param [Object] foreign_amount
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 405 def foreign_amount=(foreign_amount) if !foreign_amount.nil? && foreign_amount.to_s.length > 15 fail ArgumentError, 'invalid value for "foreign_amount", the character length must be smaller than or equal to 15.' end @foreign_amount = foreign_amount end
Custom attribute writer method with validation @param [Object] foreign_currency
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 415 def foreign_currency=(foreign_currency) if !foreign_currency.nil? && foreign_currency.to_s.length > 5 fail ArgumentError, 'invalid value for "foreign_currency", the character length must be smaller than or equal to 5.' end @foreign_currency = foreign_currency end
Custom attribute writer method with validation @param [Object] freight_amount
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 395 def freight_amount=(freight_amount) if !freight_amount.nil? && freight_amount.to_s.length > 13 fail ArgumentError, 'invalid value for "freight_amount", the character length must be smaller than or equal to 13.' end @freight_amount = freight_amount end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 497 def hash [total_amount, currency, discount_amount, duty_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, surcharge, settlement_amount, settlement_currency, amex_additional_amounts, tax_details].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 212 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 !@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 !@settlement_amount.nil? && @settlement_amount.to_s.length > 12 invalid_properties.push('invalid value for "settlement_amount", the character length must be smaller than or equal to 12.') end if !@settlement_currency.nil? && @settlement_currency.to_s.length > 3 invalid_properties.push('invalid value for "settlement_currency", the character length must be smaller than or equal to 3.') end invalid_properties end
Custom attribute writer method with validation @param [Object] national_tax_included
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 355 def national_tax_included=(national_tax_included) if !national_tax_included.nil? && national_tax_included.to_s.length > 1 fail ArgumentError, 'invalid value for "national_tax_included", the character length must be smaller than or equal to 1.' end @national_tax_included = national_tax_included end
Custom attribute writer method with validation @param [Object] settlement_amount
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 445 def settlement_amount=(settlement_amount) if !settlement_amount.nil? && settlement_amount.to_s.length > 12 fail ArgumentError, 'invalid value for "settlement_amount", the character length must be smaller than or equal to 12.' end @settlement_amount = settlement_amount end
Custom attribute writer method with validation @param [Object] settlement_currency
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 455 def settlement_currency=(settlement_currency) if !settlement_currency.nil? && settlement_currency.to_s.length > 3 fail ArgumentError, 'invalid value for "settlement_currency", the character length must be smaller than or equal to 3.' end @settlement_currency = settlement_currency end
Custom attribute writer method with validation @param [Object] tax_amount
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 345 def tax_amount=(tax_amount) if !tax_amount.nil? && tax_amount.to_s.length > 12 fail ArgumentError, 'invalid value for "tax_amount", the character length must be smaller than or equal to 12.' end @tax_amount = tax_amount end
Custom attribute writer method with validation @param [Object] tax_applied_after_discount
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 365 def tax_applied_after_discount=(tax_applied_after_discount) if !tax_applied_after_discount.nil? && tax_applied_after_discount.to_s.length > 1 fail ArgumentError, 'invalid value for "tax_applied_after_discount", the character length must be smaller than or equal to 1.' end @tax_applied_after_discount = tax_applied_after_discount end
Custom attribute writer method with validation @param [Object] tax_applied_level
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 375 def tax_applied_level=(tax_applied_level) if !tax_applied_level.nil? && tax_applied_level.to_s.length > 1 fail ArgumentError, 'invalid value for "tax_applied_level", the character length must be smaller than or equal to 1.' end @tax_applied_level = tax_applied_level end
Custom attribute writer method with validation @param [Object] tax_type_code
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 385 def tax_type_code=(tax_type_code) if !tax_type_code.nil? && tax_type_code.to_s.length > 3 fail ArgumentError, 'invalid value for "tax_type_code", the character length must be smaller than or equal to 3.' end @tax_type_code = tax_type_code end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 577 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 565 def to_s to_hash.to_s end
Custom attribute writer method with validation @param [Object] total_amount
Value to be assigned
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 305 def total_amount=(total_amount) if !total_amount.nil? && total_amount.to_s.length > 19 fail ArgumentError, 'invalid value for "total_amount", the character length must be smaller than or equal to 19.' end @total_amount = total_amount end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/cyberSource_client/models/v2payments_order_information_amount_details.rb, line 283 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 !@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 !@settlement_amount.nil? && @settlement_amount.to_s.length > 12 return false if !@settlement_currency.nil? && @settlement_currency.to_s.length > 3 true end