Home / Servers / Square API / refund_payment

RefundPayment

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

RefundPayment Refunds a payment. You can refund the entire payment amount or a portion of it. You can use this endpoint to refund a card payment or record a refund of a cash or external payment. For more… [POST /v2/refunds]

Name on the gateway: square_api__refund_payment · may change things.

Parameters

NameTypeDescription
idempotency_key requiredstringA unique string that identifies this RefundPayment request. The key can be any…
amount_money requiredobjectThe amount of money to refund. This amount cannot be more than the total_money…
app_fee_moneyobjectThe amount of money the developer contributes to help cover the refunded…
app_fee_allocationsarrayDetails pertaining to contributors to the refund of the application fee. The…
payment_idstringThe unique ID of the payment being refunded. Required when unlinked=false…
destination_idstringThe ID indicating where funds will be refunded to. Required for unlinked…
unlinkedbooleanIndicates that the refund is not linked to a Square payment. If set to true…
location_idstringThe location ID associated with the unlinked refund. Required for requests…
customer_idstringThe Customer ID of the customer associated with the refund. This is required…
reasonstringA description of the reason for the refund.
payment_version_tokenstringUsed for optimistic concurrency. This opaque token identifies the current…
team_member_idstringAn optional TeamMember ID to associate with this refund.
cash_detailsobjectAdditional details required when recording an unlinked cash refund…
external_detailsobjectAdditional details required when recording an unlinked external refund…

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__refund_payment",
  "arguments": {
    "idempotency_key": "…",
    "amount_money": "…"
  }
}

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 refundpayment tool with idempotency_key set to ….

More from Square API