Home / Servers / Square API / list_payouts
ListPayouts
An MCP tool from the Square API server, hosted on mcp.hjlabs.in.
ListPayouts Retrieves a list of all payouts for the default location. You can filter payouts by location ID, status, time range, and order them in ascending or descending order. To call this endpoint, set… [GET /v2/payouts]
Name on the gateway: square_api__list_payouts · read-only.
Parameters
| Name | Type | Description |
|---|---|---|
location_id | string | The ID of the location for which to list the payouts. By default, payouts are… |
status | SENT | FAILED | PAID | If provided, only payouts with the given status are returned. |
begin_time | string | The timestamp for the beginning of the payout creation time, in RFC 3339… |
end_time | string | The timestamp for the end of the payout creation time, in RFC 3339 format.… |
sort_order | DESC | ASC | The order in which payouts are listed. |
cursor | string | A pagination cursor returned by a previous call to this endpoint. Provide this… |
limit | integer | The maximum number of results to be returned in a single page. It is possible… |
How to call it
Through the Smart Gateway, any client can run it by name with call_tool, or let the gateway find it with search_tools:
{
"name": "square_api__list_payouts",
"arguments": {}
}Or connect the Square API server directly, which lists 308 tools including this one:
claude mcp add --transport http hj-square-api https://mcp.hjlabs.in/mcp/square-api \
--header "Authorization: Bearer YOUR_API_KEY"Try asking
Use the listpayouts tool with location_id set to ….