Square

🚀 Quickstart

Connect to Square with Tenklo and see data flow in 2 minutes.

In Tenklo (free signup), go to Integrations -> Configure New Integration -> Square.

Go to Connections -> Add Test Connection -> Authorize, then log in to Square. Later, you'll let your users do the same directly from your app.

Call the Square API

Make your first request to the Square API (e.g. list locations). Replace the placeholders below with your Environment API key, integration ID, and connection ID:

curl "https://api.tenklo.dev/proxy/v2/locations" \
  -H "Authorization: Bearer <NANGO-API-KEY>" \
  -H "Provider-Config-Key: <INTEGRATION-ID>" \
  -H "Connection-Id: <CONNECTION-ID>"

Or fetch credentials with the Node SDK or API.

✅ You're connected! Check the Logs tab in Tenklo to inspect requests.

Implement Tenklo in your app

Follow our Auth implementation guide to integrate Tenklo in your app.

To obtain your own production credentials, follow the setup guide linked below.

📚 Square Integration Guides

Tenklo maintained guides for common use cases.

How to register your own Square OAuth app
Register your own OAuth app and configure Square for production use in Tenklo

Official docs: Square API documentation

🧩 Pre-built syncs & actions for Square

Explore Nango-provided actions in your dashboard. Extend and customize them to fit your needs.

Others

Function name	Description	Type	Source code
`batch-retrieve-catalog-objects`	Retrieve multiple catalog objects by ID in one call.	Action	🔗 Github
`cancel-invoice`	Cancel a published, unpaid invoice.	Action	🔗 Github
`cancel-payment`	Cancel (void) a payment that has not yet been captured. Only works on payments in APPROVED status.	Action	🔗 Github
`cancel-subscription`	Cancel a subscription.	Action	🔗 Github
`create-customer`	Create a customer.	Action	🔗 Github
`create-invoice`	Create an invoice.	Action	🔗 Github
`create-order`	Create an order.	Action	🔗 Github
`create-payment`	Create a payment.	Action	🔗 Github
`create-subscription`	Create a subscription.	Action	🔗 Github
`create-team-member`	Create a team member.	Action	🔗 Github
`delete-catalog-object`	Delete a catalog object (and its child objects, e.g. variations).	Action	🔗 Github
`delete-customer`	Delete a customer.	Action	🔗 Github
`delete-invoice`	Delete a draft invoice.	Action	🔗 Github
`get-customer`	Retrieve a customer.	Action	🔗 Github
`get-invoice`	Retrieve an invoice.	Action	🔗 Github
`get-order`	Retrieve one or more orders by ID.	Action	🔗 Github
`get-payment`	Retrieve a payment.	Action	🔗 Github
`get-refund`	Retrieve a refund.	Action	🔗 Github
`get-subscription`	Retrieve a subscription.	Action	🔗 Github
`get-team-member`	Retrieve a team member.	Action	🔗 Github
`list-customers`	List customers.	Action	🔗 Github
`list-invoices`	List invoices.	Action	🔗 Github
`list-locations`	List locations.	Action	🔗 Github
`list-orders`	Search orders.	Action	🔗 Github
`list-payments`	List payments.	Action	🔗 Github
`list-refunds`	List refunds.	Action	🔗 Github
`pause-subscription`	Pause an active subscription.	Action	🔗 Github
`pay-order`	Pay an order.	Action	🔗 Github
`publish-invoice`	Publish a draft invoice, moving it out of DRAFT status and sending it to the recipient.	Action	🔗 Github
`refund-payment`	Refund a payment.	Action	🔗 Github
`resume-subscription`	Resume a paused or deactivated subscription.	Action	🔗 Github
`retrieve-catalog-object`	Retrieve a single catalog object by ID.	Action	🔗 Github
`search-catalog-objects`	Search catalog objects.	Action	🔗 Github
`search-customers`	Search customers by filters (email, phone, name, etc).	Action	🔗 Github
`search-subscriptions`	Search subscriptions.	Action	🔗 Github
`search-team-members`	List/search team members.	Action	🔗 Github
`update-customer`	Update a customer.	Action	🔗 Github
`update-invoice`	Update a draft or unpaid invoice.	Action	🔗 Github
`update-order`	Update an order (e.g. add line items, discounts, service charges).	Action	🔗 Github
`update-subscription`	Update a subscription (e.g. swap card_id).	Action	🔗 Github
`update-team-member`	Update a team member (e.g. name, status, assigned locations).	Action	🔗 Github
`upsert-catalog-object`	Create/update catalog object.	Action	🔗 Github
`catalog-objects`	Sync catalog objects	Sync	🔗 Github
`customers`	Sync customers.	Sync	🔗 Github
`invoices`	Sync invoices.	Sync	🔗 Github
`locations`	Sync locations.	Sync	🔗 Github
`orders`	Sync orders.	Sync	🔗 Github
`payments`	Sync payments	Sync	🔗 Github
`refunds`	Sync refunds.	Sync	🔗 Github
`subscriptions`	Sync subscriptions.	Sync	🔗 Github
`team-members`	Sync team members.	Sync	🔗 Github

🚀 QuickstartCopy Anchor Link

📚 Square Integration GuidesCopy Anchor Link

🧩 Pre-built syncs & actions for SquareCopy Anchor Link

OthersCopy Anchor Link

On this page

🚀 Quickstart

📚 Square Integration Guides

🧩 Pre-built syncs & actions for Square

Others