All integrations
Catalogue metadata onlypayment processingv20260721_00

SQUARE

Square

Square provides payment processing, POS systems, invoicing, and e-commerce tools, enabling sellers to accept card payments and manage their business

Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.

Pakkawork boundary

Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.

No Pakkawork execution adapter is enabled. Hosted account-authorisation availability is workspace-specific and checked separately in the dashboard.Check workspace connection options
Attributed source

122

Action summaries

Display-only definitions

0

Trigger types

Not installed instances

1

Auth modes

Field names, never values

No

Execution

No runtime adapter

Authentication map

What setup is declared?

Only field names, types, and required markers are shown. Secret values, default auth URLs, credential material, and inferred OAuth scopes are excluded.
OAUTH2 · managed upstream

OAUTH2

square_oauth

Upstream managed

Developer setup

  • Client idclient_id · stringRequired
  • Client secretclient_secret · stringRequired
  • Redirect URIoauth_redirect_uri · stringOptional
  • Scopesscopes · stringOptional

User connection

No fields declared in this snapshot.

Capability index

Actions and trigger definitions

Static summaries are available. Live schemas remain disabled until PROVIDER_HUB_API_KEY is configured server-side.

Showing 91–120 of 122 actions

Retrieve Merchants

SQUARE_RETRIEVE_MERCHANTS

Tool to retrieve merchant information including status, main location details, and capabilities using Square's GraphQL API. Use when you need to fetch merchant profile data for specific merchant IDs.

Untrusted display-only summary

Retrieve Order

SQUARE_RETRIEVE_ORDER

Retrieves detailed information about a specific Square order by its ID. Use this tool when you need to: - Fetch complete details of an order including line items, pricing, taxes, and discounts - Check order status and fulfillment information - View payment tenders and refunds associated with an order - Access order me…

Untrusted display-only summary

Retrieve Payment Link

SQUARE_RETRIEVE_PAYMENT_LINK

Retrieves a Square-hosted payment link by ID. Returns complete payment link details including the checkout URL, associated order ID, checkout options, pre-populated buyer data, and creation timestamps. Requires ORDERS_READ permission.

Untrusted display-only summary

Retrieve Token Status

SQUARE_RETRIEVE_TOKEN_STATUS

Tool to retrieve information about an OAuth access token or personal access token. Use when you need to verify token validity, check token expiration, inspect authorized scopes, or validate merchant association before making API calls.

Untrusted display-only summary

Retrieve Webhook Subscription

SQUARE_RETRIEVE_WEBHOOK_SUBSCRIPTION

Retrieve a Square webhook subscription by its ID. Returns subscription details including name, enabled status, event types, notification URL, and signature key. Note: Requires personal access token authentication with DEVELOPER_APPLICATION_WEBHOOKS_READ scope (OAuth tokens are not supported for webhook subscriptions).

Untrusted display-only summary

Search Booking Availability

SQUARE_SEARCH_BOOKING_AVAILABILITY

Searches for available appointment time slots for booking services at Square locations. Use this action when you need to find open booking slots for a specific service, location, and time range. This is essential for scheduling appointments as it shows which times are available for booking based on service requirement…

Untrusted display-only summary

Search Catalog Objects

SQUARE_SEARCH_CATALOG_OBJECTS

Searches for catalog objects (items, categories, taxes, discounts, etc.) in the Square catalog. Use this action when you need to find specific catalog items by name, SKU, category, or other attributes, or when retrieving the entire catalog with filtering and sorting options. Supports full-text search, exact matching,…

Untrusted display-only summary

Search Customers

SQUARE_SEARCH_CUSTOMERS

Tool to search customer profiles in Square Customer Directory. Use when you need to find customers by email, phone, creation date, or other filters. Returns paginated results with optional total count.

Untrusted display-only summary

Search Orders

SQUARE_SEARCH_ORDERS

Tool to search orders across one or more Square locations with filters. Use when you need to find orders within a date range, by state, by customer, or other criteria. This is the primary way Square exposes 'list orders for a date range' functionality.

Untrusted display-only summary

Submit Dispute Evidence

SQUARE_SUBMIT_DISPUTE_EVIDENCE

Submits evidence for a dispute to the cardholder's bank. IMPORTANT: You must upload evidence FIRST using CreateDisputeEvidenceText or CreateDisputeEvidenceFile before calling this endpoint. Once evidence is submitted, it cannot be modified or removed. The dispute state will change to PROCESSING after successful submis…

Untrusted display-only summary

Test Webhook Subscription

SQUARE_TEST_WEBHOOK_SUBSCRIPTION

Tests a webhook subscription by sending a test event to the configured notification URL. Use this to verify that your webhook endpoint is correctly receiving and processing Square events. The response includes the HTTP status code returned by your endpoint and the test payload that was sent. Useful after creating or u…

Untrusted display-only summary

Update Booking

SQUARE_UPDATE_BOOKING

Updates an existing Square booking with new appointment details, times, notes, or team members. Use when you need to modify a booking's start time, change appointment segments, update customer or seller notes, or modify the location type. Requires the current booking version number for optimistic concurrency control -…

Untrusted display-only summary

Update Customer

SQUARE_UPDATE_CUSTOMER

Tool to update an existing Square customer profile. Use when you need to modify customer details like name, email, address, or phone number. Supports sparse updates: only include fields you want to change, null values will remove fields. Include the version field for optimistic concurrency control.

Untrusted display-only summary

Update Customer Custom Attribute Definition

SQUARE_UPDATE_CUSTOMER_CUSTOM_ATTRIBUTE_DEFINITION

Tool to update a customer-related custom attribute definition in Square. Use when you need to modify the name, description, visibility, or schema of an existing custom attribute definition. Supports sparse updates: only include fields you want to change. Use the version parameter for optimistic concurrency control to…

