Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/terdelyi/omnipay-wirecard
Wirecard gateway for Omnipay payment processing library
https://github.com/terdelyi/omnipay-wirecard
Last synced: 2 months ago
JSON representation
Wirecard gateway for Omnipay payment processing library
- Host: GitHub
- URL: https://github.com/terdelyi/omnipay-wirecard
- Owner: terdelyi
- License: mit
- Created: 2016-03-03T15:57:25.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-07-25T16:04:12.000Z (over 8 years ago)
- Last Synced: 2024-04-01T13:43:23.290Z (9 months ago)
- Language: PHP
- Size: 9.77 KB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# omnipay-wirecard
Wirecard gateway for [Omnipay](https://github.com/thephpleague/omnipay) payment processing library.
> This library **only supports** Wirecard Checkout Page payment yet. You can [read more about](https://www.wirecard.at/en/solutions/products/checkout-page/) the Checkout Page solution here.
## Install
Gateway is installed via Composer:
```bash
composer require terdelyi/omnipay-wirecard
```
or add it to your composer.json file:
```json
"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](https://github.com/thephpleague/omnipay)
repository.
Firstly create the gateway:
```php
$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:
```php
$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:
```php
$request = $gateway->purchase($parameters);
```
Send the request:
```php
$response = $request->send();
```
Lastly handle the response:
```php
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:
```php
$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:
| Type | Description |
|---|---|
| BANCONTACT_MISTERCASH | Bancontact/Mister Cash |
| C2P | CLICK2PAY |
| CCARD | Credit Card |
| CCARD-MOTO | Credit Card Mail Order, Telephone Order |
| EKONTO | eKonto |
| SEPA-DD | SEPA Direct Debit |
| EPS | EPS |
| GIROPAY | giropay |
| IDL | iDEAL |
| INSTALLMENT | Installment |
| INVOICE | Invoice |
| MAESTRO | Maestro SecureCode |
| MONETA | moneta.ru |
| MPASS | mpass |
| PRZELEWY24 | Przelewy24 |
| PAYPAL | PayPal |
| PBX | Paybox |
| POLI | POLi payments |
| PSC | Paysafecard |
| QUICK | @Quick |
| SKRILLDIRECT | Skrill Direct |
| SKRILLWALLET | Skrill Digital Wallet |
| SOFORTUEBERWEISUNG | sofort.com |
| TRUSTLY | Trustly |
## 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/)