Adyen

Configure Adyen payment provider with Omnium for online and in-store payments.

Adyen Integration with Omnium

Omnium supports Adyen for comprehensive payment processing with the following features:

  • Payment Links for online checkout
  • Capture payments (full or partial)
  • Cancel payments / void authorization
  • Credit/Refund payments
  • Update Authorization amount
  • Extend Authorization time
  • Split Payments for multi-warehouse orders
  • Get Details - Retrieve payment information

Setup Instructions

Configuration Path

  1. Navigate to: Configuration > Settings > Payment > Payment Types > "..." > Add

  2. Fill out the required fields as outlined below.


Required Fields

FieldDescriptionValue
Unique Payment NameThe unique identifier for the Adyen payment method.Adyen
Payment ServiceThe name of the payment service used for this configuration.Adyen
Provider NameSpecifies which provider to use.Adyen
Display NameThe name shown in the Omnium interface.Adyen or your preferred name
Merchant IDYour Adyen Merchant Account identifier.Your Merchant Account from Adyen
API TokenYour Adyen API Key for authentication.Your API Key from Adyen
Base URLThe Adyen API endpoint URL.See Base URL Options

Base URL Options

EnvironmentBase URL
Testhttps://checkout-test.adyen.com
Productionhttps://checkout-live.adyen.com

API Version: v71 (automatically appended to endpoints)


Additional Configuration

Display Options

SettingDescriptionDefault
Display in CartShow Adyen as a payment option in the cart interface.false
Enable Update Authorization AmountAllow updating authorized amount from the interface.false
Enable Extend Authorization TimeAllow extending authorization expiration.false
Authorization Time In DaysDefault authorization expiration time in days.-

Split Payment Configuration

PropertyDescriptionDefault
SplitEnabledEnable split payments for multi-warehouse orders.true
SplitTypeSplit payment type: BalanceAccount or MarketPlace.BalanceAccount
PropertyDescriptionDefault
PaymentLinkValidInDaysNumber of days payment link remains valid.-

Supported Operations

OperationSupportedNotes
Payment Link CreationYesFor online checkout flows
CaptureYesFull or partial capture with split support
Partial CaptureYesCapture portion of authorized amount
CancelYesVoid authorization
RefundYesFull or partial refunds
Partial RefundYesWith line item tracking
Update AuthorizationYesIncrease or decrease authorized amount
Extend AuthorizationYesExtend authorization validity
Get DetailsYesRetrieve payment information

Special Features

Split Payments (Multi-Warehouse)

When SplitEnabled is enabled (default), Adyen automatically splits payments across multiple warehouses or stores:

  1. Each warehouse/store shipment is allocated a proportional split
  2. Splits are routed to separate Adyen Balance Accounts
  3. Each split includes amount, description, and reference

Balance Account Configuration:

To enable split payments, add the AdyenBalanceAccountId external ID to each store:

  1. Navigate to the store configuration
  2. Add an External ID with provider name AdyenBalanceAccountId
  3. Set the value to your Adyen Balance Account ID

Split Types:

  • BalanceAccount (default) - Funds routed to Balance Accounts
  • MarketPlace - Marketplace split configuration

In-Store/POS Integration

Adyen supports in-store payment link generation:

  • Payment links sent to customers for completion
  • Supports Sitoo POS integration (receipt ID tracking)
  • Multiple payment attempts tracked with sequence numbers

Line Item Details

Adyen receives detailed order information:

  • Product details (SKU, description, brand, color, size)
  • Quantity and amounts (with and without tax)
  • Tax rates and amounts
  • Shipping details

Amount Handling

Adyen uses minor units (cents) for all amounts:

CurrencyExample AmountAdyen Value
EUR100.5010050
SEK250.0025000
USD99.999999

Omnium handles the conversion automatically.


Error Handling

Adyen errors are displayed on the order in the Errors section.

Common Errors

ErrorPossible CauseSolution
Authentication failedInvalid API KeyVerify API Key in Adyen portal
Invalid merchant accountWrong Merchant IDCheck Merchant Account configuration
Capture failedAuthorization expired or invalidVerify authorization status
Split payment failedMissing Balance Account on storeConfigure AdyenBalanceAccountId on stores

Payment Flow

Online Checkout Flow

  1. Payment Link Created - Customer receives link for checkout
  2. Customer Completes Payment - Authorization obtained
  3. Order Received - Omnium receives order with payment reference
  4. Capture - When ready for fulfillment
  5. Refund - Through returns workflow if needed

Split Payment Flow

  1. Authorization - Full order amount authorized
  2. Capture - Split proportionally across warehouses
  3. Each Split - Routed to respective Balance Account

API Authentication

All API calls include:

  • X-API-Key header with your API Token
  • User-Agent header identifying Omnium

Configuration Reference

Payment Service

Adyen

Store External ID

  • AdyenBalanceAccountId - Balance Account ID for split payments

Supported Currencies

All currencies supported by Adyen