Square | AI Agent Tools

squareup.com

•

One-click Login

•

Ready to use

About Square

Square is a versatile platform designed to support businesses in managing their operations effectively. It offers a range of tools, including a point-of-sale system, online payment processing, invoicing, and e-commerce solutions. These features enable businesses to accept various payment methods, streamline transactions, and enhance customer experiences. Additionally, Square provides insights and analytics to help businesses optimize their operations and improve cash flow. By integrating these tools, businesses can efficiently manage their sales, customer interactions, and financial transactions across different channels.

AI Agent Use Cases

• AI agents can use Square to automate payment processing tasks by integrating with existing business systems to streamline transactions. They can analyze sales data from Square to optimize pricing strategies and inventory management. Furthermore, AI agents can leverage Square's APIs to automate the generation of invoices and manage recurring payments, enhancing business efficiency and reducing manual labor.

Available Actions

These are the specific actions that AI agents can perform with this tool

Cancel Payment by Idempotency Key

1 input

Cancel a payment using its idempotency key

Inputs

idempotency_key

The idempotency key identifying the payment to be canceled.

Complete Payment

2 inputs

Complete a pending payment by providing the payment ID

Inputs

payment_id

The unique ID identifying the payment to be completed.

version_token

An opaque token that identifies the current Payment version that the caller expects.

Create Location

1 input

Create a new location with a unique name for managing sales, receipt layouts, and prices.

Inputs

location

The initial values for the new location including a mandatory unique name. Other fields are optional but should include any relevant information for the location.

Create Payment

25 inputs

Create a payment transaction for a specified source and amount

Inputs

source_id

The ID for the source of funds for this payment.

idempotency_key

A unique string that identifies this CreatePayment request.

amount_money

The amount of money to accept for this payment.

tip_money

The amount designated as a tip, in addition to amount_money.

app_fee_money

The amount of money that the developer is taking as a fee for facilitating the payment.

delay_duration

The duration of time after the payment's creation when Square automatically either completes or cancels the payment.

delay_action

The action to be applied to the payment when the delay_duration has elapsed. Must be CANCEL or COMPLETE.

autocomplete

If set to true, this payment will be completed when possible.

order_id

Associates a previously created order with this payment.

customer_id

The customer ID associated with the payment.

location_id

The location ID to associate with the payment.

team_member_id

An optional TeamMember ID to associate with this payment.

reference_id

A user-defined ID to associate with the payment.

verification_token

An identifying token generated by payments.verifyBuyer().

accept_partial_authorization

If true, a payment might be returned with a partial amount.

buyer_email_address

The buyer's email address.

buyer_phone_number

The buyer's phone number in international format.

billing_address

The buyer's billing address.

shipping_address

The buyer's shipping address.

note

An optional note to be entered when creating a payment.

statement_description_identifier

Optional payment information to include on the customer's card statement.

cash_details

Additional details required when recording a cash payment.

external_details

Additional details required when recording an external payment.

customer_details

Details about the customer making the payment.

offline_payment_details

Specifying the offline payment details; for internal use.

Delete Location Custom Attribute Definition

1 input

Delete a custom attribute definition related to a location from a Square seller account

Inputs

key

The key of the custom attribute definition to delete.

List Payments

15 inputs

Retrieve a list of payments made by the account using specific query parameters like date range, sort order, and location.

Inputs

begin_time

Start of the time range to retrieve payments for. Default is current time minus one year.

end_time

End of the time range to retrieve payments for. Default is the current time.

sort_order

Order in which results are listed: ASC (oldest to newest) or DESC (newest to oldest, default).

cursor

Pagination cursor for retrieving the next set of results.

location_id

Limit results to specified location. By default, results are returned for the default location.

total

Exact amount in the total_money for a payment.

last_4

Last four digits of a payment card.

card_brand

Brand of the payment card (e.g., VISA).

limit

Maximum number of results per page, default and max value is 100.

is_offline_payment

Whether the payment was taken offline.

offline_begin_time

Start of the time range for offline payments retrieval, based on client_created_at field.

offline_end_time

End of the time range for offline payments retrieval, based on client_created_at field.

updated_at_begin_time

Start of the time range to retrieve payments, based on the updated_at field.

updated_at_end_time

End of the time range to retrieve payments, based on the updated_at field.

sort_field

Field used to sort results. Default is CREATED_AT.

Retrieve Location

1 input

Retrieve details of a specific location using its ID.

Inputs

location_id

The ID of the location to retrieve. Specify the string 'main' to return the main location.

Retrieve Payment by ID

1 input

Retrieve a payment by ID

Inputs

paymentId

The unique ID for the payment to retrieve.

Search Catalog Items

10 inputs

The user wants to search for catalog items or item variations by matching specific search attribute values, such as names or categories.

Inputs

text_filter

Expression to return items or variations with specified text in attributes like name or description.

category_ids

Array of category IDs to filter items by their categories.

stock_levels

Array of stock levels to filter item variations.

enabled_location_ids

Array of enabled location IDs for filtered items/variations.

cursor

Pagination token for fetching the next batch of results.

limit

