This client API library uses the API version 1.0.0 of Loxopay. If you got troubles, make sure you are using the correct library version!
We recommend to use PHP version >= 5.4
The following php modules are required: cURL
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": {
"loxopay/loxopay": "dev-master"
}
}
For the Version 1.0.0 you can use the following content of composer.json:
{
"require": {
"loxopay/loxopay": "1.0.0"
}
}
-
Instantiate the loxopay class with the following parameters: $instance: Your Loxopay instance name. (e.g. instance name 'demo' you request your Loxopay instance https://demo.loxopay.ch $apiSecret: This is your API secret which you can find in your instance's administration.
$loxopay = new \Loxopay\Loxopay($instance, $apiSecret);
-
Instantiate the model class with the parameters described in the API-reference:
$subscription = new \Loxopay\Models\Request\Subscription(); $subscription->setId(1);
-
Use your desired function:
$response = $loxopay->cancel($subscription); $subscriptionId = $response->getId();
It recommend to wrap it into a "try/catch" to handle exceptions like this:
try{ $response = $loxopay->cancel($subscription); $subscriptionId = $response->getId(); }catch(\Loxopay\LoxopayException $e){ //Do something with the error informations below $e->getCode(); $e->getMessage(); }
For further information, please refer to the official REST API reference: https://developers.loxopay.ch/v1.0/reference