Class: CyberSource::Ptsv2paymentsMerchantDefinedInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsMerchantDefinedInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_defined_information.rb', line 41

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

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

Instance Attribute Details

#key ⇒ Object

The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference ‘merchantDefinedInformation.key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation.key` and `merchantDefinedInformation.key` for data that you want to provide to the issuer to identify the transaction. For details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)



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

def key
  @key
end

#value ⇒ Object

The value you assign for your merchant-defined data field. For details, see ‘merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) Warning Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver’s license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant’s account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use ‘merchantDefinedInformation.value` and `merchantDefinedInformation.value` for data that you want to provide to the issuer to identify the transaction. For details, see "Installment Payments on CyberSource through VisaNet" in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For details, see "Installment Payments on CyberSource through VisaNet" in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation.value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation.value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3



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

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_defined_information.rb', line 24

def self.attribute_map
  {
    :'key' => :'key',
    :'value' => :'value'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_defined_information.rb', line 32

def self.swagger_types
  {
    :'key' => :'String',
    :'value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



83
84
85
86
87
88
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_defined_information.rb', line 83

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      key == o.key &&
      value == o.value
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



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

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



192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_defined_information.rb', line 192

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_defined_information.rb', line 105

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("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



98
99
100
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_defined_information.rb', line 98

def hash
  [key, value].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



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

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



172
173
174
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_defined_information.rb', line 172

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



178
179
180
181
182
183
184
185
186
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_defined_information.rb', line 178

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



166
167
168
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_defined_information.rb', line 166

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



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

def valid?
  true
end