Retrieve token details using query parameters

Request

At least one of tokenId or namespace must be provided. If the token was created with a namespace, both tokenId and namespace must be supplied. To look up all tokens created under a namespace, query by namespace alone.

Security

BasicAuth

Query

tokenIdstring, [ 15 .. 21 ] characters^[0-9A-HJ-NP-Z]+$

Worldpay's internal identifier for a token. If the token was created with a namespace, namespace must also be included as a query parameter.

Example:tokenId=9925760692793807595

namespacestring, [ 1 .. 64 ] characters

A reference to group up to 16 tokens, e.g. for one customer. When queried by itself, all tokens under the namespace will be returned; when queried in combination with tokenId, a single token will be returned. Avoid personally identifiable information (PII) here to prevent the logging of sensitive identifiers.

Example:namespace=customer-1

curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens?tokenId=9925760692793807595&namespace=customer-1'

Responses

The detail for this token.

Bodyapplication/vnd.worldpay.tokens-v3.hal+json

_embeddedobjectrequired

_linksobjectrequired

Response

{
  "_embedded": {
    "tokens": [
      {
        "tokenPaymentInstrument": {
          "type": "card/tokenized",
          "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoiMmEySFRyUGdFQk9DQVBJWE9vZFQ2NEpJa08rK3hwYktyRnlBenpoWEpQUjRyeUt6Z21BN3NxdDN6VEYxeWNieSJ9"
        },
        "tokenId": "9925760692793807595",
        "description": "Test Token Description",
        "tokenExpiryDateTime": "2026-09-02T14:37:06Z",
        "paymentInstrument": {
          "type": "card/masked",
          "cardNumber": "4444********1111",
          "cardHolderName": "Sherlock Holmes",
          "cardExpiryDate": {
            "month": 5,
            "year": 2037
          },
          "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-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoiMmEySFRyUGdFQk9DQVBJWE9vZFQ2NEpJa08rK3hwYktyRnlBenpoWEpQUjRyeUt6Z21BN3NxdDN6VEYxeWNieSJ9"
          },
          "tokens:description": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoiMmEySFRyUGdFQk9DQVBJWE9vZFQ2NEpJa08rK3hwYktyRnlBenpoWEpQU0dMUkhEVmZ5bjg0VTVBVkVqTFFvcyJ9"
          },
          "tokens:cardHolderName": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoiMmEySFRyUGdFQk9DQVBJWE9vZFQ2NEpJa08rK3hwYktyRnlBenpoWEpQVGp6RWVHOVkxUXpoMEdlMkR0ak9MeU5hRVBwbGlGeVJ1SmozZ2hta2ZFbEo3RnpSN2xPQ210elBIQkZBSzdiNHc9In0"
          },
          "tokens:cardExpiryDate": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoiMmEySFRyUGdFQk9DQVBJWE9vZFQ2NEpJa08rK3hwYktyRnlBenpoWEpQVGp6RWVHOVkxUXpoMEdlMkR0ak9MeXMxVW4ySlIzUTZHclA1aVRDV3FRS3A3RnpSN2xPQ210elBIQkZBSzdiNHc9In0"
          },
          "tokens:billingAddress": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoiMmEySFRyUGdFQk9DQVBJWE9vZFQ2NEpJa08rK3hwYktyRnlBenpoWEpQVGp6RWVHOVkxUXpoMEdlMkR0ak9MeU5aT3d3L1ZGcE1vVjBQL2t2eDBXYlhiQW8rR2RhcUxRdkhGZXJSMDBGRkU9In0"
          },
          "tokens:schemeTransactionReference": {
            "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/eyJrIjoxLCJkIjoiMmEySFRyUGdFQk9DQVBJWE9vZFQ2NEpJa08rK3hwYktyRnlBenpoWEpQU3Q1MlVockRlc2R5K1NKU1FBcUJhMzZjdHFSUklYNS9FWkYvbCtkay90WUE9PSJ9"
          }
        }
      }
    ]
  },
  "_links": {
    "tokens:tokens": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens{?tokenId,namespace}",
      "templated": true
    },
    "resourceTree": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/tokens/resourceTree.json"
    },
    "curies": [
      {
        "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/tokens/{rel}.json",
        "name": "tokens",
        "templated": true
      }
    ]
  }
}