Authorization

To sign in to Personal Area, complete the following steps.
1. Open the Personal Area page.

TEST: https://vtb.rbsuat.com/mportal3
PROD: https://platezh.vtb24.ru/generalmp3/auth/login

The authorization page will open.


2. Enter your operator login and password in the Login and Password fields.
3. Click on the Login button.

If the credentials are correct, your Personal Area will open.

Logging out

To log out of the Personal Area, click on the button in the top of the page.

Changing interface language

To change the language in which the interface of your Personal Area is displayed, follow these steps.

  1. Log in to Personal Area.
  2. At the top of the page, click on the icon with the globe.
    Available interface languages will be displayed.
  3. Click on the desired language icon.
    The Personal Area will automatically be displayed in the selected language.

Working with the API

Merchants can create a payment flow as needed. For example, design own fully customized payment page. See more information about API by the link . When you create a Merchant, you receive an email with a login and a one-time password. After that you can generate API password by yourself on the Working with API page in Merchant Portal.

To display the Working with API page, click on the icon in the navigation bar to the left.

The page will be displayed:

The following actions are available:

Settings

To get to the Settings section, in the navigation bar to the left, click .

In the Settings section, you can:

General settings

The General Settings section allows the merchant operator to configure certain account settings and permissions.

To go to the General Settings section, select Settings on the side menu, and then select General Settings in the Merchant block. The account settings page will be displayed as shown below.


A description of the settings is shown in table below:

Field Description
Show final page If enabled, allows you to display the final page upon payment completion
Autocomplete enabled If enabled, allows you to specify in the Completion time (in hours) the number of hours after which two-stage payments will be automatically completed
E-mail The merchant's email address to which notifications will be sent. You can enter more than one email address in this field (separated by commas). The triggers for notification dispatch are configurable. They can be set up for such events as change of transaction status, creation of a binding, etc.
Session duration (in minutes) The period given for entering the card data from the moment the payment is registered. If payment is not made within the specified period, the order will go to DECLINED status. After that Callback will be sent, if configured. Changing the status of such orders is performed according to the schedule, so slight delays are possible. If you request status on such an order and time has passed on it, the order will immediately be moved to DECLINED status
Send order creation notifications If enabled, the merchant will receive an email notification of the order placement
Two-stage payment Permission to use a two-stage payment scheme
Send notifications to the customer via SMS If enabled, the customer will receive SMS notifications
Open Id token You can generate an Open Id token. Also, manual token entry is available. Read more here.

Changing the fiscalization settings

To configure the fiscalization parameters, you need to configure the parameters of the fiscal data operator (FFD). To do this, perform the following actions.

  1. Log in to your personal account.
  2. In the left panel, click FFD Settings.
  3. In the FFD System list, select the FFD system to which you are connected. The following window will be displayed:
  4. Make the necessary settings according to the table below:
Setting Description
Fiscalization system The FFD system to which you are connected. If you followed the procedure you selected at the previous step
Version Allows you to select the version of the format of fiscal data: 1.05(V4) or 1.2(V5). By default, the latest version is selected.
Login Enter the login to access the system of the fiscal data operator
Password Enter the password to access the system of the fiscal data operator
TIN Enter the taxpayer identification number
POS equipment group ID ID of the POS equipment group.
Tax rate Select the tax rate, the following options are available:
  • Excluding VAT
  • VAT at 0% rate
  • VAT at 10% rate
  • VAT at the estimated rate of 10/110
  • VAT at 20% rate
  • VAT at the estimated rate of 20/120
  • VAT at 5% rate
  • VAT at the estimated rate of 5/105
  • VAT at 7% rate
  • VAT at the estimated rate of 7/107
  • VAT at 22% rate
  • VAT at the estimated rate of 22/122
Tax system Select a taxation system. The following options are available:
  • General system of taxation
  • Simplified taxation system (income)/Automated simplified taxation system (income)
  • Simplified taxation system (income minus expenses)/Automated simplified taxation system (income minus expenses)
  • Unified tax on imputed income
  • Unified agricultural tax
  • Patent taxation system
Payment subject Payment subject attribute. The following values are available:
  • Product
  • An excisable product
  • Work
  • Service
  • Bet of gambling
  • Gambling winnings
  • Lottery ticket
  • Lottery winnings
  • Provision of RID
  • Payment
  • Agency Fee
  • Composite settlement item
  • Other settlement item
  • Property right
  • Non-operating income
  • Insurance premiums
  • Trade Fee
  • Resort fee
