# 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.

Endpoint: POST /verifiedTokens/oneTime
Version: v3
Security: BasicAuth

## Security:

  - `BasicAuth` (unknown)
    http basic

## Request fields (application/vnd.worldpay.verified-tokens-v3.hal+json):

  - `paymentInstrument` (any, required)
    An object that contains the card details or token location.

  - `paymentInstrument.type` (string, required)
    Example: card/plain

  - `paymentInstrument.cardNumber` (string, required)

  - `paymentInstrument.cardExpiryDate` (object, required)

  - `paymentInstrument.cardExpiryDate.month` (integer, required)

  - `paymentInstrument.cardExpiryDate.year` (integer, required)

  - `paymentInstrument.cvc` (string)

  - `paymentInstrument.cardHolderName` (string, required)

  - `paymentInstrument.billingAddress` (object)

  - `paymentInstrument.billingAddress.address1` (string, required)

  - `paymentInstrument.billingAddress.address2` (string)

  - `paymentInstrument.billingAddress.address3` (string)

  - `paymentInstrument.billingAddress.postalCode` (string, required)

  - `paymentInstrument.billingAddress.city` (string, required)

  - `paymentInstrument.billingAddress.state` (string)

  - `paymentInstrument.billingAddress.countryCode` (string, required)

  - `paymentInstrument.sessionHref` (string, required)
    Only session href of type verified token/card created in the same environment are accepted.

  - `merchant` (object, required)

  - `merchant.entity` (string, required)

  - `verificationCurrency` (string, required)

  - `description` (string)

  - `tokenExpiryDateTime` (string)

  - `namespace` (string)

  - `narrative` (object)

  - `narrative.line1` (string, required)

  - `narrative.line2` (string)

## Request examples:

  - `Creating a new token for oneTime transactions when supplying all the payment instrument details.` (unknown)
    Creating a new token for oneTime transactions when supplying all the payment instrument details.

  - `Matching an existing token for oneTime transactions when supplying all the payment instrument details.` (unknown)
    Matching an existing token for oneTime transactions when supplying all the payment instrument details.

  - `Conflicting with an existing token for oneTime transactions when supplying all the payment instrument details.` (unknown)
    Conflicting with an existing token for oneTime transactions when supplying all the payment instrument details.

  - `Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token has been created.` (unknown)
    Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token has been created.

  - `Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token has been matched.` (unknown)
    Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token has been matched.

  - `Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token with conflicts has been returned.` (unknown)
    Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token with conflicts has been returned.

  - `Creating a new token for oneTime transactions using a verified token or card session created by the access checkout SDK.` (unknown)
    Creating a new token for oneTime transactions using a verified token or card session created by the access checkout SDK.

  - `Matching a token for oneTime transactions using a verified token or card session created by the access checkout SDK.` (unknown)
    Matching a token for oneTime transactions using a verified token or card session created by the access checkout SDK.

  - `Conflicts with an existing token for oneTime transactions using a verified token or card session created by the access checkout SDK.` (unknown)
    Conflicts with an existing token for oneTime transactions using a verified token or card session created by the access checkout SDK.

  - `Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token has been created.` (unknown)
    Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token has been created.

  - `Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token has been matched.` (unknown)
    Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token has been matched.

  - `Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token with conflicts has been returned.` (unknown)
    Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token with conflicts has been returned.

## Response 200:

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

