Home / Servers / Square API / list_payment_refunds

ListPaymentRefunds

An MCP tool from the Square API server, hosted on mcp.hjlabs.in.

ListPaymentRefunds Retrieves a list of refunds for the account making the request. Results are eventually consistent, and new refunds or changes to refunds might take several seconds to appear. The maximum results per… [GET /v2/refunds]

Name on the gateway: square_api__list_payment_refunds · read-only.

Parameters

NameTypeDescription
begin_timestringIndicates the start of the time range to retrieve each PaymentRefund for, in…
end_timestringIndicates the end of the time range to retrieve each PaymentRefund for, in RFC…
sort_orderstringThe order in which results are listed by PaymentRefund.created_at: - ASC…
cursorstringA pagination cursor returned by a previous call to this endpoint. Provide this…
location_idstringLimit results to the location supplied. By default, results are returned for…
statusstringIf provided, only refunds with the given status are returned. For a list of…
source_typestringIf provided, only returns refunds whose payments have the indicated source…
limitintegerThe maximum number of results to be returned in a single page. It is possible…
updated_at_begin_timestringIndicates the start of the time range to retrieve each PaymentRefund for, in…
updated_at_end_timestringIndicates the end of the time range to retrieve each PaymentRefund for, in RFC…
sort_fieldCREATED_AT | UPDATED_ATThe 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:

call_tool arguments
{
  "name": "square_api__list_payment_refunds",
  "arguments": {}
}

Or connect the Square API server directly, which lists 308 tools including this one:

Run in your terminal
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 listpaymentrefunds tool with begin_time set to ….

More from Square API