Skip to content
APIs/Tokens/
/
Get the actual network to...

Get the actual network token using the network token reference

Request

Retrieve the detail for this network token.

Security
BasicAuth
Path
tokenReferencestringrequired

Access Worldpay tokenReference

curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/network/{tokenReference}'

Responses

Success.

Bodyapplication/vnd.worldpay.tokens-v3.hal+json
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-bsh.securedataplatform.co.uk/tokens/network"
    },
    "tokens:networkTokenLookup": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/tokens/network/aa224320-425c-40b6-9781-2cb7df76b0c8"
    },
    "curies": [
      {
        "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/tokens/{rel}.json",
        "name": "tokens",
        "templated": true
      }
    ]
  }
}