list_payouts
Retrieve payout records from GoCardless to view transaction history and manage payment settlements.
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 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)}", ) ] - src/gocardless_mcp/server.py:233-245 (registration)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)", } }, }, ), - src/gocardless_mcp/server.py:236-244 (schema)Input schema definition for the 'list_payouts' tool.
inputSchema={ "type": "object", "properties": { "limit": { "type": "integer", "description": "Number of payouts to retrieve (default: 50)", } }, },