Class: VisaAcceptanceMergedSpec::Card1

Inherits:

BaseModel

Object
CoreLibrary::BaseModel
BaseModel
VisaAcceptanceMergedSpec::Card1

show all

Defined in:: lib/visa_acceptance_merged_spec/models/card1.rb

Overview

Card1 Model.

Instance Attribute Summary collapse

#expiration_month ⇒ String
Two-digit month in which the payment card expires.
#expiration_year ⇒ String
Four-digit year in which the payment card expires.
#hashed_number ⇒ String
Visa Platform Connect This API field will contain the SHA 256 hashed value of PAN.
#prefix ⇒ String
Bank Identification Number (BIN).
#suffix ⇒ String
Last four digits of the cardholder’s account number.
#type ⇒ String
Three-digit value that indicates the card type.

Class Method Summary collapse

.from_hash(hash) ⇒ Object
Creates an instance of the object from a hash.
.names ⇒ Object
A mapping from model property names to API property names.
.nullables ⇒ Object
An array for nullable fields.
.optionals ⇒ Object
An array for optional fields.

Instance Method Summary collapse

#initialize(suffix: SKIP, expiration_month: SKIP, expiration_year: SKIP, type: SKIP, prefix: SKIP, hashed_number: SKIP, additional_properties: nil) ⇒ Card1 constructor
A new instance of Card1.
#inspect ⇒ Object
Provides a debugging-friendly string with detailed object information.
#to_s ⇒ Object
Provides a human-readable string representation of the object.

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(suffix: SKIP, expiration_month: SKIP, expiration_year: SKIP, type: SKIP, prefix: SKIP, hashed_number: SKIP, additional_properties: nil) ⇒ `Card1`

Returns a new instance of Card1.

# File 'lib/visa_acceptance_merged_spec/models/card1.rb', line 266

