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

  • Switch

  • Solo

  • Dankort

  • Maestro

  • Forbrugsforeningen

  • Laser

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       => '2010',
  :brand      => 'visa',
  :number     => '4242424242424242'
)

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

Direct Known Subclasses

NetworkTokenizationCreditCard

Defined Under Namespace

Classes: ExpiryDate

Constant Summary

Constants included from CreditCardMethods

ActiveMerchant::Billing::CreditCardMethods::CARD_COMPANIES

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from CreditCardMethods

#card_verification_value_length, 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.



55
56
57
 
# File 'lib/active_merchant/billing/credit_card.rb', line 55

def require_name
  @require_name
end

.require_verification_value ⇒ Object

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



54
55
56
 
# File 'lib/active_merchant/billing/credit_card.rb', line 54

def require_verification_value
  @require_verification_value
end

Instance Attribute Details

#fallback_reason ⇒ String

Returns or sets a fallback reason for a EMV transaction whereby the customer’s card entered a fallback scenario. This can be an arbitrary string.

Returns:

  • (String) 


150
151
152
 
# File 'lib/active_merchant/billing/credit_card.rb', line 150

def fallback_reason
  @fallback_reason
end

#first_name ⇒ String

Returns or sets the first name of the card holder.

Returns:

  • (String) 


116
117
118
 
# File 'lib/active_merchant/billing/credit_card.rb', line 116

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) 


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

def icc_data
  @icc_data
end

#issue_number ⇒ Object

Returns the value of attribute issue_number.



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

def issue_number
  @issue_number
end

#last_name ⇒ String

Returns or sets the last name of the card holder.

Returns:

  • (String) 


121
122
123
 
# File 'lib/active_merchant/billing/credit_card.rb', line 121

def last_name
  @last_name
end

#month ⇒ Integer (readonly)

Returns or sets the expiry month for the card.

Returns:

  • (Integer) 


73
74
75
 
# File 'lib/active_merchant/billing/credit_card.rb', line 73

def month
  @month
end

#number ⇒ String

Returns or sets the credit card number.

Returns:

  • (String) 


64
65
66
 
# File 'lib/active_merchant/billing/credit_card.rb', line 64

def number
  @number
end

#start_month ⇒ Object (readonly)

Required for Switch / Solo cards



124
125
126
 
# File 'lib/active_merchant/billing/credit_card.rb', line 124

def start_month
  @start_month
end

#start_year ⇒ Object (readonly)

Required for Switch / Solo cards



124
125
126
 
# File 'lib/active_merchant/billing/credit_card.rb', line 124

def start_year
  @start_year
end

#track_data ⇒ String

Returns or sets the track data for the card

Returns:

  • (String) 


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

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



134
135
136
 
# File 'lib/active_merchant/billing/credit_card.rb', line 134

def verification_value
  @verification_value
end

#year ⇒ Integer (readonly)

Returns or sets the expiry year for the card.

Returns:

  • (Integer) 


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

def year
  @year
end

Class Method Details

.requires_name? ⇒ Boolean

Returns:

  • (Boolean) 


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

def self.requires_name?
  require_name
end

.requires_verification_value? ⇒ Boolean

Returns:

  • (Boolean) 


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

def self.requires_verification_value?
  require_verification_value
end

Instance Method Details

#brand ⇒ String

Returns or sets the credit card brand.

Valid card types are

  • ‘visa’

  • ‘master’

  • ‘discover’

  • ‘american_express’

  • ‘diners_club’

  • ‘jcb’

  • ‘switch’

  • ‘solo’

  • ‘dankort’

  • ‘maestro’

  • ‘forbrugsforeningen’

  • ‘laser’

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

Returns:

  • (String) —

    the credit card brand



100
101
102
103
104
105
106
 
# File 'lib/active_merchant/billing/credit_card.rb', line 100

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

#brand=(value) ⇒ Object 



108
109
110
111
 
# File 'lib/active_merchant/billing/credit_card.rb', line 108

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



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

def display_number
  self.class.mask(number)
end

#emv? ⇒ Boolean

Returns:

  • (Boolean) 


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

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



172
173
174
 
# File 'lib/active_merchant/billing/credit_card.rb', line 172

def expired?
  expiry_date.expired?
end

#expiry_date ⇒ ExpiryDate

Provides proxy access to an expiry date object

Returns:



165
166
167
 
# File 'lib/active_merchant/billing/credit_card.rb', line 165

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

#first_digits ⇒ Object 



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

def first_digits
  self.class.first_digits(number)
end

#first_name? ⇒ Boolean

Returns whether the first_name attribute has been set.

Returns:

  • (Boolean) 


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

def first_name?
  first_name.present?
end

#last_digits ⇒ Object 



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

def last_digits
  self.class.last_digits(number)
end

#last_name? ⇒ Boolean

Returns whether the last_name attribute has been set.

Returns:

  • (Boolean) 


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

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



194
195
196
 
# File 'lib/active_merchant/billing/credit_card.rb', line 194

def name
  [first_name, last_name].compact.join(' ')
end

#name=(full_name) ⇒ Object 



198
199
200
201
202
 
# File 'lib/active_merchant/billing/credit_card.rb', line 198

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) 


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

def name?
  first_name? || last_name?
end

#type ⇒ Object 



152
153
154
155
 
# File 'lib/active_merchant/billing/credit_card.rb', line 152

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 



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

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.



246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/active_merchant/billing/credit_card.rb', line 246

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 +
    validate_switch_or_solo_attributes
  )
end

#verification_value? ⇒ Boolean

Returns:

  • (Boolean) 


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

def verification_value?
  !verification_value.blank?
end