valiton/payum-payone

The Payum extension. It provides PAYONE payment integration.

3.0.0 2024-06-20 07:08 UTC

This package is auto-updated.

Last update: 2024-10-20 07:59:12 UTC


README

The Payum extension. It provides PAYONE payment integration

Getting started

Register factory and gateway with the PayumBuilder

use Payum\Core\GatewayFactoryInterface;
use Valiton\Payum\Payone\PayoneGatewayFactory;

$payumBuilder->addGatewayFactory('payone', function(array $config, GatewayFactoryInterface $coreGatewayFactory) {
    return new PayoneGatewayFactory($config, $coreGatewayFactory);
});

$payumBuilder->addGateway('payone', [
    'factory' => 'payone',
    'merchant_id' => 123456, // change this
    'sub_account_id' => 567890 // change this
    'portal_id' => 6543276, // change this
    'key' => '1Q2W3E4R5T6' // change this
]);

The Payone gateway needs some additional fields to work properly

$payment = new Payment();
$payment->setDetails([
    // add required key value pairs for the payment method
]);

Please see the Payment Method Documentation for Payment Method specific fields.

Symfony Integration

Payum Bundle 2.0 requires at least Symfony 2.8. If you want to use an older version of Symfony take a look at http://stackoverflow.com/questions/35896718/register-custom-gateway-with-payumbundle/35900365

Install the Payum Bundle and set it up according to it's documentation.

composer require payum/payum-bundle ^2.0

Register the Payone Gateway Factory as a service

# app/config/services.yml

services:
    app.payum.payone.factory:
        class: Payum\Core\Bridge\Symfony\Builder\GatewayFactoryBuilder
        arguments: [Valiton\Payum\Payone\PayoneGatewayFactory]
        tags:
            - { name: payum.gateway_factory_builder, factory: payone }

And configure your credentials for the gateway

# app/config/config.yml

payum:
    gateways:
        payone:
            factory: payone
            merchant_id: 123456 # change this
            sub_account_id: 567890 # change this
            portal_id: 6543276 # change this
            key: 1Q2W3E4R5T6 # change this

Now you can retrieve the gateway from the payum service

$gateway = $this->get('payum')->getGeteway('payone');

Transaction Status URL (Merchant Backend)

In the PAYONE Merchant Interface (PMI) a TransactionStatus URL have to be defined. That transaction URL have to be a non-dynamic notify URL. The Payum Bundle for symfony provides therefor a route payum_notify_do_unsafe. That takes a static parameter gateway instead of a dynamic token.

.../payment/notify/unsafe/{gateway}

For PAYONE the gateway would be payone.

.../payment/notify/unsafe/payone

Add this URL as the TransactionStatus URL to the PMI.

License

The MIT License (MIT)

Copyright (c) 2016 Valiton GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.