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

  • Sodexo

  • Vr

  • Carnet

  • Synchrony

  • Routex

  • Elo

  • Alelo

  • Cabal

  • Naranja

  • UnionPay

  • Alia

  • Olimpica

  • Creditel

  • Confiable

  • Mada

  • BpPlus

  • Passcard

  • Edenred

  • Anda

  • Creditos directos (Tarjeta D)

  • Panal

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

BRANDS_WITH_SPACES_IN_NUMBER = 
%w(bp_plus)
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::CARTES_BANCAIRES_RANGES, ActiveMerchant::Billing::CreditCardMethods::ELECTRON_RANGES, ActiveMerchant::Billing::CreditCardMethods::ELO_RANGES, ActiveMerchant::Billing::CreditCardMethods::HIPERCARD_RANGES, ActiveMerchant::Billing::CreditCardMethods::JCB_RANGES, ActiveMerchant::Billing::CreditCardMethods::MADA_RANGES, ActiveMerchant::Billing::CreditCardMethods::MAESTRO_BINS, ActiveMerchant::Billing::CreditCardMethods::MAESTRO_RANGES, ActiveMerchant::Billing::CreditCardMethods::MASTERCARD_RANGES, ActiveMerchant::Billing::CreditCardMethods::NARANJA_RANGES, ActiveMerchant::Billing::CreditCardMethods::PANAL_RANGES, ActiveMerchant::Billing::CreditCardMethods::SODEXO_NO_LUHN, 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_name ⇒ Object

Returns the value of attribute require_name.



76
77
78
 
# File 'lib/active_merchant/billing/credit_card.rb', line 76

def require_name
  @require_name
end

.require_verification_value ⇒ Object

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



75
76
77
 
# File 'lib/active_merchant/billing/credit_card.rb', line 75

def require_verification_value
  @require_verification_value
end

Instance Attribute Details

#encrypted_pin_cryptogram ⇒ String

Returns the ciphertext of the card’s encrypted PIN.

Returns:

  • (String) 


231
232
233
 
# File 'lib/active_merchant/billing/credit_card.rb', line 231

def encrypted_pin_cryptogram
  @encrypted_pin_cryptogram
end

#encrypted_pin_ksn ⇒ String

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

Returns:

  • (String) 


236
237
238
 
# File 'lib/active_merchant/billing/credit_card.rb', line 236

def encrypted_pin_ksn
  @encrypted_pin_ksn
end

#first_name ⇒ String

Returns or sets the first name of the card holder.

Returns:

  • (String) 


155
156
157
 
# File 'lib/active_merchant/billing/credit_card.rb', line 155

def first_name
  @first_name
end

#icc_data ⇒ String

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

Returns:

  • (String) 


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

def icc_data
  @icc_data
end

#last_name ⇒ String

Returns or sets the last name of the card holder.

Returns:

  • (String) 


160
161
162
 
# File 'lib/active_merchant/billing/credit_card.rb', line 160

def last_name
  @last_name
end

#manual_entry ⇒ true, 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) 


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

def manual_entry
  @manual_entry
end

#month ⇒ Integer (readonly)

Returns or sets the expiry month for the card.

Returns:

  • (Integer) 


94
95
96
 
# File 'lib/active_merchant/billing/credit_card.rb', line 94

def month
  @month
end

#number ⇒ String

Returns or sets the credit card number.

Returns:

  • (String) 


85
86
87
 
# File 'lib/active_merchant/billing/credit_card.rb', line 85

def number
  @number
end

#read_method ⇒ String

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

Returns:

  • (String) 


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

def read_method
  @read_method
end

#track_data ⇒ String

Returns or sets the track data for the card

Returns:

  • (String) 


197
198
199
 
# File 'lib/active_merchant/billing/credit_card.rb', line 197

def track_data
  @track_data
end

#verification_value ⇒ String

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



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

def verification_value
  @verification_value
end

#year ⇒ Integer (readonly)

Returns or sets the expiry year for the card.

Returns:

  • (Integer) 


99
100
101
 
# File 'lib/active_merchant/billing/credit_card.rb', line 99

def year
  @year
end

Class Method Details

.requires_name? ⇒ Boolean

Returns:

  • (Boolean) 


348
349
350
 
# File 'lib/active_merchant/billing/credit_card.rb', line 348

def self.requires_name?
  require_name
end

