{"templateId":"markdown","versions":[{"version":"v1","label":"v1","link":"/products/tokens/v1/get-started","default":false,"active":true,"folderId":"13618f6a"},{"version":"v2","label":"v2","link":"/products/tokens/v2/get-started","default":false,"active":false,"folderId":"13618f6a"},{"version":"v3","label":"v3","link":"/products/tokens/v3/get-started","default":true,"active":false,"folderId":"13618f6a"}],"sharedDataIds":{"sidebar":"sidebar-products/tokens/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/tokens/openapi"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition","code-snippet"]},"custom_product":"Tokens","type":"markdown"},"seo":{"title":"Get started with our Tokens API","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay.com/access","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay.com/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"],"excludeFiles":[]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"],"excludeFiles":[]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"],"excludeFiles":[]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"],"excludeFiles":[]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"],"excludeFiles":[]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"],"excludeFiles":[]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"],"excludeFiles":[]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"],"excludeFiles":[]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"],"excludeFiles":[]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"],"excludeFiles":[]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"],"excludeFiles":[]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"],"excludeFiles":[]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"],"excludeFiles":[]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"],"excludeFiles":[]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"],"excludeFiles":[]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"],"excludeFiles":[]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"],"excludeFiles":[]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"],"excludeFiles":[]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"],"excludeFiles":[]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"],"excludeFiles":[]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"],"excludeFiles":[]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"],"excludeFiles":[]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]},": 12 May 2025 | ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/changelog/"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Change log"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-started-with-our-tokens-api","__idx":0},"children":["Get started with our Tokens API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make yourself familiar with our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/reference/api-principles"},"children":["API Principles"]}," to ensure a resilient integration."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"set-your-headers","__idx":1},"children":["Set your headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Setting your headers is an important part of an API request. The headers represent the meta-data associated with your API request."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Authorization: {your_credentials}\nContent-Type: application/vnd.worldpay.tokens-v1.hal+json\nAccept: application/vnd.worldpay.tokens-v1.hal+json\n"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header is used for authentication and identification of our merchants within Access Worldpay. You ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["must"]}," use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header for any request you send to our Tokens API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}," header is required if the request you're sending includes a request body, and if the HTTP method is a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," or a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}," header is used to identify which version of our Tokens API you are using. You ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["must"]}," use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}," header for any request you send to our Tokens API."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you're using both the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}," headers, they must match."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{your_credentials}"]}," with your base64-encoded Basic Auth username and password. To get your Access Worldpay credentials contact your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.worldpay.com/en-GB/merchant-support#still-need-help"},"children":["Worldpay Implementation Manager"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":2},"children":["Next steps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We have reviewed our API Principle approach and consider our resources stable and unlikely to change. This means you can skip querying the root resource for a quicker integration and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/v1/create-a-token"},"children":["POST directly to the API resource"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you do want to discover all available resources, you can expand the below section \"Query the root resource\" for further steps."]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Query the root resource"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Our APIs guide you by providing you with links to the next available actions."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To discover and start using our APIs you can query the root resource first. This returns the available resources within Access Worldpay."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request","__idx":3},"children":["Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No request body is needed for this request."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":4},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You receive all our available API resources in the response."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/try-root-resource.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"_links\": {\n    \"payments:authorize\": {\n      \"href\": \"https://try.access.worldpay.com/payments/authorizations\"\n    },\n    \"service:payments\": {\n      \"href\": \"https://try.access.worldpay.com/payments\"\n    },\n    \"service:sessions\": {\n      \"href\": \"https://try.access.worldpay.com/sessions\"\n    },\n    \"service:tokens\": {\n      \"href\": \"https://try.access.worldpay.com/tokens\"\n    },\n    \"service:verifications/accounts\": {\n      \"href\": \"https://try.access.worldpay.com/verifications/accounts\"\n    },\n    \"service:verifications/customers/3ds\": {\n      \"href\": \"https://try.access.worldpay.com/verifications/customers/3ds\"\n    },\n    \"service:verifiedTokens\": {\n      \"href\": \"https://try.access.worldpay.com/verifiedTokens\"\n    },\n    \"service:fraudsight\": {\n      \"href\": \"https://try.access.worldpay.com/fraudsight\"\n    },\n    \"service:exemptions\": {\n      \"href\": \"https://try.access.worldpay.com/exemptions\"\n    },\n    \"service:payouts\": {\n      \"href\": \"https://try.access.worldpay.com/payouts\"\n    },\n    \"service:payments/alternative/direct\": {\n      \"href\": \"https://try.access.worldpay.com/payments/alternative/direct\"\n    },\n    \"service:payments/alternative/action/paypal\": {\n      \"href\": \"https://try.access.worldpay.com/payments/alternative/action/paypal\"\n    },\n    \"service:payments/alternative/action/ideal\": {\n      \"href\": \"https://try.access.worldpay.com/payments/alternative/action/ideal\"\n    },\n    \"service:payouts/accounts\": {\n      \"href\": \"https://try.access.worldpay.com/payouts/accounts\"\n    },\n    \"service:payouts/events\": {\n      \"href\": \"https://try.access.worldpay.com/payouts/events\"\n    },\n    \"service:moneyTransfers\": {\n      \"href\": \"https://try.access.worldpay.com/moneyTransfers\"\n    },\n    \"service:foreignExchange\": {\n      \"href\": \"https://try.access.worldpay.com/foreignExchange\"\n    },\n    \"service:accounts/statements\": {\n      \"href\": \"https://try.access.worldpay.com/accounts/statements\"\n    },\n    \"service:accounts/balance\": {\n      \"href\": \"https://try.access.worldpay.com/accounts/balance\"\n    },\n    \"service:accounts/transfer\": {\n      \"href\": \"https://try.access.worldpay.com/accounts/transfer\"\n    },\n    \"curies\": [\n      {\n        \"href\": \"https://try.access.worldpay.com/rels/payments/{rel}\",\n        \"name\": \"payments\",\n        \"templated\": true\n      }\n    ]\n  }\n}"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"query-the-tokens-root-resource","__idx":5},"children":["Query the Tokens root resource"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Query the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["service:tokens"]}," resource which gives you links to your next available actions and resources for our Tokens API."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-1","__idx":6},"children":["Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},"  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/tokens"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No request body is needed for this request."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-1","__idx":7},"children":["Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"./code/token-root-resource.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"_links\": {\n        \"tokens:tokens\": {\n            \"href\": \"https://try.access.worldpay.com/tokens{?tokenId,namespace}\",\n            \"templated\": true\n        },\n        \"tokens:networkToken\": {\n            \"href\": \"https://try.access.worldpay.com/tokens/network\"\n        },\n        \"resourceTree\": {\n            \"href\": \"https://try.access.worldpay.com/rels/tokens/resourceTree.json\"\n        },\n        \"curies\": [{\n            \"href\": \"https://try.access.worldpay.com/rels/tokens/{rel}.json\",\n            \"name\": \"tokens\",\n            \"templated\": true\n        }]\n    }\n}"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"resources","__idx":8},"children":["Resources"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resources"},"children":["Resources"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tokens:tokens"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You can use this resource to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/v1/create-a-token#create-a-token"},"children":["create a token"]}," or to find a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/v1/query-and-update-tokens#token-inquiry"},"children":["token"]}," or a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/v1/query-and-update-tokens#token-namespace-inquiry-request"},"children":["token in a namespace"]}," that you've previously created."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"dns-whitelisting","__idx":9},"children":["DNS whitelisting"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whitelist the following URLs:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://try.access.worldpay.com/"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://access.worldpay.com/"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Please ensure you use DNS whitelisting not explicit IP whitelisting."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"link-caching","__idx":10},"children":["Link caching"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you make a request within Access Worldpay, you should always cache the response returned."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Next steps"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/v1/create-a-token"},"children":["Create a token"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]}]},"headings":[{"value":"Get started with our Tokens API","id":"get-started-with-our-tokens-api","depth":1},{"value":"Set your headers","id":"set-your-headers","depth":2},{"value":"Next steps","id":"next-steps","depth":2},{"value":"Request","id":"request","depth":3},{"value":"Response","id":"response","depth":3},{"value":"Query the Tokens root resource","id":"query-the-tokens-root-resource","depth":2},{"value":"Request","id":"request-1","depth":3},{"value":"Response","id":"response-1","depth":3},{"value":"Resources","id":"resources","depth":4},{"value":"DNS whitelisting","id":"dns-whitelisting","depth":2},{"value":"Link caching","id":"link-caching","depth":3}],"frontmatter":{"seo":{"title":"Get started with our Tokens API"}},"lastModified":"2026-05-13T07:59:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/tokens/v1/get-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}