Skip to content
Switch branches/tags


Failed to load latest commit information.
Latest commit message
Commit time

The Checkout SDK for PHP enables developers to easily work with APIs. It requires PHP 5.6.

Getting Help

If you encounter a bug with Checkout SDK for PHP please search the existing issues and try to make sure your problem doesn’t already exist before opening a new issue. The GitHub issues are intended for bug reports and feature requests. For help and questions with using Checkout SDK for PHP please contact our integration support team.

For full usage details, see the Wiki.


Installation with Composer (Recommended)

Either run the following command in the root directory of your project:

composer require checkout/checkout-sdk-php

Or require the package inside the composer.json file of your project:

"require": { "php": ">=5.6", "checkout/checkout-sdk-php": "1.0.0"}.

Clone repository

Alternatively you can clone the repository from GitHub with git clone

git clone


A card token can be obtained using one of's JavaScript frontend solutions such as Frames or any of the mobile SDKs

Include a checkout-sdk-php/checkout.php to access the operations for each API:

use Checkout\CheckoutApi;
use Checkout\Models\Tokens\Card;
use Checkout\Models\Payments\TokenSource;
use Checkout\Models\Payments\Payment;

// Set the secret key
$secretKey = 'sk_test_key';

// Initialize the Checkout API in Sandbox mode. Use new CheckoutApi($liveSecretKey, false); for production
$checkout = new CheckoutApi($secretKey);

// Create a payment method instance with card details
$method = new TokenSource('tok_key_goes_here');

// Prepare the payment parameters
$payment = new Payment($method, 'GBP');
$payment->amount = 1000; // = 10.00

// Send the request and retrieve the response
$response = $checkout->payments()->request($payment);


Install PHPUnit by running composer require --dev phpunit/phpunit and execute the tests with ./vendor/bin/phpunit.