Configure gateways in backend

In get it started we showed you how to configure gateways in the code. Sometimes you may asked to store gateways (mostly gateway credentials) to a database for example. So the admin can edit them in the backend. Here's the basic example how to do it in plain php.


First we have to create an entity where we store information about a gateway. The model must implement Payum\Core\Model\GatewayConfigInterface.

Note: In this chapter we use DoctrineStorage.

namespace Acme\Payment\Entity;

use Doctrine\ORM\Mapping as ORM;
use Payum\Core\Model\GatewayConfig as BaseGatewayConfig;

 * @ORM\Table
 * @ORM\Entity
class GatewayConfig extends BaseGatewayConfig
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="IDENTITY")
     * @var integer $id
    protected $id;

Now, we have to create a storage for it and build payum with gateway config storage.


use Payum\Core\Bridge\Doctrine\Storage\DoctrineStorage;
use Payum\Core\PayumBuilder;
use Payum\Core\Payum;
use Payum\Core\Registry\DynamicRegistry;

// $objectManager is an instance of doctrine object manager.

$gatewayConfigStorage = new DoctrineStorage($objectManager, 'Acme\Payment\Entity\GatewayConfig');

/** @var Payum $payum */
$payum = (new PayumBuilder())


Store gateway config


include __DIR__.'/config.php';

/** @var \Payum\Core\Storage\StorageInterface $gatewayConfigStorage */

$gatewayConfig = $gatewayConfigStorage->create();
    'username' => 'EDIT ME',
    'password' => 'EDIT ME',
    'signature' => 'EDIT ME',
    'sandbox' => true,


Use gateway

// prepare.php

include __DIR__.'/config.php';

/** @var \Payum\Core\Payum $payum */
$gateway = $payum->getGateway('paypal');

Supporting Payum

Payum is an MIT-licensed open source project with its ongoing development made possible entirely by the support of community and our customers. If you'd like to join them, please consider:

Last updated