Square API Operations Reference

payments

96 operations

ActionSQUARE_ACCEPT_DISPUTE

Accept Dispute

Accept a dispute and acknowledge liability, returning funds to the cardholder.

1 input

ActionSQUARE_ADD_GROUP_TO_CUSTOMER

Add Group to Customer

Tool to add a customer to a customer group.

2 input

ActionSQUARE_UPSERT_CUSTOMER_CUSTOM_ATTRIBUTES_BATCH

Batch Upsert Customer Custom Attributes

Tool to create or update custom attributes for multiple customers in a single batch request.

1 input

ActionSQUARE_UPSERT_LOCATIONS_CUSTOM_ATTRIBUTES_BATCH

Batch Upsert Locations Custom Attributes

Tool to create or update custom attributes for multiple locations in a single batch request.

1 input

ActionSQUARE_UPSERT_MERCHANTS_CUSTOM_ATTRIBUTES_BATCH

Batch Upsert Merchants Custom Attributes

Tool to create or update custom attributes for multiple merchants in a single batch request.

1 input

ActionSQUARE_DELETE_CUSTOMERS_BULK

Bulk Delete Customers

Tool to bulk delete customer profiles from Square.

1 input

ActionSQUARE_RETRIEVE_CHANNELS_BULK

Bulk Retrieve Channels

Tool to bulk retrieve multiple Square channels by their IDs in a single request.

1 input

ActionSQUARE_UPDATE_CUSTOMERS_BULK

Bulk Update Customers

Tool to update multiple customer profiles in a single batch operation.

1 input

ActionSQUARE_CALCULATE_ORDER

Calculate Order

Tool to preview order pricing without creating an order.

2 input

ActionSQUARE_CANCEL_INVOICE

Cancel Invoice

Cancels a Square invoice, preventing further payments from being collected.

2 input

ActionSQUARE_CANCEL_PAYMENT

Cancel Payment

Cancels (voids) a payment that is in APPROVED status.

1 input

ActionSQUARE_CREATE_BULK_CUSTOMERS

Create Bulk Customers

Tool to create multiple customer profiles in a single request.

1 input

ActionSQUARE_CREATE_CARD

Create Card

Tool to create a card on file.

4 input

ActionSQUARE_CREATE_CUSTOMER

Create Customer

Tool to create a new customer profile in Square.

12 input

ActionSQUARE_CREATE_CUSTOMER_CUSTOM_ATTRIBUTE_DEFINITION

Create Customer Custom Attribute Definition

Tool to create a customer-related custom attribute definition.

2 input

ActionSQUARE_CREATE_CUSTOMER_GROUP

Create Customer Group

Tool to create a new customer group for a business.

2 input

ActionSQUARE_CREATE_DISPUTE_EVIDENCE_FILE

Create Dispute Evidence File

Tool to upload a file as dispute evidence.

8 input

ActionSQUARE_CREATE_DISPUTE_EVIDENCE_TEXT

Create Dispute Evidence Text

Upload text evidence for a dispute challenge.

4 input

ActionSQUARE_CREATE_INVOICE_ATTACHMENT

Create Invoice Attachment

Upload and attach a file to a Square invoice.

4 input

ActionSQUARE_CREATE_LOCATION

Create Location

Tool to create a new business location in a Square account.

1 input

ActionSQUARE_CREATE_LOCATION_CUSTOM_ATTRIBUTE_DEFINITION

Create Location Custom Attribute Definition

Tool to create a location-related custom attribute definition.

2 input

ActionSQUARE_DELETE_CUSTOMER

Delete Customer

Tool to delete a Square customer profile.

2 input

ActionSQUARE_DELETE_CUSTOMER_CUSTOM_ATTRIBUTE

Delete Customer Custom Attribute

Tool to delete a custom attribute from a customer profile.

2 input

ActionSQUARE_DELETE_CUSTOMER_CUSTOM_ATTRIBUTE_DEFINITION

Delete Customer Custom Attribute Definition

Tool to delete a customer-related custom attribute definition.

1 input

ActionSQUARE_DELETE_CUSTOMER_GROUP

Delete Customer Group

Tool to delete a customer group by its ID.

1 input

