Paypal payment module for Vue Storefront

Paypal payment module for Vue Storefront

PayPal Payment extension for vue-storefront, by Develo Design.

Vue Storefront PayPal Payment Extension

PayPal Payment module for vue-storefront, by Develo Design.



By hand (preferer):

$ git clone [email protected]:develodesign/vsf-payment-paypal.git ./vue-storefront/src/modules/paypal

Add the following also to your config/local.json need set paypal.env to sandbox or production.

"paypal": {
  "env": "sandbox",
  "endpoint": {
    "create": "http://localhost:8080/api/ext/payment-paypal/create",
    "execute": "http://localhost:8080/api/ext/payment-paypal/execute"

Registration the Paypal module

Open in you editor ./src/modules/index.ts

import { Paypal } from './paypal'

export const registerModules: VueStorefrontModule[] = [

PayPal payment API extension

Install additional extension for vue-storefront-api:

$ cp -f ./API/paypal ../vue-storefront-api/src/api/extensions/

Go to api config ./vue-storefront-api/config/local.json and register the Paypal Api extension:

"registeredExtensions": [

And add the paypal settings to extensions key:

  "extensions": {
    "mailchimp": {
    "paypal": {
      "api": "",
      "client": "",
      "secret": ""

Paypal payment Checkout Review

Under your theme components/core/blocks/Checkout/OrderReview.vue add the following import to your script

import PaypalButton from 'src/modules/paypal/components/Button'

export default {
  components: {
  data () {
    return {
      payment: this.$store.state.checkout.paymentDetails

And to you template add the paypal button before button-full:

<paypal-button v-if="payment.paymentMethod === 'vsfpaypal'"/>
  {{ $t('Place the order') }}

Magento2 integration

This API extension execute payment to PayPal gateway. It use develodesign/m2-paypal-payment The custom Paypal payment method for Magento2 composer module so you have to install it in your Magento instance.


Also we can use option for more customizable PayPal button view. For more info PayPal.

"paypal": {
  "style": {
    "size": "small",
    "color": "gold",
    "shape": "pill"

Github Repository