How to Use the Zip MCP in Vercel AI SDK

Q: How do I check Zip order status using Vercel AI SDK?

Call getziporderstatus with the target order ID. The result streams back instantly, letting your frontend update the UI without needing a manual refresh.

Q: What is the best way to handle Zip payments in Vercel AI SDK?

You should first use createzipcheckout to get the session details. Then, follow up with status checks and payment actions like capturezippayment as needed.

Q: Can I refund a Zip order using Vercel AI SDK?

Yes, use refundzippayment. This function processes the refund against an existing order ID and confirms the action in real-time via your MCP Server connection.

Show users real-time payment status updates with Vercel AI SDK streaming.

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 Vercel AI SDK

Create your Vinkius account to connect Zip to Vercel AI SDK 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 Vercel AI SDK

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Real-Time Zip Payments for Vercel AI SDK

Use `create_zip_checkout` to initiate a new checkout session, requiring only the amount, currency, and redirect URLs. This function kickstarts the process your agent needs to track.

Handling Zip Payment Status Checks with MCP Server

The `get_zip_order_status` tool lets your client check if a specific order is Authorized, Captured, or Cancelled. This status data streams directly into the UI as soon as it changes.

Completing Zip Orders in Vercel AI SDK

After authorization, you capture funds using `capture_zip_payment` or finalize with `confirm_zip_order`. These calls complete the transaction and stream immediate success confirmation to the user.

Setup guide

Set up Zip MCP in Vercel AI SDK

Prerequisites

Node.js 18+ and a TypeScript project
ai + @modelcontextprotocol/sdk packages
Active Vinkius subscription with a valid endpoint token

1

Install dependencies

Run npm install ai @modelcontextprotocol/sdk plus your preferred model provider (e.g. @ai-sdk/openai).
2

Create the Streamable HTTP transport

Use StreamableHTTPClientTransport with your Vinkius endpoint URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com.
3

Discover and use tools

Call mcpClient.tools() to auto-discover all Zip tools. Pass them directly to generateText() or streamText() — no manual schema definitions needed.
4

Works with any model provider

Swap openai("gpt-4o") for any AI SDK provider — Anthropic, Google, Mistral. The MCP tools work identically across all supported models.

index.ts

import { experimental_createMCPClient as createMCPClient } from "ai";
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp";
import { generateText } from "ai";
import { openai } from "@ai-sdk/openai";

const transport = new StreamableHTTPClientTransport(
  new URL("https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp")
);

const mcpClient = await createMCPClient({ transport });
const tools = await mcpClient.tools();

const { text } = await generateText({
  model: openai("gpt-4o"),
  tools,
  prompt: "List recent Zip transactions",
});

console.log(text);
await mcpClient.close();

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 Vercel AI SDK

Call `get_zip_order_status` with the target order ID. The result streams back instantly, letting your frontend update the UI without needing a manual refresh.

You should first use `create_zip_checkout` to get the session details. Then, follow up with status checks and payment actions like `capture_zip_payment` as needed.

Yes, use `refund_zip_payment`. This function processes the refund against an existing order ID and confirms the action in real-time via your MCP Server connection.

The Zip tools manage the payment lifecycle. You'll need to call specific functions like `authorize_zip_order` and then decide whether to proceed with a capture or void.

This server handles payment amounts, currencies, order IDs, and the overall transaction status. Always ensure client-side validation on these types of financial data.

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