Square Ruby SDK

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
• Installation
• Quickstart
• Usage
• Tests
• SDK Reference
• Deprecated APIs

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

• Payments
• Refunds
• Disputes
• Checkout
• Apple Pay
• Cards
• Payouts

Terminal

• Terminal

Orders

• Orders
• Order Custom Attributes

Subscriptions

• Subscriptions

Invoices

• Invoices

Items

• Catalog
• Inventory

Customers

• Customers
• Customer Custom Attributes
• Customer Groups
• Customer Segments

Loyalty

• Loyalty

Gift Cards

• Gift Cards
• Gift Card Activities

Bookings

• Bookings
• Booking Custom Attributes

Business

• Merchants
• Merchant Custom Attributes
• Locations
• Location Custom Attributes
• Devices
• Cash Drawers
• Vendors

Team

• Team
• Labor

Financials

• Bank Accounts

Online

• Sites
• Snippets

Authorization

• Mobile Authorization
• OAuth

Webhook Subscriptions

• Webhook Subscriptions

Deprecated APIs

The following Square APIs are deprecated:

• Employees - replaced by the Team API. For more information, see Migrate from the Employees API.

• Transactions - replaced by the Orders and Payments APIs. For more information, see Migrate from the Transactions API.