README

Wirecard gateway for Omnipay payment processing library.

This library only supports Wirecard Checkout Page payment yet. You can read more about the Checkout Page solution here.

Install

Gateway is installed via Composer:

composer require terdelyi/omnipay-wirecard

or add it to your composer.json file:

"require": {
    "terdelyi/omnipay-wirecard": "dev-master"
}

It will also install the Omnipay package if it's not available in the autoload.

Basic usage

The following gateways are provided by this package:

Wirecard_Checkout (Wirecard Checkout Page)

For general usage instructions, please see the main Omnipay repository.

Firstly create the gateway:

$gateway = Omnipay\Omnipay::create('Wirecard_Checkout');
$gateway->setCustomerId('D200001'); // this is a valid demo customer id
$gateway->setSecret('B8AKTPWBRMNBV455FG6M2DANE99WU2'); // this is also valid for developing

Secondly prepare the required parameters:

$parameters = [
    'paymentType' => 'CCARD',
    'shopId' => '1234', // optional
    'currency' => 'EUR',
    'description' => 'Awesome Product',
    'language' => 'EN',
    'successUrl' => 'http://your-website.com/response?type=success',
    'failureUrl' => 'http://your-website.com/response?type=failure',
    'cancelUrl' => http://your-website.com/response?type=cancel,
    'serviceUrl' => http://your-website.com/response?type=service,
    'amount' => '100.00' // must be contains decimals
];

If any required parameter is missing you will get an InvalidRequestException when you create the request:

$request = $gateway->purchase($parameters);

Send the request:

$response = $request->send();

Lastly handle the response:

if ($response->isRedirect()) {
    $response->redirect(); // redirect the browser to the Wirecard Checkout Page
} else {
    echo 'Error: '.$response->getMessage();
}

If you would like to handle return urls from the Checkout page use this on your response page:

$gateway = Omnipay\Omnipay::create('Wirecard_Checkout');
$gateway->setCustomerId('D200001');
$gateway->setSecret('B8AKTPWBRMNBV455FG6M2DANE99WU2');
$request = $gateway->completePurchase();
$response = $request->send();

if ($response->isSuccessful()) {
    echo 'Succesful payment!';
} else if ($response->isCanceled()) {
    echo 'Payment has been cancelled.';
} else if ($response->isPending()) {
    echo 'Your payment is in pending status.';
} else {
    echo $response->getMessage();
}

The getMessage() and getData() methods are available in the response object for further actions.

List of available payment types

Payment type is highly depended on your contract with Wirecard, but these are the currently available values:

To-do

Handling custom parameters (like customerStatement, duplicateRequestCheck, displayText, imageUrl, etc.)
Unit tests
Checkout Seamless integration (https://www.wirecard.at/en/solutions/products/checkout-seamless/)

terdelyi / omnipay-wirecard

Maintainers

Details

README

Install

Basic usage

List of available payment types

To-do