Widget setup

This section describes the options and settings that affect the appearance and behavior of the payment widget.

For a general overview of the widget, seeWidget overview. The integration procedure is described in the sectionOrder of widget integration.

Settings that affect display

The widget is configured using the combination:

  • application parameters passed to the API when creating a payment;

  • project and cash register settings in the merchant's account.

Below are the main parameters that affect the appearance and language of the interface.

Interface language

The widget interface language is determined by:

  • field valuelanguagein the client data block (for example,customer.language);

  • or the default language value for the user's country.

Supported language codes are listed in sectionLanguage codes. The language code is specified in the formatISO 639-1(For example,ru, en, es).

If no language is specified in the request, the system selects the default language for the user's country. The default country and language correspondence is given in the sectionCountry codes.

Currency and amount

The display of amount and currency on the widget depends on the fields:

  • payment.amount— payment amount in fractional currency units.

  • payment.currency— currency code in the formatISO 4217 alpha-3(For example,RUB, KZT, UZS).

Rules for specifying the amount and a list of supported currencies are given in the sectionCurrency codes.

User country

The user's country is passed in the field:

  • customer.country— country code in the formatISO 3166-1 alpha-2(For example,RU, KZ).

A list of supported countries is provided in the sectionCountry codes.

Country influences:

  • available payment methods;

  • default language;

  • a set of available banks and payment scenarios.

Pre-selecting a payment method

The payment method offered to the user on the first screen of the widget is specified by the parameter:

  • payment:widget_method— payment page method code.

Supported values ​​and compliance with payment scenarios are given in the sectionWidget Methods.

Examples:

  • payin-p2p-card— pre-selection of payment by card number.

  • payin-p2p-sbp— pre-selection of payment by phone number (SBP).

  • payin-ecom-card— pre-selection of payment by bank card in online payments.

  • payin-ecom-mobile— pre-selection of payment through a mobile operator.

Ifpayment:widget_methodis not specified, the widget can display a list of available methods based on the cash register and country settings.

Recommended:

  • indicate explicitlypayment:widget_methodfor basic user scenarios;

  • check the values ​​used with the current list in the sectionWidget Methods.

Valuespayment:widget_methodAndpayment.methodmay not match. For example, in a pay-per-click scenario you usepayment:widget_method: payin-1-clickin combination withpayment.method: card-p2p— in this case, the widget displays a click-through payment form, which differs from the standard form forcard-p2p.

Bank pre-selection

For certain payment methods, such as P2P or click-to-pay, it is possible to pre-select a bank. Lists of banks and their symbols are described in the sections:

General scheme:

  • the application is created indicating the payment method (for example,payin-p2p-card);

  • Additionally, the bank symbol is transmitted (for example,sberbank, t-bank, alfa-bank), agreed upon during integration;

  • if a bank is preselected, the bank selection step on the widget is skipped.

The specific field for transmitting the bank symbol depends on the scenario and integration and is configured together with a HighHelp specialist.

When using bank pre-selection it is recommended:

  • use only bank symbols from the current list;

  • take into account that the pre-selection of a bank affects the conversion and availability of individual scenarios.

Interacting with Alerts

Widget settings do not change the set of fields in notifications, but affect:

  • status change scenarios;

  • a set of possible substatuses and descriptions.

A description of the notification structure and processing examples is given in the sectionWidget Alerts. The general status model is described in sectionTransaction types and statuses, and status and substatus codes are given in the sectionStatus codes.