Payment Providers
Accepting payments via Payment Providers in Umbraco Commerce.
Payment Providers are how Umbraco Commerce is able to accept multiple different methods of payment on a Site. Their job is to provide a standard interface between third-party payment gateways and Umbraco Commerce itself. This is done in order to allow the passing of information between the two platforms.
How the integrations work is often different for each payment gateway. The Umbraco Commerce Payment Providers add a flexible interface that should be able to work with most payment gateways.
An example of a bare-bones Payment Provider would look something like this:
[PaymentProvider("my-payment-provider-alias", "My Payment Provider Name", "My Payment Provider Description")]
public class MyPaymentProvider : AsyncPaymentProviderBase<MyPaymentProviderSettings>
{
public MyPaymentProvider(UmbracoCommerceContext umbracoCommerce)
: base(umbracoCommerce)
{ }
...
}
public class MyPaymentProviderSettings
{
[PaymentProviderSetting(Name = "Continue URL",
Description = "The URL to continue to after this provider has done processing. eg: /continue/",
SortOrder = 100)]
public string ContinueUrl { get; set; }
...
}
All Payment Providers inherit from a base class
AsyncPaymentProviderBase<TSettings>. TSettings is the type of a Plain Old Class Object (POCO) model class representing the Payment Providers settings. The class must be decorated with PaymentProviderAttribute which defines the Payment Providers alias, name and description, and can also specify an icon to be displayed in the Umbraco Commerce backoffice.The settings class consists of a series of properties, each decorated with a
PaymentProviderSettingAttribute defining a name, description, and possible angular editor view file. These will all be used to dynamically build an editor interface for the given settings in the backoffice.There are two main responsibilities of a Payment Provider, and those are:
- Payment Capture - Capturing the initial Order payment and finalizing the Order.
- Payment Management - Managing a payment post Order finalization, such as being able to Capture authorized payments or Refunding captured payments.
The Payment Capture workflow can be the hardest part of a Payment Provider. This is due to the fact that no two payment gateways are alike. Therefore it can be difficult to figure out how best to implement the gateway into the provider format.
Generally, there are three methods within a Payment Provider that you may need to implement, and each one has a specific responsibility.
- GenerateForm - The
GenerateFormmethod is responsible for generating an HTML form that will redirect the customer to the given payment gateway payment form. In this method you may need to communicate with the payment gateway in order to initialize a payment, letting the payment gateway know how much to capture. This often results in some kind of code or redirect URL being returned which will need to be embedded into the generated form. The generated form is then usually displayed on a checkout Review page, the last page before payment is captured and will have an implementer-defined Continue to Payment button to submit the form and redirect the customer to the gateway. - ProcessCallback - The
ProcessCallbackmethod is responsible for handling the response coming back from the payment gateway and processing whether the payment was successful or not. This can sometimes occur synchronously, if the payment gateway sends information back as part of the confirmation page redirect, or can occur asynchronously if the payment gateway sends the information back via an out-of-band webhook request. - GetOrderReference - The
GetOrderReferencemethod is responsible for extracting an order reference number from a request when the payment gateway uses an asynchronous webhook to finalize an Order and it uses a global webhook URL strategy for all notifications rather than a notification URL per transaction. Where a webhook URL can be passed per transaction, then Umbraco Commerce provides you with a unique callback URL you can register with the gateway that already identifies the order reference as part of the URL parameters, making implementing this method unnecessary.
* denotes a required method implementation.
What follows is a generalized diagram in order to help in visualizing when each of these methods is called within a regular checkout flow.
Payment Provider Capture Workflow
In addition to the initial payment capture flow, Payment Providers can also be set up to manage the payment post-checkout. This could be Capturing Authorized transactions or Refunding Captured transactions.
These features are optional and not required for Payment Provider developers to implement. They allow store owners to manage payments directly in the backoffice rather than through the payment gateway's portal when performing these types of actions.
The implementable management methods are:
- FetchPaymentStatus - The
FetchPaymentStatusmethod communicates with the 3rd party payment gateway in order to fetch the current status of the given transaction. - CapturePayment - The
CapturePaymentmethod communicates with the 3rd party payment gateway to capture a previously authorized payment associated with the given transaction. - CancelPayment - The
CancelPaymentmethod communicates with the 3rd party payment gateway to cancel a previously authorized payment associated with the given transaction. - RefundPayment - The
RefundPaymentmethod communicates with the 3rd party payment gateway to refund a previously captured payment associated with the given transaction.
For each implemented method above, developers should also implement a corresponding boolean property returning a
true value. This is to let Umbraco Commerce know that the given feature is supported by the Payment Provider.- CanFetchPaymentStatus
- CanCapturePayments
- CanCancelPayments
- CanRefundPayments
For all implemented methods of a Payment Provider, all method return types support the returning of additional Meta Data. This is to allow Payment Providers to capture and store relevant information. This information will aid the provider in doing its job, or for storing useful reference information to display for the retailer.
Any returned Meta Data from a Payment Provider method will be stored against the Order in its Properties collection. Should you need to retrieve these values from other areas of the Payment Provider, you can use the passed-in Orders Properties collection.
As Meta Data is stored in Orders Properties collections, it is recommended to prefix your Meta Data keys with the Payment Providers alias. This is done to prevent possible conflicts.
The Meta Data that is returned from the Payment Provider is useful for the retailer. The Payment Provider can also be used to display Meta Data descriptions and information in the backoffice. This is done by exposing a
TransactionMetaDataDefinitions property consisting of a list of TransactionMetaDataDefinition values. Each of the values defines the alias, name and optional description of a Meta Data entry.public override IEnumerable<TransactionMetaDataDefinition> TransactionMetaDataDefinitions => new[]{
new TransactionMetaDataDefinition("stripeSessionId", "Stripe Session ID"),
new TransactionMetaDataDefinition("stripePaymentIntentId", "Stripe Payment Intent ID"),
new TransactionMetaDataDefinition("stripeChargeId", "Stripe Charge ID"),
new TransactionMetaDataDefinition("stripeCardCountry", "Stripe Card Country")
};
Transaction Meta Data
Last modified 2mo ago