How to integrate Paystack MCP with LlamaIndex

GET STARTED FOR FREE
Framework Integration Gradient
Paystack Logo
LlamaIndex Logo
divider

Introduction

This guide walks you through connecting Paystack to LlamaIndex using the Composio tool router. By the end, you'll have a working Paystack agent that can list all successful transactions from this week, create a new customer profile in paystack, refund a recent payment from customer through natural language commands.

This guide will help you understand how to give your LlamaIndex agent real control over a Paystack account through Composio's Paystack MCP server.

Before we dive in, let's take a quick look at the key ideas and tools involved.

TL;DR

Here's what you'll learn:
  • Set your OpenAI and Composio API keys
  • Install LlamaIndex and Composio packages
  • Create a Composio Tool Router session for Paystack
  • Connect LlamaIndex to the Paystack MCP server
  • Build a Paystack-powered agent using LlamaIndex
  • Interact with Paystack through natural language

What is LlamaIndex?

LlamaIndex is a data framework for building LLM applications. It provides tools for connecting LLMs to external data sources and services through agents and tools.

Key features include:

  • ReAct Agent: Reasoning and acting pattern for tool-using agents
  • MCP Tools: Native support for Model Context Protocol
  • Context Management: Maintain conversation context across interactions
  • Async Support: Built for async/await patterns

What is the Paystack MCP server, and what's possible with it?

The Paystack MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Paystack account. It provides structured and secure access so your agent can perform Paystack operations on your behalf.

Supported Tools & Triggers

