Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.

Verified Tokens (v1)

Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.

Download OpenAPI description
Languages
Servers
testing (try)
https://try.access.worldpay.com/
live
https://access.worldpay.com/

Verified Tokens cardOnFile Resource

Request

Create a verified cardOnFile token by sending a request to cardOnFile resource. A cardOnFile verified token allows you to take payments that are made by the customer using a stored verified token, such as in one-click or in-app purchases.

Bodyapplication/vnd.worldpay.verified-tokens-v1.hal+json
paymentInstrumentany(paymentInstrument)required

An object that contains the card details or token location.

typestringrequired
Example:

"card/plain"

Discriminator
cardNumberstring[ 10 .. 19 ] characters^[0-9]*$required
cardExpiryDateobjectrequired
monthinteger[ 1 .. 12 ]required
yearinteger<= 9999required
cvcstring[ 3 .. 4 ] characters^[0-9]*$
cardHolderNamestring(verifiedTokens_cardOnFile_cardHolderName)[ 1 .. 255 ] charactersrequired
billingAddressobject(verifiedTokens_cardOnFile_billingAddress)
merchantobjectrequired
entitystringrequired
verificationCurrencystring= 3 characters^[A-Z]*$required
descriptionstring[ 1 .. 255 ] characters^[^&<]*$
tokenExpiryDateTimestring(date-time)
namespacestring[ 1 .. 64 ] characters
curl -i -X POST \
  -u undefined:undefined \
  https://try.access.worldpay.com/verifiedTokens/cardOnFile \
  -H 'Content-Type: application/vnd.worldpay.verified-tokens-v1.hal+json' \
  -d '{
    "paymentInstrument": {
      "type": "card/plain",
      "cardHolderName": "Test name",
      "cardExpiryDate": {
        "month": 10,
        "year": 2030
      },
      "cardNumber": "4444333322221111",
      "cvc": "123"
    },
    "merchant": {
      "entity": "test-reference"
    },
    "verificationCurrency": "GBP"
  }'

Responses

The payload has been verified and a matching Token already exists. This does not include token meta data, which still may be different

Bodyapplication/vnd.worldpay.verified-tokens-v1.hal+json
outcomestringrequired
Example:

"verified"

_linksobject(verifiedTokens_links)required
verifications:verificationobjectrequired
hrefstring
Example:

"https://try.access.worldpay.com/verifications/accounts/MTphTFVWNXJYcDUvaXdJT214aWNBWHN3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6VXMzQStzaFdwWjZvV2g5STVXK0ZDb3ZiRmVoemdueWpnSDhHZFlmaFZpWitQTHNuWlZMQi84bzV0Z1FOaUZGYkpuTWRNYW9PdTJLY1Q0MURrdkpJMmFveVFJWC92MXArZFRWWUExZTRIdGZrZzBIYnBGeHJCWDJVc1lvMlZhUS8yclRzcHcrcTZ1OUtpZ0JPTVhmRW0zelhaWWl1WjlyR0xIUzR4b3lyOWFNPQ=="

tokens:tokenobjectrequired
hrefstring
Example:

"https://try.access.worldpay.com/tokens/${MAYBE_ENCRYPT:MTUzNTAzNjAzNzAyMjIzMjk0Ng==}"

curiesArray of objectsrequired
hrefstring
Example:

"https://try.access.worldpay.com/rels/verifications/accounts/{rel}.json"

namestring
Example:

"verifications"

templatedboolean
Example:

true

Response
application/vnd.worldpay.verified-tokens-v1.hal+json

Matching an existing token for cardOnFile transactions when supplying all the payment instrument details.

{ "outcome": "verified", "_links": { "verifications:verification": { "href": "https://try.access.worldpay.com/verifications/accounts/MTphTFVWNXJYcDUvaXdJT214aWNBWHN3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6VXMzQStzaFdwWjZvV2g5STVXK0ZDb3ZiRmVoemdueWpnSDhHZFlmaFZpWitQTHNuWlZMQi84bzV0Z1FOaUZGYkpuTWRNYW9PdTJLY1Q0MURrdkpJMmFveVFJWC92MXArZFRWWUExZTRIdGZrZzBIYnBGeHJCWDJVc1lvMlZhUS8yclRzcHcrcTZ1OUtpZ0JPTVhmRW0zelhaWWl1WjlyR0xIUzR4b3lyOWFNPQ==" }, "tokens:token": { "href": "https://try.access.worldpay.com/tokens/${MAYBE_ENCRYPT:MTUzNTAzNjAzNzAyMjIzMjk0Ng==}" }, "curies": [ { "href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}.json", "name": "verifications", "templated": true }, { "href": "https://try.access.worldpay.com/rels/tokens/{rel}.json", "name": "tokens", "templated": true } ] } }

Verified Tokens oneTime Resource

Request

Create a verified oneTime token by sending a request to oneTime resource. A oneTime verified token allows you to take payments that are made by the customer using a stored verified token, such as in one-click or in-app purchases.