Maximum number of results per page, default is 100.

sort_order

Order of sorting the results by item names, default is ascending.

product_types

Array of product types to filter items or variations.

custom_attribute_filters

Array of custom attribute filters, max of 10 can be used.

archived_state

Filter to return archived, not archived, or all items.

Update Location

2 inputs

Update the details of a specific business location.

Inputs

location_id

The ID of the location to update.

location

The Location object with only the fields to update.

About Square

AI Agent Use Cases

Available Actions

These are the specific actions that AI agents can perform with this tool

Cancel Payment by Idempotency Key

1 input

Cancel a payment using its idempotency key

Inputs

idempotency_key

The idempotency key identifying the payment to be canceled.

Complete Payment

2 inputs

Complete a pending payment by providing the payment ID

Inputs

payment_id

The unique ID identifying the payment to be completed.

version_token

An opaque token that identifies the current Payment version that the caller expects.

Create Location

1 input

Create a new location with a unique name for managing sales, receipt layouts, and prices.

Inputs

location

The initial values for the new location including a mandatory unique name. Other fields are optional but should include any relevant information for the location.

Create Payment

25 inputs

Create a payment transaction for a specified source and amount

Inputs

source_id

The ID for the source of funds for this payment.

idempotency_key

A unique string that identifies this CreatePayment request.

amount_money

The amount of money to accept for this payment.

tip_money

The amount designated as a tip, in addition to amount_money.

app_fee_money

The amount of money that the developer is taking as a fee for facilitating the payment.

delay_duration

The duration of time after the payment's creation when Square automatically either completes or cancels the payment.

delay_action

The action to be applied to the payment when the delay_duration has elapsed. Must be CANCEL or COMPLETE.

autocomplete

If set to true, this payment will be completed when possible.

order_id

Associates a previously created order with this payment.

customer_id

The customer ID associated with the payment.

location_id

The location ID to associate with the payment.

team_member_id

An optional TeamMember ID to associate with this payment.

reference_id

A user-defined ID to associate with the payment.

verification_token

An identifying token generated by payments.verifyBuyer().

accept_partial_authorization

If true, a payment might be returned with a partial amount.

buyer_email_address

The buyer's email address.

buyer_phone_number

The buyer's phone number in international format.

billing_address

The buyer's billing address.

shipping_address

The buyer's shipping address.

note

An optional note to be entered when creating a payment.

statement_description_identifier

Optional payment information to include on the customer's card statement.

cash_details

Additional details required when recording a cash payment.

external_details

Additional details required when recording an external payment.

customer_details

Details about the customer making the payment.

offline_payment_details

Specifying the offline payment details; for internal use.

Delete Location Custom Attribute Definition

1 input

Delete a custom attribute definition related to a location from a Square seller account

Inputs

key

The key of the custom attribute definition to delete.

List Payments

15 inputs

Retrieve a list of payments made by the account using specific query parameters like date range, sort order, and location.

Inputs

begin_time

Start of the time range to retrieve payments for. Default is current time minus one year.

end_time

End of the time range to retrieve payments for. Default is the current time.

sort_order

Order in which results are listed: ASC (oldest to newest) or DESC (newest to oldest, default).

cursor

Pagination cursor for retrieving the next set of results.

location_id

Limit results to specified location. By default, results are returned for the default location.

total

Exact amount in the total_money for a payment.

last_4

Last four digits of a payment card.

card_brand

Brand of the payment card (e.g., VISA).

limit

Maximum number of results per page, default and max value is 100.

is_offline_payment

Whether the payment was taken offline.

offline_begin_time

Start of the time range for offline payments retrieval, based on client_created_at field.

offline_end_time

End of the time range for offline payments retrieval, based on client_created_at field.

updated_at_begin_time

Start of the time range to retrieve payments, based on the updated_at field.

updated_at_end_time

End of the time range to retrieve payments, based on the updated_at field.

sort_field

Field used to sort results. Default is CREATED_AT.

Retrieve Location

1 input

Retrieve details of a specific location using its ID.

Inputs

location_id

The ID of the location to retrieve. Specify the string 'main' to return the main location.

Retrieve Payment by ID

1 input

Retrieve a payment by ID

Inputs

paymentId

The unique ID for the payment to retrieve.

Search Catalog Items

10 inputs

The user wants to search for catalog items or item variations by matching specific search attribute values, such as names or categories.

Inputs

text_filter

Expression to return items or variations with specified text in attributes like name or description.

category_ids

Array of category IDs to filter items by their categories.

stock_levels

Array of stock levels to filter item variations.

enabled_location_ids

Array of enabled location IDs for filtered items/variations.

cursor

Pagination token for fetching the next batch of results.

limit

Maximum number of results per page, default is 100.

sort_order

Order of sorting the results by item names, default is ascending.

product_types

Array of product types to filter items or variations.

custom_attribute_filters

Array of custom attribute filters, max of 10 can be used.

archived_state

Filter to return archived, not archived, or all items.

Update Location

2 inputs

Update the details of a specific business location.

Inputs

location_id

The ID of the location to update.

location

The Location object with only the fields to update.