CardValidator Class
Properties Methods Events Config Settings Errors
The CardValidator class is used to verify that a given credit card number is formatted properly, and could be a valid card number. Validating a card before actually submitting a transaction for authorization can reduce the fees that may be associated with invalid or declined transactions.
Class Name
InPay_CardValidator
Procedural Interface
inpay_cardvalidator_open(); inpay_cardvalidator_close($res); inpay_cardvalidator_register_callback($res, $id, $function); inpay_cardvalidator_get_last_error($res); inpay_cardvalidator_get_last_error_code($res); inpay_cardvalidator_set($res, $id, $index, $value); inpay_cardvalidator_get($res, $id, $index); inpay_cardvalidator_do_config($res, $configurationstring); inpay_cardvalidator_do_reset($res); inpay_cardvalidator_do_validatecard($res);
Remarks
Utilization of this class catches accidentally mistyped card numbers and allows buyers to re-input their number without having the transaction declined. It can also determine the type of credit card (Visa, MasterCard, Discover, etc) to easily determine if the customer is presenting a payment type which you do not support. The class can also parse swiped track data and perform these same checks on it.
There are three checks performed on the customer's credit card information:
| The card number is checked for validity using the Luhn mod-10 algorithm. | |
| The type of the card (Visa, MasterCard, etc.) is computed from the card number. | |
| The expiration date is checked against the current system date. |
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| CardExpMonth | Expiration month of the credit card specified in CardNumber . |
| CardExpYear | Expiration year of the credit card specified in CardNumber . |
| CardNumber | Credit card number to be validated. |
| CardType | Indicates the results of the Luhn Digit Check algorithm. |
| CardTypeDescription | Human-readable description of the CardType . |
| DateCheckPassed | Indicates whether the card is expired or not. |
| DigitCheckPassed | Indicates the results of the Luhn Digit Check algorithm. |
| TrackData | Magnetic stripe data read off the credit card. |
| TrackType | Indicates the type of the specified TrackData . |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| Reset | Clears all properties to their default values. |
| ValidateCard | Checks the card number and expiration date for validity. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| NameOnCard | The name encoded in the track data on the credit card. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
CardExpMonth Property (InPay_CardValidator Class)
Expiration month of the credit card specified in CardNumber .
Object Oriented Interface
public function getCardExpMonth(); public function setCardExpMonth($value);
Procedural Interface
inpay_cardvalidator_get($res, 1 ); inpay_cardvalidator_set($res, 1, $value );
Default Value
1
Remarks
This field contains the month portion of the expiration date of the customer's credit card. This property must be in the range 1 - 12. The ValidateCard method compares this property against the system time to determine if the card is expired.
Data Type
Integer
CardExpYear Property (InPay_CardValidator Class)
Expiration year of the credit card specified in CardNumber .
Object Oriented Interface
public function getCardExpYear(); public function setCardExpYear($value);
Procedural Interface
inpay_cardvalidator_get($res, 2 ); inpay_cardvalidator_set($res, 2, $value );
Default Value
0
Remarks
This field contains the year portion of the expiration date of the customer's credit card. This property must be in the range 00-99, or 2000-2099. The ValidateCard method compares this property against the system time to determine if the card is expired.
Data Type
Integer
CardNumber Property (InPay_CardValidator Class)
Credit card number to be validated.
Object Oriented Interface
public function getCardNumber(); public function setCardNumber($value);
Procedural Interface
inpay_cardvalidator_get($res, 3 ); inpay_cardvalidator_set($res, 3, $value );
Default Value
''
Remarks
This property contains the customer's credit card number. A credit card number may be of any length, and may optionally include dashes or spaces. However, in practice the maximum length of the supported CardTypes is 19 characters (excluding whitespace), and the minimum length is 13 characters.
Data Type
String
CardType Property (InPay_CardValidator Class)
Indicates the results of the Luhn Digit Check algorithm.
Object Oriented Interface
public function getCardType();
Procedural Interface
inpay_cardvalidator_get($res, 4 );
Default Value
0
Remarks
This property is filled after a call to the ValidateCard method. Allowable values include:
| ctUnknown (0) | The class could not determine the type of the card based on the CardNumber prefix and length. |
| vctVisa (1) | Visa card. |
| vctMasterCard (2) | MasterCard card. |
| vctAmex (3) | American Express card. |
| vctDiscover (4) | Discover Card |
| vctDiners (5) | Diner's Club card (Carte Blanche or International - the CardTypeDescription will contain the full name). |
| vctJCB (6) | Japan Credit Bureau card. |
| vctVisaElectron (7) | International Visa debit card (not available in US or Canada). |
| vctMaestro (8) | International debit card (owned and operated by MasterCard). |
| vctCUP (9) | China UnionPay - China's only credit card organization. |
| vctLaser (10) | Primary debit card used in Ireland. |
This property is read-only and not available at design time.
Data Type
Integer
CardTypeDescription Property (InPay_CardValidator Class)
Human-readable description of the CardType .
Object Oriented Interface
public function getCardTypeDescription();
Procedural Interface
inpay_cardvalidator_get($res, 5 );
Default Value
''
Remarks
This property is filled after calling the ValidateCard method, and will contain a text description of the CardType. This is useful to distinguish different program cards. For instance, a CardType of ccDiners might have a corresponding CardTypeDescription of "Diner's Club International", "Diner's Club Carte Blanche", or "Diner's Club enRoute".
This property is read-only.
Data Type
String
DateCheckPassed Property (InPay_CardValidator Class)
Indicates whether the card is expired or not.
Object Oriented Interface
public function getDateCheckPassed();
Procedural Interface
inpay_cardvalidator_get($res, 6 );
Default Value
false
Remarks
The ValidateCard method checks whether the card's expiration date (CardExpMonth and CardExpYear) is a valid future date, and stores that result in the DateCheckPassed property.
This property is read-only.
Data Type
Boolean
DigitCheckPassed Property (InPay_CardValidator Class)
Indicates the results of the Luhn Digit Check algorithm.
Object Oriented Interface
public function getDigitCheckPassed();
Procedural Interface
inpay_cardvalidator_get($res, 7 );
Default Value
false
Remarks
The ValidateCard method checks whether or not the CardNumber conforms to the mod-10 digit check algorithm, and stores that result in the DigitCheckPassed property. Note that a card may pass this check and still be an invalid card. (Either a fake number that passes the digit check, or an unknown CardType).
This property is read-only.
Data Type
Boolean
TrackData Property (InPay_CardValidator Class)
Magnetic stripe data read off the credit card.
Object Oriented Interface
public function getTrackData(); public function setTrackData($value);
Procedural Interface
inpay_cardvalidator_get($res, 8 ); inpay_cardvalidator_set($res, 8, $value );
Default Value
''
Remarks
This property may be set with the magnetic stripe read off the back of a credit card using any commercially available card reader. You may set this property with either Track1 or Track2 data. If TrackData is set, the values contained in CardNumber, CardExpMonth, and CardExpYear are ignored when calling ValidateCard. Instead, these properties are parsed out of the track data. This allows you to easily retrieve the expiration date and card number from either Track1 or Track2 data. For instance:
CardValidator1.TrackData = "4012000033330026=21121015432112345678"
CardValidator1.ValidateCard()
The CardNumber, CardExpMonth, and CardExpYear will now contain the values parsed from the track data. TrackType will also indicate whether the TrackData is Track1 or Track2 (in this case, it's Track2 data).
Data Type
String
TrackType Property (InPay_CardValidator Class)
Indicates the type of the specified TrackData .
Object Oriented Interface
public function getTrackType();
Procedural Interface
inpay_cardvalidator_get($res, 9 );
Default Value
0
Remarks
This property will be filled after a call to ValidateCard. If magnetic stripe data was supplied in the TrackData field, this property will indicate which type of track was entered. If no track data was entered (ie, the CardNumber was specified instead) then the TrackType will be ttUnknown.
This property is read-only and not available at design time.
Data Type
Integer
Config Method (InPay_CardValidator Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
inpay_cardvalidator_do_config($res, $configurationstring);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Reset Method (InPay_CardValidator Class)
Clears all properties to their default values.
Object Oriented Interface
public function doReset();
Procedural Interface
inpay_cardvalidator_do_reset($res);
Remarks
This method clears all properties to their default values.
ValidateCard Method (InPay_CardValidator Class)
Checks the card number and expiration date for validity.
Object Oriented Interface
public function doValidateCard();
Procedural Interface
inpay_cardvalidator_do_validatecard($res);
Remarks
This method performs several checks on customer information to determine if the card information submitted could be valid. This should be done before submitting an actual transaction for authorization. The tests performed are listed below:
| Luhn Digit Check | This process checks the digits of the CardNumber to make sure that it could be a valid card number. The mathematical algorithm used to determine validity is outlined in the Visa External Interface Specification: Authorization Record Formats Version 5.8, page 63. |
| Card Type Check | This process checks the length and the beginning digits of the CardNumber to determine if it is a valid card type. The results of this check is stored are the CardType and CardTypeDescription properties. |
| Expiration Date Check | The date given in CardExpMonth and CardExpYear is compared to the current system date to make sure that the card is still valid. |
Error Event (InPay_CardValidator Class)
Information about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
inpay_cardvalidator_register_callback($res, 1, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The Error event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Config Settings (CardValidator Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.CardValidator Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NameOnCard: The name encoded in the track data on the credit card.If the TrackData you're parsing is Track1 data, it contains the customer's name, and should be identical to the name printed on the face of the card. Track2 data does not contain this name. This field will be filled after a call to ValidateCard. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section. |
Trappable Errors (CardValidator Class)
CardValidator Errors
| 504 Luhn digit check failed. | |
| 505 Card date invalid. | |
| 506 Card expired. | |
| 703 Invalid CardNumber format (contains letters or unknown characters). | |
| 704 Could not determine the Credit Card type. | |
| 705 Error parsing TrackData. Format cannot be determined. |