class CyberSource::Ptsv2paymentsAggregatorInformationSubMerchant
Attributes
First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource
through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters.
Sub-merchant’s state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource
through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters.
Unique identifier assigned by the payment card company to the sub-merchant.
Sub-merchant’s country. Use the [ISO Standard Country Codes](developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource
through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. For details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - CyberSource
through VisaNet: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### CyberSource
through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address Note The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource
. CyberSource
through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.
The ID you assigned to your sub-merchant. CyberSource
through VisaNet: For American Express transaction, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 65-84 - Field: American Express Seller ID For Mastercard transactions, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 117-131 - Field: Mastercard Sub-Merchant ID FDC Compass: This value must consist of uppercase characters. American Express Direct: String (20) CyberSource
through VisaNet with American Express: String (20) CyberSource
through VisaNet with Mastercard: String (15) FDC Compass: String (20) FDC Nashville Global: String (14)
Sub-merchant’s city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource
through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters.
Sub-merchant’s business name. #### American Express Direct The maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. #### CyberSource
through VisaNet With American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.
Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - CyberSource
through VisaNet: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### CyberSource
through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\ This value must consist of uppercase characters. Use one of these recommended formats:\ `NNN-NNN-NNNN`\ `NNN-AAAAAAA`
Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource
through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters.
Sub-merchant’s region. Example\ `NE` indicates that the sub-merchant is in the northeast region. For processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 51 def self.attribute_map { :'card_acceptor_id' => :'cardAcceptorId', :'id' => :'id', :'name' => :'name', :'address1' => :'address1', :'locality' => :'locality', :'administrative_area' => :'administrativeArea', :'region' => :'region', :'postal_code' => :'postalCode', :'country' => :'country', :'email' => :'email', :'phone_number' => :'phoneNumber' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 86 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?(:'cardAcceptorId') self.card_acceptor_id = attributes[:'cardAcceptorId'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'address1') self.address1 = attributes[:'address1'] end if attributes.has_key?(:'locality') self.locality = attributes[:'locality'] end if attributes.has_key?(:'administrativeArea') self.administrative_area = attributes[:'administrativeArea'] end if attributes.has_key?(:'region') self.region = attributes[:'region'] end if attributes.has_key?(:'postalCode') self.postal_code = attributes[:'postalCode'] end if attributes.has_key?(:'country') self.country = attributes[:'country'] end if attributes.has_key?(:'email') self.email = attributes[:'email'] end if attributes.has_key?(:'phoneNumber') self.phone_number = attributes[:'phoneNumber'] end end
Attribute type mapping.
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 68 def self.swagger_types { :'card_acceptor_id' => :'String', :'id' => :'String', :'name' => :'String', :'address1' => :'String', :'locality' => :'String', :'administrative_area' => :'String', :'region' => :'String', :'postal_code' => :'String', :'country' => :'String', :'email' => :'String', :'phone_number' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 218 def ==(o) return true if self.equal?(o) self.class == o.class && card_acceptor_id == o.card_acceptor_id && id == o.id && name == o.name && address1 == o.address1 && locality == o.locality && administrative_area == o.administrative_area && region == o.region && postal_code == o.postal_code && country == o.country && email == o.email && phone_number == o.phone_number 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/ptsv2payments_aggregator_information_sub_merchant.rb, line 270 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/ptsv2payments_aggregator_information_sub_merchant.rb, line 336 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] address1 Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 170 def address1=(address1) @address1 = address1 end
Custom attribute writer method with validation @param [Object] administrative_area
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 182 def administrative_area=(administrative_area) @administrative_area = administrative_area 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/ptsv2payments_aggregator_information_sub_merchant.rb, line 249 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
Custom attribute writer method with validation @param [Object] card_acceptor_id
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 152 def card_acceptor_id=(card_acceptor_id) @card_acceptor_id = card_acceptor_id end
Custom attribute writer method with validation @param [Object] country Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 200 def country=(country) @country = country end
Custom attribute writer method with validation @param [Object] email Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 206 def email=(email) @email = email end
@see the `==` method @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 236 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 242 def hash [card_acceptor_id, id, name, address1, locality, administrative_area, region, postal_code, country, email, phone_number].hash end
Custom attribute writer method with validation @param [Object] id Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 158 def id=(id) @id = id 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/ptsv2payments_aggregator_information_sub_merchant.rb, line 139 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method with validation @param [Object] locality Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 176 def locality=(locality) @locality = locality end
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 164 def name=(name) @name = name end
Custom attribute writer method with validation @param [Object] phone_number
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 212 def phone_number=(phone_number) @phone_number = phone_number end
Custom attribute writer method with validation @param [Object] postal_code
Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 194 def postal_code=(postal_code) @postal_code = postal_code end
Custom attribute writer method with validation @param [Object] region Value to be assigned
# File lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb, line 188 def region=(region) @region = region 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/ptsv2payments_aggregator_information_sub_merchant.rb, line 322 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/ptsv2payments_aggregator_information_sub_merchant.rb, line 310 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/ptsv2payments_aggregator_information_sub_merchant.rb, line 146 def valid? true end