rocketkind
Commerce

Square

Square runs the payments, orders and customer records behind a shop, a restaurant or an online checkout.

Authentication

  • Access token

Actions

Generic API request. Call any Square API endpoint on this connection, for the case where no shipped action covers it yet. The connection supplies the base URL, the authentication and the egress route, so only the path, query and body are yours to fill.

  • Create customerCreate a customer profile (POST /v2/customers, application/json).
  • Create orderCreate an order at a location with line items (POST /v2/orders, application/json).
  • Create paymentTake a payment against a source of funds (POST /v2/payments, application/json).
  • Get customerRetrieve a single customer profile by id (GET /v2/customers/{customerid}).
  • Get paymentRead one Square payment by id to check whether it went through: the record carries its status (COMPLETED, ...) and an amountmoney object holding the amount and its currency as separate fields rather than a single formatted string.
  • List customersList customer profiles for the Square account with pagination (GET /v2/customers).
  • List locationsList all business locations for the Square account (GET /v2/locations).
  • List paymentsList payments taken by the account, optionally within a time range (GET /v2/payments).
  • Refund paymentRefund a completed payment, in full or part (POST /v2/refunds, application/json).
  • Search customersSearch customer profiles with a Square query filter (POST /v2/customers/search, application/json).
  • Update customerDestructiveUpdate fields on an existing customer profile (PUT /v2/customers/{customerid}, application/json).

Triggers

  • New customerStarts when a new customer profile is created in Square, detected by polling the List Customers endpoint for customers created since the last poll.
  • New paymentStarts when a new payment is created in Square, detected by polling the List Payments endpoint filtered to payments created after the last poll.
  • Payment updated (webhook)Starts the moment a Square payment changes state on the connected account, delivered by a webhook instead of polling the payment list for status changes.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.