Verified Tokens (v2)

Download OpenAPI specification:Download

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

Servers

testing (try)

https://try.access.worldpay.com/

live

https://access.worldpay.com/

Verified Tokens cardOnFile Resource

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.

SecurityHTTP: BasicAuth
Request
Request Body schema: application/vnd.worldpay.verified-tokens-v2.hal+json
required
any (paymentInstrument)

An object that contains the card details or token location.

required
object
verificationCurrency
required
string = 3 characters ^[A-Z]*$
description
string [ 1 .. 255 ] characters ^[^&<]*$
tokenExpiryDateTime
string <date-time>
namespace
string [ 1 .. 64 ] characters
post
/verifiedTokens/cardOnFile
Request samples
application/vnd.worldpay.verified-tokens-v2.hal+json

Creating a new token for cardOnFile transactions when supplying all the payment instrument details.

{ "paymentInstrument": { "type": "card/plain", "cardHolderName": "Test name", "cardExpiryDate": { "month": 10, "year": 2030 }, "cardNumber": "4444333322221111", "cvc": "123" }, "merchant": { "entity": "test-reference" }, "verificationCurrency": "GBP" }
Responses

200

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

Response Schema: application/vnd.worldpay.verified-tokens-v2.hal+json
outcome
required
string
Example: "verified"
required
object (verifiedTokens_links)

201

The payload has been verified and a Token has been created.

206

The supplied payload could not be verified. An unverified token has been created/matched.

409

The payload has been verified but a Token exists that conflicts with some of the details in the request.

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

Verified Tokens oneTime Resource

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.

SecurityHTTP: BasicAuth
Request
Request Body schema: application/vnd.worldpay.verified-tokens-v2.hal+json
required
any (paymentInstrument)

An object that contains the card details or token location.

required
object
verificationCurrency
required
string = 3 characters ^[A-Z]*$
description
string [ 1 .. 255 ] characters ^[^&<]*$
tokenExpiryDateTime
string <date-time>
namespace
string [ 1 .. 64 ] characters
post
/verifiedTokens/oneTime
Request samples
application/vnd.worldpay.verified-tokens-v2.hal+json

Creating a new token for oneTime transactions when supplying all the payment instrument details.

{ "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

200

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

Response Schema: application/vnd.worldpay.verified-tokens-v2.hal+json
outcome
required
string
Example: "verified"
required
object (verifiedTokens_links)

201

The payload has been verified and a Token has been created.

206

The supplied payload could not be verified. An unverified token has been created/matched.

409

The payload has been verified but a Token exists that conflicts with some of the details in the request.

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