For FFD version 1.2, the following payment subjects are available:
  • Excisable product that is subject to labeling with an identification tool and does not have a marking code
  • Excisable product that is subject to labeling with an identification tool and has a marking code
  • Product that is subject to labeling with an identification tool and does not have a marking code, with the exception of excisable goods
  • Product that is subject to labeling with an identification tool and has a marking code, with the exception of excisable goods
Payment method Settlement method sign, the list contains the following values:
  • 100% prepayment
  • Partial prepayment
  • Advance payment
  • Full settlement
Name This field should be used if you will send requests to register an order without transferring the cart. In this case the specified product name will always be registered.
Url Enter the URL of your online store.
Email Enter your online store's default email address
Additional parameter Additional user attribute that will be passed to the fiscal data operator.
Pass product names from order description If the checkbox is selected, product names will be shown in the receipt.
Fiscalization upon pre-authorization Used in two-phase payments. If the checkbox is checked, a receipt will be created when funds are held. Otherwise, the receipt will be generated after the payment is completed.
Sale of goods under an agency agreement It is used in case of selling goods under an agency agreement. If this option is selected, you must fill in the shopping cart when invoicing. Moreover, when adding an item to the cart, additional optional fields will be available for filling in. See the details here.
Activate system Enables the fiscalization settings. If the setting is enabled, order data is sent to the fiscal data operator. Otherwise, the fiscalization settings are saved but not applied.

Click the Save button.

Callback notifications

The Merchant Portal allows you to configure callback notifications. This section may be hidden for some Merchants. So if you don't see it or are not sure how to approach this, please contact the Support Service and we will be glad to help.

More information about callback notifications is available here. The Callback notification settings tab is located under Settings → Merchant → Callback Notifications.

If the User has affiliate sellers, a Merchant selection becomes available in the Merchant selector. To enable callback notification settings, click the Callback notifications disabled toggle:


After activating the callback notification functionality, follow the setup process as described below.


Callback type

If the Merchant has already configured the callback type as Dynamic, both options in the Signing Type field will not be available for selection, they will be non-clickable.

Callback method

Choose one of the two suggested methods: GET or POST.

