Class: ActiveMerchant::Billing::CreditCard
- 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
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
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::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_RANGES, ActiveMerchant::Billing::CreditCardMethods::MASTERCARD_RANGES
Class Attribute Summary collapse
-
.require_name ⇒ Object
Returns the value of attribute require_name.
-
.require_verification_value ⇒ Object
Inherited, but can be overridden w/o changing parent’s value.
Instance Attribute Summary collapse
-
#encrypted_pin_cryptogram ⇒ String
Returns the ciphertext of the card’s encrypted PIN.
-
#encrypted_pin_ksn ⇒ String
Returns the Key Serial Number (KSN) of the card’s encrypted PIN.
-
#first_name ⇒ String
Returns or sets the first name of the card holder.
-
#icc_data ⇒ String
Returns or sets the ICC/ASN1 credit card data for a EMV transaction, typically this is a BER-encoded TLV string.
-
#last_name ⇒ String
Returns or sets the last name of the card holder.
-
#manual_entry ⇒ true, false
Returns or sets whether a card has been processed using manual entry.
-
#month ⇒ Integer
readonly
Returns or sets the expiry month for the card.
-
#number ⇒ String
Returns or sets the credit card number.
-
#read_method ⇒ String
Returns or sets information about the source of the card data.
-
#track_data ⇒ String
Returns or sets the track data for the card.
-
#verification_value ⇒ String
Returns or sets the card verification value.
-
#year ⇒ Integer
readonly
Returns or sets the expiry year for the card.
Class Method Summary collapse
Instance Method Summary collapse
-
#brand ⇒ String
Returns or sets the credit card brand.
- #brand=(value) ⇒ Object
-
#display_number ⇒ String
Returns a display-friendly version of the card number.
- #emv? ⇒ Boolean
-
#expired? ⇒ Boolean
Returns whether the credit card has expired.
-
#expiry_date ⇒ ExpiryDate
Provides proxy access to an expiry date object.
- #first_digits ⇒ Object
-
#first_name? ⇒ Boolean
Returns whether the
first_name
attribute has been set. - #last_digits ⇒ Object
-
#last_name? ⇒ Boolean
Returns whether the
last_name
attribute has been set. -
#name ⇒ String
Returns the full name of the card holder.
- #name=(full_name) ⇒ Object
-
#name? ⇒ Boolean
Returns whether either the
first_name
or thelast_name
attributes has been set. -
#require_verification_value=(value) ⇒ Boolean
Sets if the credit card requires a verification value.
-
#requires_verification_value? ⇒ Boolean
Returns if this credit card needs a verification value.
- #type ⇒ Object
- #type=(value) ⇒ Object
-
#validate ⇒ Object
Validates the credit card details.
- #verification_value? ⇒ Boolean
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
Methods included from ActiveMerchant::Billing::Compatibility::Model
Constructor Details
This class inherits a constructor from ActiveMerchant::Billing::Model
Class Attribute Details
.require_name ⇒ Object
Returns the value of attribute require_name.
54 55 56 |
# File 'lib/active_merchant/billing/credit_card.rb', line 54 def require_name @require_name end |
.require_verification_value ⇒ Object
Inherited, but can be overridden w/o changing parent’s value
53 54 55 |
# File 'lib/active_merchant/billing/credit_card.rb', line 53 def require_verification_value @require_verification_value end |
Instance Attribute Details
#encrypted_pin_cryptogram ⇒ String
Returns the ciphertext of the card’s encrypted PIN.
189 190 191 |
# File 'lib/active_merchant/billing/credit_card.rb', line 189 def encrypted_pin_cryptogram @encrypted_pin_cryptogram end |
#encrypted_pin_ksn ⇒ String
Returns the Key Serial Number (KSN) of the card’s encrypted PIN.
194 195 196 |
# File 'lib/active_merchant/billing/credit_card.rb', line 194 def encrypted_pin_ksn @encrypted_pin_ksn end |
#first_name ⇒ String
Returns or sets the first name of the card holder.
113 114 115 |
# File 'lib/active_merchant/billing/credit_card.rb', line 113 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.
169 170 171 |
# File 'lib/active_merchant/billing/credit_card.rb', line 169 def icc_data @icc_data end |
#last_name ⇒ String
Returns or sets the last name of the card holder.
118 119 120 |
# File 'lib/active_merchant/billing/credit_card.rb', line 118 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.
164 165 166 |
# File 'lib/active_merchant/billing/credit_card.rb', line 164 def manual_entry @manual_entry end |
#month ⇒ Integer (readonly)
Returns or sets the expiry month for the card.
72 73 74 |
# File 'lib/active_merchant/billing/credit_card.rb', line 72 def month @month end |
#number ⇒ String
Returns or sets the credit card number.
63 64 65 |
# File 'lib/active_merchant/billing/credit_card.rb', line 63 def number @number end |
#read_method ⇒ String
Returns or sets information about the source of the card data.
174 175 176 |
# File 'lib/active_merchant/billing/credit_card.rb', line 174 def read_method @read_method end |
#track_data ⇒ String
Returns or sets the track data for the card
155 156 157 |
# File 'lib/active_merchant/billing/credit_card.rb', line 155 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.
127 128 129 |
# File 'lib/active_merchant/billing/credit_card.rb', line 127 def verification_value @verification_value end |
#year ⇒ Integer (readonly)
Returns or sets the expiry year for the card.
77 78 79 |
# File 'lib/active_merchant/billing/credit_card.rb', line 77 def year @year end |
Class Method Details
.requires_name? ⇒ Boolean
306 307 308 |
# File 'lib/active_merchant/billing/credit_card.rb', line 306 def self.requires_name? require_name end |
.requires_verification_value? ⇒ Boolean
302 303 304 |
# File 'lib/active_merchant/billing/credit_card.rb', line 302 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’
-
‘dankort’
-
‘maestro’
-
‘forbrugsforeningen’
-
‘elo’
Or, if you wish to test your implementation, ‘bogus’.
97 98 99 100 101 102 103 |
# File 'lib/active_merchant/billing/credit_card.rb', line 97 def brand if !defined?(@brand) || empty?(@brand) self.class.brand?(number) else @brand end end |
#brand=(value) ⇒ Object
105 106 107 108 |
# File 'lib/active_merchant/billing/credit_card.rb', line 105 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.
275 276 277 |
# File 'lib/active_merchant/billing/credit_card.rb', line 275 def display_number self.class.mask(number) end |
#emv? ⇒ Boolean
310 311 312 |
# File 'lib/active_merchant/billing/credit_card.rb', line 310 def emv? icc_data.present? end |
#expired? ⇒ Boolean
Returns whether the credit card has expired.
216 217 218 |
# File 'lib/active_merchant/billing/credit_card.rb', line 216 def expired? expiry_date.expired? end |
#expiry_date ⇒ ExpiryDate
Provides proxy access to an expiry date object
209 210 211 |
# File 'lib/active_merchant/billing/credit_card.rb', line 209 def expiry_date ExpiryDate.new(@month, @year) end |
#first_digits ⇒ Object
279 280 281 |
# File 'lib/active_merchant/billing/credit_card.rb', line 279 def first_digits self.class.first_digits(number) end |
#first_name? ⇒ Boolean
Returns whether the first_name
attribute has been set.
226 227 228 |
# File 'lib/active_merchant/billing/credit_card.rb', line 226 def first_name? first_name.present? end |
#last_digits ⇒ Object
283 284 285 |
# File 'lib/active_merchant/billing/credit_card.rb', line 283 def last_digits self.class.last_digits(number) end |
#last_name? ⇒ Boolean
Returns whether the last_name
attribute has been set.
231 232 233 |
# File 'lib/active_merchant/billing/credit_card.rb', line 231 def last_name? last_name.present? end |
#name ⇒ String
Returns the full name of the card holder.
238 239 240 |
# File 'lib/active_merchant/billing/credit_card.rb', line 238 def name "#{first_name} #{last_name}".strip end |
#name=(full_name) ⇒ Object
242 243 244 245 246 |
# File 'lib/active_merchant/billing/credit_card.rb', line 242 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.
221 222 223 |
# File 'lib/active_merchant/billing/credit_card.rb', line 221 def name? first_name? || last_name? end |
#require_verification_value=(value) ⇒ Boolean
Sets if the credit card requires a verification value.
132 133 134 135 |
# File 'lib/active_merchant/billing/credit_card.rb', line 132 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`.
143 144 145 146 147 148 149 150 |
# File 'lib/active_merchant/billing/credit_card.rb', line 143 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
196 197 198 199 |
# File 'lib/active_merchant/billing/credit_card.rb', line 196 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
201 202 203 204 |
# File 'lib/active_merchant/billing/credit_card.rb', line 201 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.
290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/active_merchant/billing/credit_card.rb', line 290 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
261 262 263 |
# File 'lib/active_merchant/billing/credit_card.rb', line 261 def verification_value? !verification_value.blank? end |