Square TypeScript Library

The Square TypeScript library provides convenient access to the Square APIs from TypeScript.

Table of Contents

• Installation
• Reference
• Versioning
• Usage
• Legacy Sdk
• Environments
• Request and Response Types
• Exception Handling
• File Uploads
• Pagination
• Webhook Signature Verification
• Reporting Api
• Advanced
  • Subpackage Exports
  • Additional Headers
  • Additional Query String Parameters
  • Retries
  • Timeouts
  • Aborting Requests
  • Access Raw Response Data
  • Logging
  • Custom Fetch
  • Custom Fetcher
  • Runtime Compatibility
• Contributing

Installation

npm i -s square

Reference

A full reference for this library is available here.

Versioning

By default, the SDK is pinned to the latest version. If you would like to override this version you can simply pass in a request option.

awaitclient.payments.create(...,{version: "2024-05-04"// override the version used})

Usage

Instantiate and use the client with the following:

import{SquareClient}from"square";constclient=newSquareClient({token: "YOUR_TOKEN"});awaitclient.payments.create({sourceId: "ccof:GaJGNaZa8x4OgDJn4GB",idempotencyKey: "7b0f3ec5-086a-4871-8f13-3c81b3875218",amountMoney: {amount: BigInt("1000"),currency: "USD"},appFeeMoney: {amount: BigInt("10"),currency: "USD"},autocomplete: true,customerId: "W92WH6P11H4Z77CTET0RNTGFW8",locationId: "L88917AVBK2S5",referenceId: "123456",note: "Brief description"});

Legacy SDK

Legacy SDK

If you're using TypeScript, make sure that the moduleResolution setting in your tsconfig.json is equal to node16, nodenext, or bundler to consume the legacy SDK.

While the new SDK has a lot of improvements, we at Square understand that it takes time to upgrade when there are breaking changes. To make the migration easier, the new SDK also exports the legacy SDK as square/legacy. Here's an example of how you can use the legacy SDK alongside the new SDK inside a single file:

import{randomUUID}from"crypto";import{Square,SquareClient}from"square";import{Client}from"square/legacy";constclient=newSquareClient({token: process.env.SQUARE_ACCESS_TOKEN,});constlegacyClient=newClient({bearerAuthCredentials: {accessToken: process.env.SQUARE_ACCESS_TOKEN!,},});asyncfunctiongetLocation(): Promise<Square.Location>{return(awaitclient.locations.get({locationId: "YOUR_LOCATION_ID",})).location!;}asyncfunctioncreateOrder(){constlocation=awaitgetLocation();awaitlegacyClient.ordersApi.createOrder({idempotencyKey: randomUUID(),order: {locationId: location.id!,lineItems: [{name: "New Item",quantity: "1",basePriceMoney: {amount: BigInt(100),currency: "USD",},},],},});}createOrder();

We recommend migrating to the new SDK using the following steps:

1. Upgrade the NPM module to ^40.0.0 or later.
2. Search and replace all requires and imports from "square" to "square/legacy"

• For required, replace require("square") with require("square/legacy")
• For imports, replace from "square" with from "square/legacy"
• For dynamic imports, replace import("square") with import("square/legacy")

3. Gradually move over to use the new SDK by importing it from the "square" import.

Environments

This SDK allows you to configure different environments for API requests.

import{SquareClient,SquareEnvironment}from"square";constclient=newSquareClient({environment: SquareEnvironment.Production,});

Request and Response Types

The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace:

import{Square}from"square";constrequest: Square.RevokeTokenRequest={
...
};

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

import{SquareError}from"square";try{awaitclient.payments.create(...);}catch(err){if(errinstanceofSquareError){console.log(err.statusCode);console.log(err.message);console.log(err.body);console.log(err.rawResponse);}}

File Uploads

You can upload files using the client:

import{createReadStream}from"fs";import{SquareClient}from"square";constclient=newSquareClient({token: "YOUR_TOKEN"});awaitclient.disputes.createEvidenceFile({disputeId: "dispute_id"});

The client accepts a variety of types for file upload parameters:

• Stream types: fs.ReadStream, stream.Readable, and ReadableStream
• Buffered types: Buffer, Blob, File, ArrayBuffer, ArrayBufferView, and Uint8Array

Metadata

You can configure metadata when uploading a file:

constfile: Uploadable.WithMetadata={data: createReadStream("path/to/file"),filename: "my-file",// optionalcontentType: "audio/mpeg",// optionalcontentLength: 1949,// optional};

Alternatively, you can upload a file directly from a file path:

constfile : Uploadable.FromPath={path: "path/to/file",filename: "my-file",// optionalcontentType: "audio/mpeg",// optionalcontentLength: 1949,// optional};

The metadata is used to set the Content-Length, Content-Type, and Content-Disposition headers. If not provided, the client will attempt to determine them automatically. For example, fs.ReadStream has a path property which the SDK uses to retrieve the file size from the filesystem without loading it into memory.

Pagination

List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:

import{SquareClient}from"square";constclient=newSquareClient({token: "YOUR_TOKEN"});constpageableResponse=awaitclient.bankAccounts.list({cursor: "cursor",limit: 1,locationId: "location_id",customerId: "customer_id"});forawait(constitemofpageableResponse){console.log(item);}// Or you can manually iterate page-by-pageletpage=awaitclient.bankAccounts.list({cursor: "cursor",limit: 1,locationId: "location_id",customerId: "customer_id"});while(page.hasNextPage()){page=page.getNextPage();}// You can also access the underlying responseconstresponse=page.response;

Webhook Signature Verification

The SDK provides utility methods that allow you to verify webhook signatures and ensure that all webhook events originate from Square. The Webhooks.verifySignature method will verify the signature.

import{WebhooksHelper}from"square";constisValid=WebhooksHelper.verifySignature({
requestBody,signatureHeader: request.headers['x-square-hmacsha256-signature'],signatureKey: "YOUR_SIGNATURE_KEY",notificationUrl: "https://example.com/webhook",// The URL where event notifications are sent.});

Reporting API

The Reporting API lets you query aggregated reporting data. Call reporting.getMetadata first to discover the available cubes, measures, and dimensions, then run a query with reporting.load.

import{SquareClient}from"square";constclient=newSquareClient({token: "YOUR_TOKEN"});// Discover what you can query.constmetadata=awaitclient.reporting.getMetadata();// Run a query against the discovered schema.constresponse=awaitclient.reporting.load({query: {measures: ["Orders.count"]},});

load is asynchronous: while a query is still being computed, the API returns an HTTP 200 whose body is { "error": "Continue wait" } instead of results, and the client is expected to re-send the identical request — with backoff — until the results are ready. The ReportingHelper.loadAndWait utility owns that polling loop for you and returns the resolved results (never the "Continue wait" sentinel):

import{ReportingHelper,SquareClient}from"square";constclient=newSquareClient({token: "YOUR_TOKEN"});constresponse=awaitReportingHelper.loadAndWait(client,{query: {measures: ["Orders.count"]},});console.log(response.data);

By default it polls up to 20 times with exponential backoff (2s → 20s). Tune the behavior — and pass an AbortSignal to cancel — via the options argument:

constcontroller=newAbortController();constresponse=awaitReportingHelper.loadAndWait(client,{query: {measures: ["Orders.count"]}},{maxAttempts: 10,// default 20initialDelayMs: 1000,// default 2000maxDelayMs: 20000,// default 20000backoffFactor: 2,// default 2signal: controller.signal,},);

Advanced

Subpackage Exports

This SDK supports direct imports of subpackage clients, which allows JavaScript bundlers to tree-shake and include only the imported subpackage code. This results in much smaller bundle sizes.

import{OAuthClient}from'square/oAuth';constclient=newOAuthClient({...});

Additional Headers

If you would like to send additional headers as part of the request, use the headers request option.

import{SquareClient}from"square";constclient=newSquareClient({
...
headers: {'X-Custom-Header': 'custom value'}});constresponse=awaitclient.payments.create(...,{headers: {'X-Custom-Header': 'custom value'}});

Additional Query String Parameters

If you would like to send additional query string parameters as part of the request, use the queryParams request option.

constresponse=awaitclient.payments.create(...,{queryParams: {'customQueryParamKey': 'custom query param value'}});

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

Which status codes are retried depends on the retryStatusCodes generator configuration:

legacy (current default): retries on

• 408 (Timeout)
• 429 (Too Many Requests)
• 5XX (All server errors, including 500)

recommended: retries on

• 408 (Timeout)
• 429 (Too Many Requests)
• 502 (Bad Gateway)
• 503 (Service Unavailable)
• 504 (Gateway Timeout)

Use the maxRetries request option to configure this behavior.

constresponse=awaitclient.payments.create(...,{maxRetries: 0// override maxRetries at the request level});

Timeouts

The SDK defaults to a 60 second timeout. Use the timeoutInSeconds option to configure this behavior.

constresponse=awaitclient.payments.create(...,{timeoutInSeconds: 30// override timeout to 30s});

Aborting Requests

The SDK allows users to abort requests at any point by passing in an abort signal.

constcontroller=newAbortController();constresponse=awaitclient.payments.create(...,{abortSignal: controller.signal});controller.abort();// aborts the request

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .withRawResponse() method. The .withRawResponse() method returns a promise that results to an object with a data and a rawResponse property.

const{ data, rawResponse }=awaitclient.payments.create(...).withRawResponse();console.log(data);console.log(rawResponse.headers['X-My-Header']);

Logging

The SDK supports logging. You can configure the logger by passing in a logging object to the client options.

import{SquareClient,logging}from"square";constclient=newSquareClient({
...
logging: {level: logging.LogLevel.Debug,// defaults to logging.LogLevel.Infologger: newlogging.ConsoleLogger(),// defaults to ConsoleLoggersilent: false,// defaults to true, set to false to enable logging}});

The logging object can have the following properties:

• level: The log level to use. Defaults to logging.LogLevel.Info.
• logger: The logger to use. Defaults to a logging.ConsoleLogger.
• silent: Whether to silence the logger. Defaults to true.

The level property can be one of the following values:

• logging.LogLevel.Debug
• logging.LogLevel.Info
• logging.LogLevel.Warn
• logging.LogLevel.Error

To provide a custom logger, you can pass in an object that implements the logging.ILogger interface.

Custom logger examples

Here's an example using the popular winston logging library.

importwinstonfrom'winston';constwinstonLogger=winston.createLogger({...});constlogger: logging.ILogger={debug: (msg, ...args)=>winstonLogger.debug(msg, ...args),info: (msg, ...args)=>winstonLogger.info(msg, ...args),warn: (msg, ...args)=>winstonLogger.warn(msg, ...args),error: (msg, ...args)=>winstonLogger.error(msg, ...args),};

Here's an example using the popular pino logging library.

importpinofrom'pino';constpinoLogger=pino({...});constlogger: logging.ILogger={debug: (msg, ...args)=>pinoLogger.debug(args,msg),info: (msg, ...args)=>pinoLogger.info(args,msg),warn: (msg, ...args)=>pinoLogger.warn(args,msg),error: (msg, ...args)=>pinoLogger.error(args,msg),};

Custom Fetch

The SDK provides a low-level fetch method for making custom HTTP requests while still benefiting from SDK-level configuration like authentication, retries, timeouts, and logging. This is useful for calling API endpoints not yet supported in the SDK.

constresponse=awaitclient.fetch("/v1/custom/endpoint",{method: "GET",},{timeoutInSeconds: 30,maxRetries: 3,headers: {"X-Custom-Header": "custom-value",},});constdata=awaitresponse.json();

Custom Fetcher

The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an unsupported environment, this provides a way for you to break glass and ensure the SDK works.

import{SquareClient}from"square";constclient=newSquareClient({
...
fetcher: // provide your implementation here});

Runtime Compatibility

The SDK defaults to node-fetch but will use the global fetch client if present. The SDK works in the following runtimes:

• Node.js 18+
• Vercel
• Cloudflare Workers
• Deno v1.25+
• Bun 1.0+
• React Native

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!