Skip to main content

UPG

Integration only for Callisto online stores

This page only contains instructions for integrating UPG in Callisto online stores. The following instructions are not valid for Ceres online stores!

UPG is a fully integrated payment solution for e-commerce offered by Creditreform.

1. Important notes

This chapter provides you with important information about integrating the payment provider in plentymarkets.

UPG and store design

Note that the following conditions must be met before integrating UPG successfully in plentymarkets:

  • Use of the standard design Callisto (Version 2 or higher)

  • Use of the individual order process

  • Safe handling of the plentymarkets CMS

  • Experience with integrating payment providers

Payment process

Depending on which payment method is selected, customers will either have to enter their details into an iframe or they will be redirected to a UPG page after confirming their order. If customers are redirected, they will need to enter their details for the selected payment method there. Once customers have entered the data and confirmed the payment, they will be directed back to your online store. Customers are currently redirected if they select the payment methods Sofortbanking or PayPal (as of 1st June 2016).

2. Registering with UPG

Register with UPG before you carry out the relevant settings in plentymarkets. To do so, contact UPG.

3. Setting up UPG in plentymarkets

Proceed as described below to set up the interface to UPG.

Setting up the interface to UPG:

  1. Go to System » Orders » Payment » Methods.

  2. Place a check mark next to the setting Also show inactive.

  3. Open the folder DE.

  4. Click on UPG.
    → The Settings tab will open.

  5. Click on the Interface tab.

  6. Expand the client.

  7. Carry out the settings as desired. Pay attention to the information given in Table 1.

  8. Save the settings.

Table 1. setting up the interface to UPG
Setting Explanation

Test mode

Activate the test mode to test the exchange of data between plentymarkets and UPG without the need for actual transactions.

Seller ID

Enter the seller ID that you received from UPG.

Private key

Enter the private key that you received from UPG.

Shop ID

Enter the store ID that you received from UPG.

4. Activating the payment method

Set up and activate the UPG payment method in the Settings tab of the payment method. In addition, check the settings for Permitted payment methods in the customer classes and for Blocked payment methods in the shipping profiles. You need to select the payment methods that you want to offer in your UPG account.

5. Carrying out settings in the UPG account

Enter the integration URLs and select the payment methods that you want to offer with UPG. Do this in your UPG account. Other factors such as fraud rules also influence whether a payment method is offered to specific customers. Your UPG account includes an area for the integration. There, select the payment methods that you would like to offer and enter two URLs. The URLs must be structured as follows:

6. Displaying UPG in the online store

This section explains how to display UPG in the online store of plentymarkets. This is done in several steps. To do so, edit the Order confirmation category first.

No changes to the active design

Do not make changes to your active design. Before making changes to the design, make a backup copy so that you can restore the original state of the design.

6.1. Customising the order confirmation

Modify the category Order confirmation to make the payment methods offered through UPG available to customers of your online store.

Adding the payment method selection to the order confirmation stage:

  1. Go to Item » Categories.

  2. Open the design’s folder, e.g. the folder for Callisto Light 3.

  3. Open the category Order confirmation.

  4. Click on the Description 1 tab.

  5. Search for the div class="panel-body" container.

  6. Replace the content of this div container with the example code below.

  7. Save the settings.

<div class="row margin-bottom-15">
	{% if $CheckoutMethodOfPaymentID == 5500 %}
			{% $_crefoFrame = Container_CheckoutCrefoPay() %}
		{% endif %}
		{% if strlen($_crefoFrame) %}
			{% if $_crefoFrame == "PENDING" || $_crefoFrame == "ACCEPTED" %}
			<div class="col-lg-6 col-md-6 col-sm-12">
				<h4>Thank you for your order!</h4>

				<hr>

				<p>
					Your order was transmitted successfully. You will receive an order confirmation by email.
					You can also check the order overview to find details regarding your orders.
				</p>
				<p>
					{% if $_crefoFrame == "PENDING"%}
					Your payment is being processed. Payment status => $_crefoFrame
					{% else %}
					Your payment has been processed. Payment status => $_crefoFrame
					{% endif %}
				</p>

				<div class="row">
					<div class="col-lg-6 col-md-6 col-sm-6">
						<a class="btn btn-default btn-block" href="{% Link_Home() %}">
							<span class="glyphicon glyphicon-home" aria-hidden="true"></span> Back to homepage
						</a>
					</div>

					<div class="col-lg-6 col-md-6 col-sm-6 margin-top-xs-1">
						<a class="btn btn-primary btn-block" href="{% Link_Home() %}?AccountShow=OrderOverView&OrderID=$_confirm->OrderID">
							<span class="glyphicon glyphicon-eye-open" aria-hidden="true"></span> Go to order overview
						</a>
					</div>
				</div>
			</div>
			{% else %}
				$_crefoFrame
			{% endif %}
		{% else %}

	<div class="col-lg-6 col-md-6 col-sm-12">
		<h4>Thank you for your order!</h4>

		<hr>

		<p>
			Your order was transmitted successfully. You will receive an order confirmation by email.
			You can also check the order overview to find details regarding your orders.
		</p>

		<div class="row">
			<div class="col-lg-6 col-md-6 col-sm-6">
				<a class="btn btn-default btn-block" href="{% Link_Home() %}">
					<span class="glyphicon glyphicon-home" aria-hidden="true"></span> Back to homepage
				</a>
			</div>

			<div class="col-lg-6 col-md-6 col-sm-6 margin-top-xs-1">
				<a class="btn btn-primary btn-block" href="{% Link_Home() %}?AccountShow=OrderOverView&OrderID=$_confirm->OrderID">
					<span class="glyphicon glyphicon-eye-open" aria-hidden="true"></span> Go to order overview
				</a>
			</div>
		</div>
	</div>
	{% endif %}