Untrusted display-only summary

Update Customer Group

SQUARE_UPDATE_CUSTOMER_GROUP

Tool to update a customer group's information by its ID. Use when you need to modify the name or other attributes of an existing customer group in Square.

Untrusted display-only summary

Bulk Update Customers

SQUARE_UPDATE_CUSTOMERS_BULK

Tool to update multiple customer profiles in a single batch operation. Use when you need to efficiently update 1-100 customer profiles at once. Each update request includes the customer ID as a key and the customer data to update as the value. Only modified fields need to be provided, and fields can be removed by sett…

Untrusted display-only summary

Update Location

SQUARE_UPDATE_LOCATION

Tool to update an existing business location in a Square account. Use when you need to modify location details like name, description, address, business hours, contact information, or social media profiles.

Untrusted display-only summary

Update Location Custom Attribute Definition

SQUARE_UPDATE_LOCATION_CUSTOM_ATTRIBUTE_DEFINITION

Tool to update a location-related custom attribute definition in Square. Use when you need to modify the description, name, visibility, or schema of an existing location custom attribute definition.

Untrusted display-only summary

Update Merchant Custom Attribute Definition

SQUARE_UPDATE_MERCHANT_CUSTOM_ATTRIBUTE_DEFINITION

Tool to update a merchant-related custom attribute definition in Square. Use when you need to modify the description, name, visibility, or schema of an existing merchant custom attribute definition.

Untrusted display-only summary

Update Online Checkout Location Settings

SQUARE_UPDATE_ONLINE_CHECKOUT_LOCATION_SETTINGS

Tool to update location-level settings for Square online checkout. Use when you need to modify checkout configuration including customer notes, policies, branding, and tipping options for a specific location. Supports sparse updates: only include fields you want to change.

Untrusted display-only summary

Update Order

SQUARE_UPDATE_ORDER

Updates an existing Square order by adding, modifying, or removing fields. Use for OPEN or DRAFT orders only (COMPLETED/CANCELED orders cannot be updated). Requires the current order version number for optimistic concurrency control - get this from retrieve/search order first. Supports sparse updates: only include fie…

Untrusted display-only summary

Update Team Member

SQUARE_UPDATE_TEAM_MEMBER

Tool to update an existing Square team member's information. Use when you need to modify team member details like name, email, phone number, status, location assignments, or wage settings. Supports sparse updates: only include fields you want to change. To update wage_setting.job_assignments, provide the complete list…

Untrusted display-only summary

Update Webhook Subscription

SQUARE_UPDATE_WEBHOOK_SUBSCRIPTION

Tool to update a Square webhook subscription. Use when you need to modify subscription settings such as name, enabled state, event types, notification URL, or API version of an existing webhook subscription.

Untrusted display-only summary

Update Webhook Subscription Signature Key

SQUARE_UPDATE_WEBHOOK_SUBSCRIPTION_SIGNATURE_KEY

Tool to rotate the signature key for a webhook subscription. Use when you need to replace the current signature key for security purposes.

Untrusted display-only summary

Upsert Catalog Object

SQUARE_UPSERT_CATALOG_OBJECT

Creates or updates a catalog object in the Square catalog. Use when you need to add or modify items, variations, categories, taxes, discounts, or other catalog entities in the merchant's inventory system. For new objects, use a temporary ID starting with '#' (e.g., '#new-item-1'). For updates, provide the existing obj…

Untrusted display-only summary

Batch Upsert Catalog Objects

SQUARE_UPSERT_CATALOG_OBJECTS_BATCH

Creates or updates multiple catalog objects in a single batch operation. Use this action when you need to efficiently manage catalog items, categories, discounts, taxes, or other catalog entities in bulk. Supports up to 10,000 objects across all batches, with each batch containing up to 1,000 objects. Use temporary ID…

Untrusted display-only summary

Upsert Customer Custom Attribute

SQUARE_UPSERT_CUSTOMER_CUSTOM_ATTRIBUTE

Tool to create or update a custom attribute for a customer profile. Use when you need to store custom data on a customer record, such as preferences, loyalty tiers, or external system IDs. The custom attribute key must match an existing custom attribute definition in the Square account.

Untrusted display-only summary

Batch Upsert Customer Custom Attributes

SQUARE_UPSERT_CUSTOMER_CUSTOM_ATTRIBUTES_BATCH

Tool to create or update custom attributes for multiple customers in a single batch request. Use when you need to set custom data on customer profiles (e.g., preferences, loyalty tiers, tags). Supports 1 to 25 upsert operations per request. Before using this action, ensure the custom attribute definitions exist in you…

Untrusted display-only summary

Upsert Location Custom Attribute

SQUARE_UPSERT_LOCATION_CUSTOM_ATTRIBUTE

Tool to create or update a custom attribute for a location. Use when you need to store custom data on a location record, such as capacity limits, special features, or external system IDs. The custom attribute key must match an existing custom attribute definition in the Square account.

Untrusted display-only summary

Batch Upsert Locations Custom Attributes

SQUARE_UPSERT_LOCATIONS_CUSTOM_ATTRIBUTES_BATCH

Tool to create or update custom attributes for multiple locations in a single batch request. Use when you need to set custom data on location records (e.g., store ratings, delivery zones, tags). Supports 1 to 25 upsert operations per request. Before using this action, ensure the custom attribute definitions exist in y…

Untrusted display-only summary

Provenance

Versioned facts, explicit trust.

The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.

Repository
https://github.com/provider-directoryHQ/provider-directory
Commit
85e33f6a81dfe987f6fc3637d48d45052cea8ca5
Generated
2026-09-12
Trust policy
untrusted_display_only

Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.