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

Use of the Square Ruby SDK requires:

• Ruby 2.7 through 3.1

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

For more information, see Square Ruby SDK Quickstart.

For more information, see Using the Square Ruby SDK.

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

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

• Terminal

• Orders
• Order Custom Attributes

• Subscriptions

• Invoices

• Catalog
• Inventory

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

• Loyalty

• Gift Cards
• Gift Card Activities

• Bookings
• Booking Custom Attributes

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

• Team
• Labor

• Bank Accounts

• Sites
• Snippets

• Mobile Authorization
• OAuth

• Webhook Subscriptions

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.