Create a payment

This chapter describes how to use Wallet API to initiate and control payment transactions. When making payments, default client credentials are enough, no integration with OAuth framework is required.

Integration

Before using API, you must register in Paysera system. Public registration is not yet available, please contact our support to register the client for this API. You will be provided with your credentials, for example:

client_id:     wkVd93h2uS
mac_key:       IrdTc8uQodU7PRpLzzLTW6wqZAO6tAMU
mac_algorithm: hmac-sha-256
Important mac_key must be kept secret at all times.

Every transaction follows 3 main and 1 optional steps until it's completed:

  1. Transaction is created by client (developed system);
  2. Transaction is accepted by user, relating it to specific wallet;
  3. Transaction is confirmed or revoked by the client (developed system);
  4. (Optionally) Each payment in transaction can be finalized or cancelled.

More info Making payments.

Integration with the library

You can integrate payments into your website by downloading our open source software library. The library is used to check all the necessary security parameters of transferred and received data. PHP library is available on GitHub, together with more information about installing and using it. Please feel free to fork and make pull requests for added functionality or fixed bugs. More info: Wallet libraries.

Below you will find a working example. Locations where your Paysera access data has to be entered are marked with comments.

1. Create a folder.

Create a folder, name it paysera-wallet. Here, all the files related to payment creation will be stored.

2. Download the library.

Download GitHub files to the paysera-wallet folder.

3. Create a file that will create a payment.

Create file payment.php in the paysera-wallet folder. First of all you must include library and register GatewayClient_Autoloader as an SPL autoloader:

<?php
if (!class_exists('Paysera_WalletApi_Autoloader')) {
    require_once 'lib-wallet-php-client-master/src/Paysera/WalletApi/Autoloader.php';
}

Paysera_WalletApi_Autoloader::register();

Write in your authentication data values, which you have received as Wallet credentials:

// $clientId - mac
$clientId = 'wkVd93h2uS';
// $secret - mac_key
$secret = 'IrdTc8uQodU7PRpLzzLTW6wqZAO6tAMU';

Create main object to use for all functionality. Using our library you may create object either for production, either for testing – Sandbox:

Production
$api = new Paysera_WalletApi($clientId, $secret);
Sandbox
$api = new Paysera_WalletApi($clientId, $secret, Paysera_WalletApi_Util_Router::createForSandbox());
Info Only one of two methods to asign $api must be used: sandbox or production

You may create payments with detailed description for each item, more info: Payment resource. In this example we will create transaction with one payment, which has 2 items.

Start new session as we will store transactionKey in $_SESSION['transactionKey']:

session_start();

To facilitate the catching of potential exceptions code must be surrounded in try block:

try {

// Payment steps

} catch (Exception $e) {
    echo '<pre>', $e, '</pre>';
}

Inside try block there will be logic which creates and confirms payment. First step is to create a payment object, then create a transaction with a created payment object, then authorise transaction and the last step - client (developed system) must confirm that transaction. Transaction might be confirmed automaticaly, after redirect to client (developed system) site or after callback. See Transaction resource for more information.

To create payment object we need to create price and item objects which are used in payment object. Create item with title, description, image, price and quantity:

$priceOfItemOne = Paysera_WalletApi_Entity_Money::create()
    ->setAmountInCents(100)
    ->setCurrency('EUR')
;

$itemOne = Paysera_WalletApi_Entity_Item::create()
    ->setTitle('Item One')
    ->setDescription('Item One in sale')
    ->setImageUri('https://developers.paysera.com/bundles/evpfrontpage/img/logo.png')
    ->setPrice($priceOfItemOne)
    ->setQuantity(2)
;

You may create and add more then one item to a payment object. In this example we create two items and add it to the payment object. In order to create payment object and add items we use Paysera_WalletApi_Entity_Payment:

$paymentObj = Paysera_WalletApi_Entity_Payment::create()
    ->addItem($itemOne)
    ->addItem($itemTwo)
    ->setDescription('In Sale')
;

Transaction object is created and values are updated using Paysera_WalletApi_Entity_Transaction. In this example we are adding one payment with a redirect link which will be used after user confirms transaction:

$transactionObj = Paysera_WalletApi_Entity_Transaction::create()
    ->addPayment($paymentObj)
    ->setRedirectUri('http://wallet.dev.docker/payment.php')
;

After we get transaction object we are creating the transaction:

$transactionCreated = $api->walletClient()->createTransaction($transactionObj);

User is redirected to the transaction confirmation page with a code:

