Documentation
Documentation
https://docs.worldpay.com/access/products/payments
Documentation
https://docs.worldpay.com/access/apis
OpenAPI Specification
openapi: 3.0.1
info:
title: 3DS 3DS actions Token API
description: "Protect your business and meet regulatory requirements by verifying your customer's identity.\n\n__Authentication header__\n ```\n Authorization: {your_credentials}\n ```\nReplace `{your_credentials}` with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager.\n<br /> <br />\n\nYou **must** use the `Authorization` header for any request you send to our 3DS API.\n\n__Accept/Content-Type header__\n ```\n Content-Type: application/vnd.worldpay.verifications.customers-v3.hal+json\n Accept: application/vnd.worldpay.verifications.customers-v3.hal+json\n ```\nWe use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our 3DS API.\n\nWe require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a `POST` or a `PUT`.\n<br /><br />\n\n\n__DNS whitelisting__ \nWhitelist the following URLs:\n* `https://try.access.worldpay.com/`\n* `https://access.worldpay.com/`\n\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting."
version: '3'
x-metadata:
category:
- 3DS
- SCA Exemptions
business:
- Enterprise
catalog-list: true
generated: false
servers:
- url: https://try.access.worldpay.com
description: Test (Try)
- url: https://access.worldpay.com
description: Live
security:
- BasicAuth: []
tags:
- name: Token
description: A token representing a payment instrument.
paths:
/tokens:
post:
tags:
- Token
summary: Create a new token
description: Creating a new token for the payment instrument.
operationId: createSecurityToken
requestBody:
content:
application/vnd.worldpay.tokens-v3.hal+json:
schema:
$ref: '#/components/schemas/token_creation'
examples:
Creating a Token:
description: Creating a token from payment instrument
value:
paymentInstrument:
type: card/front
cardHolderName: Testy McTester
cardNumber: '4444333322221111'
cardExpiryDate:
month: 1
year: 2025
merchant:
entity: default
responses:
'200':
headers:
Accept:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
Content-Type:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
Location:
schema:
type: string
format: uri
description: A URI identifying the created token resource.
description: You've already tokenized the card and all data supplied in your create a token request matches the data stored with us.<br/><br/>The existing token resource reference is returned in the tokenPaymentInstrument object.<br><br> **Note:** Sometimes we match a token even if the data doesn't seem quite the same. For example, if we have a billing address on file, this address is retained, if no `billingAddress` object was supplied in your request.
content:
application/vnd.worldpay.tokens-v3.hal+json:
schema:
$ref: '#/components/schemas/tokens_token_200_response'
examples:
Creating a token:
description: A token already exists matching the details in the request.
value:
tokenPaymentInstrument:
type: card/tokenized
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ
tokenId: '9902480679618049603'
description: Test Token Description
tokenExpiryDateTime: '2021-06-24T09:19:35Z'
paymentInstrument:
type: card/masked
cardNumber: 4444********1111
cardHolderName: Sherlock Holmes
cardExpiryDate:
month: 5
year: 2035
billingAddress:
address1: 221B Baker Street
address2: Marylebone
address3: Westminster
postalCode: NW1 6XE
city: London
state: Greater London
countryCode: GB
bin: '444433'
brand: VISA
fundingType: credit
_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:
- href: https://try.access.worldpay.com/rels/tokens/{rel}.json
name: tokens
templated: true
'201':
headers:
Accept:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
Content-Type:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
Location:
schema:
type: string
format: uri
description: A URI identifying the created token resource.
description: Created<br><br>This is the first time you've tokenized this card.</br></br>Your response contains a `tokenPaymentInstrument` object which contains the href to the token resource. The response also includes next available action links, e.g. updating and deleting the token.
content:
application/vnd.worldpay.tokens-v3.hal+json:
schema:
$ref: '#/components/schemas/tokens_token_201_response'
examples:
Token Created:
description: A new token was created.
value:
tokenPaymentInstrument:
type: card/tokenized
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ
tokenId: '9902480679618049603'
description: Test Token Description
tokenExpiryDateTime: '2021-06-24T09:19:35Z'
paymentInstrument:
type: card/masked
cardNumber: 4444********1111
cardHolderName: Sherlock Holmes
cardExpiryDate:
month: 5
year: 2035
billingAddress:
address1: 221B Baker Street
address2: Marylebone
address3: Westminster
postalCode: NW1 6XE
city: London
state: Greater London
countryCode: GB
bin: '444433'
brand: VISA
fundingType: credit
_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:
- href: https://try.access.worldpay.com/rels/tokens/{rel}.json
name: tokens
templated: true
'400':
headers:
Accept:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
Content-Type:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
description: We could not process the request due to a client error.
content:
application/vnd.worldpay.tokens-v3.hal+json:
schema:
$ref: '#/components/schemas/tokens_token_400_response'
examples:
Validation errors:
description: Client error.
value:
errorName: bodyDoesNotMatchSchema
message: The json body provided does not match the expected schema
validationErrors:
- errorName: stringIsTooShort
message: Token description too short - must be between 1 & 255 characters
jsonPath: $.description
- errorName: fieldHasInvalidValue
message: Card expiry month too small - must be between 1 & 12
jsonPath: $.paymentInstrument.cardExpiryDate.month
- errorName: billingAddressMightContainCardNumber
message: Address might contain a card number
jsonPath: $.paymentInstrument.billingAddress.address2
'403':
headers:
Accept:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
Content-Type:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
description: You've already added the maximum number of tokens to the namespace, 16. Please use an alternative namespace or delete some existing tokens from the namespace.
content:
application/vnd.worldpay.tokens-v3.hal+json:
schema:
$ref: '#/components/schemas/tokens_token_403_response'
examples:
Validation errors:
description: Client error.
value:
errorName: tooManyTokensForNamespace
message: Too many tokens created for this namespace
'409':
headers:
Accept:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
Content-Type:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
Location:
schema:
type: string
format: uri
description: A URI identifying the conflicting token resource.
description: Conflict<br> You've already tokenized the card, but some of the data supplied in your create a token request is different from the data in the existing token.<br/><br/>This conflict could be caused by a differentiation in the `cardHolderName`, `cardExpiryDate`, `billingAddress` or `schemeTransactionReference` (see note below) fields.<br/><br/>In this case, the data that we have on file is retained. We return the data which caused the conflict in a conflicts object. If you would like to resolve the conflict, you can update the existing token using the "tokens:conflicts" action link returned in the response.
content:
application/vnd.worldpay.tokens-v3.hal+json:
schema:
$ref: '#/components/schemas/tokens_token_409_response'
examples:
Conflict:
description: A token already exists conflicting with some details in the request.
value:
tokenPaymentInstrument:
type: card/tokenized
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ
tokenId: '9902480679618049603'
description: Test Token Description
tokenExpiryDateTime: '2021-06-24T09:19:35Z'
paymentInstrument:
type: card/masked
cardNumber: 4444********1111
cardHolderName: Sherlock Holmes
cardExpiryDate:
month: 5
year: 2035
billingAddress:
address1: 221B Baker Street
address2: Marylebone
address3: Westminster
postalCode: NW1 6XE
city: London
state: Greater London
countryCode: GB
bin: '444433'
brand: VISA
fundingType: credit
conflicts:
paymentInstrument:
cardHolderName: Sherlock Holmes
conflictsExpiryDateTime: '2019-06-24T09:49:35Z'
_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
tokens:conflicts:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0ODUrN2hvZ0cyK1JvQ3JKdUtFZnU5UTFsdTdwODVHTUcwYy92VW02MDlJd2pHQllvcW0zanhWQ3p3Zk9OUW9CYUZtQ1hNbFhwM3lhSXlkYVlNYWJnQUdQUHFpRVAxVXVpZHM2Y2tvTjEvOGNJdFQ0WkVlVEJIVWF6T1dlWTlQMkpnPT0ifQ
curies:
- href: https://try.access.worldpay.com/rels/tokens/{rel}.json
name: tokens
templated: true
'422':
headers:
Accept:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
Content-Type:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
description: The request was syntactically valid, but we couldn't process the request. For example the card number or card brand is not recognized.
content:
application/vnd.worldpay.tokens-v3.hal+json:
schema:
$ref: '#/components/schemas/tokens_token_422_response'
examples:
Card brand not recognized:
description: The request was syntactically valid, but we couldn't process the request.
value:
errorName: unrecognizedCardBrand
message: The card brand is not recognized
'500':
headers:
Accept:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
Content-Type:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
description: An internal server error occurred.
content:
application/vnd.worldpay.tokens-v3.hal+json:
schema:
$ref: '#/components/schemas/tokens_token_500_response'
examples:
Tokenization not enabled:
description: Internal server error.
value:
errorName: tokenizationNotEnabled
message: Tokenization not enabled
/tokens/{tokenId}:
get:
tags:
- Token
summary: Retrieve the detail for this token
description: A token representing a payment instrument.
operationId: getSecurityToken
parameters:
- name: tokenId
in: path
description: Access Worldpay encrypted token.
required: true
schema:
type: string
responses:
'200':
description: The detail for this token.
content:
application/vnd.worldpay.tokens-v3.hal+json:
schema:
$ref: '#/components/schemas/tokens_token_200_response'
examples:
Retrieve details about a token.:
description: Retrieve details about a token.
value:
tokenPaymentInstrument:
type: card/tokenized
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXckVkRHdJSjFNQzR5VkE5NHhYUldzYz0ifQ
tokenId: '9925760692793807595'
description: Token Description
tokenExpiryDateTime: '2025-01-23T10:57:01Z'
paymentInstrument:
type: card/masked
cardNumber: 4444********1111
cardHolderName: Card Holder Name
cardExpiryDate:
month: 5
year: 2035
bin: '444433'
brand: VISA
fundingType: credit
billingAddress:
address1: Address 1
address2: Address 2
address3: Address 3
postalCode: Postal Code
city: City
state: State
countryCode: XX
_links:
tokens:token:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXckVkRHdJSjFNQzR5VkE5NHhYUldzYz0ifQ
tokens:description:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXdW9oYzR3RUFEM2FCQnlaejhsZ1poTFVzYW1OU1lxSFE2NHI1c2JkY1pWaSJ9
tokens:cardHolderName:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXc2w4WnRHSGdzblFZd2Y4ZU1hLzhXT0pLN2N3VVc5WUk3czRUTW1RQ2JLdjFnVXlzakdPSXdWWkRhZkZyUmlMd3c9PSJ9
tokens:cardExpiryDate:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXc2w4WnRHSGdzblFZd2Y4ZU1hLzhXT0pLN2N3VVc5WUk3czRUTW1RQ2JLdkVpVW5GNnBsZThNTXNQWTRGbzFzTXc9PSJ9
tokens:billingAddress:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXc2w4WnRHSGdzblFZd2Y4ZU1hLzhXTlpSdXFxbWZlNVl1TkpHZEVvZXN3MTlCU0lmdCtxSTUyVDJSdXlmSTIwM3c9PSJ9
tokens:schemeTransactionReference:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXc2w4WnRHSGdzblFZd2Y4ZU1hLzhXTThZcVl5OWJFUHNnbzNpTHd1NlpJSTJxUUNRVXZybWJpRkdyQ0NNQ0g0ZlpsNlBnc1NkL0h5VkRCKyt0Ym9wMGs9In0
tokens:networkToken:
href: https://try.access.worldpay.com/tokens/network
curies:
- href: https://try.access.worldpay.com/rels/tokens/{rel}.json
name: tokens
templated: true
Retrieve details about a token with a network payment instrument.:
description: Retrieve details about a token with a network payment instrument.
value:
tokenPaymentInstrument:
type: card/tokenized
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXckVkRHdJSjFNQzR5VkE5NHhYUldzYz0ifQ
tokenId: '9925760692793807595'
description: Token Description
tokenExpiryDateTime: '2025-01-23T10:57:01Z'
paymentInstrument:
type: card/network+masked
cardNumber: 4818********6530
last4Digits: '6530'
networkType: APPLEPAY
cardExpiryDate:
month: 5
year: 2035
bin: '444433'
brand: VISA
fundingType: credit
_links:
tokens:token:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXckVkRHdJSjFNQzR5VkE5NHhYUldzYz0ifQ
curies:
- href: https://try.access.worldpay.com/rels/tokens/{rel}.json
name: tokens
templated: true
Retrieve details about a token with a namespace.:
description: Retrieve details about a token with a namespace.
value:
tokenPaymentInstrument:
type: card/tokenized
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abnZtYjM3RXppMy84N2J6ZWlXYkhyUiJ9
tokenId: '9925760692793807595'
description: Token Description
tokenExpiryDateTime: '2025-01-23T10:57:01Z'
namespace: my-authenticated-shopper
paymentInstrument:
type: card/masked
cardNumber: 4444********1111
cardHolderName: Card Holder Name
cardExpiryDate:
month: 5
year: 2035
bin: '444433'
brand: VISA
fundingType: credit
billingAddress:
address1: Address 1
address2: Address 2
address3: Address 3
postalCode: Postal Code
city: City
state: State
countryCode: XX
_links:
tokens:token:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abnZtYjM3RXppMy84N2J6ZWlXYkhyUiJ9
tokens:description:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abXlBdGFNaFRIdE1Oc2lybUZQeWFWOTFMR3BqVW1LaDBPdUsrYkczWEdWWWc9PSJ9
tokens:cardHolderName:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abGFqUW1IQ2k5NWk0SEx3U0JrYWdHSWlTdTNNRkZ2V0NPN09FekprQW15cjlZRk1ySXhqaU1GV1EybnhhMFlpOE09In0
tokens:cardExpiryDate:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abGFqUW1IQ2k5NWk0SEx3U0JrYWdHSWlTdTNNRkZ2V0NPN09FekprQW15cnhJbEp4ZXFaWHZERExEMk9CYU5iRE09In0
tokens:billingAddress:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abGFqUW1IQ2k5NWk0SEx3U0JrYWdHSVdVYnFxcG4zdVdMalNSblJLSHJNTmZRVWlIN2ZxaU9kazlrYnNueU50Tjg9In0
tokens:schemeTransactionReference:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abGFqUW1IQ2k5NWk0SEx3U0JrYWdHSVBHS21Ndld4RDdJS040aThMdW1TQ05xa0FrRkw2NW00aFJxd2dqQWgrSDJaZWo0TEVuZng4bFF3ZnZyVzZLZEoifQ
tokens:networkToken:
href: https://try.access.worldpay.com/tokens/network
curies:
- href: https://try.access.worldpay.com/rels/tokens/{rel}.json
name: tokens
templated: true
Retrieve detokenized card details.:
description: Retrieve all card details detokenized.
value:
tokenPaymentInstrument:
type: card/tokenized
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abnZtYjM3RXppMy84N2J6ZWlXYkhyUiJ9
tokenId: '9925760692793807595'
description: Token Description
tokenExpiryDateTime: '2025-01-23T10:57:01Z'
namespace: my-authenticated-shopper
paymentInstrument:
type: card/front
cardNumber: '4444333322221111'
cardHolderName: Card Holder Name
cardExpiryDate:
month: 5
year: 2035
bin: '444433'
brand: VISA
fundingType: credit
billingAddress:
address1: Address 1
address2: Address 2
address3: Address 3
postalCode: Postal Code
city: City
state: State
countryCode: XX
_links:
tokens:token:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abnZtYjM3RXppMy84N2J6ZWlXYkhyUiJ9
tokens:description:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abXlBdGFNaFRIdE1Oc2lybUZQeWFWOTFMR3BqVW1LaDBPdUsrYkczWEdWWWc9PSJ9
tokens:cardHolderName:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abGFqUW1IQ2k5NWk0SEx3U0JrYWdHSWlTdTNNRkZ2V0NPN09FekprQW15cjlZRk1ySXhqaU1GV1EybnhhMFlpOE09In0
tokens:cardExpiryDate:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abGFqUW1IQ2k5NWk0SEx3U0JrYWdHSWlTdTNNRkZ2V0NPN09FekprQW15cnhJbEp4ZXFaWHZERExEMk9CYU5iRE09In0
tokens:billingAddress:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abGFqUW1IQ2k5NWk0SEx3U0JrYWdHSVdVYnFxcG4zdVdMalNSblJLSHJNTmZRVWlIN2ZxaU9kazlrYnNueU50Tjg9In0
tokens:schemeTransactionReference:
href: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXaGdPVU5iVmZ0Rm5TUDZuK3N1Mm5abGFqUW1IQ2k5NWk0SEx3U0JrYWdHSVBHS21Ndld4RDdJS040aThMdW1TQ05xa0FrRkw2NW00aFJxd2dqQWgrSDJaZWo0TEVuZng4bFF3ZnZyVzZLZEoifQ
tokens:networkToken:
href: https://try.access.worldpay.com/tokens/network
curies:
- href: https://try.access.worldpay.com/rels/tokens/{rel}.json
name: tokens
templated: true
'404':
headers:
Accept:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
Content-Type:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
description: We could not find the requested resource. This may be returned if the token resource has been deleted.
content:
application/vnd.worldpay.tokens-v3.hal+json:
schema:
$ref: '#/components/schemas/tokens_token_404_response'
examples:
Tokenization not enabled:
description: Internal server error.
value:
errorName: resourceNotFound
message: Requested resource was not found
'405':
description: Requested method is not allowed.
headers:
Accept:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
Content-Type:
schema:
type: string
description: application/vnd.worldpay.tokens-v3.hal+json
content:
application/vnd.worldpay.tokens-v3.hal+json:
schema:
$ref: '#/components/schemas/tokens_token_405_response'
examples:
Method not allowed:
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/worldpay/refs/heads/main/openapi/worldpay-token-api-openapi.yml