Template Docs Commerce APIs Webhooks Tools
Get Started
Template Docs Commerce APIs Webhooks Tools
Get Started
Getting started
Overview Authentication and permissions Making requests Retrieve basic site information
Using Commerce APIs
Idempotency-Key header Rate limits Responses & error handling Upgrade Changelog Glossary FAQ
Inventory API
Overview GET: Retrieve all inventory GET: Retrieve specific inventory POST: Adjust stock quantities
Orders API
Overview POST: Create an order POST: Fulfill an order GET: Retrieve all orders GET: Retrieve a specific order
Products API
Overview About product attributes Managing attributes POST: Create a product POST: Create a product variant POST: Upload a product image GET: Retrieve all Store Pages GET: Retrieve all products GET: Retrieve specific products GET: Product image upload status POST: Assign a product image to variant POST: Reorder a product image POST: Update a product POST: Update a product variant POST: Update a product image DEL: Delete a product DEL: Delete a product variant DEL: Delete a product image
Profiles API
Overview GET: Retrieve all profiles GET: Retrieve specific profiles
Transactions API
Overview GET: Retrieve all transactions GET: Retrieve specific transactions
Webhook Subscriptions API
Overview POST: Create a webhook subscription POST: Update a webhook subscription GET: Retrieve all webhook subscriptions GET: Retrieve a specific webhook subscription DEL: Delete a webhook subscription POST: Send test notification POST: Rotate a subscription secret

Transactions API overview

Current version: 1.0
For versioning details, read the Upgrade guide.

Use the Transactions API to access financial transactions for orders and donations made on a Squarespace merchant site.

Payment gateways and processing errors

Transactions from a merchant site occur through a payment gateway. The Transactions API supports the following payment gateways: SQUARESPACE, STRIPE, PAYPAL, and SQUARE.

Payment gateway processing errors are logged by the Transactions API as one of the following:

GATEWAY_FEE_PROCEESING_ERROR An error occurred while retrieving payment processing fees; contact the payment gateway for more details.

GATEWAY_API_PERMISSION_ERROR The payment gateway has not granted Squarespace API access. Payment gateway needs to reconfigure API permission.

GATEWAY_DISCONNNECTED The payment gateway credentials configured for the site have expired or are missing; a connection to the payment gateway could not be established.

What information isn't available?

  • Order or donation details unrelated to payments, such as product information, merchant notes, and form data
  • Refunds initiated outside of Squarespace, e.g. via Stripe

API resources

The Transactions API returns Document resource objects. A Document is a collection of transactions for an order or a donation. There's a 1:1 relationship between a Document and an order or donation.

Document resources include information like:

  • Totals for an order or a donation, summing item sales, discounts, fees, shipping, taxes, and the grand total
  • Payments and payment types
  • Refunds
  • Payment gateway errors

Note: Only refunds initiated through Squarespace are captured and made available through the Transactions API.

Resource fields are described under Response example for each Transactions API endpoint.

Further reading