Tools
Add Products to PageTool to add products to a Paystack payment page.
Add Products to StorefrontTool to add previously created products to a Storefront.
Add Split Code to Virtual TerminalTool to add a split code to a virtual terminal.
Add Subaccount to SplitTool to add a subaccount to a split configuration, or update the share of an existing subaccount.
Archive Payment RequestTool to archive a payment request to clean up records.
Assign Destination to Virtual TerminalTool to assign WhatsApp destinations to a Virtual Terminal for payment notifications.
Check Pending ChargeTool to check the status of a pending charge transaction.
Check Slug AvailabilityTool to check if a custom slug is available for use when creating a payment page.
Bulk Create Transfer RecipientsCreate multiple transfer recipients in batches.
Create ChargeTool to initiate a payment by integrating the payment channel of your choice.
Create CustomerTool to create a customer on your Paystack integration.
Create Payment PageTool to create a payment page on your Paystack integration.
Create Payment RequestCreate a new payment request by issuing an invoice to a customer.
Create PlanTool to create a plan for recurring payments on Paystack.
Create RefundTool to initiate a refund for a previously completed transaction on Paystack.
Create Split ConfigurationTool to create a split configuration for transaction revenue sharing.
Create StorefrontCreate a digital storefront on Paystack to manage and display products.
Create SubaccountTool to create a subaccount on your Paystack integration.
Create Transfer RecipientTool to create a new recipient for transfers.
Create Virtual TerminalCreate a Virtual Terminal on your Paystack integration to accept payments.
Deactivate AuthorizationTool to deactivate an authorization when a card or payment method needs to be forgotten.
Deactivate Virtual TerminalTool to deactivate a Virtual Terminal on your integration.
Delete ProductDelete a previously created product from Paystack by its ID.
Delete StorefrontDelete a previously created storefront from Paystack by its ID.
Delete Transfer RecipientTool to delete a transfer recipient by setting it to inactive status.
Disable OTP for TransfersTool to disable OTP requirement for programmatic transfers.
Disable SubscriptionTool to disable a subscription on your Paystack integration.
Duplicate StorefrontTool to duplicate a previously created Storefront.
Enable OTP for TransfersTool to enable OTP requirement for transfers.
Export TransactionsTool to export transactions from Paystack for a specific timeframe.
Fetch BalanceTool to fetch the available balance on your Paystack integration.
Fetch balance ledgerTool to fetch all pay-ins and pay-outs that went into your Paystack balance.
Fetch Bulk Charge BatchTool to retrieve a specific bulk charge batch by code.
Fetch CustomerTool to get details of a customer on your integration.
Fetch Mandate AuthorizationsTool to fetch the list of direct debit mandate authorizations associated with a customer.
Fetch Payment PageTool to fetch details of a payment page on your Paystack integration.
Fetch Payment Request DetailsTool to fetch details of a payment request from Paystack.
Fetch Payment Session TimeoutTool to fetch the payment session timeout configured on your Paystack integration.
Fetch PlanTool to get details of a plan on your integration.
Fetch ProductTool to get details of a product on your integration.
Fetch Product OrdersTool to fetch all orders for a particular product on your Paystack integration.
Fetch RefundTool to get details of a refund on your integration.
Fetch SplitTool to get details of a split configuration for a transaction.
Fetch StorefrontTool to get the details of a previously created Storefront.
Fetch Storefront OrdersTool to fetch all orders in a Paystack storefront.
Fetch SubaccountTool to get details of a subaccount on your integration.
Fetch SubscriptionTool to get details of a subscription on your integration.
Fetch TransactionTool to get details of a transaction carried out on your integration.
Fetch Transaction TimelineTool to fetch the timeline of a transaction showing the steps taken from initiation to completion.
Fetch Transfer RecipientTool to fetch details of a transfer recipient.
Fetch Virtual TerminalTool to fetch a Virtual Terminal on your Paystack integration.
Finalize Payment RequestTool to finalize the creation of a draft payment request for a customer.
Generate Update Subscription LinkTool to generate a link for updating the card on a subscription.
Get Payment Request TotalsTool to retrieve metrics for all pending and successful payment requests.
Get Transaction TotalsTool to get the total amount received on your Paystack account.
Initialize AuthorizationTool to initialize a reusable authorization for recurring transactions.
Initialize TransactionTool to initialize a transaction from your backend.
Initiate Bulk ChargeTool to initiate a bulk charge on your integration.
List BanksTool to get a list of all supported banks and their properties on Paystack.
List Bulk Charge BatchesTool to list bulk charge batches created on your integration.
List Charges in BatchTool to retrieve the charges associated with a specified bulk charge batch.
List countriesTool to retrieve a list of countries that Paystack currently supports.
List CustomersTool to list customers available on your integration.
List DisputesTool to list transaction disputes filed by customers on your Paystack integration.
List Apple Pay DomainsTool to list all registered Apple Pay domains on your integration.
List Mandate AuthorizationsTool to get a list of all direct debit mandates on your integration.
List OrdersTool to list orders available on your integration.
List Payment PagesTool to list payment pages available on your Paystack integration.
List Payment RequestsTool to list all previously created payment requests to your customers.
List PlansTool to list all subscription plans available on your integration.
List ProductsTool to list products available on your integration.
List RefundsTool to list refunds available on your integration.
List SettlementsTool to list settlements made to your settlement accounts.
List SplitsTool to list the transaction splits available on your integration.
List states for address verificationTool to retrieve a list of states for a country for address verification.
List Storefront ProductsTool to list all products in a Paystack storefront.
List StorefrontsTool to list storefronts available on your integration.
List SubaccountsTool to list subaccounts available on your integration.
List SubscriptionsTool to list all subscriptions available on your integration.
List TransactionsTool to list transactions that have occurred on your integration.
List Transfer RecipientsTool to list transfer recipients available on your integration.
List TransfersTool to list all transfers carried out on your integration.
List Virtual TerminalsTool to list virtual terminals available on your integration.
Pause Bulk ChargeTool to pause processing of a bulk charge batch.
Publish StorefrontTool to make a Storefront publicly available on Paystack.
Remove Subaccount from SplitTool to remove a subaccount from a split configuration.
Resend OTP for TransferTool to resend OTP for a transfer.
Resolve Card BINTool to get basic information about a card BIN (Bank Identification Number).
Resume Bulk Charge BatchTool to resume processing of a previously paused bulk charge batch.
Send Payment Request NotificationTool to send an email notification to a customer for a previously created payment request.
Send Subscription Update LinkTool to send an email to the customer with a link to update the card on their subscription.
Set Risk ActionTool to set a customer's risk action by whitelisting or blacklisting them.
Submit PhoneTool to submit phone number when requested during a charge transaction.
Trigger direct debit activation chargeTool to trigger an activation charge on an inactive direct debit mandate for a customer.
Unassign Destination from Virtual TerminalTool to unassign WhatsApp destinations from a Virtual Terminal.
Unregister Apple Pay DomainTool to unregister a top-level domain or subdomain previously used for Apple Pay integration.
Update CustomerTool to update a customer's details on your Paystack integration.
Update Payment PageTool to update a payment page on your Paystack integration.
Update Payment RequestTool to update a payment request on your Paystack integration.
Update Payment Session TimeoutTool to update the payment session timeout on your Paystack integration.
Update PlanTool to update a plan's details on your Paystack integration.
Update ProductTool to update a product on your integration.
Update Split ConfigurationTool to update a split configuration for transactions.
Update StorefrontTool to update the details of a previously created Storefront.
Update SubaccountTool to update a subaccount's details on your Paystack integration.
Update Transfer RecipientTool to update the details of a transfer recipient.
Validate Bank AccountTool to validate the authenticity of a customer's bank account before sending money.
Validate CustomerTool to validate a customer's identity on your Paystack integration.
Validate OrderTool to validate a pay for me order on Paystack.
Verify Payment RequestTool to verify the status of a previously created payment request on Paystack.
Verify Storefront SlugTool to verify the availability of a slug before using it for a Storefront.
Verify TransactionTool to confirm the status of a transaction using its reference.