## Response 200 fields (application/vnd.worldpay.verified-tokens-v3.hal+json):

  - `_embedded` (object, required)

  - `_embedded.verification` (object, required)

  - `_embedded.verification.outcome` (string, required)
    Example: verified

  - `_embedded.verification.checkedAt` (string, required)
    Example: 2024-01-26T17:11:46.226297Z

  - `_embedded.verification.riskFactors` (array)

  - `_embedded.verification.riskFactors.risk` (string, required)
    Example: matched

  - `_embedded.verification.riskFactors.detail` (string)
    Example: postcode

  - `_embedded.verification.riskFactors.type` (string, required)
    Example: cvc

  - `_embedded.verification.paymentInstrument` (object)

  - `_embedded.verification.paymentInstrument.type` (string, required)
    Example: card/plain

  - `_embedded.verification.paymentInstrument.card` (object)

  - `_embedded.verification.paymentInstrument.card.number` (object)

  - `_embedded.verification.paymentInstrument.card.number.bin` (string, required)
    Example: 4444

  - `_embedded.verification.paymentInstrument.card.number.last4Digits` (string, required)
    Example: 1236

  - `_embedded.verification.paymentInstrument.card.countryCode` (string)
    Example: GB

  - `_embedded.verification.paymentInstrument.card.expiryDate` (object)

  - `_embedded.verification.paymentInstrument.card.expiryDate.month` (integer, required)
    Example: 1

  - `_embedded.verification.paymentInstrument.card.expiryDate.year` (integer, required)
    Example: 2024

  - `_embedded.verification.paymentInstrument.card.brand` (string)
    Example: visa

  - `_embedded.verification.paymentInstrument.card.fundingType` (string)
    Example: credit

  - `_embedded.verification.paymentInstrument.card.issuer` (object)

  - `_embedded.verification.paymentInstrument.card.issuer.name` (string, required)
    Example: UNKNOWN

  - `_embedded.verification.paymentInstrument.card.paymentAccountReference` (string)
    Example: Q1HJZ28RKA1EBL470G9XYG90R5D3E

  - `_embedded.verification._links` (object, required)

  - `_embedded.verification._links.verifications:verification` (object, required)

  - `_embedded.verification._links.verifications:verification.href` (string, required)
    Example: https://try.access.worldpay.com/verifications/accounts/Mjp1K3U0cTlvQWhPZFJxN2hQazYyaWx3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6WjBXelE2YmQwNnlwTzRqbXk1bE9ERWZ3emlUbzMyZzlRNFE5a0NkRFV2ZlliWU5wS0FnOUpWcEJZUUIxT…

  - `_embedded.verification._links.curies` (array, required)

  - `_embedded.verification._links.curies.href` (string, required)
    Example: https://try.access.worldpay.com/rels/verifications/accounts/{rel}

  - `_embedded.verification._links.curies.name` (string, required)
    Example: verifications

  - `_embedded.verification._links.curies.templated` (boolean, required)
    Example: true

  - `_embedded.token` (object, required)

  - `_embedded.token.tokenId` (string)
    Example: 9902480679618049603

  - `_embedded.token.description` (string, required)
    Example: Test Token Description

  - `_embedded.token.namespace` (string)

  - `_embedded.token.tokenExpiryDateTime` (string, required)
    Example: 2021-08-18T14:30:40Z

  - `_embedded.token.schemeTransactionReference` (string)
    Example: 000000000000020005060720116005060

  - `_embedded.token.tokenPaymentInstrument` (object, required)

  - `_embedded.token.tokenPaymentInstrument.type` (string)
    Example: card/tokenized

  - `_embedded.token.tokenPaymentInstrument.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ

  - `_embedded.token.paymentInstrument` (object, required)

  - `_embedded.token.paymentInstrument.type` (string)
    Example: card/masked

  - `_embedded.token.paymentInstrument.cardNumber` (string, required)
    Example: 4444********1111

  - `_embedded.token.paymentInstrument.cardHolderName` (string, required)
    Example: Sherlock Holmes

  - `_embedded.token.paymentInstrument.cardExpiryDate` (object, required)

  - `_embedded.token.paymentInstrument.cardExpiryDate.month` (integer, required)
    Example: 5

  - `_embedded.token.paymentInstrument.cardExpiryDate.year` (integer, required)
    Example: 2035

  - `_embedded.token.paymentInstrument.billingAddress` (object)

  - `_embedded.token.paymentInstrument.billingAddress.address1` (string, required)
    Example: 221B Baker Street

  - `_embedded.token.paymentInstrument.billingAddress.address2` (string)
    Example: Marylebone

  - `_embedded.token.paymentInstrument.billingAddress.address3` (string)
    Example: Westminster

  - `_embedded.token.paymentInstrument.billingAddress.postalCode` (string, required)
    Example: NW1 6XE

  - `_embedded.token.paymentInstrument.billingAddress.city` (string, required)
    Example: London

  - `_embedded.token.paymentInstrument.billingAddress.state` (string)
    Example: Greater London

  - `_embedded.token.paymentInstrument.billingAddress.countryCode` (string, required)
    Example: GB

  - `_embedded.token.paymentInstrument.bin` (string)
    Example: 444433

  - `_embedded.token.paymentInstrument.brand` (string)
    Example: VISA

  - `_embedded.token._links` (object, required)

  - `_embedded.token._links.tokens:token` (object)

  - `_embedded.token._links.tokens:token.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ

  - `_embedded.token._links.tokens:description` (object)

  - `_embedded.token._links.tokens:description.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0MWJVbkh1WTFGZExUNXJxc04va1ZoTFVzYW1OU1lxSFE2NHI1c2JkY1pWaSJ9

  - `_embedded.token._links.tokens:cardHolderName` (object)

  - `_embedded.token._links.tokens:cardHolderName.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdjFnVXlzakdPSXdWWkRhZkZyUmlMd3c9PSJ9

  - `_embedded.token._links.tokens:cardExpiryDate` (object)

  - `_embedded.token._links.tokens:cardExpiryDate.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdkVpVW5GNnBsZThNTXNQWTRGbzFzTXc9PSJ9

  - `_embedded.token._links.tokens:billingAddress` (object)

  - `_embedded.token._links.tokens:billingAddress.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdFpSdXFxbWZlNVl1TkpHZEVvZXN3MTlCU0lmdCtxSTUyVDJSdXlmSTIwM3c9PSJ9

  - `_embedded.token._links.tokens:schemeTransactionReference` (object)

  - `_embedded.token._links.tokens:schemeTransactionReference.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoiSENXWFZQZjNIZ1V3dnpDMElJZS9Zdmc4M0pYM3dDWEJTVnQrWVlacXdDUXFFKzhzaC8xNSs2d3NkTTdFWUFNVU9tdXBmUlZGeVNDY2dPMkhKV2NIcGc9PSJ9

  - `_embedded.token._links.tokens:networkToken` (object)

  - `_embedded.token._links.tokens:networkToken.href` (string)
    Example: https://try.access.worldpay.com/tokens/network

  - `_embedded.token._links.curies` (array)

  - `_embedded.token._links.curies.href` (string)
    Example: https://try.access.worldpay.com/rels/tokens/{rel}.json

  - `_embedded.token._links.curies.name` (string)
    Example: tokens

  - `_embedded.token._links.curies.templated` (boolean)
    Example: true

## Response 201:

  - `201` (unknown)
    The payload has been verified and a Token has been created

## Response 201 fields (application/vnd.worldpay.verified-tokens-v3.hal+json):

  - `_embedded` (object, required)

  - `_embedded.verification` (object, required)

  - `_embedded.verification.outcome` (string, required)
    Example: verified

  - `_embedded.verification.checkedAt` (string, required)
    Example: 2024-01-26T17:11:46.226297Z

  - `_embedded.verification.riskFactors` (array)

  - `_embedded.verification.riskFactors.risk` (string, required)
    Example: matched

  - `_embedded.verification.riskFactors.detail` (string)
    Example: postcode

  - `_embedded.verification.riskFactors.type` (string, required)
    Example: cvc

  - `_embedded.verification.paymentInstrument` (object)

  - `_embedded.verification.paymentInstrument.type` (string, required)
    Example: card/plain

  - `_embedded.verification.paymentInstrument.card` (object)

  - `_embedded.verification.paymentInstrument.card.number` (object)

  - `_embedded.verification.paymentInstrument.card.number.bin` (string, required)
    Example: 4444

  - `_embedded.verification.paymentInstrument.card.number.last4Digits` (string, required)
    Example: 1236

  - `_embedded.verification.paymentInstrument.card.countryCode` (string)
    Example: GB

  - `_embedded.verification.paymentInstrument.card.expiryDate` (object)

  - `_embedded.verification.paymentInstrument.card.expiryDate.month` (integer, required)
    Example: 1

  - `_embedded.verification.paymentInstrument.card.expiryDate.year` (integer, required)
    Example: 2024

  - `_embedded.verification.paymentInstrument.card.brand` (string)
    Example: visa

  - `_embedded.verification.paymentInstrument.card.fundingType` (string)
    Example: credit

  - `_embedded.verification.paymentInstrument.card.issuer` (object)

  - `_embedded.verification.paymentInstrument.card.issuer.name` (string, required)
    Example: UNKNOWN

  - `_embedded.verification.paymentInstrument.card.paymentAccountReference` (string)
    Example: Q1HJZ28RKA1EBL470G9XYG90R5D3E

  - `_embedded.verification._links` (object, required)

  - `_embedded.verification._links.verifications:verification` (object, required)

  - `_embedded.verification._links.verifications:verification.href` (string, required)
    Example: https://try.access.worldpay.com/verifications/accounts/Mjp1K3U0cTlvQWhPZFJxN2hQazYyaWx3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6WjBXelE2YmQwNnlwTzRqbXk1bE9ERWZ3emlUbzMyZzlRNFE5a0NkRFV2ZlliWU5wS0FnOUpWcEJZUUIxT…

  - `_embedded.verification._links.curies` (array, required)

  - `_embedded.verification._links.curies.href` (string, required)
    Example: https://try.access.worldpay.com/rels/verifications/accounts/{rel}

  - `_embedded.verification._links.curies.name` (string, required)
    Example: verifications

  - `_embedded.verification._links.curies.templated` (boolean, required)
    Example: true

  - `_embedded.token` (object, required)

  - `_embedded.token.tokenId` (string)
    Example: 9902480679618049603

  - `_embedded.token.description` (string, required)
    Example: Test Token Description

  - `_embedded.token.namespace` (string)

  - `_embedded.token.tokenExpiryDateTime` (string, required)
    Example: 2021-08-18T14:30:40Z

  - `_embedded.token.tokenPaymentInstrument` (object, required)

  - `_embedded.token.tokenPaymentInstrument.type` (string)
    Example: card/tokenized

  - `_embedded.token.tokenPaymentInstrument.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ

  - `_embedded.token.paymentInstrument` (object, required)

  - `_embedded.token.paymentInstrument.type` (string)
    Example: card/masked

  - `_embedded.token.paymentInstrument.cardNumber` (string, required)
    Example: 4444********1111

  - `_embedded.token.paymentInstrument.cardHolderName` (string, required)
    Example: Sherlock Holmes

  - `_embedded.token.paymentInstrument.cardExpiryDate` (object, required)

  - `_embedded.token.paymentInstrument.cardExpiryDate.month` (integer, required)
    Example: 5

  - `_embedded.token.paymentInstrument.cardExpiryDate.year` (integer, required)
    Example: 2035

  - `_embedded.token.paymentInstrument.billingAddress` (object)

  - `_embedded.token.paymentInstrument.billingAddress.address1` (string, required)
    Example: 221B Baker Street

  - `_embedded.token.paymentInstrument.billingAddress.address2` (string)
    Example: Marylebone

  - `_embedded.token.paymentInstrument.billingAddress.address3` (string)
    Example: Westminster

  - `_embedded.token.paymentInstrument.billingAddress.postalCode` (string, required)
    Example: NW1 6XE

  - `_embedded.token.paymentInstrument.billingAddress.city` (string, required)
    Example: London

  - `_embedded.token.paymentInstrument.billingAddress.state` (string)
    Example: Greater London

  - `_embedded.token.paymentInstrument.billingAddress.countryCode` (string, required)
    Example: GB

  - `_embedded.token.paymentInstrument.bin` (string)
    Example: 444433

  - `_embedded.token.paymentInstrument.brand` (string)
    Example: VISA

  - `_embedded.token._links` (object, required)

  - `_embedded.token._links.tokens:token` (object)

  - `_embedded.token._links.tokens:token.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ

  - `_embedded.token._links.tokens:description` (object)

  - `_embedded.token._links.tokens:description.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0MWJVbkh1WTFGZExUNXJxc04va1ZoTFVzYW1OU1lxSFE2NHI1c2JkY1pWaSJ9

  - `_embedded.token._links.tokens:cardHolderName` (object)

  - `_embedded.token._links.tokens:cardHolderName.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdjFnVXlzakdPSXdWWkRhZkZyUmlMd3c9PSJ9

  - `_embedded.token._links.tokens:cardExpiryDate` (object)

  - `_embedded.token._links.tokens:cardExpiryDate.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdkVpVW5GNnBsZThNTXNQWTRGbzFzTXc9PSJ9

  - `_embedded.token._links.tokens:billingAddress` (object)

  - `_embedded.token._links.tokens:billingAddress.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdFpSdXFxbWZlNVl1TkpHZEVvZXN3MTlCU0lmdCtxSTUyVDJSdXlmSTIwM3c9PSJ9

  - `_embedded.token._links.tokens:schemeTransactionReference` (object)

  - `_embedded.token._links.tokens:schemeTransactionReference.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoiSENXWFZQZjNIZ1V3dnpDMElJZS9Zdmc4M0pYM3dDWEJTVnQrWVlacXdDUXFFKzhzaC8xNSs2d3NkTTdFWUFNVU9tdXBmUlZGeVNDY2dPMkhKV2NIcGc9PSJ9

  - `_embedded.token._links.tokens:networkToken` (object)

  - `_embedded.token._links.tokens:networkToken.href` (string)
    Example: https://try.access.worldpay.com/tokens/network

  - `_embedded.token._links.curies` (array)

  - `_embedded.token._links.curies.href` (string)
    Example: https://try.access.worldpay.com/rels/tokens/{rel}.json

  - `_embedded.token._links.curies.name` (string)
    Example: tokens

  - `_embedded.token._links.curies.templated` (boolean)
    Example: true

