Skip to main content

Alias Setup and Usage Guide

Overview​

This document provides an overview of the alias feature, explaining its purpose, how it works, and how merchants can use it to manage their payment configurations effectively.

What is an Alias?​

An alias is a custom label that merchants can assign to specific payment configurations in their settings через нашу техническую поддержку. This feature is particularly useful for merchants who use multiple channels from the same provider and need to segment traffic for different purposes. The alias allows the merchant to specify which configuration to use when processing payments, providing greater control and precision.

Why Merchants Need Aliases​

Merchants may need to use several configurations with the same provider, often differing only in security credentials. Aliases address this by allowing merchants to assign a unique identifier to each configuration. When initiating a transaction via the API, the merchant can specify the alias, ensuring the correct configuration is used.

How the Alias Feature Works​

  1. The merchant contacts our technical support to request the creation of payment methods with aliases for both orders and payouts. Alias names are strings and must be unique within the merchant's shop.
  2. Technical support sets up and activates the aliases.
  3. For Orders:
    • In the response from the Retrieve Payment Methods endpoint, the paymentSettingsAlias field will be returned for payment methods configured with an alias.
    • When creating an order, the merchant should specify the alias in the paymentSettingsAlias parameter within the paymentSettings object in the request body.
  4. For Payouts:
    • In the response from the Retrieve Payout Methods endpoint, the paymentSettingsAlias field will be returned for payout methods configured with an alias.
    • When creating a payout, the merchant should specify the alias in the paymentSettingsAlias parameter in the request body.
  5. Important: If the paymentSettingsAlias field is present in the response from either the Retrieve Payment Methods or Retrieve Payout Methods endpoints, you must include the paymentSettingsAlias when creating an order or payout.