> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://ixopay.ferndocs.com/user-manual/adapters/worldpay/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://ixopay.ferndocs.com/_mcp/server.

# Worldpay

## WorldPay

Depending on the chosen method the a subset of the following parameters for the Connector need to be configured (see Connector Config - WorldPay I & II):

1. Fill in the mandatory **WorldPay Merchant Code**
2. Fill in the mandatory **Password**
3. Fill in the mandatory **API Username**
4. Fill in the mandatory **API Password**

Additional Extra Data is available to be configured:

1. Fill in the optional **Extra Data: currencyForRegister**
2. Fill in the mandatory **Extra Data:** **recurringMerchantCode**
3. Fill in the mandatory **Extra Data:** **forwardBillingDetails:** True, False
4. Fill in the optional **Extra Data: forwardShippingDetails:** True, False
5. Fill in the optional **Extra Data: useStoredCredentials:** True, False
6. Fill in the optional **Extra Data: useTokenization:** True, False
7. Fill in the optional **Extra Data: receiverCurrency**
8. Fill in the optional **Extra Data: chargeback911Secret** - optional; Secret key is related to the Authentication to accept webhook notifications from Chargeback911 with header **CB911\_SIG,** value to be hash\_hmac with sha256 of the timestamp and the secret key (for mapping see Chargeback911 Webhooks)-

