vrpay/vrpay

VRpay PHPLib

vr-pay-secure-php

VERSIONING

This client API library uses the API version 1.0.0 of VRpay. If you got troubles, make sure you are using the correct library version!, _(*1)

Requirements

We recommend to use PHP version >= 5.4, _(*2)

The following php modules are required: cURL, _(*3)

Getting started with VRpay

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

Please include this library via Composer in your composer.json and execute composer update to refresh the autoload.php., _(*5)

For the latest library version you can use the following content of composer.json:, _(*6)

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

For the Version 1.0.0 you can use the following content of composer.json:, _(*7)

{
    "require": {
        "vrpay/vrpay": "1.0.0"
    }
}

1. Instantiate the VRpay class with the following parameters: $instance: Your VRpay instance name. (e.g. instance name 'demo' you request your VRpay instance https://demo.vr-pay-secure.de $apiSecret: This is your API secret which you can find in your instance's administration., _(*8)

   $vrpay = new \VRpay\VRpay($instance, $apiSecret);
   

2. Instantiate the model class with the parameters described in the API-reference:, _(*9)

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

3. Use your desired function:, _(*10)

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

   It recommend to wrap it into a "try/catch" to handle exceptions like this:, _(*11)

   try{
       $response  = $vrpay->cancel($subscription);
       $subscriptionId = $response->getId();
   }catch(\VRpay\VRpayException $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://developers.vr-pay-secure.de/v1.0/reference, _(*12)