.requires_verification_value? ⇒ Boolean

Returns:

  • (Boolean) 


344
345
346
 
# File 'lib/active_merchant/billing/credit_card.rb', line 344

def self.requires_verification_value?
  require_verification_value
end

Instance Method Details

#allow_spaces_in_card?(number = nil) ⇒ Boolean

Returns:

  • (Boolean) 


356
357
358
 
# File 'lib/active_merchant/billing/credit_card.rb', line 356

def allow_spaces_in_card?(number = nil)
  BRANDS_WITH_SPACES_IN_NUMBER.include?(self.class.brand?(self.number || number))
end

#brand ⇒ String

Returns or sets the credit card brand.

Valid card types are

  • ‘visa’

  • ‘master’

  • ‘discover’

  • ‘american_express’

  • ‘diners_club’

  • ‘jcb’

  • ‘dankort’

  • ‘maestro’

  • ‘forbrugsforeningen’

  • ‘sodexo’

  • ‘vr’

  • ‘carnet’

  • ‘synchrony’

  • ‘routex’

  • ‘elo’

  • ‘alelo’

  • ‘cabal’

  • ‘naranja’

  • ‘union_pay’

  • ‘alia’

  • ‘olimpica’

  • ‘creditel’

  • ‘confiable’

  • ‘mada’

  • ‘bp_plus’

  • ‘passcard’

  • ‘edenred’

  • ‘anda’

  • ‘tarjeta-d’

  • ‘panal’

Or, if you wish to test your implementation, ‘bogus’.

Returns:

  • (String) —

    the credit card brand



139
140
141
142
143
144
145
 
# File 'lib/active_merchant/billing/credit_card.rb', line 139

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

#brand=(value) ⇒ Object 



147
148
149
150
 
# File 'lib/active_merchant/billing/credit_card.rb', line 147

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

#display_number ⇒ String

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



317
318
319
 
# File 'lib/active_merchant/billing/credit_card.rb', line 317

def display_number
  self.class.mask(number)
end

#emv? ⇒ Boolean

Returns:

  • (Boolean) 


352
353
354
 
# File 'lib/active_merchant/billing/credit_card.rb', line 352

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



258
259
260
 
# File 'lib/active_merchant/billing/credit_card.rb', line 258

def expired?
  expiry_date.expired?
end

#expiry_date ⇒ ExpiryDate

Provides proxy access to an expiry date object

Returns:



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

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

#first_digits ⇒ Object 



321
322
323
 
# File 'lib/active_merchant/billing/credit_card.rb', line 321

def first_digits
  self.class.first_digits(number)
end

#first_name? ⇒ Boolean

Returns whether the first_name attribute has been set.

Returns:

  • (Boolean) 


268
269
270
 
# File 'lib/active_merchant/billing/credit_card.rb', line 268

def first_name?
  first_name.present?
end

#last_digits ⇒ Object 



325
326
327
 
# File 'lib/active_merchant/billing/credit_card.rb', line 325

def last_digits
  self.class.last_digits(number)
end

#last_name? ⇒ Boolean

Returns whether the last_name attribute has been set.

Returns:

  • (Boolean) 


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

def last_name?
  last_name.present?
end

#name ⇒ String

Returns the full name of the card holder.

Returns:

  • (String) —

    the full name of the card holder



280
281
282
 
# File 'lib/active_merchant/billing/credit_card.rb', line 280

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

#name=(full_name) ⇒ Object 



284
285
286
287
288
 
# File 'lib/active_merchant/billing/credit_card.rb', line 284

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) 


263
264
265
 
# File 'lib/active_merchant/billing/credit_card.rb', line 263

def name?
  first_name? || last_name?
end

#require_verification_value=(value) ⇒ Boolean

Sets if the credit card requires a verification value.

Returns:

  • (Boolean) 


174
175
176
177
 
# File 'lib/active_merchant/billing/credit_card.rb', line 174

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) 


185
186
187
188
189
190
191
192
 
# File 'lib/active_merchant/billing/credit_card.rb', line 185

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

#type ⇒ Object 



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

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 



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

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

#validate ⇒ Object

Validates the credit card details.

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



332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/active_merchant/billing/credit_card.rb', line 332

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) 


303
304
305
 
# File 'lib/active_merchant/billing/credit_card.rb', line 303

def verification_value?
  !verification_value.blank?
end