header('Location:' . $api->router()->getTransactionConfirmationUri($transactionCreated->getKey()));

After user accepts transaction client (developed system) must confirm it:

$transaction = $api->walletClient()->getTransaction($_SESSION['transactionKey'])

$api->walletClient()->confirmTransaction($transaction->getKey());

The whole code in the file payment.php:

<?php
if (!class_exists('Paysera_WalletApi_Autoloader')) {
    require_once 'lib-wallet-php-client-master/src/Paysera/WalletApi/Autoloader.php';
}

Paysera_WalletApi_Autoloader::register();

// $clientId - mac
$clientId = 'wkVd93h2uS';
// $secret - mac_key
$secret = 'IrdTc8uQodU7PRpLzzLTW6wqZAO6tAMU';

$api = new Paysera_WalletApi($clientId, $secret, Paysera_WalletApi_Util_Router::createForSandbox());

session_start();
try {
    if (!isset($_SESSION['transactionKey'])) {
        $priceOfItemOne = Paysera_WalletApi_Entity_Money::create()
            ->setAmountInCents(100)
            ->setCurrency('EUR')
        ;

        $itemOne = Paysera_WalletApi_Entity_Item::create()
            ->setTitle('Item One')
            ->setDescription('Item One in sale')
            ->setImageUri('https://developers.paysera.com/bundles/evpfrontpage/img/logo.png')
            ->setPrice($priceOfItemOne)
            ->setQuantity(2)
        ;

        $priceOfItemTwo = Paysera_WalletApi_Entity_Money::create()
            ->setAmountInCents(150)
            ->setCurrency('EUR')
        ;

        $itemTwo = Paysera_WalletApi_Entity_Item::create()
            ->setTitle('Item Two')
            ->setDescription('Item Two in sale')
            ->setImageUri('https://developers.paysera.com/bundles/evpfrontpage/img/logo.png')
            ->setPrice($priceOfItemTwo)
            ->setQuantity(1)
        ;

        $paymentObj = Paysera_WalletApi_Entity_Payment::create()
            ->addItem($itemOne)
            ->addItem($itemTwo)
            ->setDescription('In Sale')
        ;

        $transactionObj = Paysera_WalletApi_Entity_Transaction::create()
            ->addPayment($paymentObj)
            ->setRedirectUri('http://wallet.dev.docker/payment.php')
        ;

        $transactionCreated = $api->walletClient()->createTransaction($transactionObj);

        $_SESSION['transactionKey'] = $transactionCreated->getKey();

        header('Location:' . $api->router()->getTransactionConfirmationUri($transactionCreated->getKey()));
    }

    if (isset($_SESSION['transactionKey'])){
        $transaction = $api->walletClient()->getTransaction($_SESSION['transactionKey']);

        // ToDo: some action with $transaction

        if ($transaction->getStatus() == 'reserved') {
            $api->walletClient()->confirmTransaction($transaction->getKey());
        }

        unset($_SESSION['transactionKey']);
    }
} catch (Exception $e) {
    echo '<pre>', $e, '</pre>';
}

Integration with the specification

If it's available (there is PHP with required version in your server), we strongly advise to use our library.

1. Create transaction.

Transaction groups one or more objects into one confirmable group. To confirm any created object, there must be a transaction.

Info Default transaction is created together with payment and allowance to be confirmed without creating it manually.

Moreover, transactions take part in all-or-nothing scenarios: either all of grouped payments are done successfuly, or all fail. For example, if wallet has sufficient account balance only for one of grouped payments, user will be unable to confirm this transaction.
Transactions are also good when making shop carts with payments to different beneficiaries - user will have to confirm something just once.

Warning Transactions group payments only when confirming. If payment is canceled, other payments in the same transaction remain unchanged.

This method creates transaction that groups payment(s) and/or allowance into one confirmable item. In this example we will group already created payments. More info about transaction creation: Transaction resource.

