Ruby SDK

The Square Ruby library supports Square APIs in a language-idiomatic way that reduces complexity without sacrificing API functionality.

SDK package

Reference library docs

SDK package

Reference library docs

Latest SDK Version: 42.0.0.20250319

Each SDK version is tied to a specific Square API versionSquare API version. As features are added, Square releases a new Square API version and a new SDK version. To use new features, you must update the SDK version in your application. Review the release notesrelease notes to learn about changes in each API version.

An increase in the SDK major version number indicates a breaking change. You should always test your application before deploying a change to production.

• Follow along with the Quickstart guideQuickstart guide to set up and test the Square Ruby SDK in your own project.
• Download the Square Ruby SDK Quickstart sample appSquare Ruby SDK Quickstart sample app and follow the instructions in the README.
• Download the Ruby OAuth sample appRuby OAuth sample app to view a basic implementation of the Square OAuth flow.

• Set up your Square SDK for a Ruby ProjectSet up your Square SDK for a Ruby Project
• Using the Square Ruby SDKUsing the Square Ruby SDK
• Common Square API PatternsCommon Square API Patterns