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.

Security

BasicAuth

Bodyapplication/vnd.worldpay.verified-tokens-v1.hal+json

paymentInstrumentanyrequired

merchantobjectrequired

verificationCurrencystring, = 3 characters^[A-Z]*$required

descriptionstring, [ 1 .. 255 ] characters^[^&<]*$

tokenExpiryDateTimestring, (date-time)

namespacestring, [ 1 .. 64 ] characters

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

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-v1.hal+json

outcomestringrequired

Example:"verified"

_linksobjectrequired

Response

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

{
  "outcome": "verified",
  "_links": {
    "verifications:verification": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/verifications/accounts/MTphTFVWNXJYcDUvaXdJT214aWNBWHN3PT06QUVTL0NCQy9QS0NTNVBhZGRpbmc6VXMzQStzaFdwWjZvV2g5STVXK0ZDb3ZiRmVoemdueWpnSDhHZFlmaFZpWitQTHNuWlZMQi84bzV0Z1FOaUZGYkpuTWRNYW9PdTJLY1Q0MURrdkpJMmFveVFJWC92MXArZFRWWUExZTRIdGZrZzBIYnBGeHJCWDJVc1lvMlZhUS8yclRzcHcrcTZ1OUtpZ0JPTVhmRW0zelhaWWl1WjlyR0xIUzR4b3lyOWFNPQ=="
    },
    "tokens:token": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/${MAYBE_ENCRYPT:MTUzNTAzNjAzNzAyMjIzMjk0Ng==}"
    },
    "curies": [
      {
        "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/verifications/accounts/{rel}.json",
        "name": "verifications",
        "templated": true
      },
      {
        "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/tokens/{rel}.json",
        "name": "tokens",
        "templated": true
      }
    ]
  }
}