Skip to content

mcurtis-squareup/square-php-sdk

 
 

Repository files navigation

Square PHP SDK

Build PHP version Apache-2 license

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

Use of the Square PHP SDK requires:

  • PHP 7.4 through PHP 8.1

Installation

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

Quickstart

For more information, see Square PHP SDK Quickstart.

Usage

For more information, see Using the Square PHP SDK.

Tests

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 directory containing composer.json:

composer install

Before running the tests, find a sandbox token in your Developer Dashboard and set a SQUARE_ACCESS_TOKEN environment variable.

$dotenv = Dotenv::create(__DIR__);
$dotenv->load();
$timeout = getenv('SQUARE_TIMEOUT');
$accessToken = getenv('SQUARE_ACCESS_TOKEN');
$environment = getenv('SQUARE_ENVIRONMENT');
$baseUrl = getenv('SQUARE_BASE_URL');

And run the tests.

php composer.phar run test

SDK Reference

Payments

Terminal

Orders

Subscriptions

Invoices

Items

Customers

Loyalty

Gift Cards

Bookings

Business

Team

Financials

Online

Authorization APIs

Deprecated APIs

About

PHP client library for the Square API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%