list_payouts
Retrieve payout records from GoCardless to monitor and manage payment distributions to your account. Specify the number of payouts to display for financial tracking.
Instructions
List payouts from GoCardless
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of payouts to retrieve (default: 50) |
Implementation Reference
- src/gocardless_mcp/server.py:527-546 (handler)Handler for the 'list_payouts' tool within the @server.call_tool() function. Retrieves payouts using the GoCardless client, formats them into a list with id, amount, currency, status, and created_at, and returns a formatted text response.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)}", ) ]
- src/gocardless_mcp/server.py:233-245 (registration)Registration of the 'list_payouts' tool in the @server.list_tools() handler, including its name, description, and input schema for the optional 'limit' parameter.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)", } }, }, ),
- src/gocardless_mcp/server.py:237-244 (schema)Input schema for the 'list_payouts' tool, defining an optional 'limit' integer parameter."type": "object", "properties": { "limit": { "type": "integer", "description": "Number of payouts to retrieve (default: 50)", } }, },