# 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 ## Request fields (application/vnd.worldpay.verified-tokens-v3.hal+json): - `paymentInstrument` (any, required) An object that contains the card details or token location. - `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) ## 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.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-bsh.securedataplatform.com/verifications/accounts/Mjp1K3U0cTlvQWhPZFJxN2hQazYyaWx3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6WjBXelE2YmQwNnlwTzRqbXk1bE9ERWZ3emlUbzMyZzlRNFE5a0NkRFV2ZlliWU5wS0FnOUpWcEJZUUIxTkp6Si9Kcy80UEVjUmlGbGcxeTE5SHhSVnJEV3JnUEtkYXk4dFVlYXF6ZDRoZ1k9" - `_embedded.verification._links.curies` (array, required) - `_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) ## 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.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-bsh.securedataplatform.com/verifications/accounts/Mjp1K3U0cTlvQWhPZFJxN2hQazYyaWx3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6WjBXelE2YmQwNnlwTzRqbXk1bE9ERWZ3emlUbzMyZzlRNFE5a0NkRFV2ZlliWU5wS0FnOUpWcEJZUUIxTkp6Si9Kcy80UEVjUmlGbGcxeTE5SHhSVnJEV3JnUEtkYXk4dFVlYXF6ZDRoZ1k9" - `_embedded.verification._links.curies` (array, required) - `_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) ## 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.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-bsh.securedataplatform.com/verifications/accounts/Mjp1K3U0cTlvQWhPZFJxN2hQazYyaWx3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6WjBXelE2YmQwNnlwTzRqbXk1bE9ERWZ3emlUbzMyZzlRNFE5a0NkRFV2ZlliWU5wS0FnOUpWcEJZUUIxTkp6Si9Kcy80UEVjUmlGbGcxeTE5SHhSVnJEV3JnUEtkYXk4dFVlYXF6ZDRoZ1k9" - `_embedded.verification._links.curies` (array, required) - `_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) ## 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.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-bsh.securedataplatform.com/verifications/accounts/Mjp1K3U0cTlvQWhPZFJxN2hQazYyaWx3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6WjBXelE2YmQwNnlwTzRqbXk1bE9ERWZ3emlUbzMyZzlRNFE5a0NkRFV2ZlliWU5wS0FnOUpWcEJZUUIxTkp6Si9Kcy80UEVjUmlGbGcxeTE5SHhSVnJEV3JnUEtkYXk4dFVlYXF6ZDRoZ1k9" - `_embedded.verification._links.curies` (array, required) - `_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.conflicts` (object)