Square

Fires on the Square `payment.created` event notification.

Fires on the Square `payment.updated` event notification.

Fires on the Square `refund.created` event notification.

Fires on the Square `refund.updated` event notification.

Fires on the Square `payout.paid` event notification.

Fires on the Square `payout.failed` event notification.

Fires on the Square `payout.sent` event notification.

Fires on the Square `invoice.created` event notification.

Fires on the Square `invoice.published` event notification.

Fires on the Square `invoice.payment_made` event notification.

Fires on the Square `invoice.scheduled_charge_failed` event notification.

Fires on the Square `invoice.canceled` event notification.

Fires on the Square `invoice.refunded` event notification.

Fires on the Square `order.created` event notification.

Fires on the Square `order.updated` event notification.

Fires on the Square `order.fulfillment.updated` event notification.

Fires on the Square `subscription.created` event notification.

Fires on the Square `subscription.updated` event notification.

Fires on the Square `customer.created` event notification.

Fires on the Square `customer.updated` event notification.

Fires on the Square `booking.created` event notification.

Fires on the Square `booking.updated` event notification.

Fires on the Square `dispute.created` event notification.

Fires on the Square `dispute.state.changed` event notification.

Fires on the Square `dispute.evidence.added` event notification.

Fires on the Square `inventory.count.updated` event notification.

Fires on the Square `oauth.authorization.revoked` event notification.

Polls GET /v2/payments and pages via the opaque cursor. Dedupe by payment id; advance by created_at.

Polls POST /v2/orders/search with a date_time_filter on updated_at (sort ASC) and pages via the opaque cursor. Dedupe by order id; advance by updated_at.

Retrieve the authenticated merchant (identity / connectivity probe). GET /v2/merchants/{merchant_id} — use 'me' to resolve the token's own merchant.

List the merchants associated with the access token. GET /v2/merchants.

List all locations for the merchant (also the identity / connectivity probe). GET /v2/locations.

Create a location. POST /v2/locations.

Retrieve a location by id (use 'main' for the default location). GET /v2/locations/{location_id}.

Update a location. PUT /v2/locations/{location_id}.

Take a payment using a payment source (card nonce, card-on-file, gift card). POST /v2/payments.

List payments taken by the account. GET /v2/payments. Cursor pagination.

Retrieve a payment by id. GET /v2/payments/{payment_id}.

Update a payment (e.g. adjust tip/amount before completion). PUT /v2/payments/{payment_id}.

Cancel (void) an approved but uncompleted payment. POST /v2/payments/{payment_id}/cancel.

Complete (capture) a previously authorized payment. POST /v2/payments/{payment_id}/complete.

Cancel a payment identified by its idempotency key. POST /v2/payments/cancel.

Refund a payment, in full or part. POST /v2/refunds.

List refunds for the account. GET /v2/refunds. Cursor pagination.

Retrieve a refund by id. GET /v2/refunds/{refund_id}.

Create an order with line items, taxes, and discounts. POST /v2/orders.

Retrieve up to 100 orders by id. POST /v2/orders/batch-retrieve.

Retrieve one order by id. GET /v2/orders/{order_id}.

Update an open order (add/remove line items, apply discounts). PUT /v2/orders/{order_id}.

Search orders across locations with filters and sort. POST /v2/orders/search. Cursor pagination.

Pay for an order using existing payment ids. POST /v2/orders/{order_id}/pay.

Create a new draft order that is a copy of an existing order. POST /v2/orders/clone.

Create a customer profile. POST /v2/customers.

List customer profiles. GET /v2/customers. Cursor pagination.

Search customers by filters (email, phone, reference id, created/updated). POST /v2/customers/search.

Retrieve a customer by id. GET /v2/customers/{customer_id}.

Update a customer profile. PUT /v2/customers/{customer_id}.

Delete a customer profile. DELETE /v2/customers/{customer_id}.

Store a card on file for a customer (deprecated Card endpoint; prefer create_card). POST /v2/customers/{customer_id}/cards.

Remove a card on file from a customer. DELETE /v2/customers/{customer_id}/cards/{card_id}.

List customer groups. GET /v2/customers/groups.

Create a customer group. POST /v2/customers/groups.

Retrieve a customer group by id. GET /v2/customers/groups/{group_id}.

Update a customer group. PUT /v2/customers/groups/{group_id}.

Delete a customer group. DELETE /v2/customers/groups/{group_id}.

Add a customer to a group. PUT /v2/customers/{customer_id}/groups/{group_id}.