ActionSQUARE_DELETE_DISPUTE_EVIDENCE

Delete Dispute Evidence

Removes a specific piece of evidence from a dispute.

2 input

ActionSQUARE_DELETE_INVOICE

Delete Invoice

Tool to delete a Square invoice (only DRAFT invoices can be deleted).

2 input

ActionSQUARE_DELETE_INVOICE_ATTACHMENT

Delete Invoice Attachment

Tool to delete an attachment from a Square invoice.

2 input

ActionSQUARE_DELETE_LOCATION_CUSTOM_ATTRIBUTE

Delete Location Custom Attribute

Tool to delete a custom attribute from a location.

2 input

ActionSQUARE_DELETE_LOCATION_CUSTOM_ATTRIBUTE_DEFINITION

Delete Location Custom Attribute Definition

Tool to delete a location-related custom attribute definition.

1 input

ActionSQUARE_DELETE_LOCATIONS_CUSTOM_ATTRIBUTES_BATCH

Delete Locations Custom Attributes (Batch)

Tool to delete custom attributes from multiple locations in a single batch request.

1 input

ActionSQUARE_DELETE_MERCHANT_CUSTOM_ATTRIBUTE

Delete Merchant Custom Attribute

Tool to delete a custom attribute from a merchant profile.

2 input

ActionSQUARE_DELETE_MERCHANT_CUSTOM_ATTRIBUTE_DEFINITION

Delete Merchant Custom Attribute Definition

Tool to delete a merchant-related custom attribute definition.

1 input

ActionSQUARE_DELETE_MERCHANTS_CUSTOM_ATTRIBUTES_BATCH

Delete Merchants Custom Attributes (Batch)

Tool to delete custom attributes from multiple merchants in a single batch request.

1 input

ActionSQUARE_DELETE_WEBHOOK_SUBSCRIPTION

Delete Webhook Subscription

Permanently deletes a webhook subscription by its ID.

1 input

ActionSQUARE_GET_BUSINESS_BOOKING_PROFILE

Get Business Booking Profile

Tool to retrieve the business booking profile for a Square merchant via GraphQL.

1 input

ActionSQUARE_GET_CURRENT_MERCHANT

Get Current Merchant

Tool to retrieve merchant information associated with the access token using Square's GraphQL API.

ActionSQUARE_GET_CUSTOMER_CUSTOM_ATTRIBUTE

Get Customer Custom Attribute

Retrieves a custom attribute from a customer profile in Square.

4 input

ActionSQUARE_GET_CUSTOMERS_CUSTOM_ATTRIBUTE_DEFINITIONS

Get Customer Custom Attribute Definition

Tool to retrieve a customer-related custom attribute definition from Square.

2 input

ActionSQUARE_GET_CUSTOMERS_GRAPHQL

Get Customers via GraphQL

Tool to retrieve customer profiles from Square Customer Directory using GraphQL API.

2 input

ActionSQUARE_GET_DISPUTE_EVIDENCE

Get Dispute Evidence

Retrieves detailed information about a specific piece of evidence that was uploaded for a dispute.

2 input

ActionSQUARE_GET_INVOICE

Get Invoice

Retrieves detailed information about a specific Square invoice by its ID.

1 input

ActionSQUARE_GET_MERCHANT

Get Merchant

Tool to retrieve detailed information about a specific Square merchant by ID.

1 input

ActionSQUARE_GET_ONLINE_CHECKOUT_LOCATION_SETTINGS

Get Online Checkout Location Settings

Tool to retrieve location-level settings for Square online checkout.

1 input

ActionSQUARE_LIST_CHANNELS

List Channels

Tool to list requested channels from Square.

5 input

ActionSQUARE_LIST_CUSTOMER_CUSTOM_ATTRIBUTE_DEFINITIONS

List Customer Custom Attribute Definitions

Tool to list customer-related custom attribute definitions from Square.

2 input

ActionSQUARE_LIST_CUSTOMER_CUSTOM_ATTRIBUTE_DEFINITIONS_GRAPH_QL

List Customer Custom Attribute Definitions (GraphQL)

Tool to retrieve customer custom attribute definitions via Square's GraphQL API.

1 input