POST https://wallet.paysera.com/rest/v1/transaction
Example request for creating payment and assigning optional allowance
POST /rest/v1/transaction HTTP/1.1
Host: wallet.paysera.com
Content-Type: application/json;charset=utf-8
User-Agent: Paysera WalletApi PHP library
Authorization: MAC id="wkVd93h2uS", ts="1343822400", nonce="nQnNaSNyubfPErjRO55yaaEYo9YZfKHN", mac="JoZ+SX/Q8y0W1omXBjTrZA9YyZ2gjM6tLmmSly4s5Xo=", ext="body_hash=gK8kVbYW1XEeZUf4BR1yZ45YLu%2BEYnq1WOGYtRhxyQA%3D"
{
    "payments": [
        {
            "description": "Payment for order No. 1234",
            "price": 1299,
            "currency": "EUR",
            "parameters": {
                "orderid": 1234
            }
        }
    ],
    "allowance": {
        "id": 784,
        "optional": true
    },
    "redirect_uri": "http:\/\/www.example.com\/somePage"
}
Example response
HTTP/1.1 200 OK
Content-type: application/json;charset=utf-8
{
    "transaction_key": "pDAlAZ3z",
    "created_at": 1355314332,
    "status": "new",
    "project_id": 2248,
    "valid_for_payment_card_debit": false,
    "payments": [
        {
            "id": 2988,
            "transaction_key": "pDAlAZ3z",
            "created_at": 1355314332,
            "status": "new",
            "price": 1299,
            "currency": "EUR",
            "description": "Payment for order No. 1234",
            "parameters": {
                "orderid": 1234
            }
        }
    ],
    "allowance": {
        "optional": true,
        "data": {
            "id": 784,
            "transaction_key": "pDAlAZ3z",
            "created_at": 1355314332,
            "status": "new",
            "description": "Allowance for weekly services (5 weeks)",
            "currency": "EUR",
            "max_price": 1500,
            "limits": [
                {
                    "max_price": 300,
                    "time": 604800
                }
            ]
        }
    },
    "reserve": {
        "until": 1355400732
    },
    "use_allowance": false,
    "suggest_allowance": false,
    "auto_confirm": false,
    "redirect_uri": "http:\/\/www.example.com\/somePage"
}
Info transaction_key of all objects in the transaction are the same and equals to that of transaction itself

2. Authorising transaction.

After creating transaction, it has to be authorised by a user and confirmed by the client (developed system) to take effect. Authorising (reserving funds) can be accomplished redirecting user to transaction confirmation page in Paysera system. Using this way user leaves your site and comes back only after confirming or canceling the request. You should provide redirect_uri when creating the transaction if using this confirmation way. If not provided, user will see notice and will not be redirected anywhere after confirming or rejecting the transaction.

In English
https://www.paysera.com/frontend/en/wallet/confirm/:transaction_key
In Lithuanian
https://www.paysera.com/frontend/wallet/confirm/:transaction_key
In Russian
https://www.paysera.com/frontend/ru/wallet/confirm/:transaction_key

More info about authorising transaction: Authorising transactions (reserving funds).

3. Confirm transaction.

When transaction status is reserved, you can confirm or revoke the transaction.

PUT https://wallet.paysera.com/rest/v1/transaction/:transaction_key/confirm

Confirmed transaction is returned on success. See get transaction information response data structure for more information.

Example request
PUT /rest/v1/transaction/pDAlAZ3z/confirm HTTP/1.1
Host: wallet.paysera.com
User-Agent: Paysera WalletApi PHP library
Authorization: MAC id="wkVd93h2uS", ts="1343822400", nonce="nQnNaSNyubfPErjRO55yaaEYo9YZfKHN", mac="LW8+ekuXz2uP3LBAgyX8Tm0pV9U6AnjTz3M3hRB2z0E="
Example response
HTTP/1.1 200 OK
Content-type: application/json;charset=utf-8
{
    "transaction_key": "pDAlAZ3z",
    "created_at": 1355314332,
    "status": "confirmed",
    "type": "page",
    "wallet": 14471,
    "valid_for_payment_card_debit": false,
    "confirmed_at": 1355314392,
    "project_id": 2248,
    "payments": [
        {
            "id": 2988,
            "transaction_key": "pDAlAZ3z",
            "created_at": 1355314332,
            "status": "confirmed",
            "price": 1299,
            "currency": "EUR",
            "wallet": 14471,
            "confirmed_at": 1355314392,
            "freeze": {
                "until": 1357992732
            },
            "description": "Payment for order No. 1234",
            "parameters": {
                "orderid": 1234
            }
        }
    ],
    "allowance": {
        "optional": true,
        "data": {
            "id": 784,
            "transaction_key": "pDAlAZ3z",
            "created_at": 1355314332,
            "status": "active",
            "currency": "EUR",
            "wallet": 14471,
            "confirmed_at": 1355314392,
            "valid": {
                "until": 1357992732
            },
            "description": "Allowance for weekly services (5 weeks)",
            "max_price": 1500,
            "limits": [
                {
                    "max_price": 300,
                    "time": 604800
                }
            ]
        }
    }
}