Square

Retrieve a paginated list of payments taken by the account

Create a payment using a payment source such as a card or gift card

Retrieve details for a specific payment by ID

Update a payment with APPROVED status to modify tip or amount

Cancel (void) a payment by its ID

Cancel a payment using the original idempotency key when the payment ID is unknown

Complete (capture) a payment that was created with autocomplete set to false

Retrieve a paginated list of refunds for the account

Refund a payment, either fully or partially

Retrieve details of a specific refund by ID

Create a new order for a location

Search for orders across one or more locations with filters

Retrieve an order by its ID

Update an open order by adding, replacing, or deleting fields

Pay for an order using one or more approved payments

Preview order pricing without creating an order

Retrieve multiple orders by their IDs in a single request

Create a new order by cloning an existing order

Retrieve a paginated list of all customer profiles for the account

Create a new customer profile for the business

Search customer profiles by phone, email, name, or custom attributes

Retrieve a specific customer profile by ID

Update an existing customer profile

Delete a customer profile from the business

Add a group membership to a customer profile

Remove a group membership from a customer profile

Retrieve a list of all customer groups for the business

Create a new customer group for the business

Retrieve a specific customer group by ID

Update an existing customer group’s name

Delete a customer group from the business

Create up to 100 customer profiles in a single request

Retrieve up to 100 customer profiles by ID in a single request

Update up to 100 customer profiles in a single request

Delete up to 100 customer profiles in a single request

Retrieve a list of all customer segments for the business

Retrieve a specific customer segment by ID

Retrieve a paginated list of all catalog objects for the account

Search for catalog objects of any type (items, categories, taxes, discounts, etc.) using advanced query filters

Search specifically for catalog items and item variations only (not taxes, categories, or discounts) by text, category,…

Retrieve a single catalog object by ID

Create or update a single catalog object

Delete a single catalog object and its children

Create or update up to 10,000 catalog objects in a single request

Retrieve multiple catalog objects by their IDs in a single request

Delete multiple catalog objects in a single request

Retrieve current inventory counts for a specific catalog object

Retrieve current inventory counts for multiple catalog objects at specific locations

Retrieve a list of inventory changes for catalog objects at specific locations

Retrieve a specific inventory adjustment by its ID

Retrieve a specific inventory physical count record by its ID

Apply adjustments and counts to catalog object quantities

Retrieve all seller locations for the account

Create a new location for the seller account

Retrieve details of a specific location by ID

Update an existing location’s settings and information

Retrieve the merchant profile for the account

Retrieve a specific merchant’s profile by ID

Retrieve a paginated list of all payouts for the seller’s default or specified location

Retrieve details of a specific payout by its ID

Retrieve all payout entries for a specific payout

Retrieve a list of invoices for a given location

Create a draft invoice for an order

Search for invoices by location, customer, or status

Retrieve an invoice by its ID

Update a draft or scheduled invoice

Delete a draft invoice

Publish a draft invoice to send it to the customer

Cancel a published invoice

Enroll a customer in a subscription plan

Search for subscriptions by customer, location, or plan

Retrieve a specific subscription by ID

Modify or clear field values on an active subscription

Schedule a cancellation for an active subscription

Retrieve a paginated list of events for a specific subscription

Resume a paused or canceled subscription

Retrieve a list of saved payment cards (credit/debit cards on file, not gift cards) for the account

Add a card on file to an existing customer or merchant

Retrieve details of a specific card on file by ID

Disable a card on file to prevent further charges

Retrieve a list of gift cards for the account

Create a digital gift card or register a physical gift card

Retrieve a gift card by its ID

Retrieve a gift card using the gift card account number (GAN)

Link a customer to a gift card to associate it with their account

Unlink a customer from a gift card to remove the association

Create an activity (activate, load, redeem, adjust, etc.) on a gift card

Retrieve a list of gift card activities for a specific gift card or across all gift cards

Create a new team member for the seller account

Search for team members by location, status, or other criteria

Retrieve a team member by ID

Update an existing team member’s information

Retrieve a list of all jobs defined for the seller account

Create a new job definition for the seller account

Retrieve a specific job definition by its ID

Update an existing job definition by its ID

Retrieve the wage setting for a team member

Create or update the wage setting for a team member

Create multiple team members in a single request

Update multiple team members in a single request

Retrieve a list of all break types for the seller account

Create a new break type for team member shifts

Retrieve a specific break type by ID

Search for timecard records with filters for team member and date range

Retrieve a specific timecard by ID

Create a new timecard for a team member at a location

Update an existing break type by ID

Delete a break type by ID

Update an existing timecard by ID

Delete a timecard by ID

Retrieve a list of disputes associated with the account

Retrieve details about a specific dispute by ID

Accept the loss on a dispute without submitting evidence

Retrieve all evidence submitted for a dispute

Submit collected evidence to contest a dispute

Retrieve a list of bank accounts linked to the Square account

Retrieve details of a specific bank account by ID

Upload text-based evidence to contest a dispute

Retrieve metadata for a specific piece of dispute evidence

Remove a specific piece of evidence from a dispute before submission

Retrieve a list of all payment links for the account

Create a Square-hosted checkout page with a shareable payment link

Retrieve a specific payment link by its token ID

Update an existing payment link’s settings

Delete a payment link permanently