Setup Ucommerce to include Global Collect as a Payment Method

Ucommerce comes with built-in support for Global Collect payments. This guide will help you to setup your installation to use Global Collect as a payment method.

Configuration of account for Global Collect

When you need to setup your global collect account, you need to involve their support to setup the required API calls, IpCheck/ClientAuthentication and your account needs to be setup to use delayed settlement.

Capabilities

Global Collect is one of the payment providers which support the Acquire, Cancel, and Refund functionality. You can see how to enable this here.

NOTE: Refunding functionality is not supported when using PayPal through Global Collect.

Settings in Ucommerce backend

If you haven't completed the steps from the General Setup of Payment Methods in Ucommerce document you need to do that before you move on.

When the payment method is created and saved as described in here. The back-end displays the different settings you can set for Global Collect.

Configuration settings

You now need to adjust the properties for the payment method. Under common tab, you'll find the different properties available to set. They should be set accordingly to the descriptions in the table below.

Those are the settings needed in the backend.

Creating the payments

When your client walks through the checkout flow, you must make them select between different payment options for the payment. paymentProductId in the configuration sets the default option if you will only allow the one. Otherwise you must supply different information to get the available options. Those can be achieved by using the service Ucommerce.Transactions.Payments.GlobalCollect.IGlobalCollectService.

    Ucommerce.Api.ITransactionLibrary transactionLibrary = ObjectFactory.Instance.Resolve<Ucommerce.Api.ITransactionLibrary>();
    Ucommerce.Infrastructure.Globalization.ILanguageCodeMapper langaugeCodeMapper = ObjectFactory.Instance.Resolve<Ucommerce.Infrastructure.Globalization.ILanguageCodeMapper>();
    
    Ucommerce.Transactions.Payments.GlobalCollect.IGlobalCollectService globalCollectService = ObjectFactory.Instance.Resolve<Ucommerce.Transactions.Payments.GlobalCollect.IGlobalCollectService>();
    
    var paymentMethod = PaymentMethod.FirstOrDefault(x => x.Name == "Global Collect");
    
    var basket = transactionLibrary.GetBasket(false);
    var currencyCode = basket.BillingCurrency.ISOCode;
    var countryCode = basket.BillingCurrency.ISOCode;
    var languageCode = langaugeCodeMapper.Convert(basket.CultureCode);
    
    IEnumerable<IPaymentProduct> paymentOptions = globalCollectService.GetPaymentProducts(paymentMethod, languageCode, countryCode, currencyCode);
    
    

When the user has made his choice, you must save it on the payment for the order BEFORE you request payments, which will redirect the customer:

    transactionLibrary = ObjectFactory.Instance.Resolve<Ucommerce.Api.ITransactionLibrary>();
    
    Payment payment = transactionLibrary.CreatePayment(paymentMethod.PaymentMethodId, -1, false, true);
    payment["PaymentProductId"] = paymentMethod.PaymentMethodId.ToString();
    
    transactionLibrary.ExecuteBasketPipeline();
    var paymentUrl = transactionLibrary.GetPaymentPageUrl(transactionLibrary.GetBasket(false).Payments.First());
    
    //redirect customer from paymentUrl
    
    

Configuring a language code fallback configuration

Global Collect only supports a very specific list of language codes. To accommodate this, a new service has been added.

    ObjectFactory.Instance.Resolve<Ucommerce.Infrastructure.Globalization.ILanguageCodeMapper>();
    
    

The default implementation can be configured given a dictionary where the language code mapped from is the key, and the language code mapped to is the value.

    
    <component id="GlobalCollectLanguageCodeMapper"
    		   service="Ucommerce.Infrastructure.Globalization.ILanguageCodeMapper, Ucommerce.Infrastructure"
    		   type="Ucommerce.Infrastructure.Globalization.LanguageCodeMapper, Ucommerce.Infrastructure">
    	<parameters>
    		<map>
    			<dictionary>
    				<entry key="nb">no</entry>
    			</dictionary>
    		</map>
    	</parameters>
    </component>
    

The default configuration will map Bokmål "nb" to the inclusive code "no" for Norwegian.

To add configurations, you can either override the complete component, by copying the configuration to "custom.config", and then add the additional codes mappings.

You can also extend the mappings using a partial component like this:

    
    <partial-component id="GlobalCollectLanguageCodeMapper">
    	<parameters>
    		<map>
    			<dictionary>
    				<entry key="nn">no</entry>
    			</dictionary>
    		</map>
    	</parameters>
    </partial-component>
    

Existing keys will be overridden, while new keys will be added.