Get Started


Note : We assume you followed all steps in basic get it started and your basic configuration same as described there.

Download libraries

Run the following command:

$ php composer.phar require payum/jms-payment-bridge

Configure context

By default PayumBundle knows nothing about jms payment bridge. To make payum be aware of it you have to add its factory. Let's suppose you have AcmePaymentBundle. You have to add factory inside its build method:

namespace Acme\PaymentBundle;

use Payum\Bridge\JMSPayment\DependencyInjection\Factory\Gateway\JmsGatewayFactory;
use Payum\Bundle\PayumBundle\DependencyInjection\PayumExtension;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\HttpKernel\Bundle\Bundle;

class AcmePaymentBundle extends Bundle
     * {@inheritDoc}
    public function build(ContainerBuilder $container)
        /** @var  PayumExtension $payumExtension */
        $payumExtension = $container->getExtension('payum');

        $payumExtension->addGatewayFactory(new JmsGatewayFactory);

Once you added the factory you can configure payum context.

    secret:                                               %kernel.secret%

    username:                                             %paypal.express_checkout.username%
    password:                                             %paypal.express_checkout.password%
    signature:                                            %paypal.express_checkout.signature%
    debug:                                                true

        JMS\Payment\CoreBundle\Entity\Payment: { doctrine: orm }
            Acme\PaymentBundle\Entity\PayumSecurityToken: { doctrine: orm }

            jms_payment_plugin: ~

Attention: You have to changed your_payment_name to something more descriptive and domain related, for example post_a_job_with_paypal.

Not so hard so far, let's continue.

Prepare payment

Now we are ready to prepare the payment. Here we set price, currency, cart items details and so. Please note that you have to set details in the jms plugin specific format.


public function prepareAction(Request $request)
    $gatewayName = 'your_payment_name';

    $paymentInstruction = new PaymentInstruction(

    $payment = new Payment($paymentInstruction, 100);


    $captureToken = $this->get('')->createCaptureToken(


    //the state manipulations  is needed for saving changes in extended data.
    $oldState = $payment->getPaymentInstruction()->getState();




    return $this->redirect($captureToken->getTargetUrl());

That's it. After the payment done you will be redirect to purchase_done action. Check bundle's chapter about done action to find out how this done action could look like.

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