PayPal Plugin

Sylius Core Team’s plugin for PayPal Commerce Platform - the newest and most advanced of PayPal solutions.

Why should I use PayPal in my online business?

• one of the most popular payment methods in the world;
• worldwide network of 280+ millions consumers and 24+ millions merchants;
• bank payouts are available in U.S., U.K., the E.U., Australia, and Canada;
• PCI DSS and 3DS 2.0 compliance
• full risk management, incl. customisable fraud tools & insight and dispute resolution via dynamic APIs.

What does this plugin give me?

• official payment integration developed and maintained by the Sylius Core Team;
• global support for over 100 currencies across 200+ markets;
• two-side operations between Sylius & PayPal administration panels (payments, refunds, reports, etc.);
• better conversion thanks to direct checkout from both product & cart page;
• support for all credit & debit cards;
• popular regional payment methods, i.e. iDeal, SEPA, Sofort, eps, Griopay or Przelewy24;
• direct PayPal transactions with PayPal wallet

Installation

1. Run

   composer require sylius/paypal-plugin

2. Import routes

   # config/routes/sylius_shop.yaml
   
   sylius_paypal:
       resource: "@SyliusPayPalPlugin/Resources/config/shop_routing.yaml"
       prefix: /{_locale}
       requirements:
           _locale: ^[A-Za-z]{2,4}(_([A-Za-z]{4}|[0-9]{3}))?(_([A-Za-z]{2}|[0-9]{3}))?$
   
   # config/routes/sylius_admin.yaml
   
   sylius_paypal_admin:
       resource: "@SyliusPayPalPlugin/Resources/config/admin_routing.yml"
       prefix: /admin
   
   # config/routes.yaml
   
   sylius_paypal_webhook:
       resource: "@SyliusPayPalPlugin/Resources/config/webhook_routing.yaml"

3. Import configuration

   # config/packages/_sylius.yaml
   
   imports:
       # ...
       - { resource: "@SyliusPayPalPlugin/Resources/config/config.yaml" }

4. Override Sylius' templates

   cp -R vendor/sylius/paypal-plugin/src/Resources/views/bundles/* templates/bundles/

5. Copy and apply migrations

   cp -R vendor/sylius/paypal-plugin/migrations/ src/Migrations/
   bin/console doctrine:migrations:migrate -n
   

BEWARE!

To make PayPal integration working, your local Sylius URL should be accessible for the PayPal servers. Therefore you can add the proper directive to your /etc/hosts (something like 127.0.0.1 sylius.local) or use a service as ngrok.

Sandbox vs Live

By default, plugin operates in the sandbox mode. I means all the transactions would be used with the sandbox URLs and code. To change it, you need to configure the plugin properly:

sylius_pay_pal:
    sandbox: false

You can, for example, configure it only for the production environment (e.g. in config/packages/prod/sylius_pay_pal_plugin.yaml).

PayPal reports

To be able to download reports about your payouts, you need to have reports feature enabled on your PayPal account. Also, it's required to configure SFTP account and set its data in .env file.

1. Log in to your PayPal account

2. Enter the profile settings

   

3. Pass to SFTP accounts panel

   

4. Create a new SFTP account

   

5. Configure username and password in payment method's configuration

Processing payments

Plugin provides sylius:pay-pal-plugin:complete-payments command, that should be configured as cron job on the server. It iterates over processing PayPal payments and completes them if the order is completed in PayPal.

Development

git clone [email protected]:Sylius/PayPalPlugin.git
(cd tests/Application && yarn install)
(cd tests/Application && yarn build)
(cd tests/Application && bin/console assets:install)
(cd tests/Application && bin/console doctrine:database:create)
(cd tests/Application && bin/console doctrine:migrations:migrate -n)

Opening Sylius with your plugin

• Using test environment:

  (cd tests/Application && APP_ENV=test bin/console sylius:fixtures:load)
  (cd tests/Application && APP_ENV=test symfony serve)

• Using dev environment:

  (cd tests/Application && bin/console sylius:fixtures:load)
  (cd tests/Application && symfony serve)