Skip to main content
Glama

list_payouts

Retrieve payout records from GoCardless to view transaction history and manage payment settlements.

Instructions

List payouts from GoCardless

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoNumber of payouts to retrieve (default: 50)

Implementation Reference

  • Handler implementation for the 'list_payouts' tool. Retrieves payouts using the GoCardless client with an optional limit, formats the results, and returns them as text content.
    elif name == "list_payouts":
        limit = arguments.get("limit", 50)
        payouts = client.payouts.list(params={"limit": limit})
        result = []
        for payout in payouts.records:
            result.append(
                {
                    "id": payout.id,
                    "amount": payout.amount,
                    "currency": payout.currency,
                    "status": payout.status,
                    "created_at": payout.created_at,
                }
            )
        return [
            types.TextContent(
                type="text",
                text=f"Found {len(result)} payouts:\n{_format_json(result)}",
            )
        ]
  • Registration of the 'list_payouts' tool in the list_tools handler, including its description and input schema.
    types.Tool(
        name="list_payouts",
        description="List payouts from GoCardless",
        inputSchema={
            "type": "object",
            "properties": {
                "limit": {
                    "type": "integer",
                    "description": "Number of payouts to retrieve (default: 50)",
                }
            },
        },
    ),
  • Input schema definition for the 'list_payouts' tool.
    inputSchema={
        "type": "object",
        "properties": {
            "limit": {
                "type": "integer",
                "description": "Number of payouts to retrieve (default: 50)",
            }
        },
    },

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/jmceleney/gocardless-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server