IsValid
Checks if a credit card number is valid | data8
To connect to this service you'll need to use one of these endpoints:
Description
Checks a credit card number for validity.
You can use Credit Card Validation in one of two ways:
- Without specifying the
CreditCardType
- If you pass in aCreditCardType
ofUnknown
then we will automatically detect the brand of credit card from the number (e.g. Visa, Mastercard, American Express), and then use the relevant rules for validating that card against the number you have supplied. TheCreditCardType
will be returned in the result. This can be very useful for speeding up transactions as you do not need to ask the user to specify theirCreditCardType
. - Specifying the
CreditCardType
- If you pass in anyCreditCardType
other thanUnknown
then we will only check your card against the rules relevant for that credit card.
The system performs checks on the number range and a checksum calculation to ensure no typographical errors have been entered. It does not check with the bank that the card is live, has available credit and has not expired.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
request | request An object containing the details to validate. This has the following properties:
|
Advanced Options
The following options can be specified as part of the option
parameter. Each option is specified
as a key/value pair. The list of available names is shown below, along with a description of the allowable values
for that name.
Common Options | |
---|---|
Name | Description |
ApplicationName | ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard |
Results
This method returns an object containing the following fields:
Status |
Status Success field is true , the other results described below can be used to get the results of the method.
If Success is false , some error occurred in calling the method, such as the authentication failed or the
account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored
|
---|---|
CreditCardType | CreditCardType The identified type of the credit card |
Valid | Valid Indicates if the credit card number has been identified as valid or not |