Remove a customer from a group. DELETE /v2/customers/{customer_id}/groups/{group_id}.

List customer segments. GET /v2/customers/segments.

Retrieve a customer segment by id. GET /v2/customers/segments/{segment_id}.

List custom attribute definitions for customers. GET /v2/customers/custom-attribute-definitions.

Set a custom attribute value on a customer. POST /v2/customers/{customer_id}/custom-attributes/{key}.

List catalog objects of given types. GET /v2/catalog/list. Cursor pagination.

Create or update a single catalog object. POST /v2/catalog/object.

Retrieve a catalog object (and optionally related objects) by id. GET /v2/catalog/object/{object_id}.

Delete a catalog object and its children. DELETE /v2/catalog/object/{object_id}.

Create or update up to 10,000 catalog objects in batches. POST /v2/catalog/batch-upsert.

Retrieve a set of catalog objects by id. POST /v2/catalog/batch-retrieve.

Delete a set of catalog objects by id. POST /v2/catalog/batch-delete.

Search catalog objects with filters. POST /v2/catalog/search. Cursor pagination.

Search catalog items with a simplified item-focused query. POST /v2/catalog/search-catalog-items.

Enable/disable modifier lists on catalog items. POST /v2/catalog/update-item-modifier-lists.

Enable/disable taxes on catalog items. POST /v2/catalog/update-item-taxes.

Retrieve catalog limits and standard object attributes. GET /v2/catalog/info.

Upload an image and attach it to a catalog object. POST /v2/catalog/images (multipart/form-data).

Retrieve current inventory counts for catalog objects at locations. POST /v2/inventory/counts/batch-retrieve.

Retrieve the inventory count for a catalog object at locations. GET /v2/inventory/{catalog_object_id}.

Apply adjustments and physical counts to inventory. POST /v2/inventory/changes/batch-create.

Retrieve historical inventory changes. POST /v2/inventory/changes/batch-retrieve.

Create a draft invoice from an order. POST /v2/invoices.

Search invoices for locations. POST /v2/invoices/search. Cursor pagination.

Retrieve an invoice by id. GET /v2/invoices/{invoice_id}.

Update a draft invoice. PUT /v2/invoices/{invoice_id}.

Delete a draft invoice. DELETE /v2/invoices/{invoice_id}.

Publish a draft invoice (sends it and starts collecting payment). POST /v2/invoices/{invoice_id}/publish.

Cancel a published invoice. POST /v2/invoices/{invoice_id}/cancel.

Start a subscription for a customer against a subscription plan. POST /v2/subscriptions.

Search subscriptions by location/customer. POST /v2/subscriptions/search.

Retrieve a subscription by id. GET /v2/subscriptions/{subscription_id}.

Update a subscription. PUT /v2/subscriptions/{subscription_id}.

Schedule cancellation of a subscription at the end of the billing period. POST /v2/subscriptions/{subscription_id}/cancel.

Schedule a pause of a subscription. POST /v2/subscriptions/{subscription_id}/pause.

Schedule resumption of a paused subscription. POST /v2/subscriptions/{subscription_id}/resume.

Swap the plan variation on a subscription. POST /v2/subscriptions/{subscription_id}/swap-plan.

List events for a subscription. GET /v2/subscriptions/{subscription_id}/events.

Create a hosted checkout / payment link. POST /v2/online-checkout/payment-links.

List payment links. GET /v2/online-checkout/payment-links.

Retrieve a payment link by id. GET /v2/online-checkout/payment-links/{id}.

Update a payment link. PUT /v2/online-checkout/payment-links/{id}.

Delete a payment link. DELETE /v2/online-checkout/payment-links/{id}.

Save a card on file (Cards API). POST /v2/cards.

List saved cards on file. GET /v2/cards. Cursor pagination.

Retrieve a saved card by id. GET /v2/cards/{card_id}.

Disable a saved card so it can no longer be charged. POST /v2/cards/{card_id}/disable.

List linked bank accounts. GET /v2/bank-accounts.

Retrieve a bank account by id. GET /v2/bank-accounts/{bank_account_id}.

List payment disputes (chargebacks). GET /v2/disputes.

Retrieve a dispute by id. GET /v2/disputes/{dispute_id}.

Accept a dispute (concede the disputed amount). POST /v2/disputes/{dispute_id}/accept.

Submit accumulated evidence to challenge a dispute. POST /v2/disputes/{dispute_id}/submit-evidence.

Search team members by location/status. POST /v2/team-members/search.

