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 PHP SDK requires:

• PHP 7.4 through PHP ^8.0

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

For more information, see Square PHP SDK Quickstart.

For more information, see Using the Square PHP SDK.

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

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

Next, make sure you've downloaded Composer, following the instructions here and then run the following command from the root of the repository:

composer install

Before running the tests, find a sandbox token in your Developer Dashboard and set environment variables:

export SQUARE_ACCESS_TOKEN=mytoken
export SQUARE_ENVIRONMENT=sandbox

Run the tests:

composer run test

All environment variables:

• SQUARE_TIMEOUT - number
• SQUARE_NUMBER_OF_RETRIES - number
• SQUARE_MAXIMUM_RETRY_WAIT_TIME - number
• SQUARE_SQUARE_VERSION - string
• SQUARE_USER_AGENT_DETAIL - string
• SQUARE_CUSTOM_URL - string
• SQUARE_ACCESS_TOKEN - string
• SQUARE_ENVIRONMENT - string - one of production, sandbox, custom

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

• Terminal

• Orders

• Subscriptions

• Invoices

• Catalog
• Inventory

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

• Loyalty

• Gift Cards
• Gift Card Activities

• Bookings

• Merchants
• Locations
• 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.