Class: ActiveMerchant::Billing::CreditCard

Inherits:
Model
  • Object
show all
Includes:
CreditCardMethods
Defined in:
lib/active_merchant/billing/credit_card.rb

Overview

A CreditCard object represents a physical credit card, and is capable of validating the various data associated with these.

At the moment, the following credit card types are supported:

  • Visa

  • MasterCard

  • Discover

  • American Express

  • Diner's Club

  • JCB

  • Dankort

  • Maestro

  • Forbrugsforeningen

  • Elo

  • Alelo

  • Cabal

  • Naranja

  • UnionPay

  • Alia

  • Olimpica

For testing purposes, use the 'bogus' credit card brand. This skips the vast majority of validations, allowing you to focus on your core concerns until you're ready to be more concerned with the details of particular credit cards or your gateway.

Testing With CreditCard

Often when testing we don't care about the particulars of a given card brand. When using the 'test' mode in your Gateway, there are six different valid card numbers: 1, 2, 3, 'success', 'fail', and 'error'.

For details, see ActiveMerchant::Billing::CreditCardMethods::ClassMethods#valid_number?

Example Usage

cc = CreditCard.new(
  :first_name         => 'Steve',
  :last_name          => 'Smith',
  :month              => '9',
  :year               => '2017',
  :brand              => 'visa',
  :number             => '4242424242424242',
  :verification_value => '424'
)

cc.validate # => {}
cc.display_number # => XXXX-XXXX-XXXX-4242

Direct Known Subclasses

NetworkTokenizationCreditCard

Defined Under Namespace

Classes: ExpiryDate

Constant Summary collapse

READ_METHOD_DESCRIPTIONS =
{
  nil => 'A card reader was not used.',
  'fallback_no_chip' => 'Magstripe was read because the card has no chip.',
  'fallback_chip_error' => "Magstripe was read because the card's chip failed.",
  'contactless' => 'Data was read by a Contactless EMV kernel. Issuer script results are not available.',
  'contactless_magstripe' => 'Contactless data was read with a non-EMV protocol.',
  'contact' => 'Data was read using the EMV protocol. Issuer script results may follow.',
  'contact_quickchip' => 'Data was read by the Quickchip EMV kernel. Issuer script results are not available.'
}

Constants included from CreditCardMethods

ActiveMerchant::Billing::CreditCardMethods::ALELO_RANGES, ActiveMerchant::Billing::CreditCardMethods::CABAL_RANGES, ActiveMerchant::Billing::CreditCardMethods::CARD_COMPANY_DETECTORS, ActiveMerchant::Billing::CreditCardMethods::CARNET_BINS, ActiveMerchant::Billing::CreditCardMethods::CARNET_RANGES, ActiveMerchant::Billing::CreditCardMethods::ELECTRON_RANGES, ActiveMerchant::Billing::CreditCardMethods::ELO_RANGES, ActiveMerchant::Billing::CreditCardMethods::MAESTRO_BINS, ActiveMerchant::Billing::CreditCardMethods::MAESTRO_RANGES, ActiveMerchant::Billing::CreditCardMethods::MASTERCARD_RANGES, ActiveMerchant::Billing::CreditCardMethods::NARANJA_RANGES, ActiveMerchant::Billing::CreditCardMethods::UNIONPAY_RANGES

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from CreditCardMethods

#card_verification_value_length, #credit_card?, #electron?, in_bin_range?, included, #valid_card_verification_value?, #valid_expiry_year?, #valid_issue_number?, #valid_month?, #valid_start_year?

Methods inherited from Model

#initialize

Methods included from ActiveMerchant::Billing::Compatibility::Model

#errors, #valid?

Constructor Details

This class inherits a constructor from ActiveMerchant::Billing::Model

Class Attribute Details

.require_nameObject

Returns the value of attribute require_name


60
61
62
# File 'lib/active_merchant/billing/credit_card.rb', line 60

def require_name
  @require_name
end

.require_verification_valueObject

Inherited, but can be overridden w/o changing parent's value


59
60
61
# File 'lib/active_merchant/billing/credit_card.rb', line 59

def require_verification_value
  @require_verification_value
end

Instance Attribute Details

#encrypted_pin_cryptogramString

Returns the ciphertext of the card's encrypted PIN.

Returns:

  • (String)

202
203
204
# File 'lib/active_merchant/billing/credit_card.rb', line 202

def encrypted_pin_cryptogram
  @encrypted_pin_cryptogram
end

#encrypted_pin_ksnString

