HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

Payment plugins

Describes the PaymentPlugin interface that provides an interface to the payment processing system for abstraction APIs in Optimizely Commerce (PaaS).

The Payment plugin is available when building solutions with the payment processing parts of Optimizely Commerce (PaaS). 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 (PaaS) 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 (PaaS) 11-13 example

PaymentProcessingResult ProcessPayment(IOrderGroup orderGroup, IPayment payment)

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

Commerce (PaaS) 10.2.2-10.x example

bool ProcessPayment(IPayment payment, ref string message);