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.
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-sdkNext, make sure you've downloaded Composer, following the instructions here and then run the following command from the root of the repository:
composer installBefore running the tests, find a sandbox token in your Developer Dashboard and set environment variables:
export SQUARE_ACCESS_TOKEN=mytoken
export SQUARE_ENVIRONMENT=sandboxRun the tests:
composer run testAll environment variables:
SQUARE_TIMEOUT- numberSQUARE_NUMBER_OF_RETRIES- numberSQUARE_MAXIMUM_RETRY_WAIT_TIME- numberSQUARE_SQUARE_VERSION- stringSQUARE_USER_AGENT_DETAIL- stringSQUARE_CUSTOM_URL- stringSQUARE_ACCESS_TOKEN- stringSQUARE_ENVIRONMENT- string - one of production, sandbox, custom
- Merchants
- Merchant Custom Attributes
- Locations
- Location Custom Attributes
- Devices
- Cash Drawers
- Vendors
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.