What is the Composio tool router, and how does it fit here?

What is Tool Router?

Composio's Tool Router helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Tool Router

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Tool Router works

The Tool Router follows a three-phase workflow:

  1. Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
  2. Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
  3. Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Prerequisites

Before you begin, make sure you have:
  • Python 3.8/Node 16 or higher installed
  • A Composio account with the API key
  • An OpenAI API key
  • A Paystack account and project
  • Basic familiarity with async Python/Typescript

Getting API Keys for OpenAI, Composio, and Paystack

OpenAI API key (OPENAI_API_KEY)
  • Go to the OpenAI dashboard
  • Create an API key if you don't have one
  • Assign it to OPENAI_API_KEY in .env
Composio API key and user ID
  • Log into the Composio dashboard
  • Copy your API key from Settings
    • Use this as COMPOSIO_API_KEY
  • Pick a stable user identifier (email or ID)
    • Use this as COMPOSIO_USER_ID

Installing dependencies

pip install composio-llamaindex llama-index llama-index-llms-openai llama-index-tools-mcp python-dotenv

Create a new Python project and install the necessary dependencies:

  • composio-llamaindex: Composio's LlamaIndex integration
  • llama-index: Core LlamaIndex framework
  • llama-index-llms-openai: OpenAI LLM integration
  • llama-index-tools-mcp: MCP client for LlamaIndex
  • python-dotenv: Environment variable management

Set environment variables

bash
OPENAI_API_KEY=your-openai-api-key
COMPOSIO_API_KEY=your-composio-api-key
COMPOSIO_USER_ID=your-user-id

Create a .env file in your project root:

These credentials will be used to:

  • Authenticate with OpenAI's GPT-5 model
  • Connect to Composio's Tool Router
  • Identify your Composio user session for Paystack access

Import modules

import asyncio
import os
import dotenv

from composio import Composio
from composio_llamaindex import LlamaIndexProvider
from llama_index.core.agent.workflow import ReActAgent
from llama_index.core.workflow import Context
from llama_index.llms.openai import OpenAI
from llama_index.tools.mcp import BasicMCPClient, McpToolSpec

dotenv.load_dotenv()

Create a new file called paystack_llamaindex_agent.py and import the required modules:

Key imports:

  • asyncio: For async/await support
  • Composio: Main client for Composio services
  • LlamaIndexProvider: Adapts Composio tools for LlamaIndex
  • ReActAgent: LlamaIndex's reasoning and action agent
  • BasicMCPClient: Connects to MCP endpoints
  • McpToolSpec: Converts MCP tools to LlamaIndex format

Load environment variables and initialize Composio

OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY")
COMPOSIO_USER_ID = os.getenv("COMPOSIO_USER_ID")

if not OPENAI_API_KEY:
    raise ValueError("OPENAI_API_KEY is not set in the environment")
if not COMPOSIO_API_KEY:
    raise ValueError("COMPOSIO_API_KEY is not set in the environment")
if not COMPOSIO_USER_ID:
    raise ValueError("COMPOSIO_USER_ID is not set in the environment")

What's happening:

This ensures missing credentials cause early, clear errors before the agent attempts to initialise.

Create a Tool Router session and build the agent function

