Skip to content
APIs/Tokens/Network token

Network token

A network token representing a payment instrument.

Operations

Request provisioning for a network token and receive a reference for use later

Request

Request to provision a network token.

Security
BasicAuth
Bodyapplication/vnd.worldpay.tokens-v3.hal+json
paymentInstrumentobjectrequired
merchantobjectrequired

An object that contains information about your merchant account.

{
  "paymentInstrument": {
    "cardHolderName": "Sherlock Holmes",
    "type": "card/front",
    "cardExpiryDate": {
      "month": 1,
      "year": 2035
    },
    "cardNumber": "4444333322221111"
  },
  "merchant": {
    "entity": "default"
  }
}

Responses

Success.

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

A unique reference for a single network token. Use the tokenReference to perform GET operations on a network token resource.

Example:"aa224320-425c-40b6-9781-2cb7df76b0c8"
tokenPaymentInstrumentobject

Details of the network token payment instrument. Include these values where you use this token in payment authorization requests.

paymentInstrumentobjectrequired

Details of the underlying card corresponding to this network token.

provisioningErrorsArray of objects

For a full list of provisioning errors, please see Network token error responses.

Response
{
  "tokenReference": "aa224320-425c-40b6-9781-2cb7df76b0c8",
  "tokenPaymentInstrument": {
    "status": "Active",
    "type": "card/networkToken",
    "tokenNumber": "4917610000000000",
    "expiryDate": {
      "month": 3,
      "year": 2030
    }
  },
  "paymentInstrument": {
    "type": "card/masked",
    "firstSix": "444433",
    "lastFour": "1111",
    "cardExpiryDate": {
      "month": 1,
      "year": 2030
    },
    "paymentAccountReference": "Q1HJZ28RKA1EBL470G9XYG90R5D3E"
  },
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/tokens/network"
    },
    "tokens:networkTokenLookup": {
      "href": "https://try.access.worldpay.com/tokens/network/aa224320-425c-40b6-9781-2cb7df76b0c8"
    },
    "curies": [
      {
        "href": "https://try.access.worldpay.com/rels/tokens/{rel}.json",
        "name": "tokens",
        "templated": true
      }
    ]
  }
}