Square API MCP server
Payments, orders, catalog, customers, inventory and bookings.
Square's Connect API from its OpenAPI spec: payments and refunds, orders, catalog items, customers, inventory, invoices, bookings, locations, team members, loyalty and gift cards, with your personal access token.
Why use the hosted one: Every endpoint of Square's API behind the gateway's search, with your own Square access token stored encrypted and sent only to Square.
Needs your Square access token: add it once in the dashboard (get one at Square). It is stored encrypted and sent only to that API.
Connect
claude mcp add --transport http hj-square-api https://mcp.hjlabs.in/mcp/square-api \
--header "Authorization: Bearer YOUR_API_KEY"Create an API key and put it in place of YOUR_API_KEY. Step-by-step guides: claude.ai and ChatGPT connectors, Claude Code, Cursor, VS Code, Claude Desktop, Windsurf, Zed, OpenAI Codex CLI, Gemini CLI.
All 308 tools
Retrieve 51 tools
- RetrieveTokenStatus
retrieve_token_status - RetrieveBusinessBookingProfile
retrieve_business_booking_profile - RetrieveBookingCustomAttributeDefinition
retrieve_booking_custom_attribute_definition - RetrieveLocationBookingProfile
retrieve_location_booking_profile - RetrieveTeamMemberBookingProfile
retrieve_team_member_booking_profile - RetrieveBooking
retrieve_booking - RetrieveBookingCustomAttribute
retrieve_booking_custom_attribute - RetrieveCard
retrieve_card - RetrieveCashDrawerShift
retrieve_cash_drawer_shift - RetrieveCatalogObject
retrieve_catalog_object - RetrieveChannel
retrieve_channel - RetrieveCustomerCustomAttributeDefinition
retrieve_customer_custom_attribute_definition - RetrieveCustomerGroup
retrieve_customer_group - RetrieveCustomerSegment
retrieve_customer_segment - RetrieveCustomer
retrieve_customer - RetrieveCustomerCustomAttribute
retrieve_customer_custom_attribute - RetrieveDispute
retrieve_dispute - RetrieveDisputeEvidence
retrieve_dispute_evidence - RetrieveGiftCardFromGAN
retrieve_gift_card_from_gan - RetrieveGiftCardFromNonce
retrieve_gift_card_from_nonce - RetrieveGiftCard
retrieve_gift_card - RetrieveInventoryAdjustmentReason
retrieve_inventory_adjustment_reason - RetrieveInventoryAdjustment
retrieve_inventory_adjustment - RetrieveInventoryPhysicalCount
retrieve_inventory_physical_count - RetrieveInventoryCount
retrieve_inventory_count - RetrieveScheduledShift
retrieve_scheduled_shift - RetrieveTimecard
retrieve_timecard - RetrieveLocationCustomAttributeDefinition
retrieve_location_custom_attribute_definition - RetrieveLocation
retrieve_location - RetrieveLocationCustomAttribute
retrieve_location_custom_attribute - RetrieveLoyaltyAccount
retrieve_loyalty_account - RetrieveLoyaltyProgram
retrieve_loyalty_program - RetrieveLoyaltyPromotion
retrieve_loyalty_promotion - RetrieveLoyaltyReward
retrieve_loyalty_reward - RetrieveMerchantCustomAttributeDefinition
retrieve_merchant_custom_attribute_definition - RetrieveMerchant
retrieve_merchant - RetrieveMerchantCustomAttribute
retrieve_merchant_custom_attribute - RetrieveLocationSettings
retrieve_location_settings - RetrieveMerchantSettings
retrieve_merchant_settings - RetrievePaymentLink
retrieve_payment_link - RetrieveOrderCustomAttributeDefinition
retrieve_order_custom_attribute_definition - RetrieveOrder
retrieve_order - RetrieveOrderCustomAttribute
retrieve_order_custom_attribute - RetrieveSnippet
retrieve_snippet - RetrieveSubscription
retrieve_subscription - RetrieveJob
retrieve_job - RetrieveTeamMember
retrieve_team_member - RetrieveWageSetting
retrieve_wage_setting - RetrieveTransferOrder
retrieve_transfer_order - RetrieveVendor
retrieve_vendor - RetrieveWebhookSubscription
retrieve_webhook_subscription
List 47 tools
- ListBankAccounts
list_bank_accounts - ListBookings
list_bookings - ListBookingCustomAttributeDefinitions
list_booking_custom_attribute_definitions - ListLocationBookingProfiles
list_location_booking_profiles - ListTeamMemberBookingProfiles
list_team_member_booking_profiles - ListBookingCustomAttributes
list_booking_custom_attributes - ListCards
list_cards - ListCashDrawerShifts
list_cash_drawer_shifts - ListCashDrawerShiftEvents
list_cash_drawer_shift_events - ListCatalog
list_catalog - ListChannels
list_channels - ListCustomers
list_customers - ListCustomerCustomAttributeDefinitions
list_customer_custom_attribute_definitions - ListCustomerGroups
list_customer_groups - ListCustomerSegments
list_customer_segments - ListCustomerCustomAttributes
list_customer_custom_attributes - ListDevices
list_devices - ListDeviceCodes
list_device_codes - ListDisputes
list_disputes - ListDisputeEvidence
list_dispute_evidence - ListEventTypes
list_event_types - ListGiftCards
list_gift_cards - ListGiftCardActivities
list_gift_card_activities - ListInventoryAdjustmentReasons
list_inventory_adjustment_reasons - ListInvoices
list_invoices - ListBreakTypes
list_break_types - ListTeamMemberWages
list_team_member_wages - ListWorkweekConfigs
list_workweek_configs - ListLocations
list_locations - ListLocationCustomAttributeDefinitions
list_location_custom_attribute_definitions - ListLocationCustomAttributes
list_location_custom_attributes - ListLoyaltyPromotions
list_loyalty_promotions - ListMerchants
list_merchants - ListMerchantCustomAttributeDefinitions
list_merchant_custom_attribute_definitions - ListMerchantCustomAttributes
list_merchant_custom_attributes - ListPaymentLinks
list_payment_links - ListOrderCustomAttributeDefinitions
list_order_custom_attribute_definitions - ListOrderCustomAttributes
list_order_custom_attributes - ListPayments
list_payments - ListPayouts
list_payouts - ListPayoutEntries
list_payout_entries - ListPaymentRefunds
list_payment_refunds - ListSites
list_sites - ListSubscriptionEvents
list_subscription_events - ListJobs
list_jobs - ListWebhookEventTypes
list_webhook_event_types - ListWebhookSubscriptions
list_webhook_subscriptions
Create 38 tools
- CreateBankAccount
create_bank_account - CreateBooking
create_booking - CreateBookingCustomAttributeDefinition
create_booking_custom_attribute_definition - CreateCard
create_card - CreateCatalogImage
create_catalog_image - CreateCustomer
create_customer - CreateCustomerCustomAttributeDefinition
create_customer_custom_attribute_definition - CreateCustomerGroup
create_customer_group - CreateDeviceCode
create_device_code - CreateDisputeEvidenceFile
create_dispute_evidence_file - CreateDisputeEvidenceText
create_dispute_evidence_text - CreateGiftCard
create_gift_card - CreateGiftCardActivity
create_gift_card_activity - CreateInventoryAdjustmentReason
create_inventory_adjustment_reason - CreateInvoice
create_invoice - CreateInvoiceAttachment
create_invoice_attachment - CreateBreakType
create_break_type - CreateScheduledShift
create_scheduled_shift - CreateTimecard
create_timecard - CreateLocation
create_location - CreateLocationCustomAttributeDefinition
create_location_custom_attribute_definition - CreateLoyaltyAccount
create_loyalty_account - CreateLoyaltyPromotion
create_loyalty_promotion - CreateLoyaltyReward
create_loyalty_reward - CreateMerchantCustomAttributeDefinition
create_merchant_custom_attribute_definition - CreatePaymentLink
create_payment_link - CreateOrder
create_order - CreateOrderCustomAttributeDefinition
create_order_custom_attribute_definition - CreatePayment
create_payment - CreateSubscription
create_subscription - CreateTeamMember
create_team_member - CreateJob
create_job - CreateTerminalAction
create_terminal_action - CreateTerminalCheckout
create_terminal_checkout - CreateTerminalRefund
create_terminal_refund - CreateTransferOrder
create_transfer_order - CreateVendor
create_vendor - CreateWebhookSubscription
create_webhook_subscription
Update 32 tools
- UpdateBookingCustomAttributeDefinition
update_booking_custom_attribute_definition - UpdateBooking
update_booking - UpdateCatalogImage
update_catalog_image - UpdateItemModifierLists
update_item_modifier_lists - UpdateItemTaxes
update_item_taxes - UpdateCustomerCustomAttributeDefinition
update_customer_custom_attribute_definition - UpdateCustomerGroup
update_customer_group - UpdateCustomer
update_customer - UpdateInventoryAdjustmentReason
update_inventory_adjustment_reason - UpdateInventoryAdjustment
update_inventory_adjustment - UpdateInvoice
update_invoice - UpdateBreakType
update_break_type - UpdateScheduledShift
update_scheduled_shift - UpdateTimecard
update_timecard - UpdateWorkweekConfig
update_workweek_config - UpdateLocationCustomAttributeDefinition
update_location_custom_attribute_definition - UpdateLocation
update_location - UpdateMerchantCustomAttributeDefinition
update_merchant_custom_attribute_definition - UpdateLocationSettings
update_location_settings - UpdateMerchantSettings
update_merchant_settings - UpdatePaymentLink
update_payment_link - UpdateOrderCustomAttributeDefinition
update_order_custom_attribute_definition - UpdateOrder
update_order - UpdatePayment
update_payment - UpdateSubscription
update_subscription - UpdateJob
update_job - UpdateTeamMember
update_team_member - UpdateWageSetting
update_wage_setting - UpdateTransferOrder
update_transfer_order - UpdateVendor
update_vendor - UpdateWebhookSubscription
update_webhook_subscription - UpdateWebhookSubscriptionSignatureKey
update_webhook_subscription_signature_key
Delete 25 tools
- DeleteBookingCustomAttributeDefinition
delete_booking_custom_attribute_definition - DeleteBookingCustomAttribute
delete_booking_custom_attribute - DeleteCatalogObject
delete_catalog_object - DeleteCustomerCustomAttributeDefinition
delete_customer_custom_attribute_definition - DeleteCustomerGroup
delete_customer_group - DeleteCustomer
delete_customer - DeleteCustomerCustomAttribute
delete_customer_custom_attribute - DeleteDisputeEvidence
delete_dispute_evidence - DeleteInventoryAdjustmentReason
delete_inventory_adjustment_reason - DeleteInvoice
delete_invoice - DeleteInvoiceAttachment
delete_invoice_attachment - DeleteBreakType
delete_break_type - DeleteTimecard
delete_timecard - DeleteLocationCustomAttributeDefinition
delete_location_custom_attribute_definition - DeleteLocationCustomAttribute
delete_location_custom_attribute - DeleteLoyaltyReward
delete_loyalty_reward - DeleteMerchantCustomAttributeDefinition
delete_merchant_custom_attribute_definition - DeleteMerchantCustomAttribute
delete_merchant_custom_attribute - DeletePaymentLink
delete_payment_link - DeleteOrderCustomAttributeDefinition
delete_order_custom_attribute_definition - DeleteOrderCustomAttribute
delete_order_custom_attribute - DeleteSnippet
delete_snippet - DeleteSubscriptionAction
delete_subscription_action - DeleteTransferOrder
delete_transfer_order - DeleteWebhookSubscription
delete_webhook_subscription
Bulk 23 tools
- BulkRetrieveBookings
bulk_retrieve_bookings - BulkDeleteBookingCustomAttributes
bulk_delete_booking_custom_attributes - BulkUpsertBookingCustomAttributes
bulk_upsert_booking_custom_attributes - BulkRetrieveTeamMemberBookingProfiles
bulk_retrieve_team_member_booking_profiles - BulkRetrieveChannels
bulk_retrieve_channels - BulkCreateCustomers
bulk_create_customers - BulkDeleteCustomers
bulk_delete_customers - BulkRetrieveCustomers
bulk_retrieve_customers - BulkUpdateCustomers
bulk_update_customers - BulkUpsertCustomerCustomAttributes
bulk_upsert_customer_custom_attributes - BulkPublishScheduledShifts
bulk_publish_scheduled_shifts - BulkDeleteLocationCustomAttributes
bulk_delete_location_custom_attributes - BulkUpsertLocationCustomAttributes
bulk_upsert_location_custom_attributes - BulkDeleteMerchantCustomAttributes
bulk_delete_merchant_custom_attributes - BulkUpsertMerchantCustomAttributes
bulk_upsert_merchant_custom_attributes - BulkDeleteOrderCustomAttributes
bulk_delete_order_custom_attributes - BulkUpsertOrderCustomAttributes
bulk_upsert_order_custom_attributes - BulkSwapPlan
bulk_swap_plan - BulkCreateTeamMembers
bulk_create_team_members - BulkUpdateTeamMembers
bulk_update_team_members - BulkCreateVendors
bulk_create_vendors - BulkRetrieveVendors
bulk_retrieve_vendors - BulkUpdateVendors
bulk_update_vendors
Search 19 tools
- SearchAvailability
search_availability - SearchCatalogObjects
search_catalog_objects - SearchCatalogItems
search_catalog_items - SearchCustomers
search_customers - SearchEvents
search_events - SearchInvoices
search_invoices - SearchScheduledShifts
search_scheduled_shifts - SearchTimecards
search_timecards - SearchLoyaltyAccounts
search_loyalty_accounts - SearchLoyaltyEvents
search_loyalty_events - SearchLoyaltyRewards
search_loyalty_rewards - SearchOrders
search_orders - SearchSubscriptions
search_subscriptions - SearchTeamMembers
search_team_members - SearchTerminalActions
search_terminal_actions - SearchTerminalCheckouts
search_terminal_checkouts - SearchTerminalRefunds
search_terminal_refunds - SearchTransferOrders
search_transfer_orders - SearchVendors
search_vendors
Get 13 tools
- GetBankAccountByV1Id
get_bank_account_by_v1_id - GetBankAccount
get_bank_account - GetDeviceCode
get_device_code - GetDevice
get_device - GetInvoice
get_invoice - GetBreakType
get_break_type - GetTeamMemberWage
get_team_member_wage - GetPayment
get_payment - GetPayout
get_payout - GetPaymentRefund
get_payment_refund - GetTerminalAction
get_terminal_action - GetTerminalCheckout
get_terminal_checkout - GetTerminalRefund
get_terminal_refund
Cancel 10 tools
- CancelBooking
cancel_booking - CancelInvoice
cancel_invoice - CancelLoyaltyPromotion
cancel_loyalty_promotion - CancelPaymentByIdempotencyKey
cancel_payment_by_idempotency_key - CancelPayment
cancel_payment - CancelSubscription
cancel_subscription - CancelTerminalAction
cancel_terminal_action - CancelTerminalCheckout
cancel_terminal_checkout - CancelTerminalRefund
cancel_terminal_refund - CancelTransferOrder
cancel_transfer_order
Batch 7 tools
- BatchDeleteCatalogObjects
batch_delete_catalog_objects - BatchRetrieveCatalogObjects
batch_retrieve_catalog_objects - BatchUpsertCatalogObjects
batch_upsert_catalog_objects - BatchChangeInventory
batch_change_inventory - BatchRetrieveInventoryChanges
batch_retrieve_inventory_changes - BatchRetrieveInventoryCounts
batch_retrieve_inventory_counts - BatchRetrieveOrders
batch_retrieve_orders
Upsert 7 tools
- UpsertBookingCustomAttribute
upsert_booking_custom_attribute - UpsertCatalogObject
upsert_catalog_object - UpsertCustomerCustomAttribute
upsert_customer_custom_attribute - UpsertLocationCustomAttribute
upsert_location_custom_attribute - UpsertMerchantCustomAttribute
upsert_merchant_custom_attribute - UpsertOrderCustomAttribute
upsert_order_custom_attribute - UpsertSnippet
upsert_snippet
Disable 3 tools
- DisableBankAccount
disable_bank_account - DisableCard
disable_card - DisableEvents
disable_events
Dismiss 3 tools
- DismissTerminalAction
dismiss_terminal_action - DismissTerminalCheckout
dismiss_terminal_checkout - DismissTerminalRefund
dismiss_terminal_refund
Calculate 2 tools
- CalculateLoyaltyPoints
calculate_loyalty_points - CalculateOrder
calculate_order
Publish 2 tools
- PublishInvoice
publish_invoice - PublishScheduledShift
publish_scheduled_shift
Accept 1 tool
- AcceptDispute
accept_dispute
Accumulate 1 tool
- AccumulateLoyaltyPoints
accumulate_loyalty_points
Add 1 tool
- AddGroupToCustomer
add_group_to_customer
Adjust 1 tool
- AdjustLoyaltyPoints
adjust_loyalty_points
Catalog 1 tool
- CatalogInfo
catalog_info
Change 1 tool
- ChangeBillingAnchorDate
change_billing_anchor_date
Clone 1 tool
- CloneOrder
clone_order
Complete 1 tool
- CompletePayment
complete_payment
Enable 1 tool
- EnableEvents
enable_events
Link 1 tool
- LinkCustomerToGiftCard
link_customer_to_gift_card
Obtain 1 tool
- ObtainToken
obtain_token
Pause 1 tool
- PauseSubscription
pause_subscription
Pay 1 tool
- PayOrder
pay_order
Receive 1 tool
- ReceiveTransferOrder
receive_transfer_order
Redeem 1 tool
- RedeemLoyaltyReward
redeem_loyalty_reward
Refund 1 tool
- RefundPayment
refund_payment
Register 1 tool
- RegisterDomain
register_domain
Remove 1 tool
- RemoveGroupFromCustomer
remove_group_from_customer
Restore 1 tool
- RestoreInventoryAdjustmentReason
restore_inventory_adjustment_reason
Resume 1 tool
- ResumeSubscription
resume_subscription
Revoke 1 tool
- RevokeToken
revoke_token
Start 1 tool
- StartTransferOrder
start_transfer_order
Submit 1 tool
- SubmitEvidence
submit_evidence
Swap 1 tool
- SwapPlan
swap_plan
Test 1 tool
- TestWebhookSubscription
test_webhook_subscription
Unlink 1 tool
- UnlinkCustomerFromGiftCard
unlink_customer_from_gift_card
Try asking
List today's payments at my main location and total them.
Usage and limits
Every account gets a free daily allowance of tool calls; connecting, listing and searching are not counted. See the limits. Only a tool that runs costs a call.