Class: CyberSource::Ptsv2paymentsOrderInformationAmountDetails

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsOrderInformationAmountDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 222

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

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

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

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

  if attributes.has_key?(:'subTotalAmount')
    self.sub_total_amount = attributes[:'subTotalAmount']
  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?(:'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

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

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

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

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

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

  if attributes.has_key?(:'oct-surcharge')
    self.oct_surcharge = attributes[:'oct-surcharge']
  end

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

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

Instance Attribute Details

#amex_additional_amounts ⇒ Object

Returns the value of attribute amex_additional_amounts.



81
82
83
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 81

def amex_additional_amounts
  @amex_additional_amounts
end

#anticipated_amount ⇒ Object

This API Field contains the anticipated amount details. This supports use cases where the Merchant does not wish to have funds held against the account, but needs to confirm an amount prior to authorization, such as for a trial subscription, reservation service, or loyalty program. In an account verification, the anticipated amount is used to confirm the account has availability to accept purchases.



104
105
106
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 104

def anticipated_amount
  @anticipated_amount
end

#cashback_amount ⇒ Object

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.



95
96
97
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 95

def cashback_amount
  @cashback_amount
end

#currency ⇒ Object

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.



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

def currency
  @currency
end

#currency_conversion ⇒ Object

Returns the value of attribute currency_conversion.



97
98
99
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 97

def currency_conversion
  @currency_conversion
end

#discount_amount ⇒ Object

Total discount amount applied to the order.



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

def discount_amount
  @discount_amount
end

#duty_amount ⇒ Object

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



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

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.



68
69
70
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 68

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.



71
72
73
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 71

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.



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

def foreign_amount
  @foreign_amount
end

#foreign_currency ⇒ Object

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



65
66
67
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 65

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.



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

def freight_amount
  @freight_amount
end

#gift_wrap_amount ⇒ Object

Amount being charged as gift wrap fee.



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

def gift_wrap_amount
  @gift_wrap_amount
end

#gratuity_amount ⇒ Object

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.



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

def gratuity_amount
  @gratuity_amount
end

#invoice_amount ⇒ Object

Invoice amount. The invoice amount issued by the Merchant to the Cardholder, which includes VAT (excluding items such as TIPS or CASHBACK). For transactions that do not have applicable Benefit Laws, the field may be entered as zeros. This field is only applicable for Uruguay market. Example: 100.00 Uruguay The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 7-18 - Field: Invoice Amount



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

def invoice_amount
  @invoice_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



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

def national_tax_included
  @national_tax_included
end

#oct_surcharge ⇒ Object

Returns the value of attribute oct_surcharge.



99
100
101
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 99

def oct_surcharge
  @oct_surcharge
end

#order ⇒ Object

Returns the value of attribute order.



101
102
103
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 101

def order
  @order
end

#original_amount ⇒ Object

Amount in your original local pricing currency. This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, CyberSource truncates the amount to the correct number of decimal places.



89
90
91
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 89

def original_amount
  @original_amount
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)



92
93
94
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 92

def original_currency
  @original_currency
end

#refund_balance ⇒ Object

The remaining amount which can be refunded.



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

def refund_balance
  @refund_balance
end

#service_fee_amount ⇒ Object

Service fee. Required for service fee transactions.



86
87
88
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 86

def service_fee_amount
  @service_fee_amount
end

#settlement_amount ⇒ Object

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.



76
77
78
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 76

def settlement_amount
  @settlement_amount
end

#settlement_currency ⇒ Object

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.



79
80
81
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 79

def settlement_currency
  @settlement_currency
end

#sub_total_amount ⇒ Object

Subtotal amount of all the items.This amount (which is the value of all items in the cart, not including the additional amounts such as tax, shipping, etc.) cannot change after a sessions request. When there is a change to any of the additional amounts, this field should be resent in the order request. When the sub total amount changes, you must initiate a new transaction starting with a sessions request. Note The amount value must be a non-negative number containing 2 decimal places and limited to 7 digits before the decimal point. This value can not be changed after a sessions request.



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

def sub_total_amount
  @sub_total_amount
end

#surcharge ⇒ Object

Returns the value of attribute surcharge.



73
74
75
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 73

def surcharge
  @surcharge
end

#tax_amount ⇒ Object

Total tax amount for all the items in the order.



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

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



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

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



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

def tax_applied_level
  @tax_applied_level
end

