ePay Payment Plugin for Vendure

A Vendure plugin that integrates ePay payment gateway for processing online payments.

Features

• Process payments through ePay gateway
• Store payment transaction details
• Handle payment webhooks

Installation

npm install @allecosystems/epay

Usage

Add the plugin to your Vendure configuration:

import { EpayPlugin } from '@allecosystems/epay';

export const config: VendureConfig = {
  // ... other config
  plugins: [
    EpayPlugin.init({
      // Plugin options here
    }),
  ],
};

Configuration

The plugin accepts the following configuration options:

• apiKey: Your ePay API key
• Point of sale ID: Your ePay Point of sale ID
• PAI URL: Keep it at the default https://payments.epay.eu/public/api/v1/cit
• Webhook URL: Must be your VENDURE_URL/epay/webhook
• Success URL: The order success page of your storefront
• Failure URL: The order failure page of your storefront

Frontend Integration

When a payment is initiated with the ePay payment method, the plugin returns a redirect URL. Your frontend must redirect the customer to this URL to complete the payment.

After calling addPaymentToOrder, check the returned order's last payment for redirect information:

// Get the last payment from the order
const payments = order?.payments || [];
const lastPayment = payments[payments.length - 1];

// Check if payment requires redirect
if (lastPayment?.metadata?.public?.requiresRedirect) {
  const redirectUrl = lastPayment.metadata.public.redirectUrl;
  
  if (redirectUrl) {
    // Redirect customer to ePay payment page
    window.location.href = redirectUrl;
  }
}

Payment Object Structure

The payment metadata contains:

• lastPayment.metadata.public.requiresRedirect - Boolean indicating if redirect is needed
• lastPayment.metadata.public.redirectUrl - The ePay payment URL to redirect to

Payment Flow

1. Customer initiates payment with addPaymentToOrder using method 'epay-payment'
2. Plugin creates ePay session and returns redirect URL in payment metadata
3. Frontend redirects customer to ePay payment page
4. Customer completes payment on ePay's secure page
5. ePay redirects customer back to your configured success/failure URLs
6. ePay sends webhook to confirm payment status

License

GPL-3.0-or-later

Support

For any support inquiries please contact Alleco Systems at [email protected]