Square logo

Square Ruby SDK

Build Gem version Apache-2 license

Use this library to integrate Square payments into your app and grow your business with Square APIs including Catalog, Customers, Employees, Inventory, Labor, Locations, and Orders.

Requirements

Use of the Square Ruby SDK requires:

  • Ruby 2.6 through 3.1

Installation

For more information, see Set Up Your Square SDK for a Ruby Project.

Quickstart

For more information, see Square Ruby SDK Quickstart.

Usage

For more information, see Using the Square Ruby SDK.

Tests

First, clone the repo locally and cd into the directory.

git clone https://github.com/square/square-ruby-sdk.git
cd square-ruby-sdk

Next, make sure Bundler is installed and install the development dependencies.

gem install bundler
bundle

Before running the tests, find a sandbox token in your Developer Dashboard and set a SQUARE_SANDBOX_TOKEN environment variable.

export SQUARE_SANDBOX_TOKEN="YOUR SANDBOX TOKEN HERE"

And run the tests.

rake

SDK Reference

Payments

Terminal

Orders

Subscriptions

Invoices

Items

Customers

Loyalty

Gift Cards

Bookings

Business

Team

Financials

Online

Authorization APIs

Deprecated APIs