#tax_details ⇒ Object

Returns the value of attribute tax_details.



83
84
85
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 83

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.



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

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



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

def total_amount
  @total_amount
end

Class Method Details

.attribute_map ⇒ Object

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 107

def self.attribute_map
  {
    :'refund_balance' => :'refundBalance',
    :'gift_wrap_amount' => :'giftWrapAmount',
    :'invoice_amount' => :'invoiceAmount',
    :'total_amount' => :'totalAmount',
    :'sub_total_amount' => :'subTotalAmount',
    :'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',
    :'surcharge' => :'surcharge',
    :'settlement_amount' => :'settlementAmount',
    :'settlement_currency' => :'settlementCurrency',
    :'amex_additional_amounts' => :'amexAdditionalAmounts',
    :'tax_details' => :'taxDetails',
    :'service_fee_amount' => :'serviceFeeAmount',
    :'original_amount' => :'originalAmount',
    :'original_currency' => :'originalCurrency',
    :'cashback_amount' => :'cashbackAmount',
    :'currency_conversion' => :'currencyConversion',
    :'oct_surcharge' => :'oct-surcharge',
    :'order' => :'order',
    :'anticipated_amount' => :'anticipatedAmount'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'refund_balance' => :'refund_balance',
    :'gift_wrap_amount' => :'gift_wrap_amount',
    :'invoice_amount' => :'invoice_amount',
    :'total_amount' => :'total_amount',
    :'sub_total_amount' => :'sub_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',
    :'surcharge' => :'surcharge',
    :'settlement_amount' => :'settlement_amount',
    :'settlement_currency' => :'settlement_currency',
    :'amex_additional_amounts' => :'amex_additional_amounts',
    :'tax_details' => :'tax_details',
    :'service_fee_amount' => :'service_fee_amount',
    :'original_amount' => :'original_amount',
    :'original_currency' => :'original_currency',
    :'cashback_amount' => :'cashback_amount',
    :'currency_conversion' => :'currency_conversion',
    :'oct_surcharge' => :'oct_surcharge',
    :'order' => :'order',
    :'anticipated_amount' => :'anticipated_amount'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'refund_balance' => :'String',
    :'gift_wrap_amount' => :'String',
    :'invoice_amount' => :'String',
    :'total_amount' => :'String',
    :'sub_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',
    :'surcharge' => :'Ptsv2paymentsOrderInformationAmountDetailsSurcharge',
    :'settlement_amount' => :'String',
    :'settlement_currency' => :'String',
    :'amex_additional_amounts' => :'Array<Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts>',
    :'tax_details' => :'Array<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails>',
    :'service_fee_amount' => :'String',
    :'original_amount' => :'String',
    :'original_currency' => :'String',
    :'cashback_amount' => :'String',
    :'currency_conversion' => :'Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion',
    :'oct_surcharge' => :'Ptsv2paymentsOrderInformationAmountDetailsOctsurcharge',
    :'order' => :'Ptsv2paymentsOrderInformationAmountDetailsOrder',
    :'anticipated_amount' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



532
533
534
535
536
537
538
539
540
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 532

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      refund_balance == o.refund_balance &&
      gift_wrap_amount == o.gift_wrap_amount &&
      invoice_amount == o.invoice_amount &&
      total_amount == o.total_amount &&
      sub_total_amount == o.sub_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 &&
      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 &&
      service_fee_amount == o.service_fee_amount &&
      original_amount == o.original_amount &&
      original_currency == o.original_currency &&
      cashback_amount == o.cashback_amount &&
      currency_conversion == o.currency_conversion &&
      oct_surcharge == o.oct_surcharge &&
      order == o.order &&
      anticipated_amount == o.anticipated_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



605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 605

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



671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 671

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



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 584

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


571
572
573
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 571

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



577
578
579
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 577

def hash
  [refund_balance, gift_wrap_amount, invoice_amount, total_amount, sub_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, surcharge, settlement_amount, settlement_currency, amex_additional_amounts, tax_details, service_fee_amount, original_amount, original_currency, cashback_amount, currency_conversion, oct_surcharge, order, anticipated_amount].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



363
364
365
366
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 363

def list_invalid_properties
  invalid_properties = Array.new
  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



651
652
653
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 651

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



657
658
659
660
661
662
663
664
665
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 657

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



645
646
647
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 645

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



370
371
372
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb', line 370

def valid?
  true
end