class CyberSource::PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard
Attributes
Confidence level of the tokenization. This value is assigned by the token service provider. Note This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. Returned by PIN debit credit or PIN debit purchase.
One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` NOTE The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource
to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\ Important It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource
includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer NOTE The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource
to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource
includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
First six digits of token. CyberSource
includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For details, see `token_prefix` field description in [Google Pay Using the SCMP API.] (apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/)
Value that identifies your business and indicates that the cardholder’s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider’s database. Note This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. #### PIN debit Optional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.
Last four digits of token. CyberSource
includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For details, see `token_suffix` field description in [Google Pay Using the SCMP API.] (apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/)
Three-digit value that indicates the card type. IMPORTANT It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche - `007`: JCB - `014`: Enroute - `021`: JAL - `024`: Maestro (UK Domestic) - `031`: Delta: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort - `036`: Cartes Bancaires - `037`: Carta Si - `039`: Encoded account number - `040`: UATP - `042`: Maestro (International) - `050`: Hipercard - `051`: Aura - `054`: Elo - `062`: China UnionPay [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by Authorization Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb, line 39 def self.attribute_map { :'prefix' => :'prefix', :'suffix' => :'suffix', :'type' => :'type', :'assurance_level' => :'assuranceLevel', :'expiration_month' => :'expirationMonth', :'expiration_year' => :'expirationYear', :'requestor_id' => :'requestorId' } 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_payment_information_tokenized_card.rb, line 66 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?(:'prefix') self.prefix = attributes[:'prefix'] end if attributes.has_key?(:'suffix') self.suffix = attributes[:'suffix'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'assuranceLevel') self.assurance_level = attributes[:'assuranceLevel'] end if attributes.has_key?(:'expirationMonth') self.expiration_month = attributes[:'expirationMonth'] end if attributes.has_key?(:'expirationYear') self.expiration_year = attributes[:'expirationYear'] end if attributes.has_key?(:'requestorId') self.requestor_id = attributes[:'requestorId'] end end
Attribute type mapping.
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb, line 52 def self.swagger_types { :'prefix' => :'String', :'suffix' => :'String', :'type' => :'String', :'assurance_level' => :'String', :'expiration_month' => :'String', :'expiration_year' => :'String', :'requestor_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_payment_information_tokenized_card.rb, line 152 def ==(o) return true if self.equal?(o) self.class == o.class && prefix == o.prefix && suffix == o.suffix && type == o.type && assurance_level == o.assurance_level && expiration_month == o.expiration_month && expiration_year == o.expiration_year && requestor_id == o.requestor_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_payment_information_tokenized_card.rb, line 200 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_payment_information_tokenized_card.rb, line 266 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] assurance_level
Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb, line 128 def assurance_level=(assurance_level) @assurance_level = assurance_level 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_payment_information_tokenized_card.rb, line 179 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_payment_information_tokenized_card.rb, line 166 def eql?(o) self == o end
Custom attribute writer method with validation @param [Object] expiration_month
Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb, line 134 def expiration_month=(expiration_month) @expiration_month = expiration_month end
Custom attribute writer method with validation @param [Object] expiration_year
Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb, line 140 def expiration_year=(expiration_year) @expiration_year = expiration_year end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb, line 172 def hash [prefix, suffix, type, assurance_level, expiration_month, expiration_year, requestor_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_payment_information_tokenized_card.rb, line 103 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method with validation @param [Object] prefix Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb, line 116 def prefix=(prefix) @prefix = prefix end
Custom attribute writer method with validation @param [Object] requestor_id
Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb, line 146 def requestor_id=(requestor_id) @requestor_id = requestor_id end
Custom attribute writer method with validation @param [Object] suffix Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb, line 122 def suffix=(suffix) @suffix = suffix 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_payment_information_tokenized_card.rb, line 252 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_payment_information_tokenized_card.rb, line 240 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_payment_information_tokenized_card.rb, line 110 def valid? true end