Menu

Tokens

Card Token

Copied!
{
    "token": "UUID of token",
    "reusable": true/false,
    "paymentMethod": {
        "type" : "ObfuscatedCard",
        "name": "name",
        "expiryMonth": 2,
        "expiryYear": 2015,
        "issueNumber": 1,
        "startMonth": 2,
        "startYear": 2013,
        "type": "ObfuscatedCard",
        "cardType": "VISA_CREDIT",
        "maskedCardNumber": "xxxx xxxx xxxx 1111",
        "cardSchemeType": "consumer",
        "cardSchemeName": "VISA CREDIT",
        "cardProductTypeDescNonContactless": "Visa Credit Personal",
        "cardProductTypeDescContactless": "CL Visa Credit Pers",
        "cardIssuer": "LLOYDS BANK PLC",
        "countryCode": "GB",
        "cardClass": "credit",
        "prepaid": "false"
    },
   "clientKey": "T_C_client_key"
}

WPM/APM Token

Copied!
{
  "token": "UUID of token",
  "paymentMethod": {
    "type": "APM",
    "apmName": "apm-identifier",
    "shopperCountryCode": "GB",
    "apmFields": {
      "shopperBankCode" : "code",
      "swiftCode": "swift-reference"
    }
  },
  "reusable": false,
  "shopperLanguageCode": "en"
}

Card types

Card Types Worldpay returns the following Card Types:

VISA_CREDIT: Visa Credit

VISA_DEBIT: Visa Debit

VISA_CORPORATE_CREDIT: Visa Corporate Credit

VISA_CORPORATE_DEBIT: Visa Corporate Debit

MASTERCARD_CREDIT: Mastercard Credit

MASTERCARD_DEBIT: Mastercard Debit

MASTERCARD_CORPORATE_CREDIT: Mastercard Corporate Credit

MASTERCARD_CORPORATE_DEBIT: Mastercard Corporate Debit

MAESTRO: Maestro

AMEX: American Express

CARTEBLEUE: Cartebleue

JCB: JCB

DINERS: Diners

Card Schemes

Worldpay provides additional Issuer-sourced details for many cards in the following card schemes:

VISA CREDIT: Visa Credit

VISA DEBIT: Visa Debit

ELECTRON: Electron

MCI CREDIT: Mastercard Credit

MCI DEBIT: Mastercard Debit

MAESTRO: Maestro

Worldpay can also support transactions through the following card schemes - please contact Customer Services:

AMEX: American Express

DINERS: Diners Club

JCB: JCB Card (Japan Credit Bureau)

CARTEBLEUE: Carte Bleue

WPM Types

Worldpay supports the following World Payment Methods:

Alipay Use apmName: "alipay"

Bancontact/MisterCash Use apmName: "mistercash"

Giropay Use apmName: "giropay"

iDEAL Use apmName: "ideal"

PayPal Use apmName: "paypal"

PaySafeCard Use apmName: "paysafecard"

Postepay Use apmName: "postepay"

Przelewy24 Use apmName: "przelewy24"

Sofort Use apmName: "sofort"

All token fields are limited to 255 chars in length.

Token object

tokenString, only included in response
A unique token which the WorldPay.js library added to your checkout form. This token represents the customer's card details which WorldPay.js stored on our server
reusableBoolean
Boolean indicating whether the token should be used only once (false) or multiple times (true)
shopperLanguageCodeString, optional
ISO ISO 639-1 language code indicating the preferred language of the shopper, where supported by the Payment Provider.
paymentMethodJSON
Object containing all payment details, contents vary by token type

Common Payment Method Attributes

typeString
String defining the token type - either "Card" or "APM" in a request, "ObfuscatedCard" or "APM" in a response
clientKeyString
Your client key which can be found here (requires you to be logged in)

Card-specific Payment Method Attributes

nameString
Name of the cardholder
expiryMonthString
Expiry month of the card
expiryYearString
Expiry year of the card
issueNumberString, optional
Issue number on the card. This field is only used for some types of debit cards
startMonthString, optional
Start month of the card. This field is only used for some types of debit cards
startYearString, optional
Start year of the card. This field is only used for some types of debit cards
cardNumberString
Number of the card to be charged
cvcString
Security code of the card to be charged. This is also known as CVV or CV2. It is the 3-digit number at the back of the card. In the case of Amex, the 4-digit number at the front of the card
cardTypeString, only included in response
Type of the card that was used. Please seeherefor a list of supported card types
maskedCardNumberString, only included in response
The last four digits of the card number with all other numbers masked
cardSchemeTypeString, only included in response
Indicates the card is either 'consumer' or 'corporate'. Also seeAdvanced Usage Of Worldpay.jspage
cardSchemeNameString, only included in response
Type of the card that was used. Please seeherefor a list of supported card types. Also seeAdvanced Usage Of Worldpay.jspage
cardIssuerString, only included in response
The financial institution that issued the card. Also seeAdvanced Usage Of Worldpay.jspage
countryCodeString, only included in response
The issuer country code in ISO 3166 2-letter format. Also seeAdvanced Usage Of Worldpay.jspage
cardClassString, only included in response
Indicates whether the card is 'credit' or 'debit'. Also seeAdvanced Usage Of Worldpay.jspage
cardProductTypeDescNonContactlessString, only included in response
Product type detail for non-contactless cards. Also seeAdvanced Usage Of Worldpay.jspage
cardProductTypeDescContactlessString, only included in response
Product type detail for contactless cards. Also seeAdvanced Usage Of Worldpay.jspage
prepaidString, only included in response
Indicates whether the card is prepaid. Also seeAdvanced Usage Of Worldpay.jspage

APM- / WPM-specific Payment Method Attributes

apmNameString
The specific payment method that this token represents
shopperCountryCodeString
Indicates to the WPM provider which locale to present to the shopper in ISO 3166 2-letter format. Mandatory for WPM tokens, unless a default country code is defined in Order Settings. Where both are defined this attribute's value will take precedence
apmFieldsJSON, optional
Allows additional information to be provided to Payment Providers e.g. the shopper's iDEAL Bank Code shopperBankCode or Giropay Swift Code swiftCode.