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

Verified Tokens (v3)

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-v3.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
narrativeobject
curl -i -X POST \
  -u undefined:undefined \
  https://try.access.worldpay.com/verifiedTokens/cardOnFile \
  -H 'Content-Type: application/vnd.worldpay.verified-tokens-v3.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-v3.hal+json
_embeddedobjectrequired
verificationobject(embedded_verification_cardOnFile_response)required
outcomestringrequired
Example:

"verified"

schemeTransactionReferencestring
Example:

"000000000000020005060720116005060"

checkedAtstring(date-time)required
Example:

"2024-01-26T17:11:46.226297Z"

riskFactorsArray of objects
paymentInstrumentobject
_linksobjectrequired
verifications:verificationobject
payments:cardOnFileAuthorizeobject
payments:recurringAuthorizeobject
payments:recurringSaleobject
curiesArray of objects
tokenobject(embedded_tokens_response)required
tokenIdstring[ 15 .. 21 ] characters^[0-9A-HJ-NP-Z]+$
Example:

"9902480679618049603"

descriptionstring[ 1 .. 255 ] characters^[^&<]*$required
Example:

"Test Token Description"

namespacestring[ 1 .. 64 ] characters
tokenExpiryDateTimestring(date-time)required
Example:

"2021-08-18T14:30:40Z"

schemeTransactionReferencestring[ 1 .. 56 ] characters^[a-zA-Z0-9 ]*$
Example:

"000000000000020005060720116005060"

tokenPaymentInstrumentobjectrequired
typestring
Example:

"card/tokenized"

hrefstring
Example:

"https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ"

paymentInstrumentobjectrequired
typestring
Example:

"card/masked"

cardNumberstring[ 10 .. 19 ] characters^[0-9\*]*$required
Example:

"4444********1111"

cardHolderNamestring[ 1 .. 255 ] charactersrequired
Example:

"Sherlock Holmes"

cardExpiryDateobjectrequired
monthinteger(int32)[ 1 .. 12 ]required
Example:

5

yearinteger(int32)<= 9999required
Example:

2035

billingAddressobject
binstring= 6 characters\d{6}
Example:

"444433"

brandstring[ 1 .. 255 ] characters
Example:

"VISA"

_linksobjectrequired
tokens:tokenobject
tokens:descriptionobject
tokens:cardHolderNameobject
tokens:cardExpiryDateobject
tokens:billingAddressobject
tokens:schemeTransactionReferenceobject
tokens:networkTokenobject
curiesArray of objects
Response
application/vnd.worldpay.verified-tokens-v3.hal+json

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