Returns the Key Serial Number (KSN) of the card's encrypted PIN.

Returns:

  • (String)

207
208
209
# File 'lib/active_merchant/billing/credit_card.rb', line 207

def encrypted_pin_ksn
  @encrypted_pin_ksn
end

#first_nameString

Returns or sets the first name of the card holder.

Returns:

  • (String)

126
127
128
# File 'lib/active_merchant/billing/credit_card.rb', line 126

def first_name
  @first_name
end

#icc_dataString

Returns or sets the ICC/ASN1 credit card data for a EMV transaction, typically this is a BER-encoded TLV string.

Returns:

  • (String)

182
183
184
# File 'lib/active_merchant/billing/credit_card.rb', line 182

def icc_data
  @icc_data
end

#last_nameString

Returns or sets the last name of the card holder.

Returns:

  • (String)

131
132
133
# File 'lib/active_merchant/billing/credit_card.rb', line 131

def last_name
  @last_name
end

#manual_entrytrue, false

Returns or sets whether a card has been processed using manual entry.

This attribute is optional and is only used by gateways who use this information in their transaction risk calculations. See this page on ‘card not present’ transactions for further explanation and examples of this kind of transaction.

Returns:

  • (true, false)

177
178
179
# File 'lib/active_merchant/billing/credit_card.rb', line 177

def manual_entry
  @manual_entry
end

#monthInteger (readonly)

Returns or sets the expiry month for the card.

Returns:

  • (Integer)

78
79
80
# File 'lib/active_merchant/billing/credit_card.rb', line 78

def month
  @month
end

#numberString

Returns or sets the credit card number.

Returns:

  • (String)

69
70
71
# File 'lib/active_merchant/billing/credit_card.rb', line 69

def number
  @number
end

#read_methodString

Returns or sets information about the source of the card data.

Returns:

  • (String)

187
188
189
# File 'lib/active_merchant/billing/credit_card.rb', line 187

def read_method
  @read_method
end

#track_dataString

Returns or sets the track data for the card

Returns:

  • (String)

168
169
170
# File 'lib/active_merchant/billing/credit_card.rb', line 168

def track_data
  @track_data
end

#verification_valueString

Returns or sets the card verification value.

This attribute is optional but recommended. The verification value is a card security code. If provided, the gateway will attempt to validate the value.

Returns:

  • (String)

    the verification value


140
141
142
# File 'lib/active_merchant/billing/credit_card.rb', line 140

def verification_value
  @verification_value
end

#yearInteger (readonly)

Returns or sets the expiry year for the card.

Returns:

  • (Integer)

83
84
85
# File 'lib/active_merchant/billing/credit_card.rb', line 83

def year
  @year
end

Class Method Details

.requires_name?Boolean

Returns:

  • (Boolean)

319
320
321
# File 'lib/active_merchant/billing/credit_card.rb', line 319

def self.requires_name?
  require_name
end

.requires_verification_value?Boolean

Returns:

  • (Boolean)

315
316
317
# File 'lib/active_merchant/billing/credit_card.rb', line 315

def self.requires_verification_value?
  require_verification_value
end

Instance Method Details

#brandString

Returns or sets the credit card brand.

Valid card types are

  • 'visa'

  • 'master'

  • 'discover'

  • 'american_express'

  • 'diners_club'

  • 'jcb'

  • 'dankort'

  • 'maestro'

  • 'forbrugsforeningen'

  • 'elo'

  • 'alelo'

  • 'cabal'

  • 'naranja'

  • 'union_pay'

  • 'alia'

  • 'olimpica'

  • 'creditel'

Or, if you wish to test your implementation, 'bogus'.

Returns:

  • (String)

    the credit card brand


110
111
112
113
114
115
116
# File 'lib/active_merchant/billing/credit_card.rb', line 110

def brand
  if !defined?(@brand) || empty?(@brand)
    self.class.brand?(number)
  else
    @brand
  end
end

#brand=(value) ⇒ Object


118
119
120
121
# File 'lib/active_merchant/billing/credit_card.rb', line 118

def brand=(value)
  value = value && value.to_s.dup
  @brand = (value.respond_to?(:downcase) ? value.downcase : value)
end

#display_numberString

Returns a display-friendly version of the card number.

All but the last 4 numbers are replaced with an “X”, and hyphens are inserted in order to improve legibility.

Examples:

credit_card = CreditCard.new(:number => "2132542376824338")
credit_card.display_number  # "XXXX-XXXX-XXXX-4338"

Returns:

  • (String)

    a display-friendly version of the card number


