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

Parameters:

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

    Model attributes in the form of hash



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
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 117

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

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

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

Instance Attribute Details

#bank ⇒ Object

Returns the value of attribute bank.



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

def bank
  @bank
end

#card ⇒ Object

Returns the value of attribute card.



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

def card
  @card
end

#customer ⇒ Object

Returns the value of attribute customer.



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

def customer
  @customer
end

#direct_debit ⇒ Object

Returns the value of attribute direct_debit.



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

def direct_debit
  @direct_debit
end

#e_wallet ⇒ Object

Returns the value of attribute e_wallet.



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

def e_wallet
  @e_wallet
end

#fluid_data ⇒ Object

Returns the value of attribute fluid_data.



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

def fluid_data
  @fluid_data
end

#initiation_channel ⇒ Object

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.



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

def initiation_channel
  @initiation_channel
end

#instrument_identifier ⇒ Object

Returns the value of attribute instrument_identifier.



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

def instrument_identifier
  @instrument_identifier
end

#legacy_token ⇒ Object

Returns the value of attribute legacy_token.



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

def legacy_token
  @legacy_token
end

#options ⇒ Object

Returns the value of attribute options.



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

def options
  @options
end

#payment_account_reference ⇒ Object

Returns the value of attribute payment_account_reference.



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

def 
  @payment_account_reference
end

#payment_instrument ⇒ Object

Returns the value of attribute payment_instrument.



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

def payment_instrument
  @payment_instrument
end

#payment_type ⇒ Object

Returns the value of attribute payment_type.



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

def payment_type
  @payment_type
end

#sepa ⇒ Object

Returns the value of attribute sepa.



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

def sepa
  @sepa
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



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

def shipping_address
  @shipping_address
end

#tokenized_card ⇒ Object

Returns the value of attribute tokenized_card.



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

def tokenized_card
  @tokenized_card
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.json_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 94

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      card == o.card &&
      tokenized_card == o.tokenized_card &&
      direct_debit == o.direct_debit &&
      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 &&
      options == o.options &&
      payment_type == o.payment_type &&
      initiation_channel == o.initiation_channel &&
      sepa == o.sepa &&
      e_wallet == o.e_wallet &&
       == o.
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



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

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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 332

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 245

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


232
233
234
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 232

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



238
239
240
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 238

def hash
  [card, tokenized_card, direct_debit, fluid_data, customer, payment_instrument, instrument_identifier, shipping_address, legacy_token, bank, options, payment_type, initiation_channel, sepa, e_wallet, ].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



190
191
192
193
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 190

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



312
313
314
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 312

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



318
319
320
321
322
323
324
325
326
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 318

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



306
307
308
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 306

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



197
198
199
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb', line 197

def valid?
  true
end