PHPackages                             antibodies-online/omnipay-vr-payment - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. antibodies-online/omnipay-vr-payment

ActiveLibrary[Payment Processing](/categories/payments)

antibodies-online/omnipay-vr-payment
====================================

VR Payment gateway driver for the Omnipay PHP payment processing library

v2.0.0(3y ago)22.5k3MITPHPPHP ^8.0

Since Aug 8Pushed 1y ago4 watchersCompare

[ Source](https://github.com/antibodies-online/omnipay-vr-payment)[ Packagist](https://packagist.org/packages/antibodies-online/omnipay-vr-payment)[ Docs](https://github.com/antibodies-online/omnipay-vr-payment)[ RSS](/packages/antibodies-online-omnipay-vr-payment/feed)WikiDiscussions master Synced 4d ago

READMEChangelog (6)Dependencies (2)Versions (7)Used By (0)

VR Payment
==========

[](#vr-payment)

[![GitHub license](https://camo.githubusercontent.com/7013272bd27ece47364536a221edb554cd69683b68a46fc0ee96881174c4214c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)](https://raw.githubusercontent.com/antibodies-online/omnipay-vr-payment/master/LICENSE.md)[![Packagist](https://camo.githubusercontent.com/45e637b4a77191470d9c73754d5990b19edc741fa4aeb7127f033ba6700b605d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f616e7469626f646965732d6f6e6c696e652f6f6d6e697061792d76722d7061796d656e742e737667)](https://packagist.org/packages/antibodies-online/omnipay-vr-payment)[![GitHub issues](https://camo.githubusercontent.com/b4a9750709a3bc5f1eae88600e4875bf6141c0f23fd383e24b8a29a2d2d5f734/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f616e7469626f646965732d6f6e6c696e652f6f6d6e697061792d76722d7061796d656e742e737667)](https://github.com/antibodies-online/omnipay-vr-payment/issues)[![PHP Composer Test](https://github.com/antibodies-online/omnipay-vr-payment/actions/workflows/php.yml/badge.svg)](https://github.com/antibodies-online/omnipay-vr-payment/actions/workflows/php.yml)

Table of Contents
=================

[](#table-of-contents)

- [Table of Contents](#table-of-contents)
- [Omnipay: ](#omnipay-vr-payment)[VR Payment](https://www.vr-payment.de//)
    - [Installation](#installation)
    - [Basic Usage](#basic-usage)
        - [Gateway Background](#gateway-background)
    - [Instantiate a gateway](#instantiate)
    - [Switch between Test Modes](#switch-between-test-modes)
    - [Out of standard Functions](#out-of-standard-functions)

Omnipay: [VR Payment](https://www.vr-payment.de/)
=================================================

[](#omnipay-vr-payment)

**VR Payment driver for the Omnipay PHP payment processing library**

Written to specification:

- \*[TECHNICAL REFERENCE](https://vr-pay-ecommerce.docs.oppwa.com/) (2019-08-05)

This package implements VR Payment support for [OmniPay](https://github.com/thephpleague/omnipay).

[![VR Payment GmbH](docs/logo.png?raw=true "VR Payment")](docs/logo.png?raw=true)

Installation
------------

[](#installation)

**This is the `master` branch for the current Omnipay 3.x branch (tested against 3.0.2).**

Omnipay is installed via [Composer](http://getcomposer.org/). To install, add it to your `composer.json` file:

```
{
  "require": {
      "antibodies-online/omnipay-vr-payment": "~1.0"
  }
}
```

or direct from [packagist](https://packagist.org/packages/antibodies-online/omnipay-vr-payment)

```
composer require "antibodies-online/omnipay-vr-payment: ~1.0"

```

And run composer to update your dependencies:

```
$ curl -s http://getcomposer.org/installer | php
$ php composer.phar update

```

Basic Usage
-----------

[](#basic-usage)

For general usage instructions, please see the main [Omnipay](https://github.com/thephpleague/omnipay)repository. You will find more specific details can be found below.

### Gateway Background

[](#gateway-background)

At least there is only one gateway provided by [VR Payment](https://www.vr-payment.de/). There's no separate gateway for frontend forms and server-to server requests. However they splitted the tutorials on their document page.

You will most likely be using a mix of COPY+PAY, and Server-to-Server functions as they complement each other, if you want to be SAQ-A(For more information see: [PCI](https://www.pcisecuritystandards.org/pci_security/completing_self_assessment)) compliant.

Instantiate a gateway
---------------------

[](#instantiate-a-gateway)

To communicate with vr payment there are different mandatory informations which the gateway needs:

- AccessToken:
    The access token is generated by [VR Payment](https://www.vr-payment.de/) and authenticates your application against the gateway.
- EntityId:
    The entity id is generated by [VR Payment](https://www.vr-payment.de/) and defines the gateway you want to use (e.g. Credit Card, PayPal,...)

Now let's create the gateway:

```
$gateway = Omnipay\Omnipay::create('VrPayment_VrPayment');
$gateway->setEntityId('xyz');
$gateway->setTestMode(true);
$gateway->setAccessToken('myAccessToken');

$request = $gateway->authorize([
    'transactionId' => $transactionId, // Merchant site ID (or a nonce for it)
    'amount' => 9.99, // Major units
    'currency' => 'EUR',
    'token' => 'creditCardToken', // This is only needed, if you are using COPY+PAY
    'card' => [ // Is not implemented yet
        ....
    ]
]);
$response = $request->send();
```

Switch between Test Modes
-------------------------

[](#switch-between-test-modes)

VR Payment provides two different Test Modes.

- EXTERNAL: All transactions will be forwarded to the processor's test system
- INTERNAL: All transactions will be processed by VR Payments simulator

Default: INTERNAL

You can switch the Test Mode using this command:

```
    $gateway->setSimulation('EXTERNAL');
```

Parsing Webhooks
----------------

[](#parsing-webhooks)

There are different actions which are send via Webhook. For further documentation please read the [documentation](https://vr-pay-ecommerce.docs.oppwa.com/tutorials/webhooks/integration-guide)Omnipay provides a standard way to accept and read such notifications. However the returned Request object is not standardized and may differ in other implementations.

```
$gateway = Omnipay\Omnipay::create('VrPayment_VrPayment');
$gateway->setNotificationDecryptionKey('myDecryptionKey');

$request = $gateway->acceptNotifications(); // Parses the HTTP Request
$requestArray = $request->getData();
$response = $request->sendData();
$response->sendData()->accept();
```

Out of standard functions
-------------------------

[](#out-of-standard-functions)

There are a couple of functions which are not defined in the standard of omnipay. However I think to use COPY+PAY, it's easier to include those function in this package.

- creditCardCheck()
    This function calls the gateway to create a new checkout id, which is used to generate the payment form.

```
&nbsp;

{literal}

    var wpwlOptions = {style:"card"}

{/literal}
```

```
$gateway = Omnipay\Omnipay::create('VrPayment_VrPayment');
// Set authentication info
$request = $gateway->creditCardCheck()->send();
$javascript_url = $request->getPaymentFormJsUrl();
```

- creditCardCheckStatus()
    This function calls the gateway using the reference provided in the query parameters, to query for the payment information of the creditCardCheck form result. This function will extract all needed information out of the url by itself.

```
$gateway = Omnipay\Omnipay::create('VrPayment_VrPayment');
$cardCheckStatusResponse = $gateway->creditCardCheckStatus()->send();
if ($cardCheckStatusResponse->isSuccessful()) {
    $token = $cardCheckStatusResponse->getTransactionReference();
}
```

Contributing
------------

[](#contributing)

We really appreciate if you report bugs and errors. Feel free to ask for additional functionality/fields. But be aware that the maintainers may not implement all features. If you can provide a Pull Request for your Features that would be amazing.

###  Health Score

37

—

LowBetter than 81% of packages

Maintenance29

Infrequent updates — may be unmaintained

Popularity25

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 96.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~231 days

Recently: every ~285 days

Total

6

Last Release

1359d ago

Major Versions

v1.2.2 → v2.0.02022-10-11

PHP version history (2 changes)v1.0.0PHP ^7.1

v2.0.0PHP ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/8ce067feaa3f9ece08d78385c401aab7d72e9e8ee64d77d584f884b6725ad9de?d=identicon)[manuxi](/maintainers/manuxi)

![](https://www.gravatar.com/avatar/eddcf88f91820b20232215f4296c56e46fed9860d941f9249bf1ae15d8507b90?d=identicon)[DemigodCode](/maintainers/DemigodCode)

![](https://avatars.githubusercontent.com/u/14757464?v=4)[Eugen Biedlingmaier](/maintainers/ebazot)[@ebazot](https://github.com/ebazot)

---

Top Contributors

[![DemigodCode](https://avatars.githubusercontent.com/u/36764562?v=4)](https://github.com/DemigodCode "DemigodCode (61 commits)")[![manuxi](https://avatars.githubusercontent.com/u/11303615?v=4)](https://github.com/manuxi "manuxi (2 commits)")

---

Tags

omnipayomnipay-vr-paymentvrpaymentpaymentgatewaypaymerchantomnipayvr

### Embed Badge

![Health badge](/badges/antibodies-online-omnipay-vr-payment/health.svg)

```
[![Health](https://phpackages.com/badges/antibodies-online-omnipay-vr-payment/health.svg)](https://phpackages.com/packages/antibodies-online-omnipay-vr-payment)
```

###  Alternatives

[lokielse/omnipay-alipay

Alipay gateway for Omnipay payment processing library

586422.8k11](/packages/lokielse-omnipay-alipay)[omnipay/mollie

Mollie driver for the Omnipay payment processing library

631.8M10](/packages/omnipay-mollie)[sudiptpa/omnipay-nabtransact

National Australia Bank (NAB) Transact driver for the Omnipay payment processing library.

1019.5k](/packages/sudiptpa-omnipay-nabtransact)[lucassmacedo/omnipay-mercadopago

MercadoPago gateway for OmniPay

155.4k](/packages/lucassmacedo-omnipay-mercadopago)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
