Square OAuth 2.0 Client Provider for The PHP League OAuth2-Client

v2.0.0-beta1 2015-08-05 17:52 UTC


Build Status Code Coverage Code Quality License Latest Stable Version

This package provides Square OAuth 2.0 support for the PHP League's OAuth 2.0 Client.


To install, use composer:

composer require wheniwork/oauth2-square


Usage is the same as The League's OAuth client, using Wheniwork\OAuth2\Client\Provider\Square as the provider.

To make requests against the Square staging server, pass 'debug' => true as part of the initial configuration options.

Authorization Code Flow

$provider = new Wheniwork\OAuth2\Client\Provider\Square([
    'clientId'          => '{square-client-id}',
    'clientSecret'      => '{square-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url'

if (!isset($_GET['code'])) {

    // If we don't have an authorization code then get one
    $authUrl = $provider->getAuthorizationUrl();
    $_SESSION['oauth2state'] = $provider->state;
    header('Location: '.$authUrl);

// Check given state against previously stored one to mitigate CSRF attack
} elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {

    exit('Invalid state');

} else {

    // Try to get an access token (using the authorization code grant)
    $token = $provider->getAccessToken('authorization_code', [
        'code' => $_GET['code']

    // Optional: Now you have a token you can look up a users profile data
    try {

        // We got an access token, let's now get the user's details
        $userDetails = $provider->getUserDetails($token);

        // Use these details to create a new profile
        printf('Hello %s!', $userDetails->firstName);

    } catch (Exception $e) {

        // Failed to get user details
        exit('Oh dear...');

    // Use this to interact with an API on the users behalf
    echo $token->accessToken;

Refreshing a Token

Square does not provide refresh tokens. Instead, an access token can be "renewed" up to 15 days after it expires. To accomdate this, the Square provider provides an additional grant, RenewToken.

$provider = new Wheniwork\OAuth2\Client\Provider\Square([
    'clientId'          => '{square-client-id}',
    'clientSecret'      => '{square-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url'

$token = $provider->getAccessToken('renew_token', ['access_token' => $accessToken]);

This grant can also be used by injecting the AccessToken instance directly, instead of providing a parameter to getAccessToken:

$grant = new Wheniwork\OAuth2\Client\Grant\RenewToken($token);
$token = $provider->getAccessToken($grant);