> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payaza.africa/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect to the Payaza MCP server

> Give Claude, Cursor, VS Code and other AI tools live access to the Payaza docs and API reference while you build.

The Payaza documentation ships with a hosted [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server. Once you connect it, your AI assistant can search these docs and the API reference while it writes code for you, so its answers use the real Payaza endpoints, headers and field names instead of guesses.

**Server URL**

```text theme={null}
https://docs.payaza.africa/mcp
```

> [!NOTE]
>
> The MCP server is read-only. It searches public documentation only. It does not need your API keys, cannot see your Payaza account, and cannot move money.

## What your assistant can do with it

* Search the Payaza guides and API reference (collections, transfers, virtual accounts, subscriptions, webhooks and more).
* Read a full docs page, including request and response examples.
* Answer integration questions such as "which headers does the card charge endpoint need?" with the answer taken from the docs.

## Connect your AI tool

> [tab] Claude
>
> Works in Claude on the web and in the Claude desktop app.
>
> **1. Open Connectors**
>
> Go to [claude.ai/settings/connectors](https://claude.ai/settings/connectors).
>
> **2. Add a custom connector**
>
> Click **Add custom connector**. Set the name to `Payaza` and the URL to `https://docs.payaza.africa/mcp`, then click **Add**.
>
> **3. Use it in a chat**
>
> In a chat, click the attachments (**+**) button and turn on **Payaza**.

> [tab] Claude Code
>
> Run this in your terminal:
>
> ```bash theme={null}
> claude mcp add --transport http payaza https://docs.payaza.africa/mcp
> ```
>
> Check that it is connected:
>
> ```bash theme={null}
> claude mcp list
> ```

> [tab] Cursor
>
> **1. Open MCP settings**
>
> Open the command palette (`Cmd+Shift+P` on macOS, `Ctrl+Shift+P` on Windows and Linux), search for **Open MCP settings**, then click **Add custom MCP**.
>
> **2. Add the server**
>
> Add Payaza to `mcp.json`:
>
> ```json mcp.json theme={null}
> {
>   "mcpServers": {
>     "payaza": {
>       "url": "https://docs.payaza.africa/mcp"
>     }
>   }
> }
> ```
>
> You can also click **Connect to Cursor** in the menu at the top of any docs page.

> [tab] VS Code
>
> Create `.vscode/mcp.json` in your project:
>
> ```json .vscode/mcp.json theme={null}
> {
>   "servers": {
>     "payaza": {
>       "type": "http",
>       "url": "https://docs.payaza.africa/mcp"
>     }
>   }
> }
> ```
>
> You can also click **Connect to VS Code** in the menu at the top of any docs page.

> [tab] Other clients
>
> Any MCP client that supports remote servers over Streamable HTTP can connect with the server URL:
>
> ```text theme={null}
> https://docs.payaza.africa/mcp
> ```
>
> If your client only supports local (stdio) servers, bridge it with [`mcp-remote`](https://www.npmjs.com/package/mcp-remote):
>
> ```json theme={null}
> {
>   "mcpServers": {
>     "payaza": {
>       "command": "npx",
>       "args": ["-y", "mcp-remote", "https://docs.payaza.africa/mcp"]
>     }
>   }
> }
> ```

## Try it

Once connected, ask your assistant something that needs the Payaza docs. For example:

* "Using the Payaza docs, write an Express route that creates a dynamic virtual account with `payaza-node-sdk`."
* "How do I verify a Payaza webhook signature in Spring Boot?"
* "Which `transaction_type` should I use to send a payout to a mobile wallet in Ghana?"
* "My card charge timed out. How do I check whether the customer was charged before I retry?"

> [!TIP]
>
> Pair the MCP server with an official SDK. Tell your assistant to use the [Node.js SDK](https://docs.payaza.africa/api-reference/libraries/node.md) or the [Java SDK](https://docs.payaza.africa/api-reference/libraries/java.md), and it will handle authentication headers and request shapes for you.

## Keep your keys safe

The MCP server never needs your keys, so never paste them into an AI chat. Keep them in environment variables (for example `PAYAZA_PUBLIC_KEY`) and use **test mode** keys while you build. If a key is exposed, regenerate it under **Settings > Developers** on the [Payaza dashboard](https://business.payaza.africa).

## Troubleshooting

> [accordion] My assistant is not using the Payaza tools
>
> Make sure the server is turned on for the current chat or workspace, then mention Payaza in your prompt, for example "check the Payaza docs".

> [accordion] I get a 429 Too Many Requests error
>
> The server is rate limited per user. Wait a few minutes and try again.

> [accordion] My client does not support remote MCP servers
>
> Use the `mcp-remote` bridge shown in the **Other clients** tab.

Still stuck? Ask in the [Payaza Developers Discord](https://discord.gg/hayas4mVx) or email [integrationsupport@payaza.africa](mailto:integrationsupport@payaza.africa).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.