Bodyapplication/vnd.worldpay.verified-tokens-v1.hal+json
paymentInstrumentany(paymentInstrument)required

An object that contains the card details or token location.

typestringrequired
Example:

"card/plain"

Discriminator
cardNumberstring[ 10 .. 19 ] characters^[0-9]*$required
cardExpiryDateobjectrequired
monthinteger[ 1 .. 12 ]required
yearinteger<= 9999required
cvcstring[ 3 .. 4 ] characters^[0-9]*$
cardHolderNamestring(verifiedTokens_cardOnFile_cardHolderName)[ 1 .. 255 ] charactersrequired
billingAddressobject(verifiedTokens_cardOnFile_billingAddress)
merchantobjectrequired
entitystringrequired
verificationCurrencystring= 3 characters^[A-Z]*$required
descriptionstring[ 1 .. 255 ] characters^[^&<]*$
tokenExpiryDateTimestring(date-time)
namespacestring[ 1 .. 64 ] characters
curl -i -X POST \
  -u undefined:undefined \
  https://try.access.worldpay.com/verifiedTokens/oneTime \
  -H 'Content-Type: application/vnd.worldpay.verified-tokens-v1.hal+json' \
  -d '{
    "description": "Token-Description",
    "paymentInstrument": {
      "type": "card/plain",
      "cardHolderName": "SherlockHolmes",
      "cardNumber": "4444333322221111",
      "cardExpiryDate": {
        "month": 5,
        "year": 2035
      },
      "cvc": "123",
      "billingAddress": {
        "address1": "221BBakerStreet",
        "address2": "Marylebone",
        "address3": "Westminster",
        "postalCode": "NW16XE",
        "city": "London",
        "state": "GreaterLondon",
        "countryCode": "GB"
      }
    },
    "narrative": {
      "line1": "TheMindPalaceLtd",
      "line2": "Memory265-13-08-1876"
    },
    "merchant": {
      "entity": "MindPalaceLtd"
    },
    "verificationCurrency": "GBP",
    "namespace": "SHOPPER_ID_1234567890"
  }'

Responses

The payload has been verified and a matching Token already exists. This does not include token meta data, which still may be different

Bodyapplication/vnd.worldpay.verified-tokens-v1.hal+json
outcomestringrequired
Example:

"verified"

_linksobject(verifiedTokens_links)required
verifications:verificationobjectrequired
hrefstring
Example:

"https://try.access.worldpay.com/verifications/accounts/MTphTFVWNXJYcDUvaXdJT214aWNBWHN3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6VXMzQStzaFdwWjZvV2g5STVXK0ZDb3ZiRmVoemdueWpnSDhHZFlmaFZpWitQTHNuWlZMQi84bzV0Z1FOaUZGYkpuTWRNYW9PdTJLY1Q0MURrdkpJMmFveVFJWC92MXArZFRWWUExZTRIdGZrZzBIYnBGeHJCWDJVc1lvMlZhUS8yclRzcHcrcTZ1OUtpZ0JPTVhmRW0zelhaWWl1WjlyR0xIUzR4b3lyOWFNPQ=="

tokens:tokenobjectrequired
hrefstring
Example:

"https://try.access.worldpay.com/tokens/${MAYBE_ENCRYPT:MTUzNTAzNjAzNzAyMjIzMjk0Ng==}"

curiesArray of objectsrequired
hrefstring
Example:

"https://try.access.worldpay.com/rels/verifications/accounts/{rel}.json"

namestring
Example:

"verifications"

templatedboolean
Example:

true

Response
application/vnd.worldpay.verified-tokens-v1.hal+json

Matching an existing token for oneTime transactions when supplying all the payment instrument details.

{ "outcome": "verified", "_links": { "verifications:verification": { "href": "https://try.access.worldpay.com/verifications/accounts/MTphTFVWNXJYcDUvaXdJT214aWNBWHN3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6VXMzQStzaFdwWjZvV2g5STVXK0ZDb3ZiRmVoemdueWpnSDhHZFlmaFZpWitQTHNuWlZMQi84bzV0Z1FOaUZGYkpuTWRNYW9PdTJLY1Q0MURrdkpJMmFveVFJWC92MXArZFRWWUExZTRIdGZrZzBIYnBGeHJCWDJVc1lvMlZhUS8yclRzcHcrcTZ1OUtpZ0JPTVhmRW0zelhaWWl1WjlyR0xIUzR4b3lyOWFNPQ==" }, "tokens:token": { "href": "https://try.access.worldpay.com/tokens/${MAYBE_ENCRYPT:MTUzNTAzNjAzNzAyMjIzMjk0Ng==}" }, "curies": [ { "href": "https://try.access.worldpay.com/rels/verifications/accounts/{rel}.json", "name": "verifications", "templated": true }, { "href": "https://try.access.worldpay.com/rels/tokens/{rel}.json", "name": "tokens", "templated": true } ] } }