Class: CyberSource::Ptsv2paymentsProcessingInformationJapanPaymentOptions

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsProcessingInformationJapanPaymentOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_japan_payment_options.rb', line 96

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

  if attributes.has_key?(:'bonuses')
    if (value = attributes[:'bonuses']).is_a?(Array)
      self.bonuses = value
    end
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#bonuses ⇒ Object

An array of objects, each of which contains a bonus month and bonus amount. Length of bonuses array is equal to the number of bonuses. Max length = 6. In case of bonus month and amount not specified, null objects to be returned in the array. Example: bonuses : [ "1","amount": "200", "3","amount": "2500", null]



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

def bonuses
  @bonuses
end

#business_name ⇒ Object

Business name in Japanese characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet.



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

def business_name
  @business_name
end

#business_name_alpha_numeric ⇒ Object

Business name in alphanumeric characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet.



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

def business_name_alpha_numeric
  @business_name_alpha_numeric
end

#business_name_katakana ⇒ Object

Business name in Katakana characters. This field is supported only on JCN Gateway and for the Sumitomo Mitsui Card Co. acquirer on CyberSource through VisaNet.



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

def business_name_katakana
  @business_name_katakana
end

#first_billing_month ⇒ Object

Billing month in MM format.



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

def first_billing_month
  @first_billing_month
end

#installments ⇒ Object

Number of Installments.



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

def installments
  @installments
end

#jis2_track_data ⇒ Object

Japanese Industrial Standard Type 2 (JIS2) track data from the front of the card. This field is supported only on CyberSource through VisaNet and JCN Gateway. Optional field.



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

def jis2_track_data
  @jis2_track_data
end

#payment_method ⇒ Object

This value is a 2-digit code indicating the payment method. Use Payment Method Code value that applies to the tranasction. - 10 (One-time payment) - 21, 22, 23, 24 (Bonus(one-time)payment) - 61 (Installment payment) - 31, 32, 33, 34 (Integrated (Bonus + Installment)payment) - 80 (Revolving payment)



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

def payment_method
  @payment_method
end

#preapproval_type ⇒ Object

This will contain the details of the kind of transaction that has been processe. Used only for Japan. Possible Values: - 0 = Normal (authorization with amount and clearing/settlement; data capture or paper draft) - 1 = Negative card authorization (authorization-only with 0 or 1 amount) - 2 = Reservation of authorization (authorization-only with amount) - 3 = Cancel transaction - 4 = Merchant-initiated reversal/refund transactions - 5 = Cancel reservation of authorization - 6 = Post authorization



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

def preapproval_type
  @preapproval_type
end

#terminal_id ⇒ Object

Unique Japan Credit Card Association (JCCA) terminal identifier. The difference between this field and the ‘pointOfSaleInformation.terminalID` field is that you can define `pointOfSaleInformation.terminalID`, but `processingInformation.japanPaymentOptions.terminalId` is defined by the JCCA and is used only in Japan. This field is supported only on CyberSource through VisaNet and JCN Gateway. Optional field.



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

def terminal_id
  @terminal_id
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_japan_payment_options.rb', line 47

def self.attribute_map
  {
    :'payment_method' => :'paymentMethod',
    :'bonuses' => :'bonuses',
    :'preapproval_type' => :'preapprovalType',
    :'installments' => :'installments',
    :'terminal_id' => :'terminalId',
    :'first_billing_month' => :'firstBillingMonth',
    :'business_name' => :'businessName',
    :'business_name_katakana' => :'businessNameKatakana',
    :'jis2_track_data' => :'jis2TrackData',
    :'business_name_alpha_numeric' => :'businessNameAlphaNumeric'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'payment_method' => :'payment_method',
    :'bonuses' => :'bonuses',
    :'preapproval_type' => :'preapproval_type',
    :'installments' => :'installments',
    :'terminal_id' => :'terminal_id',
    :'first_billing_month' => :'first_billing_month',
    :'business_name' => :'business_name',
    :'business_name_katakana' => :'business_name_katakana',
    :'jis2_track_data' => :'jis2_track_data',
    :'business_name_alpha_numeric' => :'business_name_alpha_numeric'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'payment_method' => :'String',
    :'bonuses' => :'Array<Ptsv2paymentsProcessingInformationJapanPaymentOptionsBonuses>',
    :'preapproval_type' => :'String',
    :'installments' => :'String',
    :'terminal_id' => :'String',
    :'first_billing_month' => :'String',
    :'business_name' => :'String',
    :'business_name_katakana' => :'String',
    :'jis2_track_data' => :'String',
    :'business_name_alpha_numeric' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payment_method == o.payment_method &&
      bonuses == o.bonuses &&
      preapproval_type == o.preapproval_type &&
      installments == o.installments &&
      terminal_id == o.terminal_id &&
      first_billing_month == o.first_billing_month &&
      business_name == o.business_name &&
      business_name_katakana == o.business_name_katakana &&
      jis2_track_data == o.jis2_track_data &&
      business_name_alpha_numeric == o.business_name_alpha_numeric
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



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

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_japan_payment_options.rb', line 325

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_japan_payment_options.rb', line 238

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


225
226
227
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_japan_payment_options.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



231
232
233
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_japan_payment_options.rb', line 231

def hash
  [payment_method, bonuses, preapproval_type, installments, terminal_id, first_billing_month, business_name, business_name_katakana, jis2_track_data, business_name_alpha_numeric].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



147
148
149
150
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_japan_payment_options.rb', line 147

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



305
306
307
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_japan_payment_options.rb', line 305

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



311
312
313
314
315
316
317
318
319
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_japan_payment_options.rb', line 311

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



299
300
301
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_japan_payment_options.rb', line 299

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



154
155
156
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_japan_payment_options.rb', line 154

def valid?
  true
end