How to Use the Zip MCP in Pydantic AI

Q: How do I check an order's status using Zip and Pydantic AI?

You use the getziporderstatus tool. It provides a clear, validated response indicating if the transaction is Authorized, Captured, or Cancelled.

Q: Can I process a refund with Zip and Pydantic AI?

Yes, you can use refundzippayment. The agent executes this tool to complete the money reversal for any targeted order through the Zip API.

Q: What is the procedure for voiding a payment with Zip and Pydantic AI?

If an authorization happened but no capture was run, use voidzippayment. This reliably cancels the pending funds before they settle.

Guaranteed data structures for payments with Pydantic AI.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect Zip MCP to Pydantic AI

Create your Vinkius account to connect Zip to Pydantic AI and route execution through our secure gateway. The platform manages server hosting, runtime updates, and security layers. Configuration requires no manual server provisioning.

GDPR Free for Subscribers

Setup Zip with Pydantic AI

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Create and confirm checkouts

To begin, the agent calls `create_zip_checkout`, passing the necessary amount, currency, and redirect URLs. This initializes a new checkout session for payment. The process moves forward using `authorize_zip_order` and then completing it with `confirm_zip_order`.

Resolve order status queries

Use the `get_zip_order_status` tool when you need to check an order's current state. It returns Authorized, Captured, or Cancelled. This guarantees your agent knows exactly what happened with the money before trying any other action.

Handle payment reversals and voids

If you need to return funds, `refund_zip_payment` processes a full refund for the order. If the payment is only authorized but never captured, run `void_zip_payment`. This ensures that financial cleanup happens reliably.

Setup guide

Set up Zip MCP in Pydantic AI

Prerequisites

Python 3.10+ installed
pydantic-ai-slim[fastmcp] package
Active Vinkius subscription with a valid endpoint token

1

Install Pydantic AI with FastMCP
Run pip install "pydantic-ai-slim[fastmcp]". The FastMCP toolset replaces the deprecated MCPServerHTTP class with full protocol support.
2

Configure the FastMCPToolset
Pass a JSON-style config dict to FastMCPToolset with your Vinkius URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com. Supports Streamable HTTP, SSE, and Stdio transports.
3

Create and run your agent
Pass the toolset to Agent(toolsets=[toolset]) and call agent.run(). Swap openai:gpt-4o for any supported model — Anthropic, Google, Mistral, or Groq.

agent.py

from pydantic_ai import Agent
from pydantic_ai.toolsets.fastmcp import FastMCPToolset

toolset = FastMCPToolset({
    "mcpServers": {
        "zip-mcp": {
            "url": "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
        }
    }
})

agent = Agent(
    "openai:gpt-4o",
    toolsets=[toolset],
    system_prompt="You have access to Zip tools.",
)

result = await agent.run("List recent Zip transactions")
print(result.output)

Get your connection token →

Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by Zip. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.

Why Choose Vinkius

Vinkius connects your tools to AI with real-time monitoring and automatic cost savings — all from one dashboard.

Connect Zip now

Real-time monitoring

Live

visibility into every interaction

Connect your favorite tools to your AI and see exactly what's happening — every request, every response, in real time.

Built-in savings

60%

lower AI costs

Vinkius compresses data between your apps and your AI automatically. Lower bills every month — no configuration required.

Single dashboard

One

place for every integration

Every tool your AI connects to, managed from a single screen. One account, complete control.

Common questions about Zip MCP in Pydantic AI

You use the `get_zip_order_status` tool. It provides a clear, validated response indicating if the transaction is Authorized, Captured, or Cancelled.

Yes, you can use `refund_zip_payment`. The agent executes this tool to complete the money reversal for any targeted order through the Zip API.

If an authorization happened but no capture was run, use `void_zip_payment`. This reliably cancels the pending funds before they settle.

You must provide three specific parameters: the transaction amount, the currency code, and the required redirect URLs for `create_zip_checkout`.

You're working with order details. The tool returns a validated status that can only be Authorized, Captured, or Cancelled.

Use it with your favorite AI tools

Connect this server to Cursor, Claude, VS Code, and more.

OpenAI Agents SDK sdk-python

Google ADK sdk-python

Pydantic AI sdk-python

Vercel AI SDK sdk-typescript

Mastra AI sdk-typescript

Start using the Zip MCP today

We host it, we monitor it, we maintain it. You just paste one token.

Get started