Create a team member. POST /v2/team-members.

Retrieve a team member by id. GET /v2/team-members/{team_member_id}.

Update a team member. PUT /v2/team-members/{team_member_id}.

Retrieve a team member's wage setting. GET /v2/team-members/{team_member_id}/wage-setting.

Create or update a team member's wage setting. PUT /v2/team-members/{team_member_id}/wage-setting.

Record a worked shift for a team member (Labor API). POST /v2/labor/shifts.

Search worked shifts. POST /v2/labor/shifts/search.

Retrieve a shift by id. GET /v2/labor/shifts/{id}.

Update a shift (edit times, breaks, wage). PUT /v2/labor/shifts/{id}.

Delete a shift. DELETE /v2/labor/shifts/{id}.

List break types configured for locations. GET /v2/labor/break-types.

List team member wages. GET /v2/labor/team-member-wages.

List loyalty programs (use 'main' to retrieve the merchant's program). GET /v2/loyalty/programs.

Retrieve a loyalty program by id (or 'main'). GET /v2/loyalty/programs/{program_id}.

Create a loyalty account for a buyer. POST /v2/loyalty/accounts.

Search loyalty accounts (by phone/customer). POST /v2/loyalty/accounts/search.

Retrieve a loyalty account by id. GET /v2/loyalty/accounts/{account_id}.

Add points to a loyalty account for an order. POST /v2/loyalty/accounts/{account_id}/accumulate.

Create a loyalty reward (redeem points for a discount). POST /v2/loyalty/rewards.

Redeem a loyalty reward, applying it to the order. POST /v2/loyalty/rewards/{reward_id}/redeem.

List promotions for a loyalty program. GET /v2/loyalty/programs/{program_id}/promotions.

Create a digital gift card. POST /v2/gift-cards.

List gift cards. GET /v2/gift-cards.

Retrieve a gift card by id. GET /v2/gift-cards/{id}.

Activate, load, redeem, or adjust a gift card balance. POST /v2/gift-cards/activities.

List gift card activities. GET /v2/gift-cards/activities.

Create an appointment booking. POST /v2/bookings.

Search available booking slots. POST /v2/bookings/availability/search.

List bookings. GET /v2/bookings.

Retrieve a booking by id. GET /v2/bookings/{booking_id}.

Update a booking. PUT /v2/bookings/{booking_id}.

Cancel a booking. POST /v2/bookings/{booking_id}/cancel.

List bookable team member profiles. GET /v2/bookings/team-member-booking-profiles.

Send a checkout to a Square Terminal device. POST /v2/terminals/checkouts.

Search terminal checkouts. POST /v2/terminals/checkouts/search.

Retrieve a terminal checkout by id. GET /v2/terminals/checkouts/{checkout_id}.

Cancel a terminal checkout. POST /v2/terminals/checkouts/{checkout_id}/cancel.

Send a refund request to a Square Terminal device. POST /v2/terminals/refunds.

Create a device code to pair a Square Terminal. POST /v2/devices/codes.

List paired devices. GET /v2/devices.

Retrieve a device by id. GET /v2/devices/{device_id}.

List cash drawer shifts for a location. GET /v2/cash-drawers/shifts.

Retrieve a cash drawer shift by id. GET /v2/cash-drawers/shifts/{shift_id}.

Search vendors. POST /v2/vendors/search.

Create a vendor. POST /v2/vendors/create.

Retrieve a vendor by id. GET /v2/vendors/{vendor_id}.

Update a vendor. PUT /v2/vendors/{vendor_id}.

List Square Online sites. GET /v2/sites.

Retrieve the snippet on a site. GET /v2/sites/{site_id}/snippet.

Add or update the snippet on a site. POST /v2/sites/{site_id}/snippet.

Remove the snippet from a site. DELETE /v2/sites/{site_id}/snippet.

List event types you can subscribe a webhook to. GET /v2/webhooks/event-types.

List webhook subscriptions. GET /v2/webhooks/subscriptions.

Create a webhook subscription for event types. POST /v2/webhooks/subscriptions.

Retrieve a webhook subscription by id. GET /v2/webhooks/subscriptions/{subscription_id}.

Update a webhook subscription. PUT /v2/webhooks/subscriptions/{subscription_id}.

Delete a webhook subscription. DELETE /v2/webhooks/subscriptions/{subscription_id}.

Send a test event to a webhook subscription's notification URL. POST /v2/webhooks/subscriptions/{subscription_id}/test.