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

IPWorks3DS_CardValidator

Procedural Interface

 ipworks3ds_cardvalidator_open();
 ipworks3ds_cardvalidator_close($res);
 ipworks3ds_cardvalidator_register_callback($res, $id, $function);
 ipworks3ds_cardvalidator_get_last_error($res);
 ipworks3ds_cardvalidator_get_last_error_code($res);
 ipworks3ds_cardvalidator_set($res, $id, $index, $value);
 ipworks3ds_cardvalidator_get($res, $id, $index);
 ipworks3ds_cardvalidator_do_config($res, $configurationstring);
 ipworks3ds_cardvalidator_do_reset($res);
 ipworks3ds_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 ValidateCard method explains these checks in more detail.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

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.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

CardExpMonth Property (IPWorks3DS_CardValidator Class)

Expiration month of the credit card specified in CardNumber .

Object Oriented Interface

public function getCardExpMonth();
public function setCardExpMonth($value);

Procedural Interface

ipworks3ds_cardvalidator_get($res, 1 );
ipworks3ds_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 (IPWorks3DS_CardValidator Class)

Expiration year of the credit card specified in CardNumber .

Object Oriented Interface

public function getCardExpYear();
public function setCardExpYear($value);

Procedural Interface

ipworks3ds_cardvalidator_get($res, 2 );
ipworks3ds_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 (IPWorks3DS_CardValidator Class)

Credit card number to be validated.

Object Oriented Interface

public function getCardNumber();
public function setCardNumber($value);

Procedural Interface

ipworks3ds_cardvalidator_get($res, 3 );
ipworks3ds_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 (IPWorks3DS_CardValidator Class)

Indicates the results of the Luhn Digit Check algorithm.

Object Oriented Interface

public function getCardType();

Procedural Interface

ipworks3ds_cardvalidator_get($res, 4 );

Default Value

0

Remarks

This property is filled after a call to the ValidateCard method. Allowable values include:

This property is read-only and not available at design time.

Data Type

Integer

CardTypeDescription Property (IPWorks3DS_CardValidator Class)

Human-readable description of the CardType .

Object Oriented Interface

public function getCardTypeDescription();

Procedural Interface

ipworks3ds_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 (IPWorks3DS_CardValidator Class)

Indicates whether the card is expired or not.

Object Oriented Interface

public function getDateCheckPassed();

Procedural Interface

ipworks3ds_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 (IPWorks3DS_CardValidator Class)

Indicates the results of the Luhn Digit Check algorithm.

Object Oriented Interface

public function getDigitCheckPassed();

Procedural Interface

ipworks3ds_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 (IPWorks3DS_CardValidator Class)

Magnetic stripe data read off the credit card.

Object Oriented Interface

public function getTrackData();
public function setTrackData($value);

Procedural Interface

ipworks3ds_cardvalidator_get($res, 8 );
ipworks3ds_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 (IPWorks3DS_CardValidator Class)

Indicates the type of the specified TrackData .

Object Oriented Interface

public function getTrackType();

Procedural Interface

ipworks3ds_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 (IPWorks3DS_CardValidator Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks3ds_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 (IPWorks3DS_CardValidator Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks3ds_cardvalidator_do_reset($res);

Remarks

This method clears all properties to their default values.

ValidateCard Method (IPWorks3DS_CardValidator Class)

Checks the card number and expiration date for validity.

Object Oriented Interface

public function doValidateCard();

Procedural Interface

ipworks3ds_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:

Error Event (IPWorks3DS_CardValidator Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks3ds_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

Trappable Errors (CardValidator Class)

CardValidator Errors