Ucommerce includes full API reference documentation and lots of helpful articles to help you build your e-commerce site as effortlessly as possible.

Topics Payment Providers

Setup Ucommerce to Include SagePay as a Payment Method

Ucommerce comes with built-in support for SagePay payments. This guide will walk you through getting Ucommerce to work with SagePay for payment processing. Ucommerce integrates with SagePay using server integration.

Settings in Ucommerce

Add a new payment method, under “Ucommerce –> Settings –> Orders –> Payment Methods”. You can call it whatever you like, here I have used “SagePay”.


Click the newly created node and select “SagePay” in the Service drop down list. Fill out the rest of the required information, like where it’s available from under the “Access” tab, pricing and the language tabs. When done click “Save”.


That’s everything in the Ucommerce interface.

Settings in SagePay Administration Panel

You can learn more about how to configure SagePay in the SagePage Help Centre.

Setting properties for the PayEx

Under "the common tab" on your payment method, you'll find the different fields to configure the details related to the payment gateway. These fields for SagePay includes:

  • TestMode
  • Vendor
  • TxType
  • SuccessUrl
  • FailureUrl
  • NotificationUrl
  • AbortUrl

Finding testmode

Testmode indicates whether your site is in testing or live environment.

Finding vendor

Vendor is the name you use when you login with SagePay.


Finding TxType

Indicates how the payment is processed. Valid options are:


The transaction type depends on the plan setup with SagePay and your concrete needs, so you need to consult them for the right type.

Finding successUrl

URL the customer is redirected to once the payment is accepted.

Finding abortUrl

URL the customer is redirect to if she cancels payment authorization.

Finding FailureUrl

URL the customer is redirect to if the payment could not be authorized.

Finding notificationUrl

Ucommerce will generate a callback URL for internal use. Leave the setting at (auto) unless you need to handle callbacks yourself.

Executing a Pipeline on Callback

After each payment has been made, SagePay will signal back to Ucommerce with the information. At that time we have the ability to run a pipeline. Usually you would have the checkout pipeline run, but you can configure any one you want.


Now the default pipeline that comes with Ucommerce will be run after each successful callback. This sets the Basket to an Order, gives it an OrderNumber, and other things.

Optional: Enable Acquire, Cancel, and Refund in Ucommerce Back Office

To be able to acquire, cancel, and refund payments you need to enable two pipeline tasks in the ToCompletedOrder pipeline and ToCancelled pipeline.

The pipeline configuration is found in /umbraco/ucommerce/pipelines.






Testmode – Make sure test mode if turned off when going live.