Vendure Payment Extensions

view v0.4.0 on npmChangelog

npm install @pinelab/vendure-plugin-payment-extensions

Vendure Payment Extensions

This Vendure plugin allows an Order to be settled without upfront payment.

• isCustomerInGroupPaymentChecker: Verifies if the customer attached to an order belongs to a specified group to allow configured payment method.
• settleWithoutPaymentHandler: This handler simply transitions the Payment to settled state.

Have a payment extension in mind? Create a Pull Request on our repository and we will maintain your feature in this plugin!

Getting started

1. Add the plugin to your vendure-config.ts

import { PaymentExtensionsPlugin } from '@pinelab/vendure-plugin-payment-extensions';

...
plugins: [
  PaymentExtensionsPlugin
... // your other plugins
]

2. Start Vendure, log in, and navigate to Settings > Payment Methods

3. Choose isCustomerInGroupPaymentChecker as the Payment eligibility checker, and then select the CustomerGroup whose members are expected to be eligible for this PaymentMethod.

4. Choose settleWithoutPaymentHandler as Payment handler

5. Click Save

Test the plugin

1. Place a test order. The PaymentMethod you created in the Getting Started section should be listed under eligiblePaymentMethods for Customers who belong to the designated CustomerGroup. For other customers, it should not be available.