async def build_agent() -> ReActAgent:
    composio_client = Composio(
        api_key=COMPOSIO_API_KEY,
        provider=LlamaIndexProvider(),
    )

    session = composio_client.create(
        user_id=COMPOSIO_USER_ID,
        toolkits=["paystack"],
    )

    mcp_url = session.mcp.url
    print(f"Composio MCP URL: {mcp_url}")

    mcp_client = BasicMCPClient(mcp_url, headers={"x-api-key": COMPOSIO_API_KEY})
    mcp_tool_spec = McpToolSpec(client=mcp_client)
    tools = await mcp_tool_spec.to_tool_list_async()

    llm = OpenAI(model="gpt-5")

    description = "An agent that uses Composio Tool Router MCP tools to perform Paystack actions."
    system_prompt = """
    You are a helpful assistant connected to Composio Tool Router.
    Use the available tools to answer user queries and perform Paystack actions.
    """
    return ReActAgent(tools=tools, llm=llm, description=description, system_prompt=system_prompt, verbose=True)

What's happening here:

  • We create a Composio client using your API key and configure it with the LlamaIndex provider
  • We then create a tool router MCP session for your user, specifying the toolkits we want to use (in this case, paystack)
  • The session returns an MCP HTTP endpoint URL that acts as a gateway to all your configured tools
  • LlamaIndex will connect to this endpoint to dynamically discover and use the available Paystack tools.
  • The MCP tools are mapped to LlamaIndex-compatible tools and plug them into the Agent.

Create an interactive chat loop

async def chat_loop(agent: ReActAgent) -> None:
    ctx = Context(agent)
    print("Type 'quit', 'exit', or Ctrl+C to stop.")

    while True:
        try:
            user_input = input("\nYou: ").strip()
        except (KeyboardInterrupt, EOFError):
            print("\nBye!")
            break

        if not user_input or user_input.lower() in {"quit", "exit"}:
            print("Bye!")
            break

        try:
            print("Agent: ", end="", flush=True)
            handler = agent.run(user_input, ctx=ctx)

            async for event in handler.stream_events():
                # Stream token-by-token from LLM responses
                if hasattr(event, "delta") and event.delta:
                    print(event.delta, end="", flush=True)
                # Show tool calls as they happen
                elif hasattr(event, "tool_name"):
                    print(f"\n[Using tool: {event.tool_name}]", flush=True)

            # Get final response
            response = await handler
            print()  # Newline after streaming
        except KeyboardInterrupt:
            print("\n[Interrupted]")
            continue
        except Exception as e:
            print(f"\nError: {e}")

What's happening here:

  • We're creating a direct terminal interface to chat with your Paystack database
  • The LLM's responses are streamed to the CLI for faster interaction.
  • The agent uses context to maintain conversation history
  • You can type 'quit' or 'exit' to stop the chat loop gracefully
  • Agent responses and any errors are displayed in a clear, readable format

Define the main entry point

async def main() -> None:
    agent = await build_agent()
    await chat_loop(agent)

if __name__ == "__main__":
    # Handle Ctrl+C gracefully
    signal.signal(signal.SIGINT, lambda s, f: (print("\nBye!"), exit(0)))
    try:
        asyncio.run(main())
    except KeyboardInterrupt:
        print("\nBye!")

What's happening here:

  • We're orchestrating the entire application flow
  • The agent gets built with proper error handling
  • Then we kick off the interactive chat loop so you can start talking to Paystack

Run the agent

npx ts-node llamaindex-agent.ts

When prompted, authenticate and authorise your agent with Paystack, then start asking questions.

Complete Code

Here's the complete code to get you started with Paystack and LlamaIndex:

import asyncio
import os
import signal
import dotenv

from composio import Composio
from composio_llamaindex import LlamaIndexProvider
from llama_index.core.agent.workflow import ReActAgent
from llama_index.core.workflow import Context
from llama_index.llms.openai import OpenAI
from llama_index.tools.mcp import BasicMCPClient, McpToolSpec

dotenv.load_dotenv()

OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY")
COMPOSIO_USER_ID = os.getenv("COMPOSIO_USER_ID")

if not OPENAI_API_KEY:
    raise ValueError("OPENAI_API_KEY is not set")
if not COMPOSIO_API_KEY:
    raise ValueError("COMPOSIO_API_KEY is not set")
if not COMPOSIO_USER_ID:
    raise ValueError("COMPOSIO_USER_ID is not set")

