Class: CyberSource::Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

Instance Attribute Details

#auth_type ⇒ Object

Authorization type. Possible values: - ‘AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see "Verbal Authorizations" in [Credit Card Services Using the SCMP API](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).



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

def auth_type
  @auth_type
end

#verbal_auth_code ⇒ Object

Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the ‘auth_code` field description in [Credit Card Services Using the SCMP API](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).



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

def verbal_auth_code
  @verbal_auth_code
end

#verbal_auth_transaction_id ⇒ Object

Transaction ID (TID). #### FDMS South This field is required for verbal authorizations and forced captures with the American Express card type to comply with the CAPN requirements: - Forced capture: Obtain the value for this field from the authorization response. - Verbal authorization: You cannot obtain a value for this field so CyberSource uses the default value of ‘000000000000000` (15 zeros).



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

def verbal_auth_transaction_id
  @verbal_auth_transaction_id
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb', line 27

def self.attribute_map
  {
    :'auth_type' => :'authType',
    :'verbal_auth_code' => :'verbalAuthCode',
    :'verbal_auth_transaction_id' => :'verbalAuthTransactionId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



36
37
38
39
40
41
42
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb', line 36

def self.swagger_types
  {
    :'auth_type' => :'String',
    :'verbal_auth_code' => :'String',
    :'verbal_auth_transaction_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



98
99
100
101
102
103
104
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb', line 98

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



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

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



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

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb', line 121

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


108
109
110
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb', line 108

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



114
115
116
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb', line 114

def hash
  [auth_type, verbal_auth_code, verbal_auth_transaction_id].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



67
68
69
70
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb', line 67

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



188
189
190
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb', line 188

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



194
195
196
197
198
199
200
201
202
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb', line 194

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



182
183
184
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb', line 182

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



74
75
76
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb', line 74

def valid?
  true
end