HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Payment plugins

This topic describes the PaymentPlugin interface that provides an interface to the payment processing system for abstraction APIs.

How it works

The Payment plugin of Optimizely Commerce is available when building solutions with the payment processing parts of Optimizely Commerce. A payment type is passed to the payment plugin, which executes the payment transaction via the payment system. One payment type is associated with each payment plugin.

📘

Note

Classes in this topic are available in the EPiServer.Commerce.Order namespace, which contains IPaymentPlugin.

IPaymentPlugin is an improvement over IPaymentGateway, which supports abstraction APIs and Serializable Carts as well. The activities below will be carried out following Payment gateways exactly:

  • Payment plugin properties
  • Using built-in payment
  • Creating a custom payment plugin

There is one important difference between IPaymentPlugin and IPaymentGateway: IPaymentPlugin uses IPayment as a parameter, while IPaymentGateway uses Payment as a parameter.

Example [New in Commerce 14]

PaymentProcessingResult ProcessPayment(IOrderGroup orderGroup, IPayment payment)

A simple implementation of the Adyen payment gateway is available in the "Quicksilver" Commerce reference sample project on GitHub.

Commerce 11-13 example

PaymentProcessingResult ProcessPayment(IOrderGroup orderGroup, IPayment payment)

Using IPaymentPlugin, Optimizely Commerce provides sample code for PayPal, DIBS and DataCash. See Payment providers.

Commerce 10.2.2-10.x example

bool ProcessPayment(IPayment payment, ref string message);

Did this page help you?