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 31–60 of 122 actions

Delete Invoice Attachment

SQUARE_DELETE_INVOICE_ATTACHMENT

Tool to delete an attachment from a Square invoice. Endpoint: DELETE /v2/invoices/{invoice_id}/attachments/{attachment_id}

Untrusted display-only summary

Delete Location Custom Attribute

SQUARE_DELETE_LOCATION_CUSTOM_ATTRIBUTE

Tool to delete a custom attribute from a location. Use when you need to remove custom data associated with a specific business location. Requires the MERCHANT_PROFILE_WRITE OAuth permission scope.

Untrusted display-only summary

Delete Location Custom Attribute Definition

SQUARE_DELETE_LOCATION_CUSTOM_ATTRIBUTE_DEFINITION

Tool to delete a location-related custom attribute definition. Once deleted, the custom attribute definition cannot be used to add custom attributes to locations. Use when you need to remove obsolete or incorrect custom attribute definitions from your Square account.

Untrusted display-only summary

Delete Locations Custom Attributes (Batch)

SQUARE_DELETE_LOCATIONS_CUSTOM_ATTRIBUTES_BATCH

Tool to delete custom attributes from multiple locations in a single batch request. Use when you need to remove custom metadata from multiple business locations efficiently. To delete custom attributes owned by other applications, the attribute's visibility must be set to VISIBILITY_READ_WRITE_VALUES.

Untrusted display-only summary

Delete Merchant Custom Attribute

SQUARE_DELETE_MERCHANT_CUSTOM_ATTRIBUTE

Tool to delete a custom attribute from a merchant profile. Use when you need to remove custom data associated with a specific merchant. Requires the MERCHANT_PROFILE_WRITE OAuth permission scope.

Untrusted display-only summary

Delete Merchant Custom Attribute Definition

SQUARE_DELETE_MERCHANT_CUSTOM_ATTRIBUTE_DEFINITION

Tool to delete a merchant-related custom attribute definition. Once deleted, the custom attribute definition cannot be used to add custom attributes to merchants. Use when you need to remove obsolete or incorrect custom attribute definitions from your Square account.

Untrusted display-only summary

Delete Merchants Custom Attributes (Batch)

SQUARE_DELETE_MERCHANTS_CUSTOM_ATTRIBUTES_BATCH

Tool to delete custom attributes from multiple merchants in a single batch request. Use when you need to remove custom metadata from merchant profiles efficiently. To delete custom attributes owned by other applications, the attribute's visibility must be set to VISIBILITY_READ_WRITE_VALUES.

Untrusted display-only summary

Delete Webhook Subscription

SQUARE_DELETE_WEBHOOK_SUBSCRIPTION

Permanently deletes a webhook subscription by its ID. Once deleted, the subscription will no longer receive event notifications. This action cannot be undone. Note: Webhook subscriptions are application-level resources and require personal access token authentication (not OAuth tokens).

Untrusted display-only summary

Get Booking

SQUARE_GET_BOOKING

Retrieves detailed information about a specific Square booking by its ID. Returns the complete booking object including appointment segments, customer notes, seller notes, location details, creator information, and current status. Use this action when you need to view or verify booking details for a known booking ID,…

Untrusted display-only summary

Get Business Booking Profile

SQUARE_GET_BUSINESS_BOOKING_PROFILE

Tool to retrieve the business booking profile for a Square merchant via GraphQL. Use when you need to check if bookings are enabled, view cancellation policies, or access booking configuration settings. This is an alpha feature.

Untrusted display-only summary

Get Current Merchant

SQUARE_GET_CURRENT_MERCHANT

Tool to retrieve merchant information associated with the access token using Square's GraphQL API. Use when you need to obtain the merchant ID required for other GraphQL queries, or to get merchant details like business name, status, currency, and main location.

Untrusted display-only summary

Get Customer Custom Attribute

SQUARE_GET_CUSTOMER_CUSTOM_ATTRIBUTE

Retrieves a custom attribute from a customer profile in Square. Use this when you need to access specific custom data associated with a customer, such as preferences, external IDs, or other merchant-defined information. Requires CUSTOMERS_READ permission.

Untrusted display-only summary

Get Customer Custom Attribute Definition

SQUARE_GET_CUSTOMERS_CUSTOM_ATTRIBUTE_DEFINITIONS

Tool to retrieve a customer-related custom attribute definition from Square. Use when you need to fetch the schema, visibility, or metadata of a specific custom attribute definition by its key.

Untrusted display-only summary

Get Customers via GraphQL

SQUARE_GET_CUSTOMERS_GRAPHQL

Tool to retrieve customer profiles from Square Customer Directory using GraphQL API. Use when you need to fetch customer information including name, contact details, and profile data for a specific merchant. Requires merchant ID filter.

Untrusted display-only summary