async def build_agent() -> ReActAgent:
    composio_client = Composio(
        api_key=COMPOSIO_API_KEY,
        provider=LlamaIndexProvider(),
    )

    session = composio_client.create(
        user_id=COMPOSIO_USER_ID,
        toolkits=["paystack"],
    )

    mcp_url = session.mcp.url
    print(f"Composio MCP URL: {mcp_url}")

    mcp_client = BasicMCPClient(mcp_url, headers={"x-api-key": COMPOSIO_API_KEY})
    mcp_tool_spec = McpToolSpec(client=mcp_client)
    tools = await mcp_tool_spec.to_tool_list_async()

    llm = OpenAI(model="gpt-5")
    description = "An agent that uses Composio Tool Router MCP tools to perform Paystack actions."
    system_prompt = """
    You are a helpful assistant connected to Composio Tool Router.
    Use the available tools to answer user queries and perform Paystack actions.
    """
    return ReActAgent(
        tools=tools,
        llm=llm,
        description=description,
        system_prompt=system_prompt,
        verbose=True,
    );

async def chat_loop(agent: ReActAgent) -> None:
    ctx = Context(agent)
    print("Type 'quit', 'exit', or Ctrl+C to stop.")

    while True:
        try:
            user_input = input("\nYou: ").strip()
        except (KeyboardInterrupt, EOFError):
            print("\nBye!")
            break

        if not user_input or user_input.lower() in {"quit", "exit"}:
            print("Bye!")
            break

        try:
            print("Agent: ", end="", flush=True)
            handler = agent.run(user_input, ctx=ctx)

            async for event in handler.stream_events():
                # Stream token-by-token from LLM responses
                if hasattr(event, "delta") and event.delta:
                    print(event.delta, end="", flush=True)
                # Show tool calls as they happen
                elif hasattr(event, "tool_name"):
                    print(f"\n[Using tool: {event.tool_name}]", flush=True)

            # Get final response
            response = await handler
            print()  # Newline after streaming
        except KeyboardInterrupt:
            print("\n[Interrupted]")
            continue
        except Exception as e:
            print(f"\nError: {e}")

async def main() -> None:
    agent = await build_agent()
    await chat_loop(agent)

if __name__ == "__main__":
    # Handle Ctrl+C gracefully
    signal.signal(signal.SIGINT, lambda s, f: (print("\nBye!"), exit(0)))
    try:
        asyncio.run(main())
    except KeyboardInterrupt:
        print("\nBye!")

Conclusion

You've successfully connected Paystack to LlamaIndex through Composio's Tool Router MCP layer. Key takeaways:
  • Tool Router dynamically exposes Paystack tools through an MCP endpoint
  • LlamaIndex's ReActAgent handles reasoning and orchestration; Composio handles integrations
  • The agent becomes more capable without increasing prompt size
  • Async Python provides clean, efficient execution of agent workflows
You can easily extend this to other toolkits like Gmail, Notion, Stripe, GitHub, and more by adding them to the toolkits parameter.

How to build Paystack MCP Agent with another framework

OpenAI Agents SDK

OpenAI Agents SDK

Use Paystack MCP with OpenAI Agents SDK

Claude Agent SDK

Claude Agent SDK

Use Paystack MCP with Claude Agent SDK

Google ADK

Google ADK

Use Paystack MCP with Google ADK

LangChain

LangChain

Use Paystack MCP with LangChain

Vercel AI SDK

Vercel AI SDK

Use Paystack MCP with Vercel AI SDK

Mastra AI

Mastra AI

Use Paystack MCP with Mastra AI

CrewAI

CrewAI

Use Paystack MCP with CrewAI

Claude Code

Claude Code

Use Paystack MCP with Claude Code

Codex

Codex

Use Paystack MCP with Codex

FAQ

What are the differences in Tool Router MCP and Paystack MCP?

With a standalone Paystack MCP server, the agents and LLMs can only access a fixed set of Paystack tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Paystack and many other apps based on the task at hand, all through a single MCP endpoint.

Can I use Tool Router MCP with LlamaIndex?

Yes, you can. LlamaIndex fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Paystack tools.

Can I manage the permissions and scopes for Paystack while using Tool Router?

Yes, absolutely. You can configure which Paystack scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

How safe is my data with Composio Tool Router?

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Paystack data and credentials are handled as safely as possible.

Used by agents from

Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.

Book a call↗Get started for free