Worldpay

v0.2.0-alpha.1API Keyalpha

Global enterprise processor (Access Worldpay REST). Target: multinationals routing LatAm volume through a global contract. Recently acquired by Global Payments (Jan 2026); platform stability TBD. Alpha on npm — HATEOAS linkData flow pending sandbox validation.

22 tools5 env vars🌐 GLOBALalpha — pending validation

Install

terminal

$ npm install @codespar/mcp-worldpay@alpha

Quickstart

Add this entry to your claude_desktop_config.json (or any MCP-compatible client config).

claude_desktop_config.json

{
  "mcpServers": {
    "worldpay": {
      "command": "npx",
      "args": [
        "-y",
        "@codespar/mcp-worldpay@alpha"
      ],
      "env": {
        "WORLDPAY_USERNAME": "<your_worldpay_username>",
        "WORLDPAY_PASSWORD": "<your_worldpay_password>",
        "WORLDPAY_ENTITY": "<your_worldpay_entity>"
      }
    }
  }
}

After restart, your agent can call any of the 22 tools below — try verify_account first.

Environment variables · 5

Required to authenticate the server. Stored encrypted when using CodeSpar managed hosting.

WORLDPAY_USERNAME

required

Access Worldpay API username (Basic Auth)

WORLDPAY_PASSWORD

requiredsecret

Access Worldpay API password (Basic Auth)

WORLDPAY_ENTITY

required

Merchant entity identifier assigned during onboarding. Injected as merchant.entity into every request body.

WORLDPAY_ENV

optional

sandbox | production. Defaults to sandbox. sandbox -> https://try.access.worldpay.com, production -> https://access.worldpay.com.

WORLDPAY_API_VERSION

optional

Payments API version for the Content-Type/Accept media-type header. Defaults to v7.

Available tools · 22

Each tool is independent — your agent loads only what it needs to reduce context and response time.

READverify_account

Run an AVS/CVC account verification on a card without charging it. Returns the verification outcome and a card-on-file or one-time verification record. merchant.entity is injected automatically.

WRITEauthorize_payment

Authorize a card payment. Returns an outcome plus HATEOAS action links (settle, cancel, refund, reverse). Extract the linkData from those links and pass it to capture_payment / cancel_payment / refund_payment / reverse_payment.

WRITEcapture_payment

Capture (settle) an authorized payment. Omit amount for a full settlement; pass amount+currency for a partial settlement. Pass linkData from the authorization's action link (_links.payments:settle.href segment) for HATEOAS-correct routing.

DELETEcancel_payment

Void an authorization that has not yet been captured. Pass linkData from _links.payments:cancel.href.

DELETErefund_payment

Refund a captured payment. Omit amount for a full refund; pass amount+currency for a partial refund. Pass linkData from _links.payments:refund.href or _links.payments:partialRefund.href.

DELETEreverse_payment

Reverse a payment atomically — voids if not yet captured, refunds if already captured. Pass linkData from _links.payments:reverse.href.

WRITEget_payment

Retrieve the detail of a payment event by its Worldpay eventId.

WRITEcreate_token

Tokenize a card for reuse (card-on-file). Returns a token you can pass as the paymentInstrument on subsequent authorizations.

Compatible frameworks

MCP is a protocol — any framework that speaks it can mount this server.

Claude Agent SDKAnthropic

OpenAI AgentsOpenAI

Vercel AI SDKVercel

LangChainLangChain

LlamaIndexLlamaIndex

CrewAICrewAI

MastraMastra

Any MCP clientProtocol

Frequently asked questions

All credentials are encrypted at rest in an isolated vault scoped per organization. OAuth2 tokens are automatically refreshed before expiry. Your agent code never sees raw secrets — it receives scoped, short-lived session tokens.