class CyberSource::PtsV2PaymentsPost201ResponsePointOfSaleInformation
Attributes
Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource
generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource
, CyberSource
passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource
and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. For details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. #### CyberSource
through VisaNet A list of all possible values is stored in your CyberSource
account. If terminal ID validation is enabled for your CyberSource
account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource
Customer Support. When you do not include this field in a request, CyberSource
uses the default value that is defined in your CyberSource
account. #### FDC Nashville Global To have your account configured to support this field, contact CyberSource
Customer Support. This value must be a value that FDC Nashville Global issued to you. #### For Payouts This field is applicable for CyberSource
through VisaNet. #### GPX Identifier for the terminal at your retail location. A list of all possible values is stored in your account. If terminal ID validation is enabled for your account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact customer support. When you do not include this field in a request, the default value that is defined in your account is used. Optional for authorizations. #### Used by Authorization Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX - Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include `pointOfSaleInformation.catLevel`. - FDMS Nashville: The default value that is defined in your account is used. - GPX - OmniPay Direct: Optional field. For the following processors, this field is not used. - GPN - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions - Worldpay VAP #### Card Present reply Terminal identifier assigned by the acquirer. This value must be printed on the receipt.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb, line 26 def self.attribute_map { :'emv' => :'emv', :'amex_capn_data' => :'amexCapnData', :'terminal_id' => :'terminalId' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb, line 45 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?(:'emv') self.emv = attributes[:'emv'] end if attributes.has_key?(:'amexCapnData') self.amex_capn_data = attributes[:'amexCapnData'] end if attributes.has_key?(:'terminalId') self.terminal_id = attributes[:'terminalId'] end end
Attribute type mapping.
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb, line 35 def self.swagger_types { :'emv' => :'PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv', :'amex_capn_data' => :'String', :'terminal_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb, line 91 def ==(o) return true if self.equal?(o) self.class == o.class && emv == o.emv && amex_capn_data == o.amex_capn_data && terminal_id == o.terminal_id end
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/pts_v2_payments_post201_response_point_of_sale_information.rb, line 135 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
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/pts_v2_payments_post201_response_point_of_sale_information.rb, line 201 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
Custom attribute writer method with validation @param [Object] amex_capn_data
Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb, line 79 def amex_capn_data=(amex_capn_data) @amex_capn_data = amex_capn_data end
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/pts_v2_payments_post201_response_point_of_sale_information.rb, line 114 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
@see the `==` method @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb, line 101 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb, line 107 def hash [emv, amex_capn_data, terminal_id].hash end
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/pts_v2_payments_post201_response_point_of_sale_information.rb, line 66 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method with validation @param [Object] terminal_id
Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb, line 85 def terminal_id=(terminal_id) @terminal_id = terminal_id end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb, line 187 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb, line 175 def to_s to_hash.to_s end
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/pts_v2_payments_post201_response_point_of_sale_information.rb, line 73 def valid? true end