A Token representing a payment instrument.

Methods

GET

Retrieve the detail for this Token.

Responses

Response schema

Copied!
{
 "type": "object",
 "properties": {
  "tokenPaymentInstrument": {
   "type": "object",
   "properties": {
    "type": {
     "type": "string"
    },
    "href": {
     "type": "string"
    }
   }
  },
  "tokenId": {
   "type": "string",
   "minLength": 15,
   "maxLength": 21,
   "pattern": "^[0-9A-HJ-NP-Z]+$"
  },
  "description": {
   "type": "string",
   "minLength": 1,
   "maxLength": 255,
   "pattern": "^[^&<]*$"
  },
  "tokenExpiryDateTime": {
   "type": "string",
   "format": "date-time"
  },
  "namespace": {
   "type": "string",
   "minLength": 1,
   "maxLength": 64
  },
  "schemeTransactionReference": {
   "type": "string",
   "minLength": 1,
   "maxLength": 56,
   "pattern": "^[a-zA-Z0-9 ]*$"
  },
  "paymentInstrument": {
   "type": "object",
   "properties": {
    "type": {
     "type": "string"
    },
    "cardNumber": {
     "type": "string",
     "minLength": 10,
     "maxLength": 19,
     "pattern": "^[0-9\\*]*$"
    },
    "cardHolderName": {
     "type": "string",
     "minLength": 1,
     "maxLength": 255
    },
    "cardExpiryDate": {
     "type": "object",
     "properties": {
      "month": {
       "type": "integer",
       "minimum": 1,
       "maximum": 12
      },
      "year": {
       "type": "integer",
       "maximum": 9999
      }
     },
     "required": [
      "month",
      "year"
     ]
    },
    "bin": {
     "type": "string",
     "minLength": 6,
     "maxLength": 6,
     "pattern": "\\d{6}"
    },
    "brand": {
     "type": "string",
     "minLength": 1,
     "maxLength": 255
    },
    "billingAddress": {
     "type": "object",
     "properties": {
      "address1": {
       "type": "string"
      },
      "address2": {
       "type": "string"
      },
      "address3": {
       "type": "string"
      },
      "postalCode": {
       "type": "string"
      },
      "city": {
       "type": "string"
      },
      "state": {
       "type": "string"
      },
      "countryCode": {
       "type": "string",
       "pattern": "^[A-Z]*$",
       "minLength": 2,
       "maxLength": 2
      }
     },
     "networkType": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
     },
     "last4Digits": {
      "type": "string",
      "minLength": 4,
      "maxLength": 4
     },
     "required": [
      "address1",
      "postalCode",
      "city",
      "countryCode"
     ]
    }
   },
   "required": [
    "cardNumber",
    "cardExpiryDate"
   ]
  },
  "_links": {
   "type": "object",
   "format": "hal+json"
  }
 },
 "required": [
  "tokenPaymentInstrument",
  "description",
  "tokenExpiryDateTime",
  "paymentInstrument",
  "_links"
 ]
}

Examples

GET
 Retrieve details about a token.
View
GET
 Retrieve details about a token with a network payment instrument.
View
GET
 Retrieve details about a token with a namespace.
View
DELETE

Delete this token.

Responses

Examples

DELETE
 Delete a Token.
View

Link relationship

get
 Retrieve details about a token. 
GET https://try.access.worldpay.com/tokens/eyJrIjoxLCJkIjoia0gvT2xpdDV3WnpOZG1GTWpwemtXckVkRHdJSjFNQzR5VkE5NHhYUldzYz0ifQ
Copied!
{
  "Accept": "application/vnd.worldpay.tokens-v2.hal+json"
}