Square

Charge a payment using a card, saved card, gift card, or other payment source.

Retrieve the details of a single payment.

List payments taken by the account, with optional date and location filters.

Change the amount or tip on an authorized payment before it is captured.

Void an authorized payment and release the hold before it is captured.

Capture funds on a previously authorized delayed-capture payment.

Void a payment identified by the idempotency key used when it was created.

Refund all or part of a completed payment back to the buyer.

Retrieve the details of a single refund.

List refunds issued by the account, with optional filters.

List payouts (bank deposits of settled funds) for a location.

Retrieve the details of a single payout.

List the individual charges, refunds, and fees that make up a payout.

List disputes and chargebacks on the account.

Retrieve the details of a single dispute.

Concede a dispute and return the disputed amount to the cardholder.

List all evidence attached to a dispute.

Upload a file as evidence to challenge a dispute.

Add a piece of text evidence to challenge a dispute.

Retrieve the details of one piece of dispute evidence.

Remove a piece of evidence from a dispute.

Submit all uploaded evidence to the bank to challenge a dispute.

Create a new order with line items, taxes, and discounts in an open state; totals are calculated for you.

Retrieve up to 100 orders at once by their IDs.

Preview taxes, discounts, service charges, and totals for a hypothetical order without saving it.

Create a new draft order by copying an existing order's line items, taxes, and discounts.

Search and filter orders across one or more locations by state, date, customer, or fulfillment.

Fetch a single order by ID, including its current version and calculated totals.

Modify an open order — add or replace line items, taxes, and discounts, or clear fields.

Complete an order by capturing its pre-authorized payments, moving money and marking the order paid.

Create a hosted Square checkout link (URL) a buyer can use to pay for an item or order later.

List all of the seller's hosted payment links.

Fetch a single payment link by ID, including its current version.

Update a payment link's description, checkout options, or pre-filled buyer data.

Permanently delete a payment link so buyers can no longer use it to pay.

Get the Square Online checkout configuration for a specific location.

Update per-location checkout settings like customer notes, policies, branding, and tipping.

Get merchant-wide checkout settings, such as which digital payment methods are enabled.

Update merchant-wide checkout settings, such as which payment methods are available.

Return catalog API limits and supported enum standards, such as batch size caps.

List catalog objects such as items, categories, taxes, discounts, and images.

Create or update a single catalog object like an item, variation, tax, discount, or category.

Create or update many catalog objects at once, with cross-references between new objects.

Fetch a set of catalog objects by ID, optionally including related objects.

Permanently delete multiple catalog objects and their child objects by ID.

Fetch a single catalog object by ID.

Permanently delete a single catalog object and its child objects.

Search any type of catalog object with attribute, prefix, range, set, or text queries.

Search items and variations by text, category, stock level, or custom attributes.

Bulk enable or disable modifier lists on a set of items.

Bulk enable or disable taxes on a set of items.

Return current stock counts for catalog item variations at specified locations.

Apply a batch of inventory adjustments and physical counts to set or transfer stock quantities.

Return the history of physical counts, adjustments, and transfers for inventory.

Return the current stock counts, by state and location, for a single item variation.

Create a new customer profile in the Square Customer Directory.

Create up to 100 customer profiles in one request.

Update up to 100 customer profiles in one request.

Permanently delete up to 100 customer profiles.

Fetch up to 100 customer profiles by id.

List all customer profiles for the seller.

Search customer profiles by email, phone, reference id, or other filters.

Fetch a single customer profile by id.

Update fields on a single customer profile.

Permanently delete a customer profile.

List the seller's manually managed customer groups.

Create a new customer group.

Fetch a single customer group.

Rename a customer group.

Permanently delete a customer group.

Add a customer to a group.

Remove a customer from a group.

List the seller's automatic customer segments.

Fetch a single customer segment.

List the seller's customer custom-attribute definitions.

Define a new custom attribute for customer profiles.

Fetch a single customer custom-attribute definition.

Update the name, description, or visibility of a customer custom-attribute definition.

