Setting Up Payment Providers

Overview

A payment type in Omnium connects a payment method (for example Klarna, Vipps, Adyen) to the payment provider that handles it. Omnium uses this setup to capture, credit (refund) and update payments on orders. It also decides where the payment method can be used: in which markets and stores.

Prerequisites

Before you set up a payment provider, make sure:

• You have access to Configuration (tenant settings) with permission to update settings.
• You have the credentials from the payment provider. Depending on the provider, this can be a Merchant ID, API token / API key, Password, Client ID and Client secret, or a Subscription key.
• You know the payment method name your sales channel (webshop, POS, ERP) sends to Omnium on orders. The name in Omnium must match exactly.
• The markets and stores you want to use the payment method in already exist in Omnium.
• You know whether you are setting up a test or production, so you choose the correct base URL.

Step-by-Step Guide

Step 1: Open the payment settings

1. Go to Configuration.
2. In the settings tree on the left, expand Settings → Order settings → Payment.
3. Click Payment Types.

You now see a list of all payment types, with columns for Logo, Payment method and Type.

Step 2: Check the general payment settings

Click Payment (the level above Payment Types) to see settings that apply to all payment types:

Under Credit reasons, you can add reasons users choose when they credit a payment. Click Add, then enter an ID and a Translate key.

Step 3: Add a new payment type

1. In the Payment Types list, click the context menu (⋮) in the header row.
2. Click Add.
3. In the Select payment type dialog, choose the provider from the dropdown (for example Klarna, Vipps, Adyen, Stripe, Cash).
4. Click Select.

Omnium adds the new payment type and opens it. The Payment method name, Provider name and Display name are filled in with the provider name.

Note: Some providers (Klarna, Klarna In-Store, Vipps, Adyen, Stripe, Nets, PayPal, Dintero, Walley and Cash) have their own settings page with fields made for that provider. The other providers use a general settings page. The steps below cover the fields you'll see on most pages.

Step 4: Fill in the basic details

In the first panel:

1. Payment settings name – Enter a descriptive name, for example "Klarna Norway".
2. Payment method name – Enter the unique name for this payment method. This must match the name the sales channel puts on the order. If you have several setups for the same provider (for example one per market), give each one a unique name.
3. Provider name – Check that the correct provider is selected.
4. Display name – Enter the label users see in Omnium.
5. Authorization time in days – Enter how many days an authorization lasts before it expires.
6. Terms URL and Fallback URL – Enter these if the provider needs them.

Step 5: Set capture and credit behaviour

Still in the first panel:

1. Credit priority – If an order has more than one payment, this decides which payment is refunded first on a return. A low number means high priority.
2. Capture priority – Decides which payment is captured first. A low number means high priority.
3. Payment provider fee – Enter the provider's fee in percent. This is used in payment reports.
4. Credit voucher – Turn on to create a return order when you credit. This is useful if credits are exported to an ERP system.
5. Refund to original sales store – Turn on if the provider settles to the store that made the sale. Returns are then booked to that store instead of the return store.

Depending on the provider, you may also see:

• Disable transactions – Stops the payment from creating new transactions.
• Requires credit – The payment can only be used if the customer has credit available.
• Allow credit amount of 0 or less – Allows crediting zero or negative amounts.
• Allow credit amount of 0 or less, but not sent to the payment provider – Same as above, but the transaction is only created in Omnium.
• Read only – The payment can't be changed.
• Get details from provider – The provider can send payment details to Omnium.

Step 6: Enter the provider credentials

In the Authorization panel, enter the credentials from the payment provider. The fields depend on the provider:

For Klarna, choose the base URL from the dropdown:

• Klarna Test / Klarna Prod – Europe
• Klarna, N.America Test / Klarna, N.America Prod – North America
• Kustom Test / Kustom Prod

Note: For Stripe, test keys start with sk_test_ and live keys start with sk_live_. Make sure you use a live key in production.

Step 7: Choose markets and stores

1. In the Markets panel, select the markets where the payment method can be used under Enabled for markets.
2. In the Stores panel, select the stores under Enabled for stores.
3. In the Properties panel, add extra properties if your setup needs them (optional).

Step 9: Set up how the payment looks in Omnium

In the User interface panel:

1. Logo URL – Enter a link to the provider's logo. It is shown in the payment list and on orders.
2. Display in cart – Turn on if users can add this payment in the cart in Omnium.
3. Editable – Turn on if users can edit the payment in Omnium.
4. Enable update authorization amount – Turn on if users can change the authorized amount.
5. Enable extended authorization time – Turn on if users can extend the authorization time.
6. Hidden – Turn on to hide the payment in Omnium.
7. Is empty payment – Turn on if Omnium's workflow should not handle this payment.

8. Vue Template – Leave empty unless you have a custom template from Omnium.

   

Step 10: Save and publish

1. When you change something, Unsaved changes appears at the top of the page.
2. Click Publish.
3. In the confirmation dialog, click Save and publish.
4. If Omnium finds validation errors or warnings, click Details to see them, or Save anyway to save

Important Notes

• Payment method name must match – Omnium finds the right setup by the payment method name on the order. If it doesn't match what the sales channel sends, captures and credits won't work.
• One setup per market or account – If you have different provider accounts per country, add one payment type for each and give each a unique payment method name.
• Test vs. production – Check the Base URL and credentials before going live. A test URL in production means payments won't be captured.
• Delete with care – To remove a payment type, click ⋮ → Delete in the list. Only delete payment types that are no longer used on open orders.
• Sitoo POS – If you use Sitoo, payment methods must be mapped in Sitoo under settings → POS Payment Options. Set the external ID to the Omnium payment method name.

Troubleshooting