## Response 206:

  - `206` (unknown)
    The supplied payload could not be verified. An unverified token has been created/matched

## Response 206 fields (application/vnd.worldpay.verified-tokens-v3.hal+json):

  - `_embedded` (object, required)

  - `_embedded.verification` (object, required)

  - `_embedded.verification.outcome` (string, required)
    Example: verified

  - `_embedded.verification.checkedAt` (string, required)
    Example: 2024-01-26T17:11:46.226297Z

  - `_embedded.verification.riskFactors` (array)

  - `_embedded.verification.riskFactors.risk` (string, required)
    Example: matched

  - `_embedded.verification.riskFactors.detail` (string)
    Example: postcode

  - `_embedded.verification.riskFactors.type` (string, required)
    Example: cvc

  - `_embedded.verification.paymentInstrument` (object)

  - `_embedded.verification.paymentInstrument.type` (string, required)
    Example: card/plain

  - `_embedded.verification.paymentInstrument.card` (object)

  - `_embedded.verification.paymentInstrument.card.number` (object)

  - `_embedded.verification.paymentInstrument.card.number.bin` (string, required)
    Example: 4444

  - `_embedded.verification.paymentInstrument.card.number.last4Digits` (string, required)
    Example: 1236

  - `_embedded.verification.paymentInstrument.card.countryCode` (string)
    Example: GB

  - `_embedded.verification.paymentInstrument.card.expiryDate` (object)

  - `_embedded.verification.paymentInstrument.card.expiryDate.month` (integer, required)
    Example: 1

  - `_embedded.verification.paymentInstrument.card.expiryDate.year` (integer, required)
    Example: 2024

  - `_embedded.verification.paymentInstrument.card.brand` (string)
    Example: visa

  - `_embedded.verification.paymentInstrument.card.fundingType` (string)
    Example: credit

  - `_embedded.verification.paymentInstrument.card.issuer` (object)

  - `_embedded.verification.paymentInstrument.card.issuer.name` (string, required)
    Example: UNKNOWN

  - `_embedded.verification.paymentInstrument.card.paymentAccountReference` (string)
    Example: Q1HJZ28RKA1EBL470G9XYG90R5D3E

  - `_embedded.verification._links` (object, required)

  - `_embedded.verification._links.verifications:verification` (object, required)

  - `_embedded.verification._links.verifications:verification.href` (string, required)
    Example: https://try.access.worldpay.com/verifications/accounts/Mjp1K3U0cTlvQWhPZFJxN2hQazYyaWx3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6WjBXelE2YmQwNnlwTzRqbXk1bE9ERWZ3emlUbzMyZzlRNFE5a0NkRFV2ZlliWU5wS0FnOUpWcEJZUUIxT…

  - `_embedded.verification._links.curies` (array, required)

  - `_embedded.verification._links.curies.href` (string, required)
    Example: https://try.access.worldpay.com/rels/verifications/accounts/{rel}

  - `_embedded.verification._links.curies.name` (string, required)
    Example: verifications

  - `_embedded.verification._links.curies.templated` (boolean, required)
    Example: true

  - `_embedded.token` (object, required)

  - `_embedded.token.tokenId` (string)
    Example: 9902480679618049603

  - `_embedded.token.description` (string, required)
    Example: Test Token Description

  - `_embedded.token.namespace` (string)

  - `_embedded.token.tokenExpiryDateTime` (string, required)
    Example: 2021-08-18T14:30:40Z

  - `_embedded.token.tokenPaymentInstrument` (object, required)

  - `_embedded.token.tokenPaymentInstrument.type` (string)
    Example: card/tokenized

  - `_embedded.token.tokenPaymentInstrument.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ

  - `_embedded.token.paymentInstrument` (object, required)

  - `_embedded.token.paymentInstrument.type` (string)
    Example: card/masked

  - `_embedded.token.paymentInstrument.cardNumber` (string, required)
    Example: 4444********1111

  - `_embedded.token.paymentInstrument.cardHolderName` (string, required)
    Example: Sherlock Holmes

  - `_embedded.token.paymentInstrument.cardExpiryDate` (object, required)

  - `_embedded.token.paymentInstrument.cardExpiryDate.month` (integer, required)
    Example: 5

  - `_embedded.token.paymentInstrument.cardExpiryDate.year` (integer, required)
    Example: 2035

  - `_embedded.token.paymentInstrument.billingAddress` (object)

  - `_embedded.token.paymentInstrument.billingAddress.address1` (string, required)
    Example: 221B Baker Street

  - `_embedded.token.paymentInstrument.billingAddress.address2` (string)
    Example: Marylebone

  - `_embedded.token.paymentInstrument.billingAddress.address3` (string)
    Example: Westminster

  - `_embedded.token.paymentInstrument.billingAddress.postalCode` (string, required)
    Example: NW1 6XE

  - `_embedded.token.paymentInstrument.billingAddress.city` (string, required)
    Example: London

  - `_embedded.token.paymentInstrument.billingAddress.state` (string)
    Example: Greater London

  - `_embedded.token.paymentInstrument.billingAddress.countryCode` (string, required)
    Example: GB

  - `_embedded.token.paymentInstrument.bin` (string)
    Example: 444433

  - `_embedded.token.paymentInstrument.brand` (string)
    Example: VISA

  - `_embedded.token._links` (object, required)

  - `_embedded.token._links.tokens:token` (object)

  - `_embedded.token._links.tokens:token.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ

  - `_embedded.token._links.tokens:description` (object)

  - `_embedded.token._links.tokens:description.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0MWJVbkh1WTFGZExUNXJxc04va1ZoTFVzYW1OU1lxSFE2NHI1c2JkY1pWaSJ9

  - `_embedded.token._links.tokens:cardHolderName` (object)

  - `_embedded.token._links.tokens:cardHolderName.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdjFnVXlzakdPSXdWWkRhZkZyUmlMd3c9PSJ9

  - `_embedded.token._links.tokens:cardExpiryDate` (object)

  - `_embedded.token._links.tokens:cardExpiryDate.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdkVpVW5GNnBsZThNTXNQWTRGbzFzTXc9PSJ9

  - `_embedded.token._links.tokens:billingAddress` (object)

  - `_embedded.token._links.tokens:billingAddress.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdFpSdXFxbWZlNVl1TkpHZEVvZXN3MTlCU0lmdCtxSTUyVDJSdXlmSTIwM3c9PSJ9

  - `_embedded.token._links.tokens:schemeTransactionReference` (object)

  - `_embedded.token._links.tokens:schemeTransactionReference.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoiSENXWFZQZjNIZ1V3dnpDMElJZS9Zdmc4M0pYM3dDWEJTVnQrWVlacXdDUXFFKzhzaC8xNSs2d3NkTTdFWUFNVU9tdXBmUlZGeVNDY2dPMkhKV2NIcGc9PSJ9

  - `_embedded.token._links.tokens:networkToken` (object)

  - `_embedded.token._links.tokens:networkToken.href` (string)
    Example: https://try.access.worldpay.com/tokens/network

  - `_embedded.token._links.curies` (array)

  - `_embedded.token._links.curies.href` (string)
    Example: https://try.access.worldpay.com/rels/tokens/{rel}.json

  - `_embedded.token._links.curies.name` (string)
    Example: tokens

  - `_embedded.token._links.curies.templated` (boolean)
    Example: true

## Response 409:

  - `409` (unknown)
    The payload has been verified but a Token exists that conflicts with some of the details in the request

## Response 409 fields (application/vnd.worldpay.verified-tokens-v3.hal+json):

  - `_embedded` (object, required)

  - `_embedded.verification` (object, required)

  - `_embedded.verification.outcome` (string, required)
    Example: verified

  - `_embedded.verification.checkedAt` (string, required)
    Example: 2024-01-26T17:11:46.226297Z

  - `_embedded.verification.riskFactors` (array)

  - `_embedded.verification.riskFactors.risk` (string, required)
    Example: matched

  - `_embedded.verification.riskFactors.detail` (string)
    Example: postcode

  - `_embedded.verification.riskFactors.type` (string, required)
    Example: cvc

  - `_embedded.verification.paymentInstrument` (object)

  - `_embedded.verification.paymentInstrument.type` (string, required)
    Example: card/plain

  - `_embedded.verification.paymentInstrument.card` (object)

  - `_embedded.verification.paymentInstrument.card.number` (object)

  - `_embedded.verification.paymentInstrument.card.number.bin` (string, required)
    Example: 4444

  - `_embedded.verification.paymentInstrument.card.number.last4Digits` (string, required)
    Example: 1236

  - `_embedded.verification.paymentInstrument.card.countryCode` (string)
    Example: GB

  - `_embedded.verification.paymentInstrument.card.expiryDate` (object)

  - `_embedded.verification.paymentInstrument.card.expiryDate.month` (integer, required)
    Example: 1

  - `_embedded.verification.paymentInstrument.card.expiryDate.year` (integer, required)
    Example: 2024

  - `_embedded.verification.paymentInstrument.card.brand` (string)
    Example: visa

  - `_embedded.verification.paymentInstrument.card.fundingType` (string)
    Example: credit

  - `_embedded.verification.paymentInstrument.card.issuer` (object)

  - `_embedded.verification.paymentInstrument.card.issuer.name` (string, required)
    Example: UNKNOWN

  - `_embedded.verification.paymentInstrument.card.paymentAccountReference` (string)
    Example: Q1HJZ28RKA1EBL470G9XYG90R5D3E

  - `_embedded.verification._links` (object, required)

  - `_embedded.verification._links.verifications:verification` (object, required)

  - `_embedded.verification._links.verifications:verification.href` (string, required)
    Example: https://try.access.worldpay.com/verifications/accounts/Mjp1K3U0cTlvQWhPZFJxN2hQazYyaWx3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6WjBXelE2YmQwNnlwTzRqbXk1bE9ERWZ3emlUbzMyZzlRNFE5a0NkRFV2ZlliWU5wS0FnOUpWcEJZUUIxT…

  - `_embedded.verification._links.curies` (array, required)

  - `_embedded.verification._links.curies.href` (string, required)
    Example: https://try.access.worldpay.com/rels/verifications/accounts/{rel}

  - `_embedded.verification._links.curies.name` (string, required)
    Example: verifications

  - `_embedded.verification._links.curies.templated` (boolean, required)
    Example: true

  - `_embedded.token` (object, required)

  - `_embedded.token.tokenId` (string)
    Example: 9902480679618049603

  - `_embedded.token.description` (string, required)
    Example: Test Token Description

  - `_embedded.token.namespace` (string)

  - `_embedded.token.tokenExpiryDateTime` (string, required)
    Example: 2021-08-18T14:30:40Z

  - `_embedded.token.schemeTransactionReference` (string)
    Example: 000000000000020005060720116005060

  - `_embedded.token.tokenPaymentInstrument` (object, required)

  - `_embedded.token.tokenPaymentInstrument.type` (string)
    Example: card/tokenized

  - `_embedded.token.tokenPaymentInstrument.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ

  - `_embedded.token.paymentInstrument` (object, required)

  - `_embedded.token.paymentInstrument.type` (string)
    Example: card/masked

  - `_embedded.token.paymentInstrument.cardNumber` (string, required)
    Example: 4444********1111

  - `_embedded.token.paymentInstrument.cardHolderName` (string, required)
    Example: Sherlock Holmes

  - `_embedded.token.paymentInstrument.cardExpiryDate` (object, required)

  - `_embedded.token.paymentInstrument.cardExpiryDate.month` (integer, required)
    Example: 5

  - `_embedded.token.paymentInstrument.cardExpiryDate.year` (integer, required)
    Example: 2035

  - `_embedded.token.paymentInstrument.billingAddress` (object)

  - `_embedded.token.paymentInstrument.billingAddress.address1` (string, required)
    Example: 221B Baker Street

  - `_embedded.token.paymentInstrument.billingAddress.address2` (string)
    Example: Marylebone

  - `_embedded.token.paymentInstrument.billingAddress.address3` (string)
    Example: Westminster

  - `_embedded.token.paymentInstrument.billingAddress.postalCode` (string, required)
    Example: NW1 6XE

  - `_embedded.token.paymentInstrument.billingAddress.city` (string, required)
    Example: London

  - `_embedded.token.paymentInstrument.billingAddress.state` (string)
    Example: Greater London

  - `_embedded.token.paymentInstrument.billingAddress.countryCode` (string, required)
    Example: GB

  - `_embedded.token.paymentInstrument.bin` (string)
    Example: 444433

  - `_embedded.token.paymentInstrument.brand` (string)
    Example: VISA

  - `_embedded.token.conflicts` (object)

  - `_embedded.token.conflicts.paymentInstrument` (object)

  - `_embedded.token.conflicts.paymentInstrument.cardHolderName` (string)
    Example: Sherlock Holmes

  - `_embedded.token.conflicts.paymentInstrument.cardExpiryDate` (object)

  - `_embedded.token.conflicts.paymentInstrument.cardExpiryDate.month` (integer, required)
    Example: 5

  - `_embedded.token.conflicts.paymentInstrument.cardExpiryDate.year` (integer, required)
    Example: 2035

  - `_embedded.token.conflicts.paymentInstrument.billingAddress` (object)

  - `_embedded.token.conflicts.paymentInstrument.billingAddress.address1` (string, required)
    Example: 221B Baker Street

  - `_embedded.token.conflicts.paymentInstrument.billingAddress.address2` (string)
    Example: Marylebone

  - `_embedded.token.conflicts.paymentInstrument.billingAddress.address3` (string)
    Example: Westminster

  - `_embedded.token.conflicts.paymentInstrument.billingAddress.postalCode` (string, required)
    Example: NW1 6XE

  - `_embedded.token.conflicts.paymentInstrument.billingAddress.city` (string, required)
    Example: London

  - `_embedded.token.conflicts.paymentInstrument.billingAddress.state` (string)
    Example: Greater London

  - `_embedded.token.conflicts.paymentInstrument.billingAddress.countryCode` (string, required)
    Example: GB

  - `_embedded.token.conflicts.schemeTransactionReference` (string)

  - `_embedded.token._links` (object, required)

  - `_embedded.token._links.tokens:token` (object)

  - `_embedded.token._links.tokens:token.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0NzI0NE1rdUtjMUFJdjYxVnlibWZuUT0ifQ

  - `_embedded.token._links.tokens:description` (object)

  - `_embedded.token._links.tokens:description.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0MWJVbkh1WTFGZExUNXJxc04va1ZoTFVzYW1OU1lxSFE2NHI1c2JkY1pWaSJ9

  - `_embedded.token._links.tokens:cardHolderName` (object)

  - `_embedded.token._links.tokens:cardHolderName.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdjFnVXlzakdPSXdWWkRhZkZyUmlMd3c9PSJ9

  - `_embedded.token._links.tokens:cardExpiryDate` (object)

  - `_embedded.token._links.tokens:cardExpiryDate.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdUpLN2N3VVc5WUk3czRUTW1RQ2JLdkVpVW5GNnBsZThNTXNQWTRGbzFzTXc9PSJ9

  - `_embedded.token._links.tokens:billingAddress` (object)

  - `_embedded.token._links.tokens:billingAddress.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoialRBL0FFelBzcnZpNCtzRGNRemh0d3ltd21ieGo3TlZLYzRYSkExOUhSdFpSdXFxbWZlNVl1TkpHZEVvZXN3MTlCU0lmdCtxSTUyVDJSdXlmSTIwM3c9PSJ9

  - `_embedded.token._links.tokens:schemeTransactionReference` (object)

  - `_embedded.token._links.tokens:schemeTransactionReference.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoiSENXWFZQZjNIZ1V3dnpDMElJZS9Zdmc4M0pYM3dDWEJTVnQrWVlacXdDUXFFKzhzaC8xNSs2d3NkTTdFWUFNVU9tdXBmUlZGeVNDY2dPMkhKV2NIcGc9PSJ9

  - `_embedded.token._links.tokens:conflicts` (object)

  - `_embedded.token._links.tokens:conflicts.href` (string)
    Example: https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoibjY5V0RxZUNzK3lkUXQ3aTVDYTdaNno4cHFtVWcrSlUvcU5wM1ViRE5QaGRlNDNXK1VNaWJ2UWxyRTZYcHpxUDFYcGRiTUhqbWEyMVdzdnljWU03aWRVcnY1WlVzZU1DditLZEExRGx6VUFia…

  - `_embedded.token._links.tokens:networkToken` (object)

  - `_embedded.token._links.tokens:networkToken.href` (string)
    Example: https://try.access.worldpay.com/tokens/network

  - `_embedded.token._links.curies` (array)

  - `_embedded.token._links.curies.href` (string)
    Example: https://try.access.worldpay.com/rels/tokens/{rel}.json

  - `_embedded.token._links.curies.name` (string)
    Example: tokens

  - `_embedded.token._links.curies.templated` (boolean)
    Example: true

