PHPackages                             swikly/swikly-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. swikly/swikly-php

AbandonedArchivedLibrary

swikly/swikly-php
=================

A PHP wrapper for Swikly's API

v1.1.0(9y ago)1154MITPHPPHP >=5.6.0

Since Feb 8Pushed 6y agoCompare

[ Source](https://github.com/swikly/swikly-php)[ Packagist](https://packagist.org/packages/swikly/swikly-php)[ Docs](https://github.com/swikly/swikly-php)[ RSS](/packages/swikly-swikly-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)DependenciesVersions (4)Used By (0)

DEPRECATED
==========

[](#deprecated)

> This is no longer supported, please consider using  or  for sandbox environment.

New [SWIKLY\_LINK](http://storage.swikly.com/docs/Swikly-LeLienSwikly.pdf).
---------------------------------------------------------------------------

[](#new-swikly_link)

It is a unique web link that works with your Swikly account. It allows you to request swiks deposit or deposit for fixed amounts known in advance.

[SWIKLY\_LINK Documentation](http://storage.swikly.com/docs/LeLienSwikly-URLParameter.pdf)

> You can sign up to get a [Swikly](https://www.swikly.com) account [here](https://www.swikly.com/views/signup.php).

Swikly PHP SDK
==============

[](#swikly-php-sdk)

Swikly provides a new and easy way to request the equivalent to a down payment or security deposit (we call that "a swik") but with no funds being transferred.

When you request a swik, you're effectively asking your customer to provide a credit card hold, specifying an amount and a period during which the deposit will be held.

This allows you to secure your bookings or request a down payment or security deposit remotely, simply, and with complete confidence. Swikly also provides a payment option which is cheaper than most of its competitors.

Requirements
------------

[](#requirements)

PHP 5.6.0 and later.

Composer
--------

[](#composer)

You can install the **Swikly SDK** via [Composer](https://getcomposer.org/):

```
composer require swikly/swikly-php
```

To use the SDK, use Composer's [autoload](https://getcomposer.org/doc/00-intro.md#autoloading)

```
require_once('vendor/autoload.php');
```

Manual installation
-------------------

[](#manual-installation)

If you do not wish to use Composer, you can download the sources. Then, to use the SDK, include the `init.php` file.

```
require_once('/path/to/swikly-php/init.php');
```

Ressources
----------

[](#ressources)

[Wiki](https://github.com/swikly/swikly-php/wiki): To understand all the SDK features and how to use them.

[Github repository](https://github.com/swikly/swikly-php): Examples are available in the examples directory.

[API documentation](https://api.sandbox.swikly.com/apidoc/): A documentation up to date about the API used by this SDK.

Quick examples
--------------

[](#quick-examples)

### Create a Swikly API client

[](#create-a-swikly-api-client)

```