IsValid - CreditCardValidation � Data8 Web Services API Documentation

IsValid

Checks if a credit card number is valid.

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 a CreditCardType of Unknown 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. The CreditCardType 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 their CreditCardType.
Specifying the CreditCardType - If you pass in any CreditCardType other than Unknown 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.

Endpoint URLs

To connect to this service you'll need to use one of these endpoints:

Protocol	URL
JSON	JSON https://webservices.data-8.co.uk/CreditCardValidation/IsValid.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/CreditCardValidation/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/creditcardvalidation.asmx

Parameters

The following parameters can be supplied to this method:

Name	Description
username	username See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix `apikey-`, e.g. `apikey-ABCD-1234-EFGH-5678`
password	password If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
request	request An object containing the details to validate. This has the following properties: `CreditCardType` - the type of credit card to validate. Use `Unknown` to determine the type automatically, or select the expected type to ensure the credit card number for that type. The available types are: `AmericanExpress` `DinersClubCarteBlance` `DinersClubenRoute` `DinersClubInternational` `Discover` `JCB` `Laser` `Maestro` `Mastercard` `Solo` `Switch` `Visa` `VisaElectron` `Unknown` `CreditCardNumber` - the credit card number to validate
options	options An array of options that control further details of how this method operates. See the `Advanced Options` section below, for more information.

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.

Name	Description
Common Options
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:

Name	Description
Status	Status Indicates whether the method call was successful, or if some error occurred. If the `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

Credit Usage

Each request to this method consumes 1 CreditCardValidation credit.

Sample Code

Request Format

{
  "request": null,
  "options": {}
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "CreditCardType": "Mastercard",
  "Valid": false
}

Depending on your chosen authentication method you will need to modify this request slightly:

API Key

Post the request to
https://webservices.data-8.co.uk/CreditCardValidation/IsValid.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.

Parameter	Value
Parameters
request
CreditCardType	CreditCardType AmericanExpressDinersClubCarteBlancheDinersClubenRouteDinersClubInternationalDiscoverJCBLaserMaestroMastercardSoloSwitchVisaVisaElectronUnknown
CreditCardNumber	CreditCardNumber
Common Options
ApplicationName	ApplicationName
Credits Remaining Today: 5 Try It Now!