square/square

Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management.

39.1.0.20241218 2024-12-18 13:37 UTC

Requires

• php: ^7.2 || ^8.0
• ext-json: *
• apimatic/core: ~0.3.12
• apimatic/core-interfaces: ~0.1.5
• apimatic/unirest-php: ^4.0.0

Requires (Dev)

• phan/phan: 5.4.5
• phpunit/phpunit: ^7.5 || ^8.5 || ^9.5
• squizlabs/php_codesniffer: ^3.5

MIT

• Square Developer Platform

• api
• sdk
• square

README

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

Requirements

Use of the Square PHP SDK requires:

• PHP 7.4 through PHP ^8.0

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 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

SDK Reference

Payments

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

Terminal

• Terminal

Orders

• Orders
• Order Custom Attributes

Subscriptions

• Subscriptions

Invoices

• Invoices

Items

• Catalog
• Inventory

Customers

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

Loyalty

• Loyalty

Gift Cards

• Gift Cards
• Gift Card Activities

Bookings

• Bookings
• Booking Custom Attributes

Business

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

Team

• Team
• Labor

Financials

• Bank Accounts

Online

• Sites
• Snippets

Authorization

• Mobile Authorization
• OAuth

Webhook Subscriptions

• Webhook Subscriptions

Deprecated APIs

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.