{ "_embedded": { "verification": { "outcome": "verified", "schemeTransactionReference": "000000000000020005060720116005060", "checkedAt": "2020-08-18T14:29:10.641180Z", "riskFactors": [ { "risk": "matched", "type": "cvc" }, { "risk": "matched", "detail": "postcode", "type": "avs" }, { "risk": "matched", "detail": "address", "type": "avs" } ], "paymentInstrument": { "type": "card/plain", "card": { "number": {}, "issuer": {}, "expiryDate": {}, "brand": "visa", "fundingType": "debit", "paymentAccountReference": "reference" } }, "_links": { "verifications:verification": { "href": "https://try.access.worldpay.com/verifications/accounts/{resource}" }, "payments:cardOnFileAuthorize": { "href": "https://try.access.worldpay.com/payments/authorizations/cardOnFile/eyJrIjoia2FhYzM1ZiIsImxpbmtWZXJzaW9uIjoiMS4wLjAifQ==.rTSaWnvtqTfgLUF9d+yia:Xr:bMt7SfZl7sgZ0yFtqVrp79hk:hZjQ1rHNZUtukWvMHHnIhvkyp4QhRO0aAcDdOsiNkkSoq+It1ADfLty7k=" }, "payments:recurringAuthorize": { "href": "https://try.access.worldpay.com/payments/authorizations/recurring/eyJrIjoia2FhYzM1ZiIsImxpbmtWZXJzaW9uIjoiMS4wLjAifQ==.rTSaWnvtqTfgLUF9d+yia:Xr:bMt7SfZl7sgZ0yFtqVrp79hk:hZjQ1rHNZUtukWvMHHnIhvkyp4QhRO0aAcDdOsiNkkSoq+It1ADfLty7k=" }, "payments:recurringSale": { "href": "https://try.access.worldpay.com/payments/sales/recurring/eyJrIjoia2FhYzM1ZiIsImxpbmtWZXJzaW9uIjoiMS4wLjAifQ==.rTSaWnvtqTfgLUF9d+yia:Xr:bMt7SfZl7sgZ0yFtqVrp79hk:hZjQ1rHNZUtukWvMHHnIhvkyp4QhRO0aAcDdOsiNkkSoq+It1ADfLty7k=" }, "curies": [ {} ] } }, "token": { "tokenId": "9902480679618049603", "description": "TestTokenDescription", "tokenExpiryDateTime": "2021-08-18T14:30:40Z", "schemeTransactionReference": "000000000000020005060720116005060", "tokenPaymentInstrument": { "type": "card/tokenized", "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ" }, "paymentInstrument": { "type": "card/masked", "cardNumber": "4444********1111", "cardHolderName": "SherlockHolmes", "cardExpiryDate": { "month": 5, "year": 2035 }, "billingAddress": { "address1": "221BBakerStreet", "address2": "Marylebone", "address3": "Westminster", "postalCode": "NW16XE", "city": "London", "state": "GreaterLondon", "countryCode": "GB" }, "bin": "444433", "brand": "VISA" }, "_links": { "tokens:token": { "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ" }, "tokens:description": { "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0MWJVbkh1WTFGZExUNXJxc04va1ZoTFVzYW1OU1lxSFE2NHI1c2JkY1pWaSJ9" }, "tokens:cardHolderName": { "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdjFnVXlzakdPSXdWWkRhZkZyUmlMd3c9PSJ9" }, "tokens:cardExpiryDate": { "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdkVpVW5GNnBsZThNTXNQWTRGbzFzTXc9PSJ9" }, "tokens:billingAddress": { "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdFpSdXFxbWZlNVl1TkpHZEVvZXN3MTlCU0lmdCtxSTUyVDJSdXlmSTIwM3c9PSJ9" }, "tokens:schemeTransactionReference": { "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoiSENXWFZQZjNIZ1V3dnpDMElJZS9Zdmc4M0pYM3dDWEJTVnQrWVlacXdDUXFFKzhzaC8xNSs2d3NkTTdFWUFNVU9tdXBmUlZGeVNDY2dPMkhKV2NIcGc9PSJ9" }, "curies": [ {} ] } } } }

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-v3.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
narrativeobject
curl -i -X POST \
  -u undefined:undefined \
  https://try.access.worldpay.com/verifiedTokens/oneTime \
  -H 'Content-Type: application/vnd.worldpay.verified-tokens-v3.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-v3.hal+json
_embeddedobjectrequired
verificationobject(embedded_verification_oneTime_response)required
outcomestringrequired
Example:

"verified"

checkedAtstring(date-time)required
Example:

"2024-01-26T17:11:46.226297Z"

riskFactorsArray of objects
paymentInstrumentobject
_linksobjectrequired
verifications:verificationobjectrequired
hrefstringrequired
Example:

"https://try.access.worldpay.com/verifications/accounts/Mjp1K3U0cTlvQWhPZFJxN2hQazYyaWx3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6WjBXelE2YmQwNnlwTzRqbXk1bE9ERWZ3emlUbzMyZzlRNFE5a0NkRFV2ZlliWU5wS0FnOUpWcEJZUUIxTkp6Si9Kcy80UEVjUmlGbGcxeTE5SHhSVnJEV3JnUEtkYXk4dFVlYXF6ZDRoZ1k9"

curiesArray of objectsrequired
hrefstringrequired
Example:

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

namestringrequired
Example:

"verifications"

templatedbooleanrequired
Example:

true

tokenobject(embedded_tokens_response)required
tokenIdstring[ 15 .. 21 ] characters^[0-9A-HJ-NP-Z]+$
Example:

