# Setup of Worldpay Payment Gateway

### **What is Worldpay Payment Gateway?**

**Worldpay** is a global payment gateway that allows businesses to accept online payments securely through multiple payment methods. It enables customers to complete transactions using cards and other supported payment options, depending on their region and configuration.

With Worldpay integrated into the platform, agencies can offer more flexible and secure payment choices for subscription purchases, add-ons, and renewals.

***

### Key Benefits of Worldpay Integration

* Supports secure online payments.
* Accepts multiple card types and payment methods (based on region).
* Provides a trusted, globally recognized payment solution.
* Improves payment success rates with additional options.
* Enables smooth subscription purchases and renewals.

***

### Where Worldpay Is Used

In the agency panel, Worldpay can be used for:

* Plan purchases
* Add-on purchases
* Subscription renewals

Customers can choose Worldpay as their preferred payment method during checkout.

***

#### Prerequisites

Before Integrating Worldpay, make sure you have:

* A valid **Worldpay merchant account**
* Access to your **Worldpay Entity ID**
* Your **Public Key** and **Secret Key** from the Worldpay dashboard

***

### How to Use Worldpay Integration

Follow the steps below to configure Worldpay as your payment gateway in the Agency Panel.

### A. How to Get Worldpay Entity ID, Public Key, and Secret Key

Follow these steps in your Worldpay account:

1. Log in to your **Worldpay Merchant Dashboard**.

<figure><img src="/files/EHWYCrA6Sm18a7juqkyD" alt=""><figcaption></figcaption></figure>

2. Go to "**Developer Tools".**

<figure><img src="/files/0T8eIBZEbzE4f1bI1CKj" alt=""><figcaption></figcaption></figure>

3. Click the **Copy** button next to the **Entity ID** under the Developer Tools section.

<figure><img src="/files/zIKMsy9t1fl0AEYJySWh" alt=""><figcaption></figcaption></figure>

4. Expand the API Credentials section.

<figure><img src="/files/vClnHcnCorvvRlIsesKR" alt=""><figcaption></figcaption></figure>

5. Switch to the **Live mode.**

<figure><img src="/files/8qoWQ4HiK9uFnfsGO22e" alt=""><figcaption></figcaption></figure>

6. Click on **Generate Live Credentials** button.

{% hint style="info" %}
Click on **Try mode** to generate the dummy credentials and click on **live mode** to generate the live credentials for production.
{% endhint %}

7. Locate the following details:

* User name will copied for the Public Key
* Password will be copied for the Secret Key (sometimes called Private Key)

<figure><img src="/files/Ay8e66uO7kL1rz4SiGWW" alt=""><figcaption></figcaption></figure>

8. Copy these credentials and keep them secure.

> If you don’t see the keys, contact **Worldpay support** or your account manager to enable API access.

***

### B. Steps to Integrate Worldpay in Agency Panel.

1. Log in to your **Agency dashboard**.
2. Go to **Integrations** from the left-side menu.

<figure><img src="/files/UU3HUPnUMy2wqSkQNzeS" alt=""><figcaption></figcaption></figure>

3. Search the **Worldpay Integration** and click on configure button.
4. Enter the following details:
   * **Worldpay Entity ID** as Copied from the Entity field.
   * **Worldpay Public Key** as copied from the Username field.
   * **Worldpay Secret Key** as copied from the Password field.

<figure><img src="/files/ZC3aRkkdLTPViAU8mTuc" alt=""><figcaption></figcaption></figure>

5. Click the **Save** button to save the settings or update in case of updating the changes.

***

#### Field Descriptions

| Field                   | Description                                          |
| ----------------------- | ---------------------------------------------------- |
| **Worldpay Entity ID**  | Unique identifier for your WorldPay merchant account |
| **Worldpay Public Key** | Public API key used to authenticate payment requests |
| **Worldpay Secret Key** | Private key used to securely process transactions    |

***

### C. Enable Worldpay Payment Method for Customers

After completing the Worldpay integration, you must enable the payment method for your customers.

**Steps:**

1. Log in to your dashboard.
2. Go to Customers → Customer Plans.
3. Open the Configuration tab.
4. Navigate to Currency & Payment Reminders.
5. Under Set Payment Method For Your Currencies:
   * Select the Currency.
   * Choose Worldpay as the Payment Method.
   * Select Payment Grace Applicable option.
6. Click the "**Update"** button to save the settings.

The selected payment method will now be applied to customers using that currency.

<figure><img src="/files/Z5fDQN3Qbwyd4BHRllGI" alt=""><figcaption></figcaption></figure>

***

#### Troubleshooting

* Ensure all keys are copied correctly from the Worldpay dashboard.
* Check that your WorldPay account is active.
* If payments fail, re-verify the Entity ID and keys.

***

### FAQs

<details>

<summary>What is Worldpay used for in the platform?</summary>

Worldpay is used to accept secure online payments for:

* Plan purchases
* Add-on purchases
* Subscription renewals

It allows customers to pay using supported card and regional payment methods.

</details>

<details>

<summary>Where can I configure the Worldpay integration?</summary>

You can configure Worldpay from the **Agency Panel**:

* Go to **Integrations**
* Search for **Worldpay**
* Click **Configure**
* Enter the required credentials and save.

</details>

<details>

<summary>What credentials are required for Worldpay integration?</summary>

You need the following details from your Worldpay account:

* Entity ID
* Public Key
* Secret Key

</details>

<details>

<summary>Where do I find the Entity ID, Public Key, and Secret Key?</summary>

In your **Worldpay Merchant Dashboard**:

1. Go to **Developer Tools**.
2. Copy the **Entity ID**.
3. Open **API Credentials**.
4. Switch to **Live Mode**.
5. Generate live credentials.
6. Use:
   * **Username** as Public Key
   * **Password** as Secret Key

</details>

<details>

<summary>Do I need a Worldpay account before integrating?</summary>

Yes. You must have:

* An active Worldpay merchant account
* API access enabled for your account

</details>

<details>

<summary>How do customers select Worldpay during payment?</summary>

When Worldpay is enabled for their currency:

* Customers will see **Worldpay** as a payment option at checkout.
* They can select it and complete the payment securely.

</details>

#### Need Help?

If you still have questions for our team, write to us at [**support@botpenguin.com**](mailto:support@botpenguin.com). We’ll get back to you within 48 hours.


---

# Agent Instructions: 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:

```
GET https://partners.botpenguin.com/partner-platform-guidelines/integration-setup/setup-of-worldpay-payment-gateway.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.