{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/smb/plugins/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial","badge","admonition"]},"type":"markdown"},"seo":{"title":"WooCommerce","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"]},": 10 April 2026 | ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/smb/plugins/changelog/"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Change log"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"woocommerce","__idx":0},"children":["WooCommerce"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Badge","attributes":{"size":"small","fontWeight":"bold","color":"var(--wp-colour-black)","mt":"0rem","mb":"0.5rem","px":"1rem","py":"0.5rem","borderRadius":"6rem","bg":"#A5EFFF"},"children":["SMB (Worldpay eCommerce)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the WooCommerce Plugin to integrate your online store into Worldpay eCommerce."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Prerequisite"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You must have a Worldpay eCommerce account with us and access to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.worldpay.com/"},"children":["Dashboard Portal"]},"."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Compatibility"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Plugin is designed to function as the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["only"]}," active payment or checkout-related Plugin in your store. Using it together with other third-party Plugins performing similar functions may lead to conflicts and unexpected behavior."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If issues occur, we recommend you:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["deactivate all other payment, subscription, and checkout Plugins"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["test with only the Worldpay Plugin enabled"]}]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Go and watch our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.youtube.com/watch?v=fxyCNlRE25s"},"children":["video tutorial"]}," on how to install the WooCommerce Plugin!"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"woocommerce-version-support","__idx":1},"children":["WooCommerce version support"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Woocommerce version required at least: 8.4.0",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","Woocommerce version tested up to: 8.5.1",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","Wordpress required at least: 6.4.2",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","PHP version required at least: 7.4",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-get-the-plugin","__idx":2},"children":["How to get the Plugin"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Install the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/Worldpay/Worldpay-Ecommerce/tree/main/EmbeddedCheckout/Woocommerce"},"children":["WooCommerce Plugin"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log in with your WooCommerce credentials."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"retrieve-your-credentials","__idx":3},"children":["Retrieve your credentials"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log into your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.worldpay.com/"},"children":["dashboard"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click on \"Developer Tools\"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click on \"API Credentials\"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Choose \"Try mode\" and retrieve your credentials. You need:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["your Try API username"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["your Try API password"]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/access/assets/creds-try.d70152284bf1bd2581f9a280e401f6f1e86e1e66127550f890531250f23fb2a8.5e4dae80.png","alt":"Dashboard Try username and password example screenshot"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":6},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If you want to you use the embedded checkout, click on \"Access Checkout\". You also need:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["your Try Checkout ID"]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/access/assets/checkout-try.2fa1c4084e3eee2a0e59130da9912802f576d22bcb2fed84e2e2b6460a75220a.5e4dae80.png","alt":"Try Checkout ID example screenshot"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"retrieve-your-entity","__idx":4},"children":["Retrieve your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log into your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.worldpay.com/"},"children":["dashboard"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click on \"Developer Tools\"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You can find your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]}," next to \"Entity\" usually prefixed with \"PO\"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/access/assets/entity.5108dc92b9d02c90d2a45327a98b6d126b84067bf184bf78703b6d6d5be623ec.5e4dae80.png","alt":"Dashboard entity example screenshot"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"installing-the-woocommerce-plugin","__idx":5},"children":["Installing the WooCommerce Plugin"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://wordpress.com/log-in/"},"children":["WordPress Admin Dashboard"]},", go to \"Plugins\" then click \"Add New\" then click \"Upload Plugin\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click \"Install\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once installed click \"Activate\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Go to the \"Payments\" tab and tick the box to \"Enable Worldpay\""]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/access/assets/config.ee66cb3eff2ebb4a05d1cb31cea6cd163ae0db28b03b69b6df01181bfe541433.72afc7f5.jpg","alt":"WordPress Payments tab, enable Worldpay box screenshot"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Scroll down and enter your Worldpay Try username and password in the \"Try API Credentials\" section"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/access/assets/woo_creds.9692fa01c65d0a64828b88071688ffd408274c7af1a85aaa09b6df783b5249dc.72afc7f5.png","alt":"Try username and password form screenshot"},"children":[]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["\"Save changes\""]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"setup-recurring-payments","__idx":6},"children":["Setup recurring payments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can offer subscription payments by navigating to \"Settings\" and then clicking on the \"Subscriptions\" tab in your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://wordpress.com/log-in/"},"children":["WooCommerce dashboard"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can find full instructions on how to setup your recurring offering in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://woocommerce.com/documentation/products/extensions/woocommerce-subscriptions/subscriptions-management/"},"children":["WooCommerce subscription management guide"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Among other things, the portal allows you to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["edit button text"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["set subscriber roles"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["enable retries and customer notifications"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["set a sales price - the initial charge that ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["is lower"]}," than any subsequent amounts of the subscription e.g. promotions, offers etc."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["set a subscriptions price - the recurring subsequent amount you want to charge in the subscription"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["set renewal schedules"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["enable sign-up fees"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["set free trial periods"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"testing","__idx":7},"children":["Testing"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have configured your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://wordpress.com/log-in/"},"children":["WooCommerce Worldpay Plugin"]},", you can take test transactions using our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-payment-pages/testing"},"children":["test card numbers"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To view your test transactions, log into your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://wordpress.com/log-in/"},"children":["WordPress Admin Dashboard"]},". Click on \"Orders\" where the test transactions appear."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/access/assets/test.fa93e3db3bce839db0e60c9f2fe10bd5fc527bc308204c2e44a399222e3b34f9.72afc7f5.jpg","alt":"WordPress Orders tab screenshot"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"go-live","__idx":8},"children":["Go live"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These are the steps you need to follow to go live:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log into your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.worldpay.com/"},"children":["dashboard"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click on \"Developer Tools\"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click on \"API Credentials\"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Choose \"Live mode\" and retrieve your credentials. You need:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["your Live API username"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["your Live API password"]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/access/assets/creds-live.e0b0dff280bda136e190bc5839201a58a9da0c7285968f63fb5309e37dcaac76.5e4dae80.png","alt":"Dashboard Live mode username and password example screenshot"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":6},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If you are using embedded checkout, click on \"Access Checkout\" and get:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["your Live Checkout ID"]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/access/assets/checkout-live.673d3e98ff70f7fcc228b4be67a61fbd4a03c87d0d32d74e0b66b87303ddbab2.5e4dae80.png","alt":"Live mode Checkout ID example screenshot"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your Live credentials and Checkout ID are different to any other Worldpay credentials you already have. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity"]}," used for production transactions is the same for Try and Live."]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Navigate to the WooCommerce \"Payments\" screen in your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://wordpress.com/log-in/"},"children":["WordPress Admin Dashboard"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tick the \"Enable live mode\" box."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Copy and paste the credentials from your dashboard to the config screen. This time making sure they are going into the \"Live API Credentials\" section."," ",{"$$mdtype":"Tag","name":"img","attributes":{"src":"/access/assets/woo_creds.9692fa01c65d0a64828b88071688ffd408274c7af1a85aaa09b6df783b5249dc.72afc7f5.png","alt":"Live API Credentials screenshot"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ensure the \"debug\" toggle is off."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You can now initiate a live transaction."]}]}]},"headings":[{"value":"WooCommerce","id":"woocommerce","depth":1},{"value":"WooCommerce version support","id":"woocommerce-version-support","depth":2},{"value":"How to get the Plugin","id":"how-to-get-the-plugin","depth":2},{"value":"Retrieve your credentials","id":"retrieve-your-credentials","depth":3},{"value":"Retrieve your entity","id":"retrieve-your-entity","depth":3},{"value":"Installing the WooCommerce Plugin","id":"installing-the-woocommerce-plugin","depth":3},{"value":"Setup recurring payments","id":"setup-recurring-payments","depth":3},{"value":"Testing","id":"testing","depth":2},{"value":"Go live","id":"go-live","depth":2}],"frontmatter":{"seo":{"title":"WooCommerce"}},"lastModified":"2026-04-02T10:28:31.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/smb/plugins/woocommerce","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}