Enter the URL (for example, https://test.com) to which notifications will be sent. It is allowed to specify multiple links (separated by commas and without spaces).

Additional parameters

Enter the parameters to be passed to the callback, separated by commas.


Signing type

Select one of the signing types: Symmetric or Asymmetric.

If the Symmetric signing type is selected, it is possible to generate a callback token. Also, if you select the Symmetric signing type, manual token entry is available.


If Asymmetric signing type is selected, the Generate button will be inactive. The key for Asymmetric signing can be obtained from the support team.


Operations

Select the events for which a callback notification will be sent. The notification will be sent both when the operation is successful and in case of an error.


Changing the password

To change the password to Personal Area, complete the following steps.

  1. Log in to Personal Area.
  2. In the navigation bar to the left, go to Settings by clicking .
  3. On the page that appears, select Change password. The page will look as follows.
  4. Enter your current password in Current password field.
  5. Enter a new password in New password and Confirm password fields.

The password must meet the following requirements:

  1. The password must not contain the name of the store or the login of any of the users created for the merchant (using logins in different leTTER CaSe as passwords is also not allowed).
  2. Password must contain the following characters:

    • uppercase Latin characters (A-Z)
    • lowercase Latin characters (a-z)
    • digits (0-9)
    • special characters (! "#;:? \ * () + = /\ < > , . [ ] { } );
  3. The password must be at least 8 characters long.

  4. Click on the Change password button.

E-mail for password recovery

To be able to recover the password for your Personal Area, enter your email address:

  1. Log in to Personal Area.
  2. In the navigation bar to the left, go to Settings by clicking .
  3. In Email-address section, click Edit, and then specify the e-mail address you want to use for password recovery.
  4. Click on the Save button.


The confirmation e-mail will be sent to the specified e-mail address. After the e-mail address is confirmed, editing the e-mail address via this page becomes disabled. If you need to change the e-mail address once again, contact the support team.

Two-factor authentication (2FA)

You can set up two-factor authentication to provide additional level of security that guarantees that only you can have access to your Personal Area. In this case, at the logon to the Personal Area, you should enter not only login and password, but also the authentication code generated by Google Authenticator application or sent to your e-mail address (depending on the authentication method configured).

To set up two-factor authentication, in the navigation bar to the left, go to Settings > Two-factor authentication (2FA). The page provides two options for setting up two-factor authentication:

  1. In the provided list of options select Google Authenticator (recommended) and click on the Enable button.
  2. A form appears where you have to confirm your password:
  3. Download and open Google Authenticator application on your device. Enter a secret key or scan the QR-code to add your account to Google Authenticator application. The application generates a code. Enter the generated code into the Enter 6-digit code field.
  4. Once two-factor authentication via Google Authenticator is enabled, at the next logons to your Personal Area, you are asked to enter Google Authenticator code:

E-mail verification code

  1. In the provided list of options select E-mail verification code and click on the Enable button.
  2. In case your e-mail address is not set in the settings and not confirmed, first you need to do it. Otherwise, please proceed.
  3. A form appears where you have to confirm your password:
  4. To complete two-factor authentication setup, enter 4-digit code sent to your e-mail address:
  5. Once two-factor authentication via E-mail is enabled, at the next logons to your Personal Area, you are asked to enter 4-digit code sent to your e-mail address.

Dashboard

To display the Dashboard page, click on the icon in the navigation bar to the left.

The page contains information about transactions:

The menu at the top allows you to select the period for which the transaction information will be displayed. The following values are available:

The Conversion graph displays the percentage of successful transactions to the total number of transactions.

The Decline codes graph shows the major causes of order processing errors.

The Transactions count graph displays information about transactions for the selected period.

The counters on the chart are the following:

The Gross transactions amounts graph displays information about amounts of successful and declined transactions.


The Net transactions amounts graph displays information about amounts of successful vs. refunded/reversed transactions.

Pay by link

You can issue an invoice to the customer for payment for goods or services via e-mail. To do so, use the Pay by link section of the Merchant Portal. Once the invoice is issued, the customer receives an e-mail and follows the link in it to the payment page.

Sending a link to the payment page via e-mail

To invoice a customer and send them a link to the payment page via email, follow these steps.

  1. Go to Pay by link section of the Personal Area. You also may open this section by clicking Create at the top of Personal area and select Invoice.
  2. The page for entering the invoice parameters will be displayed:

  3. Configure the settings according to the table below.

    Setting Description
    Merchant Merchant login in the payment gateway
    Client name Client's first name, last name, and patronymic. The data entered in this field is displayed in an email containing a link to the payment page
    E-mail The e-mail address to which the payment link will be sent
    Payment type Choose from two options.
    • One-phase – after the payment has been made, no additional actions are required on your part.
    • Two-phase – after the client has confirmed the payment, you must complete the payment in your Personal Area. Before you do this, the money will be held (reserved) on the client's account until you confirm the payment or until the confirmation period expires.
      If you confirm the payment, the money will be transferred to your account.
      The reserved funds on client's account will be released if the reservation period expires before confirmation.
    Currency Select currency from a drop-down list
    Language Select language from a drop-down list
    Due date Indicate the date and time by which the payment can be made. After this date and time it will be impossible to pay the invoice
    Description Free-form description of the payment
    Enter the amount Enter the payment amount here. If the order contains a shopping cart, the field value is populated automatically
  4. Click the Create link button.

    Upon successful dispatch, the corresponing message will be displayed below:

You can view the payment page sent to the client by clicking on the Open link to payment page button.

Adding a shopping cart to invoice

When generating an invoice, you can add a shopping cart for the order. The Products section is located below the area for creating a link to payment page:

  1. To add a product to the shopping cart, click on the Add product button and select New product.

    A form with the parameters of the product being added will be displayed.

  2. Fill in the required fields according to the table below.

    Field Description
    Name Product/service name. Mandatory field.
    Article The vendor code of the product. Mandatory field.
    Qty The number of units of the product. Mandatory field.
    Measure Units of measurement, for example: L – liters, pcs. – pieces. Mandatory field.
    Price Price of one product unit. Mandatory field.
    Amount Total amount for all units of one product item. Calculated automatically when filling in the Price and Qty fields.

    If you have configured fiscalization, fill in (optionally) the following fields (the set of values may slightly differ depending on the FFD version):

    Field Description
    Payment subject Payment subject, available values:
    • Product;
    • Excisable product;
    • Work;
    • Service;
    • Betting gambling;
    • Gambling winnings;
    • Lottery ticket;
    • Winning a lottery;
    • Providing RIDs;
    • Payment;
    • Agency fee;
    • Compound subject of payment;
    • Other subject of payment;
    • Property right;
    • Non-operating gain;
    • Insurance premiums;
    • Sales tax;
    • Resort fee;
    • Excisable goods subject to labeling by identification means that does not have a marking code;
    • Excisable goods subject to labeling by means of identification, having a marking code;
    • Product to be labeled by means of identification that does not have a marking code (except for excisable goods);
    • Product to be labeled by means of identification with a marking code (except for excisable goods).
    Payment method Payment method. Possible values:
    • Full prepayment;
    • Part prepayment;
    • Advance payment;
    • Full payment;
    • Part payment;
    • Transfer on credit;
    • Credit payment.
    Commodity nomenclature code Commodity nomenclature code.
    Tax type VAT rate, the following values are available:
    • No VAT;
    • VAT at 0% rate;
    • VAT at 10% rate;
    • VAT at calculated rate 10/110;
    • VAT at 20% rate;
    • VAT at calculated rate 20/120
    • VAT at 5% rate;
    • VAT at calculated rate 5/105;
    • VAT at 7% rate;
    • VAT at calculated rate 7/107;
    • VAT at 22% rate;
    • VAT at calculated rate 22/122.
    .
    Tax amount Tax amount calculated by the seller. Specified in minimum currency units.
    Excise Excise amount.
    Country code 3-digit country code.
    Declaration number Customs declaration number.
  3. If the Sale of goods under an agency agreement option is selected in fiscalization settings, fill in (optionally) the fields with additional OFD parameters that are displayed in the More parameters section.

    Field Description
    Agent type Agent type, available values:
    • Bank paying agent;
    • Bank paying subagent;
    • Paying agent;
    • Paying subagent;
    • Attorney;
    • Commission agent;
    • Another.
    Payment agent operation name Payment agent transaction name.
    Payment agent phone number Payment agent phone number.
    Name of the transfer operator Transfer operator name.
    Taxpayer identification number (INN) of the transfer operator Transfer operator INN. It must be a valid INN consisting of 10 or 12 digits.
    Address of the transfer operator Transfer operator address.
    Transfer operator phone number Transfer operator phone number.
    Supplier INN Supplier INN. It must be a valid INN consisting of 10 or 12 digits.
    Supplier name Supplier name.
    Supplier's phone number Supplier phone number.
  4. Click Add product.

  5. Repeat the required steps for each item in the shopping cart. If you need to delete the added product, click and confirm the action. If you want to delete the cart, click on the Delete all products button and confirm the action.

  6. You can add items from the catalog, if you have previousy set up the product catalog. Click Add product, select Product from catalog, and then select the item in the opened window.

After adding a product item, you can edit it. To do this, click the item line and change the values in the editing form.

Having added all items to the shopping cart, issue an invoice to the customer.

Importing a CSV file

You can register an order (invoice) with a shopping cart and this cart can be populated automatically from a CSV file. To upload cart automatically, click on the Add product button and select Import CSV. In the window that opens, select the file to be uploaded on your device.


You can upload two types of files that can contain:
- only cart data (ORDER_BUNDLE)
- cart data (ORDER_BUNDLE) and order data (ORDER_PARAMS)

Please note, there are no mandatory fields and only certain fields can be mapped.

Possible cart data fields:

  • TaxSum — tax amount calculated by the merchant. The amount is specified in minor denomination.

  • PaymentSubject — sign of the subject of settlement, available values:

    • 1 — commodity;
    • 2 — excisable goods;
    • 3 — work;
    • 4 — service;
    • 5 — gambling bet;
    • 6 — gambling winnings;
    • 7 — lottery ticket;
    • 8 — lottery winnings;
    • 9 — provision of rd;
    • 10 — payment;
    • 11 — agency fee;
    • 12 — composite item of settlement;
    • 13 — other subject of settlement;
    • 14 — property right;
    • 15 — non-operating income;
    • 16 — insurance premiums;
    • 17 — trade levy;
    • 18 — resort fee;
    • 19 — pledge.
  • PaymentMethod — payment type, the available values are:

    • 1 — full prepayment;
    • 2 — partial prepayment;
    • 3 — advance payment;
    • 4 — full payment;
    • 5 — partial payment with further installment payments;
    • 6 — no payment with further installment payments;
    • 7 — payment with further installment payments.
  • CountryCode — two-letter country code.

  • Excise — the amount of excise tax — decimal number with two digits after the decimal point.

  • DeclarationNumber — the number of customs declaration.

  • Possible order data fields:

    Example with cart data:

    ItemCode,Price,Amount,Measure,Quantity,Name
    1,10,20,pieces,2,apples

    Example with cart and order data:

    Download example file

    Important: To ensure proper file processing, please make sure to avoid including commas within field values. Commas should only be used to separate fields and their corresponding values.

    An example of incorrect field input in the file:

    ItemCode,Name,Amount,Quantity,Measure,Price
    123,apples,red,20000,1,kg,20000

    Example of correct field input in the file:

    ItemCode,Name,Amount,Quantity,Measure,Price
    123,apples red,20000,1,kg,20000

    Making a test transaction

    You can test the payment process on behalf of the client. To do so:

    1. Create an invoice for the client.
    2. Go to the payment page by clicking on the Link to payment page button in the invoice-issued-successfully message.


    3. Enter the details of one of the test cards.

    4. Select Save my card if you want to store the credential: in this case, you will not have to enter the card data next time.

    5. Click the Pay button. To confirm the transaction, use the 3-D Secure code specified for the test card.

    Final page

    After successfull payment, the client can optionally be redirected to the Final page. This page contains data about the payment and a link back to the store.

    The table below describes the data displayed on the final page.

    Field Description
    Merchant Merchant’s login.
    Web-site Merchant’s website address.
    ID Automatically generated order number in the merchant’s system.
    Authorization code International payment system authorization code (6 symbols).
    Terminal ID Terminal identifier in the system that processes the payment.
    Reference ID (RRN) Reference number of the payment authorization that has been assigned to it upon its registration.
    Amount Payment amount.
    Description Description of the payment.
    Card information Masked number and expiration date of the card used for payment.

    For the client to go back to the store, they would click the Return to Merchant link.

    You can enable or disable showing the final page using the Show final page check box on the General settings page of your Personal Area. Read more here.

    Batch sending invoices by e-mail

    If you have an appropriate permission, you can send multiple invoices at once to the customers by uploading a CSV file with invoice data and e-mails. The file format is defined by a template that is configured by the support team.

    The example of the file content (amount, currency code, e-mail):

    Uploading a batch file

    To upload a batch file:

    1. Go to the Pay by Link section and open the Multiple tab. The page displays the list of already uploaded files (if they present).

    2. Click Create. In the opened dialog, you can download the template for the file creation. Download the template and fill it in with the required values.

    3. Choose the file or drag and drop it to the corresponding fields. If you want the payment links to be sent immediately to the customers, check the Send invoices to customers box, and then click Issue and send invoices. Otherwise, clear the Send invoices to customers box and click Issue invoices.

    4. A new line with the uploaded file appears in the list of processed files. While the file is being generated, the "Processing" status is displayed in the Finished column. When the file is processed, this column displays the date and time when the file was processed. The Send column contains a checkmark if the payment links have been sent to the customers.

    Viewing the details of the processed file

    To view the content of the processed batch file, go to the Pay by link section, open the Multiple tab and click on the line of the uploaded file. A page opens with the details for each invoice.

    The table contains the following columns with details for each invoice:

    Export of the processed file

    To export the processed file, open the file details and click Export. The file will be exported to CSV with the following fields:

    The output file may contain other fields if they were present in the template.

    Reports

    The Reports section is designed for generation of transaction reports based on a variety of parameters to choose from. To display the Reports page, click on the icon in the navigation bar to the left.

    To filter the transactions in the report by merchant login, select one in the Merchant login list. Multiple logins may be available if you have permission to view transactions of other merchants or have child merchants.

    The reports functionality provides several filters for report generation. You can select transactions by date:

    Specify the required date range (Day, Week, Month, Quarter, Year) or enter a custom period by selecting dates in the calendar.

    You can also filter transactions by status.

    The report can be downloaded as an .xls or .csv file. Select the format by clicking the corresponding option.

    Use the Add columns template button to create a field template for future use in the reports. After clicking the button, a column configuration form will appear. Enter the name of the template and check the boxes next to the columns that are to be displayed in the report. Some columns are interdependent for your convenience:

    After selecting the columns, click Create Template.

    The saved template will be available for selection in the Columns Template list.

    Having the parameters set, click the Generate report button. The report generation process will start. Depending on the settings of your browser, either the report file will be downloaded automatically or a dialog box will appear allowing you to choose a location where to save the report file.

    Payment links

    You can create a template for payment links that will redirect the customer to the payment page.

    To create a link to a payment page, log in to your Personal Area, select the Payment Links section in the left sidebar, and then click Create payment link.

    You can also create a payment link by clicking Create at the top of the page and selecting Payment link.

    This will display a form for you to fill out:

    Fill in the required fields according to the table:

    Required Field Description
    Mandatory Link name The name of the link, which is only available to the merchant.
    Optional Description Description of the order, which is only visible to the merchant.
    Optional Language Language of the payment page.
    Mandatory Amount The default value is "100.00". If you click on "Arbitrary", the customer can specify the amount for payment on the payment page.
    Optional Currency It is set by default, the value is set according to the merchant settings.
    Optional Validity The default setting is one month from the current date. You can set a different interval: to do this, click on the date and select the required start and end dates of the link from the drop-down calendar. If the Indefinite field is enabled, this field is not available for editing.
    Optional Description Description of the order, which will be displayed to the customer on the pre-payment page.

    Fill in additional parameters if needed.

    Field Description
    Address Whether or not to display the delivery address field on the pre-payment page.
    Email Whether or not to display the field for entering the customer's e-mail on the pre-payment page.
    Full name Whether or not to display the field for entering the customer's name and surname on the pre-payment page.
    Phone number Whether or not to display the field for entering the customer's phone number on the pre-payment page.

    It is possible to add your own parameters. To do this, click +Add parameter and fill in the fields:

    Field Description
    Label The name of the parameter that the client sees.
    Name Required for the payment gateway. Only Latin characters and underscores are allowed. For example: size, items_count, etc.
    Placeholder A tip for the customer with an example of how to fill out the field.
    Regexp A regular expression is used to check the input data.
    Value Pre-filled data in the field. The client will not be able to change this value.
    Required parameter A checkbox to be checked if the new parameter is mandatory for the client.
    Visible for client A checkbox to be checked if the new parameter is displayed on the pre-payment page.
    Printable A checkbox to be checked if the new parameter should be displayed in PDF receipt.

    After filling in all the required fields, click Create at the bottom of the form. After that the link will be displayed on the main page with the status Active:

    The possible actions are available by clicking on the icon.

    Additionally you can do the following:

    Select the required search criteria and click Apply in the filter window. To clear all filter fields, click the Reset filters button.

    You can search by the following parameters:

    Pre-payment/Payment page

    If additional parameters were specified while creating the link (E-mail/Full name/Phone/Address) or the payment amount field was left blank, the client should fill in the required field(s) on the prepayment page when opening the generated payment link and only then proceed to the payment of the order. An example of the pre-payment page with an additional parameter:

    An example of a pre-payment page with an order amount without additional parameters:

    An example of a payment page:

    Working with transactions

    The eCom operations page contains detailed information about orders and payments. To go to the page, click on the icon in the navigation bar to the left.

    The top part of eCom operations page contains the search area where the filters can be set. The page displays the list of transactions that meet the search criteria.

    Using the transactions filter

    To work with transactions, you must first define and apply the filter settings.

    To set search criteria for transactions, follow these steps.

    1. In your Personal Area, go to the eCom operations page.
    2. In the search area on the top, set the required filter parameters. To add more filter parameters, and click More filters and then click the Apply button.



    Matching transactions will be displayed in the list.

    You can copy the search link from the address bar for further usage or bookmark it in the browser.

    To reset the filters, click the Reset button.

    Transaction filter parameters

    The filter allows you to set the criteria for selecting transactions.

    See description of other search criteria here.

    Transactions table

    The transactions table is located on the eCom operations page. Transactions appear in the table after the filter is applied.

    By default, the table contains the following columns with transaction attributes:

    Exporting transactions

    In some cases you may need to export your transactions. The following formats are available: CSV, XLS, or XML. To do so:

    1. Find the desired transactions by specifying the search criteria in the filter.
    2. Click the Export button and choose one of the three formats suggested for saving: CSV, XLS, or XML.
    3. The report generation process will start. Depending on the settings of your browser, either the report file will be downloaded automatically or a dialog box will appear allowing you to choose a location where to save the report file.

    Transaction information

    Personal Area provides detailed information about each payment.


    To learn more about a payment, while on the eCom operations page, click on the row of respective transaction in the table.

    The Transaction details page will open. It always contains the Operation details and Activity tabs. For transactions of certain types, the Refund tab can be displayed in addition.

    Also, depending on the status and type of transaction, the Complete and Refund buttons may be present on this page.

    The Complete button is used to confirm two-phase payments from clients. This button is active only when the order is in the Approved status.

    The Refund button is used to return the payment to the client. The functionality of the button depends on the status of the order and whether a shopping cart was used or not.

    Operation details


    The transaction details are shown on the Operation details tab which contains the following sections:

    Fields in the Payment data section:

    Field Description
    Order number Order number in the store system.
    Unique order number Order ID in the Payment Gateway.
    Response code A numeric code of a result received from a processing bank (action code). See the list of action codes here.
    Payment type Means of payment used to pay for the order.
    Fee The amount of the fee (if charged).
    Registration amount The order amount.
    Deposited amount The amount that was actually debited.
    Refund amount Refund amount, if a refund was made.
    Creation date Date and time of order creation.
    ECI

    Electronic Commerce Indicator. Possible values are:

    • 01 - Secure Code was available but not used;
    • 02 - full authorization, MasterCard;
    • 05 - full authorization, Visa;
    • 06 - 3-D Secure was available but not used;
    • 07 - SSL payment.
    Order description Arbitrary description of goods and services

    Fields in Customer information section:

    Field Description
    Card number Masked number of the card used for payment.
    IP address IP address of the payer.
    Expiry The payer's card expiration date.
    Payment system The name of the International Payment System (card network) to which the payer's card belongs.
    Cardholder name Cardholder name used for payment.
    E-mail Payer's e-mail address.

    The Products section contains information about goods and services paid for in the transaction.

    Column Description
    ID Number of a line item in the cart.
    Name The name of the line item.
    Article Alphanumeric ID of a line item (vendor ID).
    Price Price of one product unit.
    Qty The quantity of the line item.
    Amount The total amount for specified line item (calculated automatically).
    Refund Refund amount. Displayed only if there was a refund. The icon in the row means that there was a partial refund.

    If you have configured fiscalization, the following columns are also displayed (the set of values may slightly differ depending on the FFD version):

    Column Description
    Payment subject Payment subject, available values:
    • Product;
    • Excisable product;
    • Work;
    • Service;
    • Betting gambling;
    • Gambling winnings;
    • Lottery ticket;
    • Winning a lottery;
    • Providing RIDs;
    • Payment;
    • Agency fee;
    • Compound subject of payment;
    • Other subject of payment;
    • Property right;
    • Non-operating gain;
    • Insurance premiums;
    • Sales tax;
    • Resort fee;
    • Excisable goods subject to labeling by identification means that does not have a marking code;
    • Excisable goods subject to labeling by means of identification, having a marking code;
    • Product to be labeled by means of identification that does not have a marking code (except for excisable goods);
    • Product to be labeled by means of identification with a marking code (except for excisable goods).
    Payment method Payment method. Possible values:
    • Full prepayment;
    • Part prepayment;
    • Advance payment;
    • Full payment;
    • Part payment;
    • Transfer on credit;
    • Credit payment.
    Commodity nomenclature code Commodity nomenclature code.
    Tax type VAT rate, the following values are available:
    • No VAT;
    • VAT at 0% rate;
    • VAT at 10% rate;
    • VAT at calculated rate 10/110;
    • VAT at 20% rate;
    • VAT at calculated rate 20/120
    • VAT at 5% rate
    • VAT at calculated rate 5/105
    • VAT at 7% rate
    • VAT at calculated rate 7/107
    • VAT at 22% rate
    • VAT at calculated rate 22/122.
    .
    Tax amount Tax amount calculated by the seller. Specified in minimum currency units.
    Excise Excise amount.
    Country code Digital country code.
    Declaration number Customs declaration number.

    In the case of selling goods under an agency agreement, the additional OFD parameters may be displayed in the product details:

    Field Description
    Agent type Agent type, available values:
    • Bank paying agent;
    • Bank paying subagent;
    • Paying agent;
    • Paying subagent;
    • Attorney;
    • Commission agent;
    • Another.
    Payment agent operation name Payment agent transaction name.
    Payment agent phone number Payment agent phone number.
    Name of the transfer operator Transfer operator name.
    Taxpayer identification number (INN) of the transfer operator Transfer operator INN.
    Address of the transfer operator Transfer operator address.
    Transfer operator phone number Transfer operator phone number.
    Supplier INN Supplier INN.
    Supplier name Supplier name.
    Supplier's phone number Supplier phone number.

    Activity

    The Activity tab contains information about all events relevant to the order: payments, refunds, etc.

    Column Description
    Operation type Operations made while working with an order.
    Date Date and time when the operation was made.
    Description The order amount.

    Refund

    The Refund tab contains information about line items in the order and allows making a refund to the payer. The refund can be made for the full amount or for specific line items.

    Full refund

    To issue a full refund to the payer for the order, follow these steps:

    While on the Refund tab, click on the Full refund button. The order status will become Reversed or Refunded, depending on the payment stage and the date the refund was processed:

    Refund for specific items

    To issue a refund for specific items, follow these steps:

    1. While on the Refund tab, use the table with content of the shopping cart.

      Column Description
      Name The name of the line item.
      Article Alphanumeric ID of a line item (vendor ID).
      Price Price of one product unit.
      Qty The quantity of the line item.
      Amount The total amount for specified line item (calculated automatically).
      Refund Qty The number of items to be returned.
      Refund amount The amount to be refunded. The field is calculated automatically.
    2. In Refund Qty field, indicate the number of items for which the refund should be issued. The resulting amount will be populated in the Refund amount field.

    3. Click on the Refund button.

      If the refunded amount is less than order amount, the order status will become Refund. If the refund is for full amount, the order status will become Reversed.

    Available operations with a transaction

    The main operations that can be carried out with transactions in the Personal Area are:

    These operations are invoked by corresponding buttons on the Transaction details page. See the detailed description of each operation below.

    Order cancellation

    Usually an order that is neither paid nor pre-authorized is automatically cancelled after a certain time set in the system, for example, after 20 minutes. But this operation can be performed manually from the merchant's Personal Area.

    If you want to cancel an order before payment or pre-authorization, you can do it by clicking the Decline button on the Transaction details page.


    Decline button

    After cancellation, the order gets the Declined status.

    Order completion

    In case of a two-phase payment, the funds are first reserved on the client's account (order status is Approved) and only then are credited to the merchant's account (order status is Deposited). It is possible to configure that the final transfer takes place automatically after a certain time set in the system, e.g. after 24 hours. But this operation can be performed manually from the merchant's Personal Area.

    To complete a transaction, while on the Transaction details page, click on the Complete button.

    A confirmation window will open. Its appearance is shown below and depends on whether the cart was used in the order or not.

    If the cart was NOT used, the confirmation window looks like this:

    Check the value in the field and click on the Confirm button.

    If the cart was used, the confirmation window looks like this:

    Check the data, change it if necessary and click on the Complete button. After the completion, the order gets Deposited status.

    If there are necessary permissions, you can adjust the shopping cart in a way that the completion amount will exceed the pre-authorization amount. The percentage by which the deposit amount may be exceeded can be set to any value - it is determined by a specific setting. To activate this feature, please contact technical support.

    As an example, let's say the percentage by which the deposit amount may exceed is set at 100% in the settings. You have entered an amount of 910 RUB in the payment form. Then you can modify the cart so that the capture amount does not exceed 1820 RUB. If it does exceed, an error message will appear and the Complete button will become disabled.

    Reversal

    From your Personal Area, you can reverse payments for two-stage transactions in Approved status (when the funds are reserved on the client's account but not deposited yet). Reversal means that the transaction is canceled and all the reserved funds are released.

    To make a reversal, while on the Transaction details page, click the Refund button.

    The functionality of this button depends on the status of the order and whether a shopping cart was used or not. If the order status is Approved (with or without shopping cart), this button allows to reverse the whole amount only.

    In the confirmation window, click Confirm. The order will get the Reversed status.

    Refund

    From your Personal Area you can issue full or partial refunds on orders paid by customers (when the order status is Deposited). For two-phase payments, the Deposited status means that the funds held on the payer's card have already been debited.

    Refunds are issued from the Transaction information page by using the Refund button.

    The functionality of the button depends on the status of the order and whether a shopping cart was used or not.

    Check the data, change it if necessary and click on the Confirm button. After the completion, the order gets Deposited status.

    Reverse/Refund specifics depending on phases, status, and shopping cart

    The table below shows all the options of Refund button depending on the status of the payment, the number of phases in it, and whether a shopping cart is used or not. The logic can vary depending of your permissions. As a general rule, Merchant Portal makes a reversal if possible, and if not, makes a refund.

    Type With cart Without cart
    One-phase Deposited - refund for specific items Deposited - refund in amount, partial available
    Two-phase Approved - reversal, full amount only
    Deposited - refund for specific items
    Approved - reversal, full amount only
    Deposited - refund in amount, partial available

    Closing OFD receipt

    If you have configured fiscalization settings, you can send a closing receipt to the OFD system. This operation is possible for orders in the following statuses:

    To close an OFD receipt, click the Close receipt button on the transaction detais page.

    Close receipt

    For an order without shopping cart, the confirmation window appears. Edit the amount of the closing receipt, if necessary, and then click Confirm.

    Close receipt confirmation

    If the order contains a shopping cart, the table of cart items will be displayed. The set of displayed parameters depends on the configured OFD system. Edit the cart parameters, if necessary, and then click Confirm.

    Close receipt confirmation with cart

    The closing receipt will be sent to the OFD system.

    Catalog

    The Catalog section provides a quick way to select items when creating an invoice. To access the Catalog section, click in the left sidebar.

    The page will be displayed:

    To get started, select a merchant from the drop-down list, download the catalog template clicking Download Catalog Template button and fill in your item parameters:

    Then upload the completed catalog in .CSV format by clicking Import file with products:

    Alternatively, add the product by clicking the corresponding button.

    A form will open to fill out information about the product.

    Fill in the required fields referring to the table below.

    Field Description
    Name Product/service name.
    Price Price of one product unit.
    Measure Units of measurement, for example: L – liters, pcs. – pieces.
    Number The vendor code of the line item.

    After uploading the catalog or product it will be available to add items from the catalog to the invoice. For more information on adding items from the catalog, please see the Pay by link section.

    In addition to adding a product to the catalog, you can, if necessary, make changes to the parameters of the added product, or delete it from the catalog. To do this, mouse over the item line in the list and click the appropriate button:

    Clicking the Edit button opens a form for making amendments to the product:

    Clicking the Delete button opens a confirmation window to either proceed with deletion or cancel it:

    Categories:
    eCommerce API V1 Merchant Portal
    Categories
    Search results