Access Worldpay
/
Network Token

Tokens (3)

Authentication Header

  Authorization: {your_credentials}

Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Implementation Manager.

You must use the Authorization header for any request you send to our Token API, unless you are using client certificate authenticating with SSL/TLS.

Accept Header

  Accept: application/vnd.worldpay.tokens-v3.hal+json

We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Account APIs.

DNS Whitelisting

Whitelist the following URLs:

  • https://try.access.worldpay.com/
  • https://access.worldpay.com/

Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
testing (try)
https://try.access.worldpay.com/
live
https://access.worldpay.com/

Token

A token representing a payment instrument.

Operations

Network Token

A Network Token representing a payment instrument.

Operations

Get the actual network token using the network token reference

Request

Retrieve the detail for this network token

Path
networkTokenIdstringrequired

Network Token Id

No request payload

Responses

Success

Bodyapplication/vnd.worldpay.tokens-v3.hal+json
tokenPaymentInstrumentobjectrequired
statusstringrequired
typestringrequired
tokenNumberstring
expiryDateobject
paymentInstrumentobjectrequired
typestringrequired
firstSixstringrequired
lastFourstringrequired
cardExpiryDateobjectrequired
provisioningErrorsArray of objects
errorCodestringrequired
providerErrorCodestringrequired
sourcestringrequired
contextstringrequired
messagestringrequired
Response
application/vnd.worldpay.tokens-v3.hal+json

Get a network token after it has been provisioned.

{
  "tokenPaymentInstrument": {
    "status": "Active",
    "type": "card/networkToken",
    "tokenNumber": "4111111111111111",
    "expiryDate": {
      "month": 12,
      "year": 2025
    }
  },
  "paymentInstrument": {
    "type": "card/masked",
    "firstSix": "411111",
    "lastFour": "1111",
    "cardExpiryDate": {
      "month": 12,
      "year": 2025
    },
    "paymentAccountReference": "41111111111111111111111111111"
  },
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/tokens/network/aa224320-425c-40b6-9781-2cb7df76b0c8"
    },
    "tokens:networkTokenCryptogram": {
      "href": "https://try.access.worldpay.com/tokens/network/cryptograms"
    },
    "curies": [
      {
        "href": "https://try.access.worldpay.com/rels/tokens/{rel}.json",
        "name": "tokens",
        "templated": true
      }
    ]
  }
}

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

Request

TBD.

Bodyapplication/vnd.worldpay.tokens-v3.hal+json
paymentInstrumentobjectrequired
typestringrequired
cardHolderNamestring

The name on the customer's card.

cardExpiryDateobject
cardNumberstring
hrefstring
merchantobjectrequired

An object that contains information about your merchant account.

entitystringrequired

Identifies merchant account for billing, reporting and reconciliation. Contact your Implementation Manager for more details.

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

Request to provision a network token.

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

Responses

Success

Bodyapplication/vnd.worldpay.tokens-v3.hal+json
tokenReferencestringrequired
paymentInstrumentobjectrequired
typestringrequired
firstSixstringrequired
lastFourstringrequired
cardExpiryDateobjectrequired
paymentAccountReferencestringrequired
tokenPaymentInstrumentobject
statusstringrequired
typestringrequired
tokenNumberstringrequired
expiryDateobjectrequired
Response
application/vnd.worldpay.tokens-v3.hal+json

Request to provision a network token.

{
  "tokenReference": "aa224320-425c-40b6-9781-2cb7df76b0c8",
  "paymentInstrument": {
    "type": "card/masked",
    "firstSix": "444433",
    "lastFour": "1111",
    "cardExpiryDate": {
      "month": 1,
      "year": 2050
    },
    "paymentAccountReference": "41111111111111111111111111111"
  },
  "_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
      }
    ]
  }
}

Provision a cryptogram for short time use based on a network token

Request

TBD.

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

Provision a cryptogram based on a network token

{
  "tokenNumber": "4111111111111111"
}

Responses

Success

Bodyapplication/vnd.worldpay.tokens-v3.hal+json
cryptogramDetailsobjectrequired
cryptogramstringrequired
ecistringrequired
Response
application/vnd.worldpay.tokens-v3.hal+json

Provision a cryptogram based on a network token

{
  "cryptogramDetails": {
    "cryptogram": "AgAAAAAASFh+gDRt/rq8QOkAAAA=",
    "eci": "07"
  },
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/tokens/network/cryptograms"
    },
    "tokens:networkTokenLookup": {
      "href": "https://try.access.worldpay.com/tokens/network/{tokenReference}",
      "templated": true
    },
    "curies": [
      {
        "href": "https://try.access.worldpay.com/rels/tokens/{rel}.json",
        "name": "tokens",
        "templated": true
      }
    ]
  }
}