shopandpay/shopandpay

ShopAndPay PHPLib

v1.0.0 2021-05-18 12:35 UTC

Requires

• php: >=5.4

MIT

• ShopAndPay

• payment
• gateway

README

VERSIONING

This client API library uses the API version 1.0.0 of Shop & Pay. If you got troubles, make sure you are using the correct library version!

Requirements

We recommend to use PHP version >= 5.4

The following php modules are required: cURL

Getting started with SHOP & PAY

If you don't already use Composer, then you probably should read the installation guide http://getcomposer.org/download/.

Please include this library via Composer in your composer.json and execute composer update to refresh the autoload.php.

For the latest library version you can use the following content of composer.json:

{
    "require": {
        "shopandpay/shopandpay": "dev-master"
    }
}

For the Version 1.0.0 you can use the following content of composer.json:

{
    "require": {
        "shopandpay/shopandpay": "1.0.0"
    }
}

1. Instantiate the shopandpay class with the following parameters: $instance: Your Shop & Pay instance name. (e.g. instance name 'demo' you request your Shop & Pay instance https://demo.shop-and-pay.com $apiSecret: This is your API secret which you can find in your instance's administration.

   $shopandpay = new \ShopAndPay\ShopAndPay($instance, $apiSecret);

2. Instantiate the model class with the parameters described in the API-reference:

   $subscription = new \ShopAndPay\Models\Request\Subscription();
   $subscription->setId(1);

3. Use your desired function:

   $response  = $shopandpay->cancel($subscription);
   $subscriptionId = $response->getId();

   It recommend to wrap it into a "try/catch" to handle exceptions like this:

   try{
       $response  = $shopandpay->cancel($subscription);
       $subscriptionId = $response->getId();
   }catch(\ShopAndPay\ShopAndPayException $e){
       //Do something with the error informations below
       $e->getCode();
       $e->getMessage();
   }

Documentation

For further information, please refer to the official REST API reference: https://shop-and-pay.readme.io/