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

# Worldpay

Connect to Access Worldpay to search card payments, follow their event history, and settle, refund, or cancel them.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Worldpay  | Credentials    |

### Worldpay

Connect to Access Worldpay with the API username and password from your Worldpay Implementation Manager to search payments, check their status, and settle, refund, or cancel them. The Payment Queries API must be enabled for the credentials.

#### Set up in Worldpay

1. Prepare the Worldpay account or service that the workflow will access. Grant access to the required resources and operations.
2. **Username:** Your Access Worldpay API username, from your Worldpay Implementation Manager.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Worldpay**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                     |
| ------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Environment   | Optional / as applicable | 'try' for Worldpay's test environment, 'live' for production. Each has its own username and password.                                                             |
| Username      | Yes                      | Your Access Worldpay API username, from your Worldpay Implementation Manager. [Provider instructions](https://docs.worldpay.com/access/products/payment-queries). |
| Password      | Yes                      | The API password that goes with that username. [Provider instructions](https://docs.worldpay.com/access/products/payment-queries).                                |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Worldpay** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Search Payments

Find payments by date, amount, card, event, or reference.

#### Inputs

| Field                        | Type            | Required | Description                                                                                                                                         |
| ---------------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| Search by                    | select (string) | No       | Search a date range, or look up one of your references. Available values: Date range, Transaction reference, Order reference. Default: date\_range. |
| From                         | datetime        | No       | Start of the window; defaults to 7 days ago.                                                                                                        |
| To                           | datetime        | No       | End of the window; defaults to now.                                                                                                                 |
| Currency                     | string          | No       | Only payments in this currency.                                                                                                                     |
| Minimum amount (minor units) | integer         | No       | Only payments above this amount; needs a currency. 1000 = 10.00. Minimum: 0.                                                                        |
| Maximum amount (minor units) | integer         | No       | Only payments below this amount; needs a currency. 50000 = 500.00. Minimum: 0.                                                                      |
| Card last 4 digits           | string          | No       | Only payments made with a card ending in these digits.                                                                                              |
| Merchant entities            | string          | No       | Only these merchant entities, comma-separated.                                                                                                      |
| Received events              | string          | No       | Only payments that received these events, comma-separated.                                                                                          |
| Transaction reference        | string          | No       | The unique reference you gave the payment.                                                                                                          |
| Order reference              | string          | No       | The order reference shared by one or more payments.                                                                                                 |
| Max results                  | integer         | No       | How many payments to return (1-3000). Minimum: 1. Maximum: 3000. Default: 100.                                                                      |
| Next page                    | string          | No       | Continue a previous search from its next\_page value.                                                                                               |

#### Outputs

| Field     | Type          | Description                                                 |
| --------- | ------------- | ----------------------------------------------------------- |
| Payments  | object\_array | Matching payments, newest first.                            |
| Count     | integer       | How many payments this call returned.                       |
| Next page | string        | Pass back to continue; empty when every match was returned. |

### Get Payment

Get a payment's status, event history, and available actions.

#### Inputs

| Field      | Type   | Required | Description                      |
| ---------- | ------ | -------- | -------------------------------- |
| Payment ID | string | Yes      | The Worldpay payment to look up. |

#### Outputs

| Field             | Type   | Description                                           |
| ----------------- | ------ | ----------------------------------------------------- |
| Payment           | object | The payment's details and event history.              |
| Last event        | string | The payment's latest event, e.g. settlementRequested. |
| Available actions | array  | What can be done with the payment now.                |

### Settle Payment

Settle an authorized payment in full or in part.

#### Inputs

| Field                        | Type            | Required | Description                                                                         |
| ---------------------------- | --------------- | -------- | ----------------------------------------------------------------------------------- |
| Payment ID                   | string          | Yes      | The authorized Worldpay payment to settle.                                          |
| Amount                       | select (string) | No       | Settle the full amount, or only part of it. Available values: Full amount, Partial. |
| Partial amount (minor units) | integer         | No       | How much to settle; 1250 = 12.50. Minimum: 1.                                       |
| Reference                    | string          | No       | Your reference for this settlement; generated if empty.                             |

#### Outputs

| Field        | Type    | Description                                                |
| ------------ | ------- | ---------------------------------------------------------- |
| Payment ID   | string  | The payment the request was made on.                       |
| Action       | string  | The Worldpay action requested, e.g. partialRefund.         |
| Command ID   | string  | Worldpay's ID for this request.                            |
| Reference    | string  | The reference sent with the request.                       |
| Amount       | integer | The partial amount requested; empty for the full amount.   |
| Currency     | string  | The payment's currency.                                    |
| Next actions | array   | Actions Worldpay offers on the payment after this request. |

### Refund Payment

Refund a settled payment in full or in part.

#### Inputs

| Field                        | Type            | Required | Description                                                                         |
| ---------------------------- | --------------- | -------- | ----------------------------------------------------------------------------------- |
| Payment ID                   | string          | Yes      | The Worldpay payment to refund.                                                     |
| Amount                       | select (string) | No       | Refund the full amount, or only part of it. Available values: Full amount, Partial. |
| Partial amount (minor units) | integer         | No       | How much to refund; 1250 = 12.50. Minimum: 1.                                       |
| Reference                    | string          | No       | Your reference for this refund; generated if empty.                                 |

#### Outputs

| Field        | Type    | Description                                                |
| ------------ | ------- | ---------------------------------------------------------- |
| Payment ID   | string  | The payment the request was made on.                       |
| Action       | string  | The Worldpay action requested, e.g. partialRefund.         |
| Command ID   | string  | Worldpay's ID for this request.                            |
| Reference    | string  | The reference sent with the request.                       |
| Amount       | integer | The partial amount requested; empty for the full amount.   |
| Currency     | string  | The payment's currency.                                    |
| Next actions | array   | Actions Worldpay offers on the payment after this request. |

### Cancel Authorization

Cancel an authorized payment before it is settled.

#### Inputs

| Field                        | Type            | Required | Description                                                                         |
| ---------------------------- | --------------- | -------- | ----------------------------------------------------------------------------------- |
| Payment ID                   | string          | Yes      | The authorized Worldpay payment to cancel.                                          |
| Amount                       | select (string) | No       | Cancel the full amount, or only part of it. Available values: Full amount, Partial. |
| Partial amount (minor units) | integer         | No       | How much to cancel; 1250 = 12.50. Minimum: 1.                                       |
| Reference                    | string          | No       | Your reference for this cancellation; generated if empty.                           |

#### Outputs

| Field        | Type    | Description                                                |
| ------------ | ------- | ---------------------------------------------------------- |
| Payment ID   | string  | The payment the request was made on.                       |
| Action       | string  | The Worldpay action requested, e.g. partialRefund.         |
| Command ID   | string  | Worldpay's ID for this request.                            |
| Reference    | string  | The reference sent with the request.                       |
| Amount       | integer | The partial amount requested; empty for the full amount.   |
| Currency     | string  | The payment's currency.                                    |
| Next actions | array   | Actions Worldpay offers on the payment after this request. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/worldpay.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