"9902480679618049603"

descriptionstring[ 1 .. 255 ] characters^[^&<]*$required
Example:

"Test Token Description"

namespacestring[ 1 .. 64 ] characters
tokenExpiryDateTimestring(date-time)required
Example:

"2021-08-18T14:30:40Z"

schemeTransactionReferencestring[ 1 .. 56 ] characters^[a-zA-Z0-9 ]*$
Example:

"000000000000020005060720116005060"

tokenPaymentInstrumentobjectrequired
typestring
Example:

"card/tokenized"

hrefstring
Example:

"https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ"

paymentInstrumentobjectrequired
typestring
Example:

"card/masked"

cardNumberstring[ 10 .. 19 ] characters^[0-9\*]*$required
Example:

"4444********1111"

cardHolderNamestring[ 1 .. 255 ] charactersrequired
Example:

"Sherlock Holmes"

cardExpiryDateobjectrequired
monthinteger(int32)[ 1 .. 12 ]required
Example:

5

yearinteger(int32)<= 9999required
Example:

2035

billingAddressobject
binstring= 6 characters\d{6}
Example:

"444433"

brandstring[ 1 .. 255 ] characters
Example:

"VISA"

_linksobjectrequired
tokens:tokenobject
tokens:descriptionobject
tokens:cardHolderNameobject
tokens:cardExpiryDateobject
tokens:billingAddressobject
tokens:schemeTransactionReferenceobject
tokens:networkTokenobject
curiesArray of objects
Response
application/vnd.worldpay.verified-tokens-v3.hal+json

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

{ "_embedded": { "verification": { "outcome": "verified", "checkedAt": "2020-08-18T14:29:10.641180Z", "riskFactors": [ { "risk": "matched", "type": "cvc" }, { "risk": "matched", "detail": "postcode", "type": "avs" }, { "risk": "matched", "detail": "address", "type": "avs" } ], "paymentInstrument": { "type": "card/plain", "card": { "number": {}, "issuer": {}, "expiryDate": {}, "brand": "visa", "fundingType": "debit", "paymentAccountReference": "reference" } }, "_links": { "verifications:verification": { "href": "https://try.access.worldpay.com/verifications/accounts/{resource}" }, "curies": [ {} ] } }, "token": { "tokenId": "9902480679618049603", "description": "TestTokenDescription", "tokenExpiryDateTime": "2021-08-18T14:30:40Z", "tokenPaymentInstrument": { "type": "card/tokenized", "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ" }, "paymentInstrument": { "type": "card/masked", "cardNumber": "4444********1111", "cardHolderName": "SherlockHolmes", "cardExpiryDate": { "month": 5, "year": 2035 }, "billingAddress": { "address1": "221BBakerStreet", "address2": "Marylebone", "address3": "Westminster", "postalCode": "NW16XE", "city": "London", "state": "GreaterLondon", "countryCode": "GB" }, "bin": "444433", "brand": "VISA" }, "_links": { "tokens:token": { "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ" }, "tokens:description": { "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0MWJVbkh1WTFGZExUNXJxc04va1ZoTFVzYW1OU1lxSFE2NHI1c2JkY1pWaSJ9" }, "tokens:cardHolderName": { "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdjFnVXlzakdPSXdWWkRhZkZyUmlMd3c9PSJ9" }, "tokens:cardExpiryDate": { "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdkVpVW5GNnBsZThNTXNQWTRGbzFzTXc9PSJ9" }, "tokens:billingAddress": { "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdFpSdXFxbWZlNVl1TkpHZEVvZXN3MTlCU0lmdCtxSTUyVDJSdXlmSTIwM3c9PSJ9" }, "tokens:schemeTransactionReference": { "href": "https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoiSENXWFZQZjNIZ1V3dnpDMElJZS9Zdmc4M0pYM3dDWEJTVnQrWVlacXdDUXFFKzhzaC8xNSs2d3NkTTdFWUFNVU9tdXBmUlZGeVNDY2dPMkhKV2NIcGc9PSJ9" }, "curies": [ {} ] } } } }