PHPackages                             asplinsol/trustshare-api-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. [API Development](/categories/api)
4. /
5. asplinsol/trustshare-api-php

ActiveLibrary[API Development](/categories/api)

asplinsol/trustshare-api-php
============================

PHP library for access to TrustShare API

v1.0.0(4y ago)09LGPL-2.1PHPPHP >=5.5

Since May 9Pushed 4y ago1 watchersCompare

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

READMEChangelog (1)Dependencies (4)Versions (2)Used By (0)

SwaggerClient-php
=================

[](#swaggerclient-php)

Welcome to the trustshare API Reference documentation. Here you can find detailed information about the endpoints we provide as well as the shape of entities within the system. # Getting Started It only takes a few minutes to begin using our **Sandbox** environment straight away. Let's begin... 1. **Create an Organisation** — Head over to the [dashboard](https://dashboard.trustshare.io) to login and being creating your Organisation. You can provide your logo and your brand's accent colour to customise the Checkout UI which is instantiated from the [Client SDK](/guides/client-sdk). 1. **Generate an API Key** — Head to the developers section of the [dashboard](https://dashboard.trustshare.io/developers/api-keys) and generate a new key pair. The *private key* is used to interact with the trustshare API, where-as the *public key* is used to instantiate the [Client SDK](/guides/client-sdk). # Environments The trustshare API has two environments, **Sandbox** and **Live**. Both environments are available under the same endpoint however API Keys and client secrets are prefixed with the environment name. - A **Sandbox** API Key will be in the format: `sandbox_api_[0-9a-z]`. - A **Live** API Key will be in the format: `live_api_[0-9a-z]`. ## Sandbox Our **Sandbox** environment endeavours to be as close to the **Live** environment as possible, however, there are a couple of limitations and features which should be noted. - Card payments take around 7 days to settle into accounts. In **Live** this is generally closer to 2 days. - Manual inbound payments can only be "faked" in **Sandbox** when they are less-than or equal-to `250,000.00`. - Open Banking in **Sandbox** will always use a "Mock Bank" UI to accept the payment. # Webhooks Payments are, by their very nature, asynchronous. As such methods of payment, including the receipt and release of funds can take an arbitrary amount of time to settle or execute. It is therefore advised to integrate with our *Webhook Events* to be notified of changes to payments in real-time. For more information about our *Webhooks*, please visit our [Webhook Events](/guide/webhooks) guide. # Authentication Every API call must include an `Authorization` header containing your API Key.

This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

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

[](#requirements)

PHP 5.5 and later

Installation & Usage
------------------------

[](#installation--usage)

### Composer

[](#composer)

To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:

```
{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

```

Then run `composer install`

### Manual Installation

[](#manual-installation)

Download the files and include `autoload.php`:

```
    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
```

Tests
-----

[](#tests)

To run the unit tests:

```
composer install
./vendor/bin/phpunit

```

Getting Started
---------------

[](#getting-started)

Please follow the [installation procedure](#installation--usage) and then run the following:

```