ActionSQUARE_LIST_CUSTOMER_CUSTOM_ATTRIBUTES

List Customer Custom Attributes

Tool to list custom attributes for a customer profile.

4 input

ActionSQUARE_LIST_CUSTOMER_GROUPS

List Customer Groups

Tool to retrieve the list of customer groups of a business.

2 input

ActionSQUARE_LIST_CUSTOMER_SEGMENTS

List Customer Segments

Tool to retrieve the list of customer segments of a business.

2 input

ActionSQUARE_LIST_CUSTOMERS

List Customers

Tool to retrieve customer profiles associated with a Square account.

5 input

ActionSQUARE_LIST_DISPUTE_EVIDENCE

List Dispute Evidence

Tool to list evidence items associated with a given dispute.

2 input

ActionSQUARE_LIST_INVOICES

List Invoices

Tool to list invoices for a Square location.

3 input

ActionSQUARE_LIST_LOCATION_CUSTOM_ATTRIBUTE_DEFINITIONS

List Location Custom Attribute Definitions

Tool to list location-related custom attribute definitions from Square.

3 input

ActionSQUARE_LIST_LOCATIONS

List Locations

Tool to retrieve all business locations from a Square account.

ActionSQUARE_LIST_LOCATIONS_CUSTOM_ATTRIBUTES

List Locations Custom Attributes

Tool to list custom attributes for a specific location in Square.

5 input

ActionSQUARE_LIST_MERCHANT_CUSTOM_ATTRIBUTE_DEFINITIONS

List Merchant Custom Attribute Definitions

Tool to list merchant-related custom attribute definitions from Square.

3 input

ActionSQUARE_LIST_MERCHANTS

List Merchants

Tool to retrieve merchant account information associated with the access token.

1 input

ActionSQUARE_LIST_MERCHANTS_CUSTOM_ATTRIBUTES

List Merchants Custom Attributes

Tool to list custom attributes for a specific merchant in Square.

5 input

ActionSQUARE_LIST_PAYMENTS

List Payments

Tool to list payments by location and time range to enable reconciliation and net sales reporting from Square POS.

15 input

ActionSQUARE_LIST_WEBHOOK_EVENT_TYPES

List Webhook Event Types

Tool to list available webhook event types.

1 input

ActionSQUARE_LIST_WEBHOOK_SUBSCRIPTIONS

List Webhook Subscriptions

List all webhook subscriptions owned by your application.

4 input

ActionSQUARE_REMOVE_GROUP_FROM_CUSTOMER

Remove Group From Customer

Removes a customer from a customer group.

2 input

ActionSQUARE_RETRIEVE_BULK_CUSTOMERS

Retrieve Bulk Customers

Tool to retrieve multiple customer profiles in a single request.

1 input

ActionSQUARE_RETRIEVE_CHANNEL

Retrieve Channel

Retrieve a Square channel by its ID.

1 input

ActionSQUARE_RETRIEVE_CUSTOMER

Retrieve Customer

Tool to retrieve detailed information about a specific Square customer by ID.

1 input

ActionSQUARE_RETRIEVE_CUSTOMER_GROUP

Retrieve Customer Group

Tool to retrieve a specific Square customer group by ID.

1 input

ActionSQUARE_RETRIEVE_CUSTOMER_SEGMENT

Retrieve Customer Segment

Tool to retrieve a specific customer segment by its ID.

1 input

ActionSQUARE_RETRIEVE_DISPUTE

Retrieve Dispute

Tool to retrieve a Square dispute by ID.

1 input

ActionSQUARE_RETRIEVE_LOCATION

Retrieve Location

Tool to retrieve detailed information about a specific Square location by ID.

1 input

ActionSQUARE_RETRIEVE_LOCATION_CUSTOM_ATTRIBUTE

Retrieve Location Custom Attribute

Retrieves a custom attribute associated with a location in Square.

4 input

ActionSQUARE_RETRIEVE_LOCATION_CUSTOM_ATTRIBUTE_DEFINITION

Retrieve Location Custom Attribute Definition

Tool to retrieve a location-related custom attribute definition.

2 input

ActionSQUARE_RETRIEVE_MERCHANT_CUSTOM_ATTRIBUTE

