SupportLog InSign Up
DocumentationAPIs & IntegrationsChangelog

Square Sandbox

Integrate your application with the Square Sandbox API

🚀 Quickstart

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

Create the integration

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

Authorize Square

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

Call the Square Sandbox API

Make your first request to the Square Sandbox 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.

Use squareup-sandbox for development and squareup for production in Tenklo.

📚 Square Sandbox Integration Guides

Official docs: Square API documentation

🧩 Pre-built syncs & actions for Square Sandbox

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

Others

Function nameDescriptionTypeSource code
batch-retrieve-catalog-objectsRetrieve multiple catalog objects by ID in one call.Action🔗 Github
cancel-invoiceCancel a published, unpaid invoice.Action🔗 Github
cancel-paymentCancel (void) a payment that has not yet been captured. Only works on payments in APPROVED status.Action🔗 Github
cancel-subscriptionCancel a subscription.Action🔗 Github
create-customerCreate a customer.Action🔗 Github
create-invoiceCreate an invoice.Action🔗 Github
create-orderCreate an order.Action🔗 Github
create-paymentCreate a payment.Action🔗 Github
create-subscriptionCreate a subscription.Action🔗 Github
create-team-memberCreate a team member.Action🔗 Github
delete-catalog-objectDelete a catalog object (and its child objects, e.g. variations).Action🔗 Github
delete-customerDelete a customer.Action🔗 Github
delete-invoiceDelete a draft invoice.Action🔗 Github
get-customerRetrieve a customer.Action🔗 Github
get-invoiceRetrieve an invoice.Action🔗 Github
get-orderRetrieve one or more orders by ID.Action🔗 Github
get-paymentRetrieve a payment.Action🔗 Github
get-refundRetrieve a refund.Action🔗 Github
get-subscriptionRetrieve a subscription.Action🔗 Github
get-team-memberRetrieve a team member.Action🔗 Github
list-customersList customers.Action🔗 Github
list-invoicesList invoices.Action🔗 Github
list-locationsList locations.Action🔗 Github
list-ordersSearch orders.Action🔗 Github
list-paymentsList payments.Action🔗 Github
list-refundsList refunds.Action🔗 Github
pause-subscriptionPause an active subscription.Action🔗 Github
pay-orderPay an order.Action🔗 Github
publish-invoicePublish a draft invoice, moving it out of DRAFT status and sending it to the recipient.Action🔗 Github
refund-paymentRefund a payment.Action🔗 Github
resume-subscriptionResume a paused or deactivated subscription.Action🔗 Github
retrieve-catalog-objectRetrieve a single catalog object by ID.Action🔗 Github
search-catalog-objectsSearch catalog objects.Action🔗 Github
search-customersSearch customers by filters (email, phone, name, etc).Action🔗 Github
search-subscriptionsSearch subscriptions.Action🔗 Github
search-team-membersList/search team members.Action🔗 Github
update-customerUpdate a customer.Action🔗 Github
update-invoiceUpdate a draft or unpaid invoice.Action🔗 Github
update-orderUpdate an order (e.g. add line items, discounts, service charges).Action🔗 Github
update-subscriptionUpdate a subscription (e.g. swap card_id).Action🔗 Github
update-team-memberUpdate a team member (e.g. name, status, assigned locations).Action🔗 Github
upsert-catalog-objectCreate/update catalog object.Action🔗 Github
catalog-objectsSync catalog objectsSync🔗 Github
customersSync customers.Sync🔗 Github
invoicesSync invoices.Sync🔗 Github
locationsSync locations.Sync🔗 Github
ordersSync orders.Sync🔗 Github
paymentsSync paymentsSync🔗 Github
refundsSync refunds.Sync🔗 Github
subscriptionsSync subscriptions.Sync🔗 Github
team-membersSync team members.Sync🔗 Github

Square

Previous Page

Stack Exchange

Next Page

On this page

🚀 Quickstart📚 Square Sandbox Integration Guides🧩 Pre-built syncs & actions for Square Sandbox