Class: CyberSource::PtsV2PaymentsPost201ResponsePaymentInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PtsV2PaymentsPost201ResponsePaymentInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_featuresObject

Returns the value of attribute account_features.



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

def 
  @account_features
end

#account_typeObject

Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. For all possible values, see the ‘score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/) Click **Decision Manager** > Documentation > Guides > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).



40
41
42
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 40

def 
  @account_type
end

#bankObject

Returns the value of attribute bank.



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

def bank
  @bank
end

#binObject

Credit card BIN (the first six digits of the credit card).Derived either from the ‘cc_bin` request field or from the first six characters of the `customer_cc_num` field. For all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/) Click **Decision Manager** > Documentation > Guides > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).



37
38
39
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 37

def bin
  @bin
end

#bin_countryObject

Country (two-digit country code) associated with the BIN of the customer’s card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. For all possible values, see the ‘bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/) Click **Decision Manager** > Documentation > Guides > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).



46
47
48
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 46

def bin_country
  @bin_country
end

#cardObject

Returns the value of attribute card.



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

def card
  @card
end

#customerObject

Returns the value of attribute customer.



25
26
27
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 25

def customer
  @customer
end

#e_walletObject

Returns the value of attribute e_wallet.



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

def e_wallet
  @e_wallet
end

#instrument_identifierObject

Returns the value of attribute instrument_identifier.



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

def instrument_identifier
  @instrument_identifier
end

#issuerObject

Name of the bank or entity that issued the card account. For all possible values, see the ‘score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/) Click **Decision Manager** > Documentation > Guides > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).



43
44
45
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 43

def issuer
  @issuer
end

#payment_instrumentObject

Returns the value of attribute payment_instrument.



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

def payment_instrument
  @payment_instrument
end

#schemeObject

Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron Note Additional values may be present. For all possible values, see the ‘score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/) Click **Decision Manager** > Documentation > Guides > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).



34
35
36
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 34

def scheme
  @scheme
end

#shipping_addressObject

Returns the value of attribute shipping_address.



31
32
33
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 31

def shipping_address
  @shipping_address
end

#tokenized_cardObject

Returns the value of attribute tokenized_card.



19
20
21
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 19

def tokenized_card
  @tokenized_card
end

Class Method Details

.attribute_mapObject

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 51

def self.attribute_map
  {
    :'card' => :'card',
    :'tokenized_card' => :'tokenizedCard',
    :'account_features' => :'accountFeatures',
    :'bank' => :'bank',
    :'customer' => :'customer',
    :'payment_instrument' => :'paymentInstrument',
    :'instrument_identifier' => :'instrumentIdentifier',
    :'shipping_address' => :'shippingAddress',
    :'scheme' => :'scheme',
    :'bin' => :'bin',
    :'account_type' => :'accountType',
    :'issuer' => :'issuer',
    :'bin_country' => :'binCountry',
    :'e_wallet' => :'eWallet'
  }
end

.json_mapObject

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 71

def self.json_map
  {
    :'card' => :'card',
    :'tokenized_card' => :'tokenized_card',
    :'account_features' => :'account_features',
    :'bank' => :'bank',
    :'customer' => :'customer',
    :'payment_instrument' => :'payment_instrument',
    :'instrument_identifier' => :'instrument_identifier',
    :'shipping_address' => :'shipping_address',
    :'scheme' => :'scheme',
    :'bin' => :'bin',
    :'account_type' => :'account_type',
    :'issuer' => :'issuer',
    :'bin_country' => :'bin_country',
    :'e_wallet' => :'e_wallet'
  }
end

.swagger_typesObject

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 91

def self.swagger_types
  {
    :'card' => :'PtsV2PaymentsPost201ResponsePaymentAccountInformationCard',
    :'tokenized_card' => :'PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard',
    :'account_features' => :'PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures',
    :'bank' => :'PtsV2PaymentsPost201ResponsePaymentInformationBank',
    :'customer' => :'Ptsv2paymentsPaymentInformationCustomer',
    :'payment_instrument' => :'Ptsv2paymentsPaymentInformationPaymentInstrument',
    :'instrument_identifier' => :'PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier',
    :'shipping_address' => :'Ptsv2paymentsPaymentInformationShippingAddress',
    :'scheme' => :'String',
    :'bin' => :'String',
    :'account_type' => :'String',
    :'issuer' => :'String',
    :'bin_country' => :'String',
    :'e_wallet' => :'PtsV2PaymentsPost201ResponsePaymentInformationEWallet'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 220

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      card == o.card &&
      tokenized_card == o.tokenized_card &&
       == o. &&
      bank == o.bank &&
      customer == o.customer &&
      payment_instrument == o.payment_instrument &&
      instrument_identifier == o.instrument_identifier &&
      shipping_address == o.shipping_address &&
      scheme == o.scheme &&
      bin == o.bin &&
       == o. &&
      issuer == o.issuer &&
      bin_country == o.bin_country &&
      e_wallet == o.e_wallet
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



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

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



341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 341

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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 254

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


241
242
243
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 241

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



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

def hash
  [card, tokenized_card, , bank, customer, payment_instrument, instrument_identifier, shipping_address, scheme, bin, , issuer, bin_country, e_wallet].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



177
178
179
180
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 177

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



321
322
323
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 321

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



327
328
329
330
331
332
333
334
335
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 327

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



315
316
317
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 315

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



184
185
186
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb', line 184

def valid?
  true
end