def initialize(suffix: SKIP, expiration_month: SKIP, expiration_year: SKIP,
               type: SKIP, prefix: SKIP, hashed_number: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @suffix = suffix unless suffix == SKIP
  @expiration_month = expiration_month unless expiration_month == SKIP
  @expiration_year = expiration_year unless expiration_year == SKIP
  @type = type unless type == SKIP
  @prefix = prefix unless prefix == SKIP
  @hashed_number = hashed_number unless hashed_number == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#expiration_month ⇒ `String`

Two-digit month in which the payment card expires. Format: MM. Valid values: 01 through 12. Leading 0 is required.

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 Visa Acceptance to reject your request. However, an invalid expiration date might cause the issuer to reject your request.

Encoded Account Numbers

For encoded account numbers (type=039), if there is no expiration date on the card, use 12.

FDMS Nashville

Required field.

All other processors

Required if pointOfSaleInformation.entryMode=keyed. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. Important It is your responsibility to determine whether a field is required for the transaction you are requesting.

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

Returns:

(String)



60
61
62

# File 'lib/visa_acceptance_merged_spec/models/card1.rb', line 60

def expiration_month
  @expiration_month
end

#expiration_year ⇒ `String`

Four-digit year in which the payment card expires. Format: YYYY.

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 Visa Acceptance to reject your request. However, an invalid expiration date might cause the issuer to reject your request.

Encoded Account Numbers

For encoded account numbers (**type**=039), if there is no expiration date on the card, use 2021.

FDMS Nashville

Required field.

FDC Nashville Global and FDMS South

You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.

All other processors

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

Returns:

(String)



89
90
91

# File 'lib/visa_acceptance_merged_spec/models/card1.rb', line 89

def expiration_year
  @expiration_year
end

#hashed_number ⇒ `String`

Visa Platform Connect

This API field will contain the SHA 256 hashed value of PAN.

Returns:

(String)



235
236
237

# File 'lib/visa_acceptance_merged_spec/models/card1.rb', line 235

def hashed_number
  @hashed_number
end

#prefix ⇒ `String`

Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number.

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

Returns:

(String)



230
231
232

# File 'lib/visa_acceptance_merged_spec/models/card1.rb', line 230

def prefix
  @prefix
end

#suffix ⇒ `String`

Last four digits of the cardholder’s account number. 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.

Google Pay transactions

For PAN-based Google Pay transactions, this field is returned in the API response.

PIN debit

This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder. Returned by PIN debit credit and PIN debit purchase. This field is supported only by the following processors:

American Express Direct
Credit Mutuel-CIC
FDC Nashville Global
OmniPay Direct
SIX

Returns:

(String)



32
33
34

# File 'lib/visa_acceptance_merged_spec/models/card1.rb', line 32

def suffix
  @suffix
end

#type ⇒ `String`

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. 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
008: Optima
009: GE Private Label
010: Beneficial Private Label
011: Twinpay Credit Card
012: Twinpay Debit Card
013: WalMart
014: Enroute
015: Lowe's Consumer
016: Home Depot Consumer
017: MBNA
018: Dick's Sportswear
019: Casual Corner
020: Sears
021: JAL
023: Disney Card
024: Maestro (UK Domestic)[^1]
025: Sam's Club Consumer
026: Sam's Club Business
027: Nico's
028: Paymentech Bill Me Later
029: Bebe
030: Restoration Hardware
031: Delta Online
032: Solo
033: Visa Electron. Do not use this value. Use 001 for all Visa card types.
034: Dankort
035: Laser
036: Cartes Bancaires
037: Carta Si
038: Pinless Debit
039: Encoded account number
040: UATP
041: HOUSEHOLD
042: Maestro (International)[^1]
043: GE MONEY
044: Korean Cards
045: Style Cards
046: JCrew
047: Payeasecn eWallet
048: Payeasecn Bank Transfer
049: Meijer
050: Hipercard
051: Aura
052: Redecard
053: Orico card
054: Elo
055: Capitol One Private Label
056: Carnet
057: Costco Private Label
058: Carnet
059: ValueLink
060: MADA
061: RuPay
062: China UnionPay
063: Falabella Private Label
064: Prompt Card
065: Korean Domestic
066: Banricompras
067: MEEZA
068: PayPak
070: EFTPOS
071: Codensa
072: Olimpica
073: Colsubsidio
074: Tuya
075: Sodexo
076: Naranja
077: Cabal
078: DINELCO
079: PANAL
080: EPM
081: Jaywan [^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

Returns:

(String)



222
223
224

# File 'lib/visa_acceptance_merged_spec/models/card1.rb', line 222

def type
  @type
end

Class Method Details

.from_hash(hash) ⇒ `Object`

Creates an instance of the object from a hash.

# File 'lib/visa_acceptance_merged_spec/models/card1.rb', line 282

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
  expiration_month =
    hash.key?('expirationMonth') ? hash['expirationMonth'] : SKIP
  expiration_year =
    hash.key?('expirationYear') ? hash['expirationYear'] : SKIP
  type = hash.key?('type') ? hash['type'] : SKIP
  prefix = hash.key?('prefix') ? hash['prefix'] : SKIP
  hashed_number = hash.key?('hashedNumber') ? hash['hashedNumber'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  Card1.new(suffix: suffix,
            expiration_month: expiration_month,
            expiration_year: expiration_year,
            type: type,
            prefix: prefix,
            hashed_number: hashed_number,
            additional_properties: additional_properties)
end

.names ⇒ `Object`

A mapping from model property names to API property names.

# File 'lib/visa_acceptance_merged_spec/models/card1.rb', line 238

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['suffix'] = 'suffix'
  @_hash['expiration_month'] = 'expirationMonth'
  @_hash['expiration_year'] = 'expirationYear'
  @_hash['type'] = 'type'
  @_hash['prefix'] = 'prefix'
  @_hash['hashed_number'] = 'hashedNumber'
  @_hash
end

.nullables ⇒ `Object`

An array for nullable fields



262
263
264

# File 'lib/visa_acceptance_merged_spec/models/card1.rb', line 262

def self.nullables
  []
end

.optionals ⇒ `Object`

An array for optional fields

# File 'lib/visa_acceptance_merged_spec/models/card1.rb', line 250

def self.optionals
  %w[
    suffix
    expiration_month
    expiration_year
    type
    prefix
    hashed_number
  ]
end

Instance Method Details

#inspect ⇒ `Object`

Provides a debugging-friendly string with detailed object information.

# File 'lib/visa_acceptance_merged_spec/models/card1.rb', line 321

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} suffix: #{@suffix.inspect}, expiration_month: #{@expiration_month.inspect},"\
  " expiration_year: #{@expiration_year.inspect}, type: #{@type.inspect}, prefix:"\
  " #{@prefix.inspect}, hashed_number: #{@hashed_number.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ `Object`

Provides a human-readable string representation of the object.

# File 'lib/visa_acceptance_merged_spec/models/card1.rb', line 313

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} suffix: #{@suffix}, expiration_month: #{@expiration_month},"\
  " expiration_year: #{@expiration_year}, type: #{@type}, prefix: #{@prefix}, hashed_number:"\
  " #{@hashed_number}, additional_properties: #{@additional_properties}>"
end

Class: VisaAcceptanceMergedSpec::Card1

Overview

Instance Attribute Summary collapse

Visa Platform Connect This API field will contain the SHA 256 hashed value of PAN.

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

Constructor Details

#initialize(suffix: SKIP, expiration_month: SKIP, expiration_year: SKIP, type: SKIP, prefix: SKIP, hashed_number: SKIP, additional_properties: nil) ⇒ Card1

Instance Attribute Details

#expiration_month ⇒ String

Barclays and Streamline

Encoded Account Numbers

FDMS Nashville

All other processors

Google Pay transactions

#expiration_year ⇒ String

Barclays and Streamline

Encoded Account Numbers

FDMS Nashville

FDC Nashville Global and FDMS South

All other processors

Google Pay transactions

#hashed_number ⇒ String

Visa Platform Connect

#prefix ⇒ String

Google Pay transactions

#suffix ⇒ String

Google Pay transactions

PIN debit

#type ⇒ String

Used by

Card Present reply

Google Pay transactions

GPX

Class Method Details

.from_hash(hash) ⇒ Object

.names ⇒ Object

.nullables ⇒ Object

.optionals ⇒ Object

Instance Method Details

#inspect ⇒ Object

#to_s ⇒ Object

#initialize(suffix: SKIP, expiration_month: SKIP, expiration_year: SKIP, type: SKIP, prefix: SKIP, hashed_number: SKIP, additional_properties: nil) ⇒ `Card1`

#expiration_month ⇒ `String`

#expiration_year ⇒ `String`

#hashed_number ⇒ `String`

#prefix ⇒ `String`

#suffix ⇒ `String`

#type ⇒ `String`

.from_hash(hash) ⇒ `Object`

.names ⇒ `Object`

.nullables ⇒ `Object`

.optionals ⇒ `Object`

#inspect ⇒ `Object`

#to_s ⇒ `Object`