class CyberSource::Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions

Attributes

auth_type[RW]

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).

verbal_auth_code[RW]

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).

verbal_auth_transaction_id[RW]

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).

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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
auth_type=(auth_type) click to toggle source

Custom attribute writer method with validation @param [Object] auth_type Value to be assigned

# File lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb, line 80
def auth_type=(auth_type)
  @auth_type = auth_type
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb, line 108
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb, line 188
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb, line 182
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb, line 74
def valid?
  true
end
verbal_auth_code=(verbal_auth_code) click to toggle source

Custom attribute writer method with validation @param [Object] verbal_auth_code Value to be assigned

# File lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb, line 86
def verbal_auth_code=(verbal_auth_code)
  @verbal_auth_code = verbal_auth_code
end
verbal_auth_transaction_id=(verbal_auth_transaction_id) click to toggle source

Custom attribute writer method with validation @param [Object] verbal_auth_transaction_id Value to be assigned

# File lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb, line 92
def verbal_auth_transaction_id=(verbal_auth_transaction_id)
  @verbal_auth_transaction_id = verbal_auth_transaction_id
end