Menu

Card token type

Worldpay STS tokens (Direct) examples are shown below for the Card token type. Each example includes a request and a response.

Note: eCheck is not supported for Worldpay STS (WPG) tokens.

Token types

Merchants can be onboarded to use either Card or Card Number token types. The token type is configured on the STS system.

If you were onboarded using the Card token type, refer to the Worldpay STS token (Direct) examples shown below.

Headers

Include theTMS-specific headersin all of your requests.

Tokenize card - shopper tokens

Tokenize card - shopper tokens request and response examples are shown below.

Request

  • token.payloadType must be card.
  • outputTokenProviderProfileIds contains your assigned profileId(s) that you want to tokenize against.
  • cardDetails.cardNumber, cardDetails.expirationDate and shopper.id are required.
Copied!
{
    "token": {
        "payloadType": "card"
    },
    "cardDetails": {
        "cardNumber": "5555555555554444",
        "expirationDate": "02/22"
    },
    "shopper": {
        "id": "12345"
    },
    "outputTokenProviderProfileIds": [
        "Your_STSCard_Profile"
    ]
}

Response

Ignore tokens.isNewlyCreated as it does not apply to STS tokens.

Copied!
{
    "tokens": [
        {
            "statusCode": "100",
            "tokenProvider": "STS WPG Token Provider",
            "profileId": "Your_STSCard_Profile",
            "value": "99360732688021433695",
            "payloadType": "card",
            "tokenProviderRefId": "f4aa71e6a8b84dc58f9712ff1f47ca05",
            "isNewlyCreated": false,
            "expirationDate": "2026-06-08 16:13:29Z"
        }
    ],
    "statusCode": "100",
    "requestId": "MMcKNTSKnUCji236U88fkw"
}

Detokenize card - shopper tokens

Detokenize card - shopper tokens request and response examples are shown below.

Request

GET https://dev-tesua-vip.pmdev.local/api/tokens/99360732688021433695?profileId=Your_STSCard_Profile&payloadType=Card&shopperId=12345

Response

Copied!
{
   "cardDetails": {
      "cardNumber": "5555555555554444",
      "expirationDate": "02/22"
   },
   "addressDetails": {},
   "statusCode": "100",
   "requestId": "fAXQDUD2P0Ot0FejKdMxrw"
}

Tokenize card - Merchant tokens

Tokenize card - Merchant tokens request and response examples are shown below.

  • token.payloadType must be card.
  • outputTokenProviderProfileIds contains your assigned profileId(s).
  • cardDetails.cardNumber and cardDetail.expirationDate are required.
  • Other fields are optional.

Request

Copied!
{
    "token": {
        "payloadType": "card"
    },
    "cardDetails": {
        "cardNumber": "5454545454545454",
        "expirationDate": "02/22"
    },
    "addressDetails": {
        "country": "US",
        "state": "Illinois",
        "city": "Chicago",
        "address3": "address3 info",
        "address2": "Suite 567",
        "address1": "1234 Some Street",
        "name": "James Evans",
        "postalCode": "12345"
    },
    "outputTokenProviderProfileIds": [
        "Your_STSCard_Profile"
    ]
}

Response

Ignore tokens.isNewlyCreated as it does not apply to STS tokens.

Copied!
{
    "tokens": [
        {
            "statusCode": "100",
            "tokenProvider": "STS WPG Token Provider",
            "profileId": "Your_STSCard_Profile",
            "value": "99300974229343858351",
            "payloadType": "card",
            "tokenProviderRefId": "aed0cda411684fb9891f9f9696590ecf",
            "isNewlyCreated": false,
            "expirationDate": "2026-06-15 17:26:03Z"
        }
    ],
    "statusCode": "100",
    "requestId": "80Pcg8yzEejH0jzzAMVoQ"
}

Detokenize card - Merchant tokens

Detokenize card - Merchant tokens request and response examples are shown below.

Request

GET https://cert-tesapi.paymetric.com/api/tokens/99300974229343858351?profileId=Your_STSCard_Profile&payloadType=Card

Response

Copied!
{
    "cardDetails": {
        "cardNumber": "5454545454545454",
        "expirationDate": "02/22"
    },
    "addressDetails": {
        "name": "James Evans",
        "address1": "1234 Some Street",
        "address2": "Suite 567",
        "address3": "address3 info",
        "city": "Chicago",
        "state": "Illinois",
        "country": "US",
        "postalCode": "12345"
    },
    "statusCode": "100",
    "requestId": "0jtjCeUXjkKgvrb0spqaZQ"
}