Retrieve Merchant Custom Attribute

Retrieves a custom attribute associated with a merchant in Square.

4 input

ActionSQUARE_RETRIEVE_MERCHANT_CUSTOM_ATTRIBUTE_DEFINITION

Retrieve Merchant Custom Attribute Definition

Tool to retrieve a merchant-related custom attribute definition from Square.

2 input

ActionSQUARE_RETRIEVE_MERCHANTS

Retrieve Merchants

Tool to retrieve merchant information including status, main location details, and capabilities using Square's GraphQL API.

1 input

ActionSQUARE_RETRIEVE_ORDER

Retrieve Order

Retrieves detailed information about a specific Square order by its ID.

1 input

ActionSQUARE_RETRIEVE_PAYMENT_LINK

Retrieve Payment Link

Retrieves a Square-hosted payment link by ID.

1 input

ActionSQUARE_RETRIEVE_TOKEN_STATUS

Retrieve Token Status

Tool to retrieve information about an OAuth access token or personal access token.

ActionSQUARE_RETRIEVE_WEBHOOK_SUBSCRIPTION

Retrieve Webhook Subscription

Retrieve a Square webhook subscription by its ID.

1 input

ActionSQUARE_SEARCH_CUSTOMERS

Search Customers

Tool to search customer profiles in Square Customer Directory.

4 input

ActionSQUARE_SEARCH_ORDERS

Search Orders

Tool to search orders across one or more Square locations with filters.

5 input

ActionSQUARE_SUBMIT_DISPUTE_EVIDENCE

Submit Dispute Evidence

Submits evidence for a dispute to the cardholder's bank.

1 input

ActionSQUARE_TEST_WEBHOOK_SUBSCRIPTION

Test Webhook Subscription

Tests a webhook subscription by sending a test event to the configured notification URL.

2 input

ActionSQUARE_UPDATE_CUSTOMER

Update Customer

Tool to update an existing Square customer profile.

13 input

ActionSQUARE_UPDATE_CUSTOMER_CUSTOM_ATTRIBUTE_DEFINITION

Update Customer Custom Attribute Definition

Tool to update a customer-related custom attribute definition in Square.

6 input

ActionSQUARE_UPDATE_CUSTOMER_GROUP

Update Customer Group

Tool to update a customer group's information by its ID.

2 input

ActionSQUARE_UPDATE_LOCATION

Update Location

Tool to update an existing business location in a Square account.

2 input

ActionSQUARE_UPDATE_LOCATION_CUSTOM_ATTRIBUTE_DEFINITION

Update Location Custom Attribute Definition

Tool to update a location-related custom attribute definition in Square.

3 input

ActionSQUARE_UPDATE_MERCHANT_CUSTOM_ATTRIBUTE_DEFINITION

Update Merchant Custom Attribute Definition

Tool to update a merchant-related custom attribute definition in Square.

3 input

ActionSQUARE_UPDATE_ONLINE_CHECKOUT_LOCATION_SETTINGS

Update Online Checkout Location Settings

Tool to update location-level settings for Square online checkout.

2 input

ActionSQUARE_UPDATE_ORDER

Update Order

Updates an existing Square order by adding, modifying, or removing fields.

4 input

ActionSQUARE_UPDATE_WEBHOOK_SUBSCRIPTION

Update Webhook Subscription

Tool to update a Square webhook subscription.

6 input

ActionSQUARE_UPDATE_WEBHOOK_SUBSCRIPTION_SIGNATURE_KEY

Update Webhook Subscription Signature Key

Tool to rotate the signature key for a webhook subscription.

2 input

ActionSQUARE_UPSERT_CUSTOMER_CUSTOM_ATTRIBUTE

Upsert Customer Custom Attribute

Tool to create or update a custom attribute for a customer profile.

4 input

ActionSQUARE_UPSERT_LOCATION_CUSTOM_ATTRIBUTE

Upsert Location Custom Attribute

Tool to create or update a custom attribute for a location.

4 input

ActionSQUARE_UPSERT_MERCHANT_CUSTOM_ATTRIBUTE

Upsert Merchant Custom Attribute

Tool to create or update a custom attribute for a merchant profile.

4 input