Square Connect PHP SDK - RETIRED replaced by square/square-php-sdk
NOTICE: Square Connect PHP SDK retired
The Square Connect PHP SDK is retired (EOL) as of 2020-06-10 and will no longer receive bug fixes or product updates. To continue receiving API and SDK improvements, please follow the instructions below to migrate to the new Square PHP SDK.
The old Connect SDK documentation is available under the /docs folder.
Migrate to the Square PHP SDK
Follow the instructions below to migrate your apps from the deprecated square/connect sdk to the new library.
You need to update your app to use the Square PHP SDK instead of the Connect PHP SDK The Square PHP SDK uses the square/square identifier.
- On the command line, run:
$ php composer.phar require square/square
-or-
- Update your composer.json:
"require": {
...
"square/square": "^5.0.0",
...
}
Update your code
- Change all instances of
use SquareConnect\...touse Square\.... - Replace
SquareConnectmodels with the newSquareequivalents - Update client instantiation to follow the method outlined below.
- Update code for accessing response data to follow the method outlined below.
- Check
$apiResponse->isSuccess()or$apiResponse->isError()to determine if the call was a success.
To simplify your code, we also recommend that you use method chaining to access APIs instead of explicitly instantiating multiple clients.
Client instantiation
Connect SDK
require 'vendor/autoload.php';
use SquareConnect\Configuration;
use SquareConnect\ApiClient;
$access_token = 'YOUR_ACCESS_TOKEN';
# setup authorization
$api_config = new Configuration();
$api_config->setHost("https://connect.squareup.com");
$api_config->setAccessToken($access_token);
$api_client = new ApiClient($api_config);
Square SDK
require 'vendor/autoload.php';
use Square\SquareClient;
use Square\Environment;
// Initialize the Square client.
$api_client = new SquareClient([
'accessToken' => "YOUR_ACCESS_TOKEN",
'environment' => Environment::SANDBOX
]); // In production, the environment arg is 'production'
Example code migration
As a specific example, consider the following code for creating a new payment from the following nonce:
# Fail if the card form didn't send a value for `nonce` to the server
$nonce = $_POST['nonce'];
if (is_null($nonce)) {
echo "Invalid card data";
http_response_code(422);
return;
}
With the deprecated square/connect library, this is how you instantiate a client for the Payments API, format the request, and call the endpoint:
use SquareConnect\Api\PaymentsApi;
use SquareConnect\ApiException;
$payments_api = new PaymentsApi($api_client);
$request_body = array (
"source_id" => $nonce,
"amount_money" => array (
"amount" => 100,
"currency" => "USD"
),
"idempotency_key" => uniqid()
);
try {
$result = $payments_api->createPayment($request_body);
echo "<pre>";
print_r($result);
echo "</pre>";
} catch (ApiException $e) {
echo "Caught exception!<br/>";
print_r("<strong>Response body:</strong><br/>");
echo "<pre>"; var_dump($e->getResponseBody()); echo "</pre>";
echo "<br/><strong>Response headers:</strong><br/>";
echo "<pre>"; var_dump($e->getResponseHeaders()); echo "</pre>";
}
Now consider equivalent code using the new square/square library:
require 'vendor/autoload.php';
use Square\Environment;
use Square\Exceptions\ApiException;
use Square\SquareClient;
use Square\Models\CreatePaymentRequest;
use Square\Models\Money;
$payments_api = $api_client->getPaymentsApi();
$money = new Money();
$money->setAmount(100);
$money->setCurrency('USD');
$create_payment_request = new CreatePaymentRequest($nonce, uniqid(), $money);
try {
$response = $payments_api->createPayment($create_payment_request);
if ($response->isError()) {
echo 'Api response has Errors';
$errors = $response->getErrors();
exit();
}
echo '<pre>';
print_r($response);
echo '</pre>';
} catch (ApiException $e) {
echo 'Caught exception!<br/>';
exit();
}
That's it!
Ask the community
Please join us in our Square developer community if you have any questions!
54 Jul 14, 2022
4 Jan 18, 2022
140 Sep 28, 2022
7.1k Dec 23, 2022
3.9k Dec 29, 2022
2.1k Jan 2, 2023
175 Dec 26, 2022
946 Jan 1, 2023
2 May 26, 2022
12 Dec 26, 2022
3 Jan 8, 2022
8.4k Dec 30, 2022
235 Dec 31, 2022
469 Dec 23, 2022
289 Nov 24, 2022
2 Sep 17, 2022
263 Dec 14, 2022
264 Jan 3, 2023
119 Nov 25, 2022
2 Oct 2, 2022