![Connector Config - WorldPay I](https://documentation.ixopay.com/manual/assets/ideal-img/connector-config-worldpay-i.75e42c7.1280.png)Connector Config - WorldPay I![Connector Config - WorldPay II](https://documentation.ixopay.com/manual/assets/ideal-img/connector-config-worldpay-ii.3c78136.1280.png)Connector Config - WorldPay II

Keep in mind that for PCI compliant Adapters you need to connect with the PCI environment and the [PCI Vault Configuration](https://documentation.ixopay.com/manual/docs/connector/create) is shown.

## WorldPay Creditcard

Depending on the chosen Interface Type a subset of the following parameters for the Connector need to be configured (see PCI Vault Configuration - Creditcard WorldPay I, II & III):

1. Select the mandatory **Environment** : Live, Test, Production
2. Fill in the mandatory **Username**
3. Fill in the mandatory **Password**
4. Fill in the mandatory **Merchant Entity**
5. Fill in the optional **Merchant Category Code**
6. Fill in the optional **Shared Secret for Notifications**
7. Fill in the mandatory **AccountID**
8. Fill in the mandatory **AccountToken**
9. Fill in the mandatory **AcceptorID**
10. Fill in the mandatory **TerminalID**
11. Fill in the mandatory **ApplicationName**
12. Select the mandatory **Currency**
13. Select the mandatory **Market Code**
14. Check the option **Enable Incremental Authorizations**
15. Fill in the mandatory **Merchant Code**
16. Fill in the mandatory **XML Username**
17. Fill in the mandatory **XML Password**
18. Select an optional **Amount for card verification**
19. Select the optional **Debit waits for webhook**
20. Check the Option **Do not send 3DS 2.x dsTransactionId for Visa**

![PCI Vault Configuration - Creditcard WorldPay I](https://documentation.ixopay.com/manual/assets/ideal-img/pci-vault-configuration-creditcard-worldpay-i.ebc0287.1280.png)PCI Vault Configuration - Creditcard WorldPay I![PCI Vault Configuration - Creditcard WorldPay II](https://documentation.ixopay.com/manual/assets/ideal-img/pci-vault-configuration-creditcard-worldpay-ii.e590c57.1280.png)PCI Vault Configuration - Creditcard WorldPay II![PCI Vault Configuration - Creditcard WorldPay III](https://documentation.ixopay.com/manual/assets/ideal-img/pci-vault-configuration-creditcard-worldpay-iii.2c729e6.1280.png)PCI Vault Configuration - Creditcard WorldPay III

## Data Fetcher Configuration

You have the option to configure Data Fetchers (see section [Enable and Set Up Reconciliation on the Provider Level](https://documentation.ixopay.com/manual/docs/post-processing/provider)) either on Provider or on Connector Level, depending on which setup works better for your provider (see Edit Provider).

![Edit Provider](https://documentation.ixopay.com/manual/assets/ideal-img/edit-provider.d73a22a.1280.png)Edit Provider

### Provider Settlement

Configure the following Parameters for the Settlements Provider Data Fetcher to fetch Settlement (CSV format) via SFTP (see Edit Provider Settlement Data Fetcher Provider Level):

1. Fill in the expected **Interval** in which the Provider Settlement File should be fetched - days, hours
2. Select the Adapter **WorldPay**
3. Enable **Testmode** - irrelevant for this adapter
4. Fill in the mandatory **Extra Data: sftpUser** used for authentication
5. Fill in the mandatory **Extra Data: private Key** used for authentication
6. Fill in the mandatory **Extra Data: regex** used to specify file pattern

![Edit Provider Settlement Data Fetcher Provider Level](https://documentation.ixopay.com/manual/assets/ideal-img/edit-provider-settlement-data-fetcher-provider-level.3b2cd18.982.png)Edit Provider Settlement Data Fetcher Provider Level

#### Settlement fields

##### Batch Number

The batch number is taken from the value of the column "Batch ID".

##### Mapped Fields

We are mapping the following fields from the Worldpay settlement reports (Provider → IXOPAY platform):

| Provider            | IXOPAY platform             | default (if not set by Provider) |
| ------------------- | --------------------------- | -------------------------------- |
| Date                | transaction settlement date | none                             |
| Order Code          | transaction settlement id   | none                             |
| Settlement Currency | settlement currency         | none                             |
| Payment Amount      | settlement amount           | none                             |
| Net Amount          | net settlement amount       | none                             |
| Batch ID            | settlement batch number     | none                             |
| Event Type          | settlement type             | none                             |
| Commission Amount   | transaction fee amount      | none                             |
| Settlement Currency | transaction fee currency    | none                             |

> **Tip**
>
> For settlement type status:
>
> * `MISCELLANEOUS`
> * `SETTLED_MISCELLANEOUS`
> * `PAYMENT_TO_MERCHANT_INIATED`
> * `INVOICE_PAID`
>
> an **OtherLineItem** is created.

###### Mapped status values

| Provider                  | IXOPAY platform | default (if not set by Provider) |
| ------------------------- | --------------- | -------------------------------- |
| `SETTLED`                 | debit           |                                  |
| `REFUNDED`                | refund          |                                  |
| `CHARGED_BACK`            | chargeback      |                                  |
| `CHARGEDBACK_REVERSED`    | cb-reversal     |                                  |
| `DISPUTED_FUNDS_RELEASED` | debit           |                                  |

## Chargeback911 Webhooks

A chargeback is only created when the IXOPAY platform receives a webhook with status **New** , a chargeback reversal is only created when the verdict = **Win** is received (see [https://apidoc.chargebacks911.com/documentation#tag/Webhooks/paths/\~1webhooks/post](https://apidoc.chargebacks911.com/documentation#tag/Webhooks/paths/~1webhooks/post))

###### Chargeback

| Chargeback911    | IXOPAY platform               | default (if not set by Provider) |
| ---------------- | ----------------------------- | -------------------------------- |
| Status           | New                           | none                             |
| `order_id`       | Original transaction id       | none                             |
| `dispute_amount` | Chargeback amount             | none                             |
| `currency`       | Chargeback currency           | none                             |
| `cb_id`          | Adapter tx id                 | none                             |
| Date time        | Date time of received Webhook | none                             |
| `case_no`        | Extra data case\_no           | none                             |
| `reason_code`    | Extra data reason\_code       | none                             |

###### Chargeback Reversal

| Chargeback911    | IXOPAY platform              | default (if not set by Provider) |
| ---------------- | ---------------------------- | -------------------------------- |
| Status           | Win                          | none                             |
| `dispute_amount` | Chargeback Reversal amount   | none                             |
| `currency`       | Chargeback Reversal currency | none                             |
| `order_id`       | Original transaction id      | none                             |
| `cb_id`          | Adapter tx id                | none                             |
| `reason_code`    | Extra data reason\_code      | none                             |