Class: CyberSource::Ptsv2paymentsPaymentInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsPaymentInformation

Initializes the object



98
99
100
101
102
103
104
105
106
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
143
144
145
146
147
148
149
150
151
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 98

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

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

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

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

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

Instance Attribute Details

#bankObject

Returns the value of attribute bank.



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

def bank
  @bank
end

#cardObject

Returns the value of attribute card.



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

def card
  @card
end

#customerObject

Returns the value of attribute customer.



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

def customer
  @customer
end

#e_walletObject

Returns the value of attribute e_wallet.



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

def e_wallet
  @e_wallet
end

#fluid_dataObject

Returns the value of attribute fluid_data.



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

def fluid_data
  @fluid_data
end

#initiation_channelObject

Mastercard-defined code that indicates how the account information was obtained. - ‘00`: Card - `01`: Mobile Network Operator (MNO) controlled removable secure element (SIM or UICC) personalized for use with a mobile phone or smartphone - `02`: Key fob - `03`: Watch using a contactless chip or a fixed (non-removable) secure element not controlled by the MNO - `04`: Mobile tag - `05`: Wristband - `06`: Mobile phone case or sleeve - `07`: Mobile phone or smartphone with a fixed (non-removable) secure element controlled by the MNO,for example, code division multiple access (CDMA) - `08`: Removable secure element not controlled by the MNO, for example, memory card personalized forused with a mobile phone or smartphone - `09`: Mobile Phone or smartphone with a fixed (non-removable) secure element not controlled by the MNO - `10`: MNO controlled removable secure element (SIM or UICC) personalized for use with a tablet or e-book - `11`: Tablet or e-book with a fixed (non-removable) secure element controlled by the MNO - `12`: Removable secure element not controlled by the MNO, for example, memory card personalized foruse with a tablet or e-book - `13`: Tablet or e-book with fixed (non-removable) secure element not controlled by the MNO - `14`: Mobile phone or smartphone with a payment application running in a host processor - `15`: Tablet or e-book with a payment application running in a host processor - `16`: Mobile phone or smartphone with a payment application running in the Trusted ExecutionEnvironment (TEE) of a host processor - `17`: Tablet or e-book with a payment application running in the TEE of a host processor - `18`: Watch with a payment application running in the TEE of a host processor - `19`: Watch with a payment application running in a host processor Values from 20–99 exclusively indicate the form factor only without also indicating the storage technology - `20`: Card - `21`: Phone e.g. Mobile Phone - `22`: Tablet/e-reader - `23`: Watch/Wristband e.g. Watch or wristband, including a fitness band, smart strap, disposable band, watch add-on, and security/ID band - `24`: Sticker - `25`: PC - `26`: Device Peripheral e.g. mobile phone case or sleeve - `27`: Tag e.g. key fob or mobile tag - `28`: Jewelry e.g. ring, bracelet, necklace and cuff links - `29`: Fashion Accessory e.g. handbag, bag charm and glasses - `30`: Garment e.g. dress - `31`: Domestic Appliance e.g refrigerator, washing machine - `32`: Vehicle e.g. vehicle, including vehicle attached devices - `33`: Media/Gaming Device e.g. media or gaming device, including a set top box, media player and television 34–99 are reserved for future form factors. Any value in this range may occur within form factor and transaction data without prior notice. This field is supported only for Mastercard on CyberSource through VisaNet. When initiation channel is not provided via this API field, the value is extracted from EMV tag 9F6E for Mastercard transactions. To enable this feature please call support. #### Used by Authorization Optional field.



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

def initiation_channel
  @initiation_channel
end

#instrument_identifierObject

Returns the value of attribute instrument_identifier.



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

def instrument_identifier
  @instrument_identifier
end

#legacy_tokenObject

Returns the value of attribute legacy_token.



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

def legacy_token
  @legacy_token
end

#payment_instrumentObject

Returns the value of attribute payment_instrument.



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

def payment_instrument
  @payment_instrument
end

#payment_typeObject

Returns the value of attribute payment_type.



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

def payment_type
  @payment_type
end

#shipping_addressObject

Returns the value of attribute shipping_address.



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

def shipping_address
  @shipping_address
end

#tokenized_cardObject

Returns the value of attribute tokenized_card.



19
20
21
# File 'lib/cybersource_rest_client/models/ptsv2payments_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.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 43

def self.attribute_map
  {
    :'card' => :'card',
    :'tokenized_card' => :'tokenizedCard',
    :'fluid_data' => :'fluidData',
    :'customer' => :'customer',
    :'payment_instrument' => :'paymentInstrument',
    :'instrument_identifier' => :'instrumentIdentifier',
    :'shipping_address' => :'shippingAddress',
    :'legacy_token' => :'legacyToken',
    :'bank' => :'bank',
    :'payment_type' => :'paymentType',
    :'initiation_channel' => :'initiationChannel',
    :'e_wallet' => :'eWallet'
  }
end

.json_mapObject

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 61

def self.json_map
  {
    :'card' => :'card',
    :'tokenized_card' => :'tokenized_card',
    :'fluid_data' => :'fluid_data',
    :'customer' => :'customer',
    :'payment_instrument' => :'payment_instrument',
    :'instrument_identifier' => :'instrument_identifier',
    :'shipping_address' => :'shipping_address',
    :'legacy_token' => :'legacy_token',
    :'bank' => :'bank',
    :'payment_type' => :'payment_type',
    :'initiation_channel' => :'initiation_channel',
    :'e_wallet' => :'e_wallet'
  }
end

.swagger_typesObject

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 79

def self.swagger_types
  {
    :'card' => :'Ptsv2paymentsPaymentInformationCard',
    :'tokenized_card' => :'Ptsv2paymentsPaymentInformationTokenizedCard',
    :'fluid_data' => :'Ptsv2paymentsPaymentInformationFluidData',
    :'customer' => :'Ptsv2paymentsPaymentInformationCustomer',
    :'payment_instrument' => :'Ptsv2paymentsPaymentInformationPaymentInstrument',
    :'instrument_identifier' => :'Ptsv2paymentsPaymentInformationInstrumentIdentifier',
    :'shipping_address' => :'Ptsv2paymentsPaymentInformationShippingAddress',
    :'legacy_token' => :'Ptsv2paymentsPaymentInformationLegacyToken',
    :'bank' => :'Ptsv2paymentsPaymentInformationBank',
    :'payment_type' => :'Ptsv2paymentsPaymentInformationPaymentType',
    :'initiation_channel' => :'String',
    :'e_wallet' => :'Ptsv2paymentsPaymentInformationEWallet'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 174

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      card == o.card &&
      tokenized_card == o.tokenized_card &&
      fluid_data == o.fluid_data &&
      customer == o.customer &&
      payment_instrument == o.payment_instrument &&
      instrument_identifier == o.instrument_identifier &&
      shipping_address == o.shipping_address &&
      legacy_token == o.legacy_token &&
      bank == o.bank &&
      payment_type == o.payment_type &&
      initiation_channel == o.initiation_channel &&
      e_wallet == o.e_wallet
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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

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



293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 293

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 206

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

See Also:

  • `==` method


193
194
195
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 193

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.



199
200
201
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 199

def hash
  [card, tokenized_card, fluid_data, customer, payment_instrument, instrument_identifier, shipping_address, legacy_token, bank, payment_type, initiation_channel, e_wallet].hash
end

#list_invalid_propertiesObject

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



155
156
157
158
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 155

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)



273
274
275
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 273

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash



279
280
281
282
283
284
285
286
287
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 279

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



267
268
269
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 267

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid



162
163
164
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 162

def valid?
  true
end