Home / Servers / Square API / list_payments
ListPayments
An MCP tool from the Square API server, hosted on mcp.hjlabs.in.
ListPayments Retrieves a list of payments taken by the account making the request. Results are eventually consistent, and new payments or changes to payments might take several seconds to appear. The maximum… [GET /v2/payments]
Name on the gateway: square_api__list_payments · read-only.
Parameters
| Name | Type | Description |
|---|---|---|
begin_time | string | Indicates the start of the time range to retrieve payments for, in RFC 3339… |
end_time | string | Indicates the end of the time range to retrieve payments for, in RFC 3339… |
sort_order | string | The order in which results are listed by ListPaymentsRequest.sort_field: - ASC… |
cursor | string | A pagination cursor returned by a previous call to this endpoint. Provide this… |
location_id | string | Limit results to the location supplied. By default, results are returned for… |
total | integer | The exact amount in the total_money for a payment. |
last_4 | string | The last four digits of a payment card. |
card_brand | string | The brand of the payment card (for example, VISA). |
limit | integer | The maximum number of results to be returned in a single page. It is possible… |
is_offline_payment | boolean | Whether the payment was taken offline or not. |
offline_begin_time | string | Indicates the start of the time range for which to retrieve offline payments… |
offline_end_time | string | Indicates the end of the time range for which to retrieve offline payments, in… |
updated_at_begin_time | string | Indicates the start of the time range to retrieve payments for, in RFC 3339… |
updated_at_end_time | string | Indicates the end of the time range to retrieve payments for, in RFC 3339… |
sort_field | CREATED_AT | OFFLINE_CREATED_AT | UPDATED_AT | The field used to sort results by. The default is CREATED_AT. |
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_payments",
"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 listpayments tool with begin_time set to ….