Get Dispute Evidence

SQUARE_GET_DISPUTE_EVIDENCE

Retrieves detailed information about a specific piece of evidence that was uploaded for a dispute. Use this action to: - Get metadata about evidence (file details, upload time, evidence type) - Verify evidence was uploaded successfully - Review evidence details before submitting a dispute response Note: This returns m…

Untrusted display-only summary

Get Gift Card From GAN

SQUARE_GET_GIFT_CARD_FROM_GAN

Retrieves detailed information about a gift card by its GAN (gift card account number). Use this action when you need to look up a gift card using the GAN that buyers use to make purchases or check balances. Returns the complete gift card object including ID, type, state, balance, and associated customer IDs.

Untrusted display-only summary

Get Invoice

SQUARE_GET_INVOICE

Retrieves detailed information about a specific Square invoice by its ID. Returns the complete invoice object including payment requests, recipient details, accepted payment methods, custom fields, attachments, and current status. Use this when you need to view or verify invoice details for a known invoice ID. Require…

Untrusted display-only summary

Get Loyalty Account

SQUARE_GET_LOYALTY_ACCOUNT

Tool to retrieve detailed information about a specific Square loyalty account by ID. Use when you need to fetch loyalty account data including balance, lifetime points, customer association, and point expiration schedules. This action provides read-only access to loyalty program membership details.

Untrusted display-only summary

Get Merchant

SQUARE_GET_MERCHANT

Tool to retrieve detailed information about a specific Square merchant by ID. Use when you need to fetch merchant profile data including business name, country, currency, and main location ID. Use 'me' as the merchant_id to retrieve the currently authenticated merchant.

Untrusted display-only summary

Get Online Checkout Location Settings

SQUARE_GET_ONLINE_CHECKOUT_LOCATION_SETTINGS

Tool to retrieve location-level settings for Square online checkout. Use when you need to get checkout configuration including customer notes, policies, branding, and tipping options for a specific location.

Untrusted display-only summary

Get Payment Refund

SQUARE_GET_REFUND

Retrieves a specific payment refund by its unique ID from Square. Returns complete refund details including amount, status, associated payment and order IDs, and refund destination information. Use this action when you need to retrieve detailed information about a specific refund, such as verifying refund status, chec…

Untrusted display-only summary

Get Subscription

SQUARE_GET_SUBSCRIPTION

Retrieves detailed information about a specific Square customer subscription by its ID. Use this action when you need to fetch subscription details including status, billing information, plan variation, associated customer, and scheduled actions. Returns comprehensive subscription data including payment information, i…

Untrusted display-only summary

Get Team Member

SQUARE_GET_TEAM_MEMBER

Tool to retrieve detailed information about a specific Square team member by ID. Use when you need to fetch team member profile data including name, contact information, location assignments, and wage settings.

Untrusted display-only summary

Link Customer to Gift Card

SQUARE_LINK_CUSTOMER_TO_GIFT_CARD

Tool to link a customer to a gift card in Square. Links the customer profile to the gift card, adding their ID to the gift card's customer_ids list. Use when you need to associate a customer with a gift card for tracking purchases, balances, or gifting purposes.

Untrusted display-only summary

List Cards

SQUARE_LIST_CARDS

Tool to retrieve cards on file associated with a Square account. Use when you need to list saved payment methods for a merchant or customer for payment processing or management purposes. Returns a maximum of 25 cards per request with pagination support.

Untrusted display-only summary

List Channels

SQUARE_LIST_CHANNELS

Tool to list requested channels from Square. Use when you need to retrieve channel information for a specific reference type, reference ID, or status.

Untrusted display-only summary

List Customer Custom Attribute Definitions

SQUARE_LIST_CUSTOMER_CUSTOM_ATTRIBUTE_DEFINITIONS

Tool to list customer-related custom attribute definitions from Square. Use when you need to discover available custom attributes that can be attached to customer profiles.

Untrusted display-only summary

List Customer Custom Attribute Definitions (GraphQL)

SQUARE_LIST_CUSTOMER_CUSTOM_ATTRIBUTE_DEFINITIONS_GRAPH_QL

Tool to retrieve customer custom attribute definitions via Square's GraphQL API. Use when you need to discover available custom attributes and their metadata for customer profiles. Alpha feature.

Untrusted display-only summary

List Customer Custom Attributes

SQUARE_LIST_CUSTOMER_CUSTOM_ATTRIBUTES

Tool to list custom attributes for a customer profile. Use when you need to retrieve all custom data associated with a specific customer, including optional definitions that provide metadata about each attribute.

Untrusted display-only summary

List Customer Groups

SQUARE_LIST_CUSTOMER_GROUPS

Tool to retrieve the list of customer groups of a business. Use when you need to discover customer group IDs or list all customer groups for segmentation and targeting purposes.

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.