## Response 200 examples:

  - `Matching an existing token for oneTime transactions when supplying all the payment instrument details.` (unknown)
    Matching an existing token for oneTime transactions when supplying all the payment instrument details.

  - `Matching a token for oneTime transactions using a verified token or card session created by the access checkout SDK.` (unknown)
    Matching a token for oneTime transactions using a verified token or card session created by the access checkout SDK.

## Response 201 examples:

  - `Creating a new token for oneTime transactions when supplying all the payment instrument details.` (unknown)
    Creating a new token for oneTime transactions when supplying all the payment instrument details.

  - `Creating a new token for oneTime transactions using a verified token or card session created by the access checkout SDK.` (unknown)
    Creating a new token for oneTime transactions using a verified token or card session created by the access checkout SDK.

## Response 206 examples:

  - `Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token has been created.` (unknown)
    Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token has been created.

  - `Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token has been matched.` (unknown)
    Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token has been matched.

  - `Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token with conflicts has been returned.` (unknown)
    Payload cannot be verified for oneTime transactions when supplying all the payment instrument details. An unverified token with conflicts has been returned.

  - `Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token has been created.` (unknown)
    Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token has been created.

  - `Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token has been matched.` (unknown)
    Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token has been matched.

  - `Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token with conflicts has been returned.` (unknown)
    Payload cannot be verified for oneTime transactions using a verified token or card session created by the access checkout SDK. An unverified token with conflicts has been returned.

## Response 409 examples:

  - `Conflicting with an existing token for oneTime transactions when supplying all the payment instrument details.` (unknown)
    Conflicting with an existing token for oneTime transactions when supplying all the payment instrument details.

  - `Conflicts with an existing token for oneTime transactions using a verified token or card session created by the access checkout SDK.` (unknown)
    Conflicts with an existing token for oneTime transactions using a verified token or card session created by the access checkout SDK.

