class CyberSource::Riskv1addressverificationsOrderInformationBillTo
Attributes
Payment card billing street address as it appears on the credit card issuer’s records. #### Atos This field must not contain colons (:). #### CyberSource
through VisaNet Important When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource
through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource
through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource
through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource
through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource
through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. Important It is your responsibility to determine whether a field is required for the transaction you are requesting.
Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### CyberSource
through VisaNet Important When you populate `orderInformation.billTo.address1` and `orderInformation.billTo.address2`, CyberSource
through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource
through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource
through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource
through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource
through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60)
Additional address information (third line of the billing address)
Additional address information (fourth line of the billing address)
State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource
through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource
through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource
through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource
through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
Payment card billing country. Use the two-character [ISO Standard Country Codes](apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource
through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource
through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource
through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource
through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
Payment card billing city. #### Atos This field must not contain colons (:). #### CyberSource
through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource
through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource
through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource
through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][4 digits] Example `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][alpha][numeric][numeric] Example `A1B 2C3` Important It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource
removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource
through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource
through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource
through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource
through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is not in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb, line 42 def self.attribute_map { :'address1' => :'address1', :'address2' => :'address2', :'address3' => :'address3', :'address4' => :'address4', :'administrative_area' => :'administrativeArea', :'country' => :'country', :'locality' => :'locality', :'postal_code' => :'postalCode' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb, line 71 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?(:'address1') self.address1 = attributes[:'address1'] end if attributes.has_key?(:'address2') self.address2 = attributes[:'address2'] end if attributes.has_key?(:'address3') self.address3 = attributes[:'address3'] end if attributes.has_key?(:'address4') self.address4 = attributes[:'address4'] end if attributes.has_key?(:'administrativeArea') self.administrative_area = attributes[:'administrativeArea'] end if attributes.has_key?(:'country') self.country = attributes[:'country'] end if attributes.has_key?(:'locality') self.locality = attributes[:'locality'] end if attributes.has_key?(:'postalCode') self.postal_code = attributes[:'postalCode'] end end
Attribute type mapping.
# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb, line 56 def self.swagger_types { :'address1' => :'String', :'address2' => :'String', :'address3' => :'String', :'address4' => :'String', :'administrative_area' => :'String', :'country' => :'String', :'locality' => :'String', :'postal_code' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb, line 209 def ==(o) return true if self.equal?(o) self.class == o.class && address1 == o.address1 && address2 == o.address2 && address3 == o.address3 && address4 == o.address4 && administrative_area == o.administrative_area && country == o.country && locality == o.locality && postal_code == o.postal_code 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/riskv1addressverifications_order_information_bill_to.rb, line 258 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/riskv1addressverifications_order_information_bill_to.rb, line 324 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/riskv1addressverifications_order_information_bill_to.rb, line 145 def address1=(address1) if address1.nil? fail ArgumentError, 'address1 cannot be nil' end @address1 = address1 end
Custom attribute writer method with validation @param [Object] address2 Value to be assigned
# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb, line 155 def address2=(address2) @address2 = address2 end
Custom attribute writer method with validation @param [Object] address3 Value to be assigned
# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb, line 161 def address3=(address3) @address3 = address3 end
Custom attribute writer method with validation @param [Object] address4 Value to be assigned
# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb, line 167 def address4=(address4) @address4 = address4 end
Custom attribute writer method with validation @param [Object] administrative_area
Value to be assigned
# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb, line 173 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/riskv1addressverifications_order_information_bill_to.rb, line 237 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] country Value to be assigned
# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb, line 179 def country=(country) if country.nil? fail ArgumentError, 'country cannot be nil' end @country = country end
@see the `==` method @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb, line 224 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb, line 230 def hash [address1, address2, address3, address4, administrative_area, country, locality, postal_code].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/riskv1addressverifications_order_information_bill_to.rb, line 112 def list_invalid_properties invalid_properties = Array.new if @address1.nil? invalid_properties.push('invalid value for "address1", address1 cannot be nil.') end if @country.nil? invalid_properties.push('invalid value for "country", country cannot be nil.') end if @locality.nil? invalid_properties.push('invalid value for "locality", locality cannot be nil.') end if @postal_code.nil? invalid_properties.push('invalid value for "postal_code", postal_code cannot be nil.') end invalid_properties end
Custom attribute writer method with validation @param [Object] locality Value to be assigned
# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb, line 189 def locality=(locality) if locality.nil? fail ArgumentError, 'locality cannot be nil' end @locality = locality end
Custom attribute writer method with validation @param [Object] postal_code
Value to be assigned
# File lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb, line 199 def postal_code=(postal_code) if postal_code.nil? fail ArgumentError, 'postal_code cannot be nil' end @postal_code = postal_code 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/riskv1addressverifications_order_information_bill_to.rb, line 310 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/riskv1addressverifications_order_information_bill_to.rb, line 298 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/riskv1addressverifications_order_information_bill_to.rb, line 135 def valid? return false if @address1.nil? return false if @country.nil? return false if @locality.nil? return false if @postal_code.nil? true end