Skip to content

Model Context Protocol (MCP) server

Our MCP server makes it easy to enable payment and payout related actions in your automated operational workflows.

Preview

This feature is for preview only and is subject to change.

Local

1. Get the code

Add the following configuration for Claude desktop (settings > developer > edit config).

claude/claude_desktop_config.json
{
    "mcpServers": {
        "worldpay": {
            "command": "npx",
            "args": [
                "-y",
                "@worldpay/worldpay-mcp"
            ],
            "env": {
                "WORLDPAY_USERNAME": "username",
                "WORLDPAY_PASSWORD": "password",
                "WORLDPAY_URL": "https://try.access.worldpay-bsh.securedataplatform.com",
                "MERCHANT_ENTITY": "default"
            }
        }
    }
}

Usage

A couple of examples of what this looks like when integrated to Claude:

Query for a payment using transaction reference

  • Text: Query payment using transaction reference claude-123
  • Toolset/tool: Payment queries / query_payments_by_transaction_reference
  • Prompt to confirm details before query
Claude - payment query using transaction reference
  • Text: Create a payment link for 10 GBP
  • Toolset/tool: Hosted payment / create_hosted_payment
  • Prompt to confirm details before link creation


Claude - create a Hosted Payment Pages link

Tools supported

ToolsetTools
API
Description
Payment take_guest_paymentPayments APITake a guest card payment. (Worldpay token and Checkout session only.)
create_worldpay_tokenPayments APICreate a Worldpay token for future Customer Initiated Transactions. (Checkout session only.)
create_hosted_paymentHosted Payment PagesCreate a hosted payment page link to send to your customers.
manage_paymentPayments APIPerform actions on a payment after authorization such as refund, cancel and settle.
Payment queries query_payments_by_datePayment Queries APIQuery a payment based on the date.
query_payments_by_transaction_referencePayment Queries APIQuery a payment based on the transactionReference.
query_payment_by_idPayment Queries APIQuery a payment based on the paymentId.
Payouts query_account_payoutsAccount Payouts APIQuery for payouts.
Agentic commerce create_delegate_tokenSessions APICreate an ACP delegate payment token. See Agentic Commerce Protocol (ACP) for details.