> For the complete documentation index, see [llms.txt](https://help.peoplevine.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.peoplevine.com/products/integrations-overview/setup-worldpay.md).

# How to Set Up Worldpay

> **Note:** Worldpay is a retiring integration. New clients should use [Stripe](/products/integrations-overview/setup-stripe.md) or [GoCardless](/products/integrations-overview/setup-gocardless.md) instead. Existing Worldpay clients can continue using the integration.

### Before you begin (Prerequisites)

* **Permissions**: You must be an **Administrator** or **Supervisor**. See: [How to Manage Users and Permissions](/products/control-panel-overview/admin-overview/manage-roles-permissions.md).
* **Worldpay account** with access to the Worldpay console.
* **XML credentials**: Configure your XML username and password in the Worldpay console under **Account > Profile**.
* **Merchant Code and Installation ID**: Found in the Worldpay console under **Integration > Installations**.
* **Webhooks configured**: Worldpay webhooks must be set up before transaction statuses sync. See the Instructions section below.
* **Payment processor slot**: Decide which slot Worldpay will fill. See: [How to Link a Payment Processor](/products/control-panel-overview/admin-overview/link-payment-processor.md) for slot definitions.

> For full Worldpay-side setup details including webhook endpoint format and IP configuration, see [Connect Worldpay and Peoplevine](https://docs.peoplevine.com/peoplevine-docs/peoplevine-connect) in Peoplevine Connect. The steps below cover the Peoplevine Control Panel side.

### Instructions

#### Step 1: Configure Worldpay Console

1. Log in to the **Worldpay console**.
2. Navigate to **Account > Profile** and configure your **XML username and password**. Save these credentials.
3. Navigate to **Integration > Merchant Channel**.
4. Enable the **HTTP** protocol, then select **XML** and **POST**.
5. Configure the webhook endpoint URL (provided by your Peoplevine onboarding contact). Select all HTTP events you want notifications for.
6. Save the configuration.
7. *(Optional)* Under **Integration > Merchant Channel**, configure authorized IP addresses. By default, Worldpay allows all IPs (`0.0.0.0`). For production security, contact Worldpay support to restrict to specific IPs.
8. Navigate to **Integration > Installations** and record your **Merchant Code** and **Installation ID**.

#### Step 2: Register in Peoplevine

1. Navigate to [**Settings > Integrations > Payment Processors**](https://control.peoplevine.com/admin_processors.aspx).

> **Note (Pro Dash):** **Settings & Tools > Payment Processors**.

2. Click **REGISTER A PAYMENT PROCESSOR**.
3. From the list, select **Worldpay**.
4. Enter the following credentials from the Worldpay console:
   * **XML Username**
   * **XML Password**
   * **Merchant Code**
   * **Installation ID**
5. Select the **Worldpay environment** (Production or Test).
6. Click **SAVE** to complete the registration.

### What It Handles

| Payment Type              | How It Works                                                                               |
| ------------------------- | ------------------------------------------------------------------------------------------ |
| **Credit card charges**   | Card payments processed through Worldpay's gateway                                         |
| **Webhook notifications** | Transaction status updates (created, submitted, paid out) sent from Worldpay to Peoplevine |

### Best Practice

* **Configure webhooks before going live** — without webhooks, Peoplevine will not receive transaction status updates from Worldpay. Set up the Merchant Channel webhook endpoint as part of initial configuration.
* **Use Test environment first** — Worldpay supports separate test and production environments. Connect in test mode, process sample transactions, then switch to production.
* **Plan your migration** — Worldpay is a retiring integration. Work with your Peoplevine account manager to plan a transition to Stripe or GoCardless.

### Common Issues

**Transaction statuses not updating in Peoplevine:** Webhooks are not configured or the endpoint URL is incorrect. Verify the Merchant Channel settings in the Worldpay console and ensure all relevant HTTP events are selected.

**Authentication errors when registering:** Verify that the XML username, password, Merchant Code, and Installation ID are all correct and from the same Worldpay environment (test or production).

**IP restrictions blocking webhook delivery:** If you configured authorized IPs in Worldpay, ensure the Peoplevine server IP is included. Contact Worldpay support for production IP changes.

### What Happens Next

* Credit card payments process through Worldpay for all assigned transaction types
* Webhook notifications update transaction statuses in Peoplevine automatically
* Transaction records in Peoplevine link to the corresponding Worldpay payment

*Last updated: 2026-05-24*


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.peoplevine.com/products/integrations-overview/setup-worldpay.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