288
289
290
# File 'lib/active_merchant/billing/credit_card.rb', line 288

def display_number
  self.class.mask(number)
end

#emv?Boolean

Returns:

  • (Boolean)

323
324
325
# File 'lib/active_merchant/billing/credit_card.rb', line 323

def emv?
  icc_data.present?
end

#expired?Boolean

Returns whether the credit card has expired.

Returns:

  • (Boolean)

    true if the card has expired, false otherwise


229
230
231
# File 'lib/active_merchant/billing/credit_card.rb', line 229

def expired?
  expiry_date.expired?
end

#expiry_dateExpiryDate

Provides proxy access to an expiry date object

Returns:


222
223
224
# File 'lib/active_merchant/billing/credit_card.rb', line 222

def expiry_date
  ExpiryDate.new(@month, @year)
end

#first_digitsObject


292
293
294
# File 'lib/active_merchant/billing/credit_card.rb', line 292

def first_digits
  self.class.first_digits(number)
end

#first_name?Boolean

Returns whether the first_name attribute has been set.

Returns:

  • (Boolean)

239
240
241
# File 'lib/active_merchant/billing/credit_card.rb', line 239

def first_name?
  first_name.present?
end

#last_digitsObject


296
297
298
# File 'lib/active_merchant/billing/credit_card.rb', line 296

def last_digits
  self.class.last_digits(number)
end

#last_name?Boolean

Returns whether the last_name attribute has been set.

Returns:

  • (Boolean)

244
245
246
# File 'lib/active_merchant/billing/credit_card.rb', line 244

def last_name?
  last_name.present?
end

#nameString

Returns the full name of the card holder.

Returns:

  • (String)

    the full name of the card holder


251
252
253
# File 'lib/active_merchant/billing/credit_card.rb', line 251

def name
  "#{first_name} #{last_name}".strip
end

#name=(full_name) ⇒ Object


255
256
257
258
259
# File 'lib/active_merchant/billing/credit_card.rb', line 255

def name=(full_name)
  names = full_name.split
  self.last_name  = names.pop
  self.first_name = names.join(' ')
end

#name?Boolean

Returns whether either the first_name or the last_name attributes has been set.

Returns:

  • (Boolean)

234
235
236
# File 'lib/active_merchant/billing/credit_card.rb', line 234

def name?
  first_name? || last_name?
end

#require_verification_value=(value) ⇒ Boolean

Sets if the credit card requires a verification value.

Returns:

  • (Boolean)

145
146
147
148
# File 'lib/active_merchant/billing/credit_card.rb', line 145

def require_verification_value=(value)
  @require_verification_value_set = true
  @require_verification_value = value
end

#requires_verification_value?Boolean

Returns if this credit card needs a verification value.

By default this returns the configured value from `CreditCard.require_verification_value`, but one can set a per instance requirement with `credit_card.require_verification_value = false`.

Returns:

  • (Boolean)

156
157
158
159
160
161
162
163
# File 'lib/active_merchant/billing/credit_card.rb', line 156

def requires_verification_value?
  @require_verification_value_set ||= false
  if @require_verification_value_set
    @require_verification_value
  else
    self.class.requires_verification_value?
  end
end

#typeObject


209
210
211
212
# File 'lib/active_merchant/billing/credit_card.rb', line 209

def type
  ActiveMerchant.deprecated 'CreditCard#type is deprecated and will be removed from a future release of ActiveMerchant. Please use CreditCard#brand instead.'
  brand
end

#type=(value) ⇒ Object


214
215
216
217
# File 'lib/active_merchant/billing/credit_card.rb', line 214

def type=(value)
  ActiveMerchant.deprecated 'CreditCard#type is deprecated and will be removed from a future release of ActiveMerchant. Please use CreditCard#brand instead.'
  self.brand = value
end

#validateObject

Validates the credit card details.

Any validation errors are added to the ActiveMerchant::Billing::Compatibility::Model#errors attribute.


303
304
305
306
307
308
309
310
311
312
313
# File 'lib/active_merchant/billing/credit_card.rb', line 303

def validate
  errors = validate_essential_attributes + validate_verification_value

  # Bogus card is pretty much for testing purposes. Lets just skip these extra tests if its used
  return errors_hash(errors) if brand == 'bogus'

  errors_hash(
    errors +
    validate_card_brand_and_number
  )
end

#verification_value?Boolean

Returns:

  • (Boolean)

274
275
276
# File 'lib/active_merchant/billing/credit_card.rb', line 274

def verification_value?
  !verification_value.blank?
end