1. Installation

We assume you’re familiar with Composer, a dependency manager for PHP. Use the following command to add the bundle to your composer.json and download package.

If you have Composer installed globally.

$ composer require "sylius/omnipay-bundle"

Otherwise you have to download .phar file.

$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar require "sylius/omnipay-bundle"

1.1. Adding required bundles to the kernel

First, you need to enable the bundle inside the kernel.

<?php

// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new FOS\RestBundle\FOSRestBundle(),
        new JMS\SerializerBundle\JMSSerializerBundle($this),

        new Sylius\Bundle\OmnipayBundle\SyliusOmnipayBundle()
    );
}

1.2. Configuration

Put this configuration inside your app/config/config.yml.

sylius_omnipay:
    gateways:
        AuthorizeNet_AIM:            # gateway name, use anyone
            type: AuthorizeNet_AIM   # predefined list of types, read father for explanation
            label: Authorize.Net AIM # how is gateway will be displayed in a form, etc.
        AuthorizeNet_SIM:
            type: AuthorizeNet_SIM
            label: Authorize.Net SIM
        Stripe:
            type: Stripe
            label: Stripe
            mode: true                # optional, default: false, activate test mode
            active: false             # optional, default: true, does this gateway is active
            options:                  # optional, predefine list of options to get work with gateway
                apikey: secretapikey
        PayPal_Express:
            type: PayPal_Express
            label: PayPal Express
        PayPal_Pro:
            type: PayPal_Pro
            label: PayPal Pro

1.3. Implemented gateways

The following gateways are already implemented:

  • 2Checkout
  • Authorize.Net AIM
  • Authorize.Net SIM
  • CardSave
  • Dummy
  • GoCardless
  • Manual
  • Netaxept (BBS)
  • PayFast
  • Payflow Pro
  • PaymentExpress (DPS) PxPay
  • PaymentExpress (DPS) PxPost
  • PayPal Express Checkout
  • PayPal Payments Pro
  • Pin Payments
  • Sage Pay Direct
  • Sage Pay Server
  • Stripe
  • WorldPay

The list above is always growing. The full list of supported gateways can be found at the Omnipay github repository.