Delete a customer custom-attribute definition and all values stored under it.

Create or update custom-attribute values on up to 25 customers at once.

List the custom-attribute values stored on one customer.

Fetch one custom-attribute value on a customer.

Set or overwrite one custom-attribute value on a customer.

Delete one custom-attribute value from a customer.

List stored cards-on-file for the seller or a customer.

Save a customer's credit or debit card on file for future charges.

Fetch a stored card-on-file by id.

Permanently disable a stored card so it can no longer be charged.

List the seller's gift cards.

Create a digital gift card or register a physical one; no funds are loaded yet.

Look up a gift card by its Gift Card Account Number.

Look up a gift card by a secure payment token (nonce).

Associate a customer profile with a gift card.

Remove a customer association from a gift card.

Fetch a gift card by its Square id.

List the ledger of gift-card activities like activations, loads, and redemptions.

Change a gift card's balance or state — activate, load, redeem, adjust, clear, or deactivate.

Enroll a buyer in the seller's loyalty program.

Find loyalty accounts by phone number or customer id.

Fetch one loyalty account with its point balance.

Add points earned from a purchase to a loyalty account.

Manually add or subtract points on a loyalty account.

Fetch a loyalty program by id, or use 'main' for the active program.

Preview how many points a purchase would earn.

List promotions for a loyalty program.

Create a points promotion, such as a bonus multiplier, for a loyalty program.

Fetch a single loyalty promotion.

End an active or scheduled loyalty promotion.

Search the loyalty event ledger of point movements.

Issue a reward against a loyalty account, locking the required points.

Search rewards for a loyalty account.

Fetch a single loyalty reward.

Delete an issued reward and return its locked points to the account.

Redeem an issued reward, spending its points and applying the discount.

Lists the invoices for a single business location.

Creates a draft invoice for a customer based on an existing order.

Searches invoices at one location, optionally by customer.

Retrieves the details of one invoice.

Updates the editable fields on an invoice.

Permanently deletes a draft invoice.

Sends an invoice to the customer and charges any card on file.

Cancels a published invoice so it can no longer be paid.

Signs a customer up for a recurring subscription plan.

Moves every subscription from one plan to another at a location.

Searches subscriptions by location, customer, or source.

Retrieves the details of one subscription.

Updates a subscription's billing amount or payment card.

Cancels a scheduled pause, cancel, or plan-swap that hasn't run yet.

Changes the day of the month a subscription bills on.

Schedules a subscription to end at the current period's close.

Lists the history of changes to a subscription.

Pauses billing on a subscription.

Resumes a paused subscription.

Changes the plan a subscription is billed on.

Lists appointment bookings, optionally filtered by staff, location, or time.

Creates a new appointment booking.

Finds open appointment time slots for services and staff.

Retrieves several bookings at once by their ids.

Retrieves the business's overall booking settings.

Lists the booking settings for each location.

Retrieves the booking settings for one location.

Lists the bookable staff members and their booking settings.

Retrieves several staff booking profiles at once.

Retrieves one staff member's booking profile.

Retrieves the details of one booking.

Updates or reschedules an appointment booking.

Cancels an appointment booking.

Adds a new team member to the business.

Adds several team members in one request.

Updates several team members in one request.

Searches team members by location or active status.

Retrieves the details of one team member.

Updates a team member, or deactivates them by setting status inactive.

Retrieves a team member's pay and job-assignment settings.

Sets a team member's pay and job assignments.

Lists the business's job definitions.

Creates a new job definition.

Retrieves one job definition.

Updates a job definition.

Lists all of the seller's business locations.

Creates a new business location.

Retrieves the details of one location.

Updates a location's settings.

Lists the merchant accounts for the connected login.

Retrieves the details of one merchant account.

Fires when a new customer is added to your Square directory (polled).

Fires when a new order is created at a Square location (polled).

Fires when a new invoice is created at a Square location (polled).

Fires when a new appointment/booking is created (polled).

Fires when a catalog ITEM is created or updated (polled by updated timestamp).