</div>

6.2. Editing CheckoutCustomerInvoiceAddress

A small change in the CheckoutCustomerInvoiceAddress template is necessary, to display only those address values that are valid for CrefoPay.

Editing CheckoutCustomerInvoiceAddress:

  1. Go to CMS » Web design.

  2. Open the folder Layout » Checkout.

  3. Open the template CheckoutCustomerInvoiceAddress.

  4. Search for the line of code <option value="3"{% if $FormOfAddressID == 3 %} selected{% endif %}>Familie</option>.

  5. Delete this line of code from the template.

  6. Save the settings.

6.3. Editing CheckoutCustomerShippingAddress

Edit the template CheckoutCustomerShippingAddress in the same way.

Editing CheckoutCustomerShippingAddress:

  1. Go to CMS » Web design.

  2. Open the folder Layout » Checkout.

  3. Open the template CheckoutCustomerShippingAddress.

  4. Search for the line of code <option value="3"{% if $FormOfAddressID == 3 %} selected{% endif %}>Familie</option>.

  5. Delete this line of code from the template.

  6. Save the settings.

6.4. Setting up name validation for B2B customers

When using the payment provider UPG for B2B orders, the first name and last name of the customer must be shown on the invoice address. The template variables ValidateInvoiceAddressFirstNameIfCompany and ValidateInvoiceAddressLastNameIfCompany allow you to validate first and last names of B2B customers for invoice addresses if the company name was entered in the Company text field.

Setting up name validation for B2B customers:

  1. Go to CMS » Web design.

  2. Open the folder Layout » PageDesign.

  3. Click on PageDesignPrepareMainColumn.

  4. Search for the template variables ValidateInvoiceAddressFirstNameIfCompany and ValidateInvoiceAddressLastNameIfCompany.

  5. Change the values of both variables from false to true. Pay attention to the information given in Table 2.

  6. Save the settings.

Table 2. template variables for B2B customers
Element Explanation

ValidateInvoiceAddressFirstNameIfCompany

true = Check the First name text field if the company name was entered in the Company text field of the invoice address.
false Do not check the First name text field.

ValidateInvoiceAddressLastNameIfCompany

true = Check the Last name text field if the company name was entered in the Company text field of the invoice address.
false Do not check the Last name text field.

7. Automatically sending shipping confirmations

You need to confirm UPG that you have sent the items to your customer before you will receive the customers payment from UPG. Set up an event procedure to automatically send shipping confirmations when the outgoing items are booked.

Setting up an event procedure
  1. Go to System » Orders » Events.

  2. Click on Add event procedure.
    → The Create new event procedure window will open.

  3. Enter a name.

  4. Select the event listed in table 3.

  5. Save the settings.

  6. Pay attention to the explanations given in table 3 and carry out the settings as desired.

  7. Place a check mark next to the option Active.

  8. Save the settings.

Table 3. event procedure for sending automatic shipping confirmations to UPG
Setting Option Selection

Event

Order change: Outgoing items booked

Filter 1

Order > Order type

Order
Delivery order - optional for partial delivery

Filter 2

Order > Payment method

UPG

Procedure

Shipping > Send shipping confirmation to UPG

8. Automatically sending refunds

Create a return and report this return to UPG if a customer has returned an item. The customer will only get a refund if you report the return. Set up an event procedure to automatically report returns to UPG.

Creating a return:

  1. Go to Orders » Edit orders.

  2. Open the UPG order.
    → The Overview tab will open.

  3. Select the option create from the Return…​ drop-down list.

  4. Select the items that were returned.
    → The return will be created and opened.

Setting up an event procedure
  1. Go to System » Orders » Events.

  2. Click on Add event procedure.
    → The Create new event procedure window will open.

  3. Enter a name.

  4. Select the event listed in table 4.

  5. Save the settings.

  6. Pay attention to the explanations given in table 4 and carry out the settings as desired.

  7. Place a check mark next to the option Active.

  8. Save the settings.

Table 4. event procedure for automatically reporting refunds to UPG
Setting Option Selection

Event

Order generation: New return

Filter

Order > Payment method

UPG

Procedure

Payment methods > Send refund to UPG

9. Automatically sending cancellations

Set up an event procedure to automatically inform UPG of cancellations.

Setting up an event procedure
  1. Go to System » Orders » Events.

  2. Click on Add event procedure.
    → The Create new event procedure window will open.

  3. Enter a name.

  4. Select the event listed in table 5.

  5. Save the settings.

  6. Pay attention to the explanations given in table 5 and carry out the settings as desired.

  7. Place a check mark next to the option Active.

  8. Save the settings.

Table 5. event procedure for sending automatic cancellations to UPG
Setting Option Selection

Event

Order change: Status change

Select status for cancelled orders.

Filter

Order > Order type

Order

Filter

Order > Payment method

UPG

Procedure

Payment methods > Send cancellation to UPG

10. Reporting a refund for partial cancellation to UPG

If you cannot deliver an item that a customer has already paid for, you need to report this cancellation to UPG, so that the customer will get their money back. You can trigger this refund by completing the order. Once an order has been completed, the customer receives the amount of money that is left, when the delivered items are subtracted from the total the customer has paid.

Sending a refund:

  1. Go to Orders » Edit orders.

  2. Open the UPG order.
    → The Overview tab will open.

  3. Click on the Settings tab.

  4. Click on Complete UPG payment process.

You can also complete an order to give the customer a refund if the customer has paid a higher amount than the invoice amount.

To top