# Спецификация Payment Page API {#ru_PP_Parameters}

спецификация с описанием структуры параметров, которые могут использоваться в запросах на открытие платёжной формы Payment Page

В этой статье представлена спецификация параметров вызова Payment Page, с базовой информацией о применяемых параметрах и со ссылками на связанные статьи \(с описанием возможностей и сценариев, для которых актуальны отдельные параметры\).

Параметры, отмеченные в этой спецификации как обязательные \(required\), являются обязательными для всех вызовов Payment Pageс проведением платежей. В режиме Card Tokenize к обязательным не относятся параметры платежа \(`payment_amount`, `payment_currency`, `payment_id`\).

Параметры, отмеченные в этой спецификации как необязательные \(optional\), могут дополнительно настраиваться как обязательные для отдельных проектов и платёжных методов.Кроме того, ряд параметров может быть рекомендуемым к использованиюдля избегания участия пользователя в аутентификации 3‑D Secure \(с уходом от варианта challenge flow к варианту frictionless flow; [подробнее](ru_pp_3ds.md#)\), для избегания процедуры дополнения информации о платеже \([подробнее](ru_pp_clarification.md)\) и для других улучшений в пользовательских сценариях и работе платёжной формы.

С вопросами об обязательности и желательности передачи отдельных параметров в различных ситуациях можно обращаться к настоящей документации и специалистам технической поддержки Ecommpay.

|Параметр|Описание|
|--------|--------|
|`account_token`  
 string, optional

|Токен платёжного инструмента.

 Представляет собой идентификатор, полученный от платёжной платформы при сохранении реквизитов этого платёжного инструмента. Может использоваться для проведения платежей по сохранённым данным \(в частности, [при проведении оплат](ru_PP_Payment_by_token.md)\).

 Пример: `42ab631449a78914502803aed8a0e5a728d558035d29a56f4dcc136c6bfc3021`

|
|`avs_post_code`  
 string, optional

|Почтовый индекс пользователя, используемый для проверки [Address Verification Service](ru_PP_avs.md).

 Пример: `WS13 6LG`

|
|`avs_street_address`  
 string, optional

|Адрес пользователя, используемый для проверки [Address Verification Service](ru_PP_avs.md).

 Включает в себя номер дома и название улицы.

 Пример: `4 Breadmarket Street`

|
|`baseUrl`  
 string, optional

|Базовый адрес вызова платёжной формы.

 Применяется в случаях, когдапо согласованию с курирующим менеджером Ecommpay он отличается от используемого по умолчанию \(https://paymentpage.ecommpay.com\) и его актуально указывать в запросах в явном виде.

 Пример: `https://cosmopage.site.com`

|
|`best_before`  
 string, optional

|Дата и время, до наступления которых по указанному часовому поясу пользователь может работать с платёжной формой для подтверждения целевого действия \([подробнее](ru_pp_time_limit.md)\).

 Могут указываться в виде записи формата `ГГГГ-ММ-ДДTчч:мм:сс`±`чч` или `ГГГГ-ММ-ДДTчч:мм:сс`±`чч:мм`. Должны указываться таким образом, чтобы допустимое время работы с формой составляло не более 30 суток с момента отправки запроса на открытие Payment Page.

 Пример: `2024-04-26T13:50:37+00`

|
|`billing_address`  
 string, optional

|Номер дома\(с обозначением корпуса или строения, где это актуально\) и название улицы в расчётном адресе пользователя.

 При оплатах с использованием платёжных карт передача этих сведений вместе с другими сведениями о пользователе может повышать вероятность аутентификации 3‑D Secure без участия пользователя \(с уходом от варианта challenge flow к варианту frictionless flow; [подробнее](ru_pp_3ds.md#)\).

 Пример: `33 Store Street`

|
|`billing_city`  
 string, optional

|Название города в расчётном адресе пользователя.

 При оплатах с использованием платёжных карт передача этих сведений вместе с другими сведениями о пользователе может повышать вероятность аутентификации 3‑D Secure без участия пользователя \(с уходом от варианта challenge flow к варианту frictionless flow; [подробнее](ru_pp_3ds.md#)\).

 Пример: `London`

|
|`billing_country`  
 string, optional  


|Код страны в расчётном адресе пользователя.

 Указывается в формате ISO 3166-1 alpha-2. При оплатах с использованием платёжных карт передача этих сведений вместе с другими сведениями о пользователе может повышать вероятность аутентификации 3‑D Secure без участия пользователя \(с уходом от варианта challenge flow к варианту frictionless flow; [подробнее](ru_pp_3ds.md#)\).

 Шаблон: `^[A-Z]{2}$`

 Пример: `GB`

|
|`billing_postal`  
 string, optional

|Почтовый индекс в расчётном адресе пользователя.

 При оплатах с использованием платёжных карт передача этих сведений вместе с другими сведениями о пользователе может повышать вероятность аутентификации 3‑D Secure без участия пользователя \(с уходом от варианта challenge flow к варианту frictionless flow; [подробнее](ru_pp_3ds.md#)\).

 Пример: `BR1 1AA`

|
|`billing_region`  
 string, optional

|Название региона\(штата, провинции или иной территориальной области\) в расчётном адресе пользователя.

 При оплатах с использованием платёжных карт передача этих сведений вместе с другими сведениями о пользователе может повышать вероятность аутентификации 3‑D Secure без участия пользователя \(с уходом от варианта challenge flow к варианту frictionless flow; [подробнее](ru_pp_3ds.md#)\).

 Пример: `Dorset`

|
|`billing_region_code`  
 string, optional  


|Внутренний код региона\(штата, провинции или иной территориальной области\) в расчётном адресе пользователя.

 Представляет собой вторую часть международного кода территории \(в формате ISO 3166-2\), без двухбуквенного кода страны и разделительного дефиса, и является применимым в тех случаях, когда передаётся в одном запросе с кодом страны в значении параметра `billing_country`.При оплатах с использованием платёжных карт передача этих сведений вместе с другими сведениями о пользователе может повышать вероятность аутентификации 3‑D Secure без участия пользователя \(с уходом от варианта challenge flow к варианту frictionless flow; [подробнее](ru_pp_3ds.md#)\).

 Шаблон: `^[0-9A-Z]{1,3}$`

 Пример: `DOR`

|
|`booking_info`  
 string, optional

|Информация о бронировании услуг для учёта на стороне веб-сервиса.

 Представляет собой строку, полученную в результате кодирования исходного JSON-объекта с применением алгоритма Base64.Этот объект может включать в себя различные сведения из числа допустимых. Может использоваться для фиксации и учёта актуальных сведений при оплате услуг различных организаций \([подробнее](ru_pp_additional_data.md#)\).

 -   `bookers`, array — массив с информацией о лицах, для которых бронируется услуга; каждый элемент такого массива содержит:
    -   `first_name`, string — имя получателя услуги, указанное при бронировании
    -   `last_name`, string — фамилия получателя услуги, указанная при бронировании
    -   `email`, string — адрес электронной почты, указанный при бронировании
-   `items`, array — массив с информацией об отдельных услугах, которые входят в состав бронирования; каждый элемент такого массива содержит:
    -   `description`, string — описание отдельной услуги в рамках бронирования
    -   `start_date`, string, `^\\d{2}-\\d{2}-\\d{4}$` — дата начала действия отдельной услуги
    -   `end_date`, string, `^\\d{2}-\\d{2}-\\d{4}$` — дата окончания действия отдельной услуги
-   `start_date`, string, `^\\d{2}-\\d{2}-\\d{4}$` — дата начала действия забронированной услуги
-   `end_date`, string, `^\\d{2}-\\d{2}-\\d{4}$` — дата окончания действия забронированной услуги
-   `description`, string — произвольное описание бронирования
-   `total`, integer — итоговая стоимость бронирования
-   `pax`, integer — количество лиц, для которых бронируется услуга
-   `reference`, string — указатель забронированной услуги, в качестве которого могут выступать URL, название или код услуги в сервисе мерчанта
-   `id`, string — идентификатор бронирования, уникальный в рамках сервиса мерчанта

 ``` {#codeblock_fk4_4bn_phc .language-json}
"booking_info": {
  "start_date": "12-08-2026",
  "end_date": "14-08-2026",
  "description": "Sideris music festival full pass",
  "total": 200000,
  "pax": 2,
  "bookers": [
     {
        "first_name": "William",
        "last_name": "Herschel",
        "email": "rsfellow@mail.com"
     },
     {
        "first_name": "Caroline",
        "last_name": "Herschel",
        "email": "salariedastronomer@mail.com"
     }
  ],        
  "items":[
     {
        "description": "VIP Arrival",
        "start_date": "12-08-2026",
        "end_date": "12-08-2026"
     },
     {
        "description": "Hotel",
        "start_date": "12-08-2026",
        "end_date": "14-08-2026"
     },
     {
        "description": "Concerts",
        "start_date": "12-08-2026",
        "end_date": "14-08-2026"
     },
     {
        "description": "VIP Departure",
        "start_date": "14-08-2026",
        "end_date": "14-08-2026"
     }
  ],
  "reference": "musicfestlink",
  "id": "83"
}
```

 ``` {#codeblock_rpj_bcn_phc}
ewogICJzdGFydF9kYXRlIjogIjEyLTA4LTIwMjYiLAogICJlbmRfZGF0ZSI6ICIxNC0wOC0yMDI2IiwKICAiZGVzY3JpcHRpb24iOiAiU2lkZXJpcyBtdXNpYyBmZXN0aXZhbCBmdWxsIHBhc3MiLAogICJ0b3RhbCI6IDIwMDAwMCwKICAicGF4IjogMiwKICAiYm9va2VycyI6IFsKICAgICB7CiAgICAgICAgImZpcnN0X25hbWUiOiAiV2lsbGlhbSIsCiAgICAgICAgImxhc3RfbmFtZSI6ICJIZXJzY2hlbCIsCiAgICAgICAgImVtYWlsIjogInJzZmVsbG93QG1haWwuY29tIgogICAgIH0sCiAgICAgewogICAgICAgICJmaXJzdF9uYW1lIjogIkNhcm9saW5lIiwKICAgICAgICAibGFzdF9uYW1lIjogIkhlcnNjaGVsIiwKICAgICAgICAiZW1haWwiOiAic2FsYXJpZWRhc3Ryb25vbWVyQG1haWwuY29tIgogICAgIH0KICBdLCAgICAgICAgCiAgIml0ZW1zIjpbCiAgICAgewogICAgICAgICJkZXNjcmlwdGlvbiI6ICJWSVAgQXJyaXZhbCIsCiAgICAgICAgInN0YXJ0X2RhdGUiOiAiMTItMDgtMjAyNiIsCiAgICAgICAgImVuZF9kYXRlIjogIjEyLTA4LTIwMjYiCiAgICAgfSwKICAgICB7CiAgICAgICAgImRlc2NyaXB0aW9uIjogIkhvdGVsIiwKICAgICAgICAic3RhcnRfZGF0ZSI6ICIxMi0wOC0yMDI2IiwKICAgICAgICAiZW5kX2RhdGUiOiAiMTQtMDgtMjAyNiIKICAgICB9LAogICAgIHsKICAgICAgICAiZGVzY3JpcHRpb24iOiAiQ29uY2VydHMiLAogICAgICAgICJzdGFydF9kYXRlIjogIjEyLTA4LTIwMjYiLAogICAgICAgICJlbmRfZGF0ZSI6ICIxNC0wOC0yMDI2IgogICAgIH0sCiAgICAgewogICAgICAgICJkZXNjcmlwdGlvbiI6ICJWSVAgRGVwYXJ0dXJlIiwKICAgICAgICAic3RhcnRfZGF0ZSI6ICIxNC0wOC0yMDI2IiwKICAgICAgICAiZW5kX2RhdGUiOiAiMTQtMDgtMjAyNiIKICAgICB9CiAgXSwKICAicmVmZXJlbmNlIjogIm11c2ljZmVzdGxpbmsiLAogICJpZCI6ICI4MyIKfQ==
```

|
|`card_holder`  
 string, optional  


|Имя и фамилия держателя платёжной карты.

 Могут использоваться для предварительного заполнения соответствующего поля в платёжной форме\(с возможностью редактирования пользователем\) и должны соответствовать написанию, используемому непосредственно на карте, а также общим требованиям к написанию \([подробнее](ru_faq_payment_processing.md#section_z41_5cj_31c)\).

 Шаблон: `^[\p\{L}\p\{M}\s\-\'.]{1,255}$`

 Пример: `John Doe`

|
|`close_on_missclick`  
 integer \(boolean\*\), optional

|Указатель действия при щелчке за пределами формы, открытой [в модальном окне](ru_PP_method_ModalWindow.md#).

 Актуален, когда используется соответствующий способ открытия. Может принимать одно из следующих значений:

 -   `0` — оставить форму открытой \(вариант, используемый по умолчанию\);
-   `1` — закрыть форму.

 При работе с библиотекой `merchant.js` \([подробнее](ru_pp_interaction_organisation.md#)\) значение этого параметра допустимо указывать как булево: `false` или `true`.

 Пример: `1`

|
|`css_modal_wrap`  
 string, optional

|Указатель дополнительного CSS-класса для оболочки модального окнас платёжной формой.

 Актуален, когда используется соответствующий способ открытия.

 Пример: `CosmoshopModal`

|
|`customer_address`  
 string, optional

|Название улицы и номер дома\(с обозначением корпуса или строения, где это актуально\) в адресе проживания пользователя, с использованием разделительной запятой.

 Представляет собой строку длиной не более 255 символов. Передача этих сведений вместе с другими сведениями о пользователе может способствовать избеганию процедуры дополнения информации о платеже и упрощать пользовательский сценарий \([подробнее](ru_pp_clarification.md)\).

 Пример: `Main Street, 12`

|
|`customer_account_info`  
 string, optional

|Информация об учётной записипользователя на стороне веб-сервиса и о его контактных данных.

 Представляет собой строку, полученную в результате кодирования исходного JSON-объекта с применением алгоритма Base64.Этот объект может включать в себя объект `customer` с различными сведениями из числа допустимых. При оплатах с использованием платёжных карт передача этих сведений вместе с другими сведениями о пользователе может повышать вероятность аутентификации 3‑D Secure без участия пользователя \(с уходом от варианта challenge flow к варианту frictionless flow; [подробнее](ru_pp_3ds.md#)\).

 -   `address_match`, string — указатель совпадения платёжного адреса пользователя с адресом доставки, указанным в объекте `shipping`, в виде одного из следующих значений:
    -   `Y` — адреса совпадают
    -   `N` — адреса не совпадают
-   `account`, object — объект со сведениями об учётной записи пользователя на стороне веб-сервиса мерчанта:
    -   `activity_day`, integer — количество попыток проведения оплаты за последние 24 часа, в виде числа от 0 до 999
    -   `activity_year`, integer — количество попыток проведения оплаты за последние 365 дней, в виде числа от 0 до 999
    -   `additional`, string — дополнительная информация об учётной записи пользователя, например её идентификатор, в произвольном формате с использованием до 64 символов
    -   `age_indicator`, string, `^0[1-5]$` — индикатор давности учётной записи, который может принимать одно из следующих значений:
        -   `01` — при невозможности оценить давность \(при инициировании платежа без аутентификации пользователя\)
        -   `02` — при нулевой давности \(при создании учётной записи для инициирования платежа\)
        -   `03` — при давности менее 30 дней
        -   `04` — при давности от 30 до 60 дней
        -   `05` — при давности более 60 дней
    -   `auth_data`, string — дополнительная информация об аутентификации на стороне веб-сервиса, в произвольном формате с использованием не более 255 символов
    -   `auth_method`, string, `^(0[1-4]|0[1-4][1-6])$` — указатель способа последней аутентификации пользователя на стороне веб-сервиса, который может принимать одно из следующих значений:
        -   для классических карточных платежей:
            -   `01` — отсутствие аутентификации
            -   `02` — аутентификация с использованием данных, сохранённых на стороне веб-сервиса мерчанта
            -   `03` — аутентификация с использованием технологии Federated Identity \(например, Google Account или Facebook\)
            -   `04` — аутентификация с использованием аутентификатора, соответствующего стандартам Fast IDentity Online \(FIDO\)
    -   `auth_time`, string, `^\\d{2}-\\d{2}-\\d{4}\\d{2}:\\d{2}$` — дата и время последней аутентификации пользователя на стороне веб-сервиса в формате `ДД-ММ-ГГГГчч:мм`
    -   `change_date`, string, `^\\d{2}-\\d{2}-\\d{4}$` — дата последних изменений в учётной записи, за исключением изменения или сброса пароля, в формате `ДД-ММ-ГГГГ`
    -   `change_indicator`, string, `^0[1-4]$` — индикатор давности изменений в учётной записи, за исключением изменения или сброса пароля, который может принимать одно из следующих значений:
        -   `01` — при нулевой давности \(при изменениях в день проведения платежа\)
        -   `02` — при давности менее 30 дней
        -   `03` — при давности от 30 до 60 дней
        -   `04` — при давности более 60 дней
    -   `date`, string, `^\\d{2}-\\d{2}-\\d{4}$` — дата создания учётной записи в формате `ДД-ММ-ГГГГ`
    -   `pass_change_date`, string, `^\\d{2}-\\d{2}-\\d{4}$` — дата последнего изменения или сброса пароля в формате `ДД-ММ-ГГГГ`
    -   `pass_change_indicator`, string, `^0[1-5]$` — индикатор давности последнего изменения или сброса пароля, который может принимать одно из следующих значений:
        -   `01` — при невозможности оценить давность \(пароль не был изменён или сброшен\)
        -   `02` — при нулевой давности \(пароль был изменён или сброшен в день проведения платежа\)
        -   `03` — при давности менее 30 дней
        -   `04` — при давности от 30 до 60 дней
        -   `05` — при давности более 60 дней
    -   `payment_age`, string, `^\\d{2}-\\d{2}-\\d{4}$` — дата добавления реквизитов платёжного инструмента в формате `ДД-ММ-ГГГГ`
    -   `payment_age_indicator`, string, `^0[1-5]$` — давность сохранения данных платёжного инструмента, используемой для проведения платежа, который может принимать одно из следующих значений:
        -   `01` — при невозможности оценить давность \(платёж проводится без аутентификации в учётной записи\)
        -   `02` — при нулевой давности \(данные карты сохранены в день проведения платежа\)
        -   `03` — при давности менее 30 дней
        -   `04` — при давности от 30 до 60 дней
        -   `05` — при давности более 60 дней
    -   `provision_attempts`, integer — количество попыток сохранения реквизитов для новых платёжных инструментов за последние 24 часа, от 0 до 999
    -   `purchase_number`, integer — количество покупок, совершённых через учётную запись за последние 6 месяцев, от 0 до 9999
    -   `suspicious_activity`, string, `^0[1-2]$` — индикатор подозрительной активности, который может принимать одно из следующих значений:
        -   `01` — без выявления подозрительной активности
        -   `02` — с выявлением подозрительной активности
    -   `home_phone`, string — номер домашнего телефона пользователя, в виде последовательности цифр без использования разделителей
    -   `work_phone`, string — номер рабочего телефона пользователя, в виде последовательности цифр без использования разделителей

 ```language-json
{ 
  "customer":{ 
    "address_match":"Y",
    "home_phone":"44991234567",
    "work_phone":"44997654321",
    "account":{ 
      "additional":"gamer12345",
      "age_indicator":"01",
      "date":"01-10-2022",
      "change_indicator":"01",
      "change_date":"01-10-2022",
      "pass_change_indicator":"01",
      "pass_change_date":"01-10-2022",
      "purchase_number":12,
      "provision_attempts":16,
      "activity_day":22,
      "activity_year":222,
      "payment_age_indicator":"01",
      "payment_age":"01-10-2022",
      "suspicious_activity":"01",
      "auth_method":"01",
      "auth_time":"01-10-202213:12",
      "auth_data":"login_0102"
    }
  }
}
```

 ```
eyAKICAiY3VzdG9tZXIiOnsgCiAgICAiYWRkcmVzc19tYXRjaCI6IlkiLAogICAgImhvbWVfcGhvbmUiOiI3OTEwNTIxMTExMSIsCiAgICAid29ya19waG9uZSI6Ijc0OTU1MjExMTExIiwKICAgICJhY2NvdW50Ijp7IAogICAgICAiYWRkaXRpb25hbCI6ImdhbWVyMTIzNDUiLAogICAgICAiYWdlX2luZGljYXRvciI6IjAxIiwKICAgICAgImRhdGUiOiIwMS0xMC0yMDIyIiwKICAgICAgImNoYW5nZV9pbmRpY2F0b3IiOiIwMSIsCiAgICAgICJjaGFuZ2VfZGF0ZSI6IjAxLTEwLTIwMjIiLAogICAgICAicGFzc19jaGFuZ2VfaW5kaWNhdG9yIjoiMDEiLAogICAgICAicGFzc19jaGFuZ2VfZGF0ZSI6IjAxLTEwLTIwMjIiLAogICAgICAicHVyY2hhc2VfbnVtYmVyIjoxMiwKICAgICAgInByb3Zpc2lvbl9hdHRlbXB0cyI6MTYsCiAgICAgICJhY3Rpdml0eV9kYXkiOjIyLAogICAgICAiYWN0aXZpdHlfeWVhciI6MjIyMiwKICAgICAgInBheW1lbnRfYWdlX2luZGljYXRvciI6IjAxIiwKICAgICAgInBheW1lbnRfYWdlIjoiMDEtMTAtMjAyMiIsCiAgICAgICJzdXNwaWNpb3VzX2FjdGl2aXR5IjoiMDEiLAogICAgICAiYXV0aF9tZXRob2QiOiIwMSIsCiAgICAgICJhdXRoX3RpbWUiOiIwMS0xMC0yMDIyMTM6MTIiLAogICAgICAiYXV0aF9kYXRhIjoibG9naW5fMDEwMiIKICAgIH0KICB9Cn0==
```

|
|`customer_account_number`  
 string, optional

|Идентификатор учётной записи пользователя на стороне платёжной системы.

 Может быть актуален при работе с отдельными платёжными методами\(например, [Neteller](pm_neteller.md#) или [OVO Wallet](pm_ovo.md#)\) и с учётом специфики конкретного метода может представлять собой идентификатор электронного кошелька, адрес электронной почты, номер телефона или иную запись.

 Пример: `example@mail.com`

|
|`customer_birthplace`  
 string, optional

|Название места рождения пользователя\(города или иного населённого пункта\).

 Представляет собой строку длиной не более 255 символов. Передача этих сведений вместе с другими сведениями о пользователе может способствовать избеганию процедуры дополнения информации о платеже и упрощать пользовательский сценарий \([подробнее](ru_pp_clarification.md)\).

 Пример: `London`

|
|`customer_city`  
 string, optional

|Название города \(или иного населённого пункта\) в адресе проживания пользователя.

 Представляет собой строку длиной не более 255 символов. Передача этих сведений вместе с другими сведениями о пользователе может способствовать избеганию процедуры дополнения информации о платеже и упрощать пользовательский сценарий \([подробнее](ru_pp_clarification.md)\).

 Пример: `London`

|
|`customer_country`  
 string, optional  


|Код страны в адресе проживания пользователя.

 Указывается в формате ISO 3166-1 alpha-2. Передача этих сведений вместе с другими сведениями о пользователе может способствовать избеганию процедуры дополнения информации о платеже и упрощать пользовательский сценарий [\(подробнее](ru_pp_clarification.md)\).

 Шаблон: `^[A-Z]{2}$`

 Пример: `GB`

|
|`customer_day_of_birth`  
 string, optional  


|Дата рождения пользователя.

 Представляет собой строку в формате `ДД-ММ-ГГГГ`. Передача этих сведений вместе с другими сведениями о пользователе может способствовать избеганию процедуры дополнения информации о платеже и упрощать пользовательский сценарий \([подробнее](ru_pp_clarification.md)\).

 Шаблон: `^\\d{2}-\\d{2}-\\d{4}$`

 Пример: `12-12-1990`

|
|`customer_email`  
 string, optional

|Адрес электронной почты пользователя.

 Представляет собой строку длиной не более 255 символов, состоящую из локального адреса и доменного имени, разделённых символом «@».Должен указываться для оплат с прямым использованием платёжных карт, если не указывается номер телефона \(в значении параметра `customer_phone`\) и не используется возможность указания таких сведений пользователем \([подробнее](ru_PP_Gathering_customer_data.md)\).

 Пример: `john@example.com`

|
|`customer_first_name`  
 string, optional

|Имя пользователя.

 Представляет собой строку длиной не более 255 символов. Передача этих сведений вместе с другими сведениями о пользователе может способствовать избеганию процедуры дополнения информации о платеже и упрощать пользовательский сценарий \([подробнее](ru_pp_clarification.md)\).

 Пример: `Jane`

|
|`customer_id`  
 string, required

|Идентификатор пользователя в рамках проекта\(указанного в значении параметра `project_id`\).

 Должен быть однозначно сопоставим с учётной записью пользователя в веб-сервисе, в том числе для корректной работы с рисками и борьбы с мошенническими операциями.

 Пример: `customer_112`

|
|`customer_last_name`  
 string, optional

|Фамилия пользователя.

 Представляет собой строку длиной не более 255 символов.Передача этих сведений вместе с другими сведениями о пользователе может способствовать избеганию процедуры дополнения информации о платеже и упрощать пользовательский сценарий \([подробнее](ru_PP_Gathering_customer_data.md)\).

 Пример: `Smith`

|
|`customer_middle_name`  
 string, optional

|Отчество \(или второе или среднее имя\) пользователя.

 Представляет собой строку длиной не более 255 символов.Передача этих сведений вместе с другими сведениями о пользователе может способствовать избеганию процедуры дополнения информации о платеже и упрощать пользовательский сценарий \([подробнее](ru_PP_Gathering_customer_data.md)\).

 Пример: `Mary`

|
|`customer_mpi_result`  
 string, optional

|Информация о предыдущей аутентификации пользователя с использованием протокола 3‑D Secure.

 Представляет собой строку, полученную в результате кодирования исходного JSON-объекта с применением алгоритма Base64.Этот объект может включать в себя различные сведения из числа допустимых. При оплатах с использованием платёжных карт передача этих сведений вместе с другими сведениями о пользователе может повышать вероятность аутентификации 3‑D Secure без участия пользователя \(с уходом от варианта challenge flow к варианту frictionless flow; [подробнее](ru_pp_3ds.md#)\).

 -   `mpi_result`, object — объект с данными о предыдущей аутентификации пользователя:
    -   `acs_operation_id`, string, `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$` — идентификатор предыдущей операции пользователя на стороне эмитента, полученный в параметре `acs_operation_id` оповещения о результате проведения предыдущего платежа, не более тридцати шести символов
    -   `authentication_flow`, string, `^0[1-2]$` — указатель варианта предыдущего прохождения аутентификации пользователем, полученное в параметре `authentication_flow` оповещения о результате проведения предыдущего платежа, может принимать следующие значения:
        -   `01` — frictionless flow
        -   `02` — challenge flow
    -   `authentication_timestamp`, string, `^\\d{12}$` — дата и время предыдущей успешной аутентификации пользователя, полученные в параметре `mpi_timestamp` оповещения о результате проведения предыдущего платежа

 ```language-json
{ 
  "customer":{ 
    "mpi_result":{ 
      "acs_operation_id":"00000000-0005-5a5a-8000-016d3ea31d54",
      "authentication_flow":"01",
      "authentication_timestamp":"202210101050"
    }
  }
}
```

 ```
eyAKICAiY3VzdG9tZXIiOnsgCiAgICAibXBpX3Jlc3VsdCI6eyAKICAgICAgImFjc19vcGVyYXRpb25faWQiOiIwMDAwMDAwMC0wMDA1LTVhNWEtODAwMC0wMTZkM2VhMzFkNTQiLAogICAgICAiYXV0aGVudGljYXRpb25fZmxvdyI6IjAxIiwKICAgICAgImF1dGhlbnRpY2F0aW9uX3RpbWVzdGFtcCI6IjIwMjIxMDEwMTA1MCIKICAgIH0KICB9Cn0==
```

|
|`customer_phone`  
 string, optional  


|Номер телефона пользователя.

 В общем случае должен быть полным, с кодом страны, хотя в отдельных случаях допустимо указание и без кода страны.

 Должен содержать не менее 4 и не более 24 цифр, при этом, если такое допускается в рамках используемого проекта и платёжного метода, в записи номера могут использоваться знаки пунктуации и специальные символы \(подобные случаи, как правило, оговариваются отдельно\).Должен указываться для оплат с прямым использованием платёжных карт, если не указывается адрес электронной почты \(в значении параметра `customer_email`\) и не используется возможность указания таких сведений пользователем \([подробнее](ru_PP_Gathering_customer_data.md)\).

 Шаблон: `^[0-9]{4,24}$`

 Пример: `443031237300`

|
|`customer_security_code`  
 string, optional

|Код подтверждения платежа пользователем.

 Может быть актуален при работе с отдельными платёжными методами\(в соответствии с их спецификой\).

 Пример: `852923`

|
|`customer_shipping`  
 string, optional

|Информация о доставке товара или услуги пользователю.Может быть актуальна при работе с классическими карточными платежами и отдельными платёжными методами.

 Представляет собой строку, полученную в результате кодирования исходного JSON-объекта с применением алгоритма Base64.Этот объект может включать в себя различные сведения из числа допустимых. При оплатах с использованием платёжных карт передача таких сведений вместе с другими сведениями о пользователе может повышать вероятность аутентификации 3‑D Secure без участия пользователя \(с уходом от варианта challenge flow к варианту frictionless flow; [подробнее](ru_pp_3ds.md#)\).

 -   `shipping`, object — объект с информацией о доставке, который может быть актуален для классических карточных платежей и может включать в себя следующие сведения:
    -   `address`, string — название улицы и номер дома в адресе доставки \(с обозначением корпуса или строения, где это актуально\), в виде строки длиной не более 150 символов
    -   `address_usage`, string, `^\\d{2}-\\d{2}-\\d{4}$` — дата первого использования указанного адреса, в формате `ДД-ММ-ГГГГ`
    -   `address_usage_indicator`, string, `^0[1-4]$` — индикатор давности первого использования указанного адреса доставки, который может принимать одно из следующих значений:
        -   `01` — при нулевой давности \(указанный адрес используется впервые\)
        -   `02` — при давности менее 30 дней
        -   `03` — при давности от 30 до 60 дней
        -   `04` — при давности более 60 дней
    -   `city`, string — название города \(или иного населённого пункта\) в адресе доставки, в виде строки длиной не более 50 символов
    -   `country`, string, `^[A-Z]{2}$` — код страны в адресе доставки в формате ISO 3166-1 alpha-2
    -   `delivery_email`, string — адрес электронной почты в случае доставки на этот адрес, может содержать не более 255 символов
    -   `delivery_time`, string, `^0[1-4]$` — индикатор срока доставки, который может принимать одно из следующих значений:
        -   `01` — в день покупки в электронном виде
        -   `02` — в день покупки в материальном виде
        -   `03` — на следующий день после покупки
        -   `04` — позднее чем на следующий день после покупки
    -   `name_indicator`, string, `^0[1-2]$` — индикатор совпадения имени пользователя с именем получателя доставки, который может принимать одно из следующих значений:
        -   `01` — имена совпадают
        -   `02` — имена не совпадают
    -   `postal`, string — почтовый индекс в адресе доставки, представляет собой строку длиной не более 16 символов
    -   `region`, string — название региона \(штата, провинции или иной территориальной области\) в адресе доставки, представляет собой строку длиной не более 255 символов
    -   `region_code`, string, `^[0-9A-Z]{1,3}$` — внутренний код региона в адресе доставки, представляет собой вторую часть международного кода территории \(в формате ISO 3166-2\), без двухбуквенного кода страны и разделительного дефиса
    -   `type`, string, `^0[1-7]$` — индикатор варианта доставки, который может принимать одно из следующих значений:
        -   `01` — доставка на платёжный адрес держателя карты
        -   `02` — доставка на другой подтверждённый адрес
        -   `03` — доставка на адрес, не совпадающий с платёжным и не являющийся подтверждённым
        -   `04` — доставка в магазин мерчанта
        -   `05` — доставка в электронном виде
        -   `06` — отсутствие доставки
        -   `07` — другой вариант

 ```language-json
{ 
  "customer":{ 
    "shipping":{ 
      "type":"01",
      "delivery_time":"01",
      "delivery_email":"test@gmail.com",
      "address_usage_indicator":"01",
      "address_usage":"01-10-2022",
      "city":"Vilnius",
      "country":"LT",
      "address":"Dukstu street 30",
      "postal":"LT-071171",
      "region":"Vilnius County",
      "region_code":"VL",
      "name_indicator":"01"
    }
  }
}
```

 ```
eyAKICAiY3VzdG9tZXIiOnsgCiAgICAic2hpcHBpbmciOnsgCiAgICAgICJ0eXBlIjoiMDEiLAogICAgICAiZGVsaXZlcnlfdGltZSI6IjAxIiwKICAgICAgImRlbGl2ZXJ5X2VtYWlsIjoidGVzdEBnbWFpbC5jb20iLAogICAgICAiYWRkcmVzc191c2FnZV9pbmRpY2F0b3IiOiIwMSIsCiAgICAgICJhZGRyZXNzX3VzYWdlIjoiMDEtMTAtMjAyMiIsCiAgICAgICJjaXR5IjoiTW9zY293IiwKICAgICAgImNvdW50cnkiOiJSVSIsCiAgICAgICJhZGRyZXNzIjoiTGVuaW5hIHN0cmVldCAxMiIsCiAgICAgICJwb3N0YWwiOiIxMDkxMTEiLAogICAgICAicmVnaW9uX2NvZGUiOiJSVSIsCiAgICAgICJuYW1lX2luZGljYXRvciI6IjAxIgogICAgfQogIH0KfQ====
```

|
|`customer_ssn`  
 integer, optional

|Последние 4 цифры в номере социального страхования налогоплательщика в США.

 Передача этих сведений вместе с другими сведениями о пользователе может способствовать избеганию процедуры дополнения информации о платеже и упрощать пользовательский сценарий \([подробнее](ru_PP_Gathering_customer_data.md)\).

 Пример: `1984`

|
|`customer_state`  
 string, optional

|Название региона\(штата, провинции или иной территориальной области\) в адресе проживания пользователя.

 Представляет собой строку длиной не более 255 символов.Передача этих сведений вместе с другими сведениями о пользователе может способствовать избеганию процедуры дополнения информации о платеже и упрощать пользовательский сценарий \([подробнее](ru_PP_Gathering_customer_data.md)\).

 Пример: `Greater London`

|
|`customer_street`  
 string, optional

|Название улицы в адресе проживания пользователя.

 Представляет собой строку длиной не более 255 символов.Передача этих сведений вместе с другими сведениями о пользователе может способствовать избеганию процедуры дополнения информации о платеже и упрощать пользовательский сценарий \([подробнее](ru_PP_Gathering_customer_data.md)\).

 Пример: `Main`

|
|`customer_zip`  
 string, optional

|Почтовый индекс в адресе проживания пользователя.

 Представляет собой строку длиной не более 10 символов.Передача этих сведений вместе с другими сведениями о пользователе может способствовать избеганию процедуры дополнения информации о платеже и упрощать пользовательский сценарий \([подробнее](ru_PP_Gathering_customer_data.md)\).

 Пример: `75001`

|
|`debt_account`  
 string, optional

|Номер счёта для получения средств в рамках оплаты с погашением задолженности пользователя.

 Актуален при проведении соответствующих оплат \([подробнее](ru_PP_debt_repayments.md)\).Может содержать не более 10 символов, среди которых допустимы буквы латинского алфавита и цифры.

 Пример: `an9876170i`

|
|`force_acs_new_window`  
 integer \(boolean\*\), optional

|Указатель необходимости использования отдельной вкладки при перенаправлении пользователя к стороннему сервису \([подробнее](ru_PP_redirect_modes.md#)\).

 Может быть актуален при работе с отдельными платёжными методами и допускает следующие значения:

 -   `0` — для перенаправления тем способом, который задан для используемого платёжного метода и применяется для него по умолчанию;
-   `1` — для перенаправления в отдельной вкладкенезависимо от способа, который задан для используемого платёжного метода по умолчанию.

 При работе с библиотекой `merchant.js` \([подробнее](ru_pp_interaction_organisation.md#)\) значение этого параметра допустимо указывать как булево: `false` или `true`.

 Пример: `1`

|
|`force_payment_method`  
 string, optional

|Служебный код платёжного метода, который следует использовать в качестве предварительно выбранногодля проведения платежа \([подробнее](ru_PP__PreselectingPS.md)\).

 Может принимать значения в соответствии [со справочником](ru_pm_codes.md).

 Пример: `paypal-wallet`

|
|`force_payment_group`   
 string, optional

|Служебный код группы платёжных методов, которую следует использовать в качестве предварительно выбранной для проведения платежа \([подробнее](ru_PP__PreselectingPS.md)\).

 При указании такого кода доступными для выбора являются те методы, которые входят в указанную группу и доступны в рамках используемого проекта. Вместе с тем, при указании этого кода в одном запросе с кодом конкретного метода \(в значении параметра `force_payment_method`\) платёжная форма открывается для проведения оплаты указанным методом, без учёта выбранной группы.

 В настоящее время с помощью этого параметра применим выбор группы методов Open Banking — с помощью идентификатора `openbanking`.

 Пример: `openbanking`

|
|`force_payment_method_subtype`  
 string, optional

|Служебный код бренда платёжных карт, который следует использовать в качестве предварительно выбранного для проведения платежа \([подробнее](ru_PP__PreselectingPS.md)\).

 Может принимать значения в соответствии [со справочником](ru_card_codes.md).

 Пример: `mastercard`

|
|`hide`  
 string, optional

|Набор служебных кодов тех методов, которые следует исключить из выбора для конкретного платежа\([подробнее](ru_pp_methods_availability.md#)\).

 Может включать в себя коды в соответствии [со справочником](ru_pm_codes.md) и с использованием запятой и пробела в качестве разделителя.

 Пример: `card, cup-union`

|
|`identify_doc_number`  
 string, optional

|Идентификатор документа, подтверждающего личность пользователя.

 Может быть актуален при работе с отдельными платёжными методами и с учётом специфики метода может представлять собой номер удостоверяющего личность документа, номер налогоплательщика\(как при работе с методом [PIX](pm_pix.md#)\) или иные сведения подобного характера.

 Пример: `6543234567`

|
|`interface_type`  
 string, optional

|Служебный идентификатор интерфейса, используемого для проведения платежа через платёжную платформу.

 Может использоваться в отдельно оговариваемых случаях.

 Пример: `{"id":7}`

|
|`language_code`  
 string, optional  


|Код целевого языка для отображения платёжной формы \([подробнее](ru_PP_WigetLanguages.md)\) и отправки пользователю дополнительных уведомлений о проведении платежа \([подробнее](ru_PP_receipt_data.md)\).

 Может представлять собой двухбуквенный код в формате ISO 639-1 alpha-2 \(согласно [справочнику](ru_language_codes.md)\) и в отдельно согласованных случаях код, не входящий в указанный стандарт.

 Шаблон: `/^([a-z]{2}|zh\-hant)$/i`

 Пример: `de`

|
|`merchant_callback_url`   
 string, optional

|Aдрес доставки оповещений по запросу.

 Актуален, когда оповещения по конкретному вызову Payment Page необходимо отправлять на специфический адрес, отличающийся от заданных по умолчанию \(подробнее об оповещениях и работе с ними — [в отдельной статье](ru_platform_callbacks.md#)\).

 Пример: `https://cosmoshop.earth/specialorder`

|
|`merchant_data`  
 string, optional

|Дополнительная информация для учёта на стороне веб-сервиса.

 Состав сведений, передаваемых в значении этого параметра, может быть произвольным, но должен предварительно согласовываться и настраиваться для корректной обработки в платформе и представления в оповещениях и карточках платежей \([подробнее](ru_pp_additional_data.md#)\). В согласованных случаях может представлять собой JSON-объект, при передаче которого методом POST требуется экранировать символ `"` \(двойной штрих, U+0022\) путём постановки перед ним символа `\` \(косой обратной черты, U+005C\), в то время как при использовании метода GET экранирование может быть необязательным.

 ``` {#codeblock_f2k_rv1_4fc .language-json}
"merchant_data": "{"items":[{"sku":"GM12-CC",
        "description":"10 Copper Coins","count":1},
        {"sku":"GM12-GC","description":"Golden Coin",
        "count":2}],"total_count":3,"user_id":"122"}"
```

 ``` {#codeblock_hnr_wvd_wdc .language-json}
"merchant_data": "{\"items\":[{\"sku\":\"GM12-CC\",
        \"description\":\"10 Copper Coins\",\"count\":1},
        {\"sku\":\"GM12-GC\",\"description\":\"Golden Coin\",
        \"count\":2}],\"total_count\":3,\"user_id\":\"122\"}"
```

|
|`merchant_descriptor`   
 string, optional

|Сведения о мерчанте для предоставления организациям, участвующим в проведении карточных платежей, и, через них, пользователям.

 Могут быть актуальны при проведении оплат и проверок действительности платёжных карт, при этом длина строки для карт платёжной системы Mastercard ограничивается 22 символами, а для карт платёжной системы Visa — 25 символами. Более подробная информация о работе с этими сведениями представлена [в отдельной статье](ru_pp_descriptor.md).

 Пример: `Cosmotour* to the Moon`

|
|`merchant_domain`  
 string, optional

|Доменное имя веб-сервиса, в котором необходимо открыть платёжную форму.

 Актуально, когда используется открытие платёжной формы с помощью встроенных кнопок Apple Pay и Google Pay \(подробнее — [в отдельной статье](ru_pp_embedded_payment_buttons.md#)\).

 Пример: `merchant.example.com`

|
|`merchant_fail_enabled`  
 integer, optional

|Вариант обеспечения для пользователя доступности итогового возвращения к веб-сервису при отклонении оплаты.

 Может принимать одно из следующих значений:

 -   `0` — отсутствие доступа к возможности возвращения;
-   `1` — частичная доступность возвращения,в рамках которой при открытии Payment Page в объекте iframe или модальном окне перенаправление к веб-сервису не выполняется, а при открытии Payment Page в отдельной вкладке браузераспособ открытия страницы веб-сервиса определяется через параметр группы `mode`;
-   `2` — полная доступность возвращения, используемая по умолчаниюи сочетаемая со способом открытия страницы веб-сервиса, указанным в параметре группы `mode`.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `2`

|
|`merchant_fail_redirect_mode`  
 string, optional

|Указатель способа, применяемого для итогового возвращения к веб-сервису по решению пользователя при отклонении оплаты.

 Может принимать одно из следующих значений:

 -   `iframe` — открытие страницыв объекте iframe \(работающее при открытии платёжной формы в объекте iframe или модальном окне; при открытии платёжной формы в отдельной вкладке этот способ ведёт к перенаправлению в этой же вкладке\);
-   `parent_page` — открытие страницыв используемой вкладке;
-   `blank_page` — открытие страницыв новой вкладке.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `blank_page`

|
|`merchant_fail_url`  
 string, optional

|Адрес для итогового возвращения к веб-сервису по решению пользователя при отклонении оплаты.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `https://cosmoshop.jupiter.example/pages/failed`

|
|`merchant_return_enabled`  
 integer, optional

|Вариант обеспечения для пользователя доступности предварительного возвращения к веб-сервису со страниц платёжной формы.

 Может принимать одно из следующих значений:

 -   `0` — отсутствие доступа к возможности возвращения;
-   `1` — частичная доступность возвращения, в рамках которой при открытии Payment Page в объекте iframe или модальном окне перенаправление к веб-сервису не выполняется, апри открытии Payment Page в отдельной вкладке браузераспособ открытия страницы веб-сервиса определяется через параметр группы `mode`;
-   `2` — полная доступность возвращения, используемая по умолчаниюи сочетаемая со способом открытия страницы веб-сервиса, указанным в параметре группы `mode`.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `0`

|
|`merchant_return_redirect_mode`  
 string, optional

|Указатель способа, применяемого для предварительного возвращения к веб-сервису со страниц платёжной формы.

 Может принимать одно из следующих значений:

 -   `iframe` — открытие страницыв объекте iframe \(работающее при открытии платёжной формы в объекте iframe или модальном окне; при открытии платёжной формы в отдельной вкладке этот способ ведёт к перенаправлению в этой же вкладке\);
-   `parent_page` — открытие страницыв используемой вкладке;
-   `blank_page` — открытие страницыв новой вкладке.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `iframe`

|
|`merchant_return_url`  
 string, optional

|Адрес для предварительного возвращения к веб-сервису со страниц платёжной формы.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `https://cosmoshop.jupiter.example/return`

|
|`merchant_success_enabled`  
 integer, optional

|Вариант обеспечения для пользователя доступности итогового возвращения к веб-сервису при проведении оплаты.

 Может принимать одно из следующих значений:

 -   `0` — отсутствие доступа к возможности возвращения;
-   `1` — частичная доступность возвращения, в рамках которой при открытии Payment Page в объекте iframe или модальном окне перенаправление к веб-сервису не выполняется, апри открытии Payment Page в отдельной вкладке браузераспособ открытия страницы веб-сервиса определяется через параметр группы `mode`;
-   `2` — полная доступность возвращения, используемая по умолчаниюи сочетаемая со способом открытия страницы веб-сервиса, указанным в параметре группы `mode`.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `1`

|
|`merchant_success_redirect_mode`  
 string, optional

|Указатель способа, применяемого для итогового возвращения к веб-сервису по решению пользователя при проведении оплаты.

 Может принимать одно из следующих значений:

 -   `iframe` — открытие страницыв объекте iframe \(работающее при открытии платёжной формы в объекте iframe или модальном окне; при открытии платёжной формы в отдельной вкладке этот способ ведёт к перенаправлению в этой же вкладке\);
-   `parent_page` — открытие страницыв используемой вкладке;
-   `blank_page` — открытие страницыв новой вкладке.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `parent_page`

|
|`merchant_success_url`  
 string, optional

|Адрес для итогового возвращения к веб-сервису по решению пользователя при проведении оплаты.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `https://cosmoshop.jupiter.example/pages/success`

|
|`mode`  
 string, optional

|Указатель режима работы Payment Page.

 Может принимать одно из следующих значений:

 -   `purchase` — для проведения оплатыв режиме Purchase \(этот режимиспользуется по умолчанию\);
-   `payout` — для проведения выплатыв режиме Payout;
-   `card_verify` — для проверки действительности платёжного инструментав режиме Card Verify;
-   `card_tokenize` — для формирования токена платёжных данныхв режиме Card Tokenize.

 Пример: `card_verify`

|
|`moto_type`  
 integer, optional

|Тип заказа для проведения оплаты категории Mail Order/Telephone Order \(с предоставлением реквизитов платёжной карты её держателем по телефону, почте, факсимильной связи или электронной почте\):

 -   `1` — Mail Order;
-   `2` — Telephone Order.

 Пример: `2`

|
|`operation_type`  
 string, optional

|Указатель варианта проведения оплаты— в одну или две стадии.

 Актуален в тех случаях, когда необходимо использовать вариант, отличный от заданного по умолчанию. Может принимать одно из следующих значений:

 -   `sale` — для оплатыв одну стадию \(с незамедлительным списанием средств;[подробнее](ru_pp_purchase.md)\);
-   `auth` — для оплатыв две стадии \(с предварительной блокировкой и последующим списанием средств;[подробнее](ru_pp_purchase_auth.md)\).

 Пример: `auth`

|
|`payment_amount`  
 integer, required\*

|Сумма платежа.

 Приводится в дробных единицах валюты без десятичного разделителя.Не используется в режиме Card Tokenize, в остальных случаях обязательна.

 Пример: `1815`\(для суммы 18,15 при использовании валюты с двумя дробными разрядами\)

|
|`payment_cryptocurrency_type` string, optional

|Указатель категории цифровой валюты.

 Обязателен при выполнении операций, связанных с использованием криптовалют в рамках сервисов Mastercard MoneySend и Visa Direct. Может принимать одно из следующих значений:

 -   `cbdc` — цифровая валюта центрального банка или токенизированный депозит, выпущенные определённым государством;
-   `stablecoins_fiat_backed` — цифровая валюта \(в виде стейблкоина\), чья стабильность обеспечивается за счёт резервов в определённой фиатной валюте;
-   `native_tokens` — цифровая валюта определённого блокчейна, необходимая для выполнения операций в его сети, в том числе для оплаты комиссий;
-   `other` — нефиатная валюта, которая заведомо не относится ни к одной из других категорий либо не может быть отнесена ни к одной из категорий при инициировании операции.

 Пример: `cbdc`

|
|`payment_currency`  
 string, required\*  


|Трёхбуквенный код валюты платежа.

 Указывается в формате ISO-4217 alpha-3, согласно [справочнику](ru_currency_codes.md). Не используется в режиме Card Tokenize, в остальных случаях обязателен.

 Шаблон: `^[A-Z]{3}$`

 Пример: `EUR`

|
|`payment_description`  
 string, optional

|Краткое описание платежадля отображения пользователю и учёта на стороне веб-сервиса.

 Представляет собой строку длиной не более 255 символов. Может отображаться пользователю на странице с информацией о результате выполнения операции и быть доступным на стороне веб-сервиса через программные оповещения и интерфейс Dashboard.

 Пример: `Thai massage session`

|
|`payment_extra_param`  
 string, optional

|Дополнительная информация, актуальная для проведения платежа.

 Может быть уместной при работе с отдельными платёжными методами и в иных специфических случаях. Как правило, уместность и способы использования этого параметра, а также форматы передаваемых в нём данных согласовываются отдельно, на этапе технической интеграции веб-сервиса с платформой Ecommpay или при подключении дополнительных методов и возможностей.

|
|`payment_id`  
 string, required\*

|Идентификатор платежа.

 Должен задаваться на стороне веб-сервиса и представлять собой строку длиной не более 255 символов с обеспечением регистронезависимости и уникальности в рамках используемого проекта.Не используется в режиме Card Tokenize, в остальных случаях обязателен.

 Пример: `payment_443`

|
|`payment_merchant_risk`  
 string, optional

|Дополнительные сведения об оплате товара или услуги пользователем и о предпочтительном для мерчанта варианте аутентификации 3‑D Secure.

 Представляют собой строку, полученную в результате кодирования исходного JSON-объекта с применением алгоритма Base64.Этот объект может включать в себя различные сведения из числа допустимых. При оплатах с использованием платёжных карт передача этих сведений вместе с другими сведениями о пользователе может повышать вероятность аутентификации 3‑D Secure без участия пользователя \(с уходом от варианта challenge flow к варианту frictionless flow; [подробнее](ru_pp_3ds.md#)\).

 -   `challenge_indicator`, string, `^0[1-9]$` — указатель предпочтения по использованию варианта аутентификации challenge flow, может принимать следующие значения:
    -   `01` — без предпочтений
    -   `02` — предпочтительно не выполнять
    -   `03` — предпочтительно выполнять
    -   `04` — обязательно выполнять
    -   `05` — не выполнять, анализ рисков выполнен на стороне мерчанта
    -   `06` — не выполнять, применить сценарий Data Only
    -   `07` — не выполнять, Strong Customer Authentication уже выполнена иным способом
    -   `08` — не выполнять, мерчант включен в список доверенных для этого пользователя
    -   `09` — обязательно выполнять, предпочтительно предложить пользователю добавить мерчанта в список доверенных
-   `challenge_window`, string, `^0[1-5]$` — размер окна для открытия страницы аутентификации, может принимать следующие значения:
    -   `01` — 250 x 400 пикселей
    -   `02` — 390 x 400 пикселей
    -   `03` — 500 x 600 пикселей
    -   `04` — 600 x 400 пикселей
    -   `05` — полноэкранный режим
-   `gift_card`, object — объект с информацией об оплате предоплаченными или подарочными картами:
    -   `amount`, integer — общая сумма оплаты предоплаченными или подарочными картами в минорных единицах валюты
    -   `count`, integer — количество предоплаченных или подарочных карт, использованных для оплаты
    -   `currency`, string — код валюты оплаты предоплаченными или подарочными картами в формате ISO 4217 alpha-3
-   `preorder_date`, string, `^\\d{2}-\\d{2}-\\d{4}$` — планируемая дата поступления товара или услуги в формате `ДД-ММ-ГГГГ`
-   `preorder_purchase`, string, `^0[1-2]$` — индикатор предварительного заказа, может принимать следующие значения:
    -   `01` — не является предварительным заказом
    -   `02` — является предварительным заказом
-   `reorder`, string, `^0[1-2]$` — индикатор первичной или повторной покупки данного товара или услуги пользователем, может принимать следующие значения:
    -   `01` — первичная покупка
    -   `02` — повторная покупка

 ```language-json
{ 
  "payment":{ 
    "reorder":"01",
    "preorder_purchase":"01",
    "preorder_date":"11-10-2022",
    "challenge_indicator":"01",
    "challenge_window":"01",
    "gift_card":{ 
      "amount":12345,
      "currency":"USD",
      "count":1
    }
  }
}
```

 ```
eyAKICAicGF5bWVudCI6eyAKICAgICJyZW9yZGVyIjoiMDEiLAogICAgInByZW9yZGVyX3B1cmNoYXNlIjoiMDEiLAogICAgInByZW9yZGVyX2RhdGUiOiIxMS0xMC0yMDIyIiwKICAgICJjaGFsbGVuZ2VfaW5kaWNhdG9yIjoiMDEiLAogICAgImNoYWxsZW5nZV93aW5kb3ciOiIwMSIsCiAgICAiZ2lmdF9jYXJkIjp7IAogICAgICAiYW1vdW50IjoxMjM0NSwKICAgICAgImN1cnJlbmN5IjoiVVNEIiwKICAgICAgImNvdW50IjoxCiAgICB9CiAgfQp9==
```

|
|`payment_methods_options`  
 string, optional

|Дополнительные сведения, актуальные при работе с отдельными платёжными методами и сторонними сервисами.

 Могут быть актуальны для управления возможностями выбора отдельных методови банков, для передачи дополнительных сведений о пользователе и платеже, для управления размерами страниц сторонних сервисов при перенаправлении к ним и для других целей — в соответствии со спецификой используемых платёжных методов.

 Пример: `{\"online_thailand_banks\": {\"split_banks\": true}}`

|
|`project_id`  
 integer, required

|Идентификатор проектавзаимодействия веб-сервиса с платёжной платформой, полученный от Ecommpayпри интеграции \([подробнее](ru_glossary.md#)\).

 Пример: `57123`

|
|`receipt_data`  
 string, optional

|Информация о товарных позициях оплачиваемого заказа.

 Может использоваться для отправки пользователю \([подробнее](ru_PP_receipt_data.md)\).Представляют собой строку, полученную в результате кодирования исходного JSON-объекта с применением алгоритма Base64.Этот объект может включать в себя различные сведения из числа допустимых.

 -   `positions`, array — массив, в котором можно перечислить до 300 товарных позиций; для каждой товарной позиции указывается следующее:
    -   `amount`, integer — стоимость товара
    -   `quantity`, integer — количество товарных единиц
    -   `tax`, integer — ставка налога на добавленную стоимость \(НДС\), если она отличается для разных товарных позиций
    -   `tax_amount`, integer — сумма налога на добавленную стоимость \(НДС\)
    -   `description`, string — произвольное описание товара
-   `total_tax_amount`, integer — общая сумма НДС за всю покупку
-   `common_tax`, integer — ставка налога на добавленную стоимость \(НДС\), если она одинаковая для всех товарных позиций

 ``` {#codeblock_jg4_sj2_wdc .language-json}
{  
   "receipt_data":{  
      "positions":[  
         {  
            "quantity":3,
            "amount":10000,
            "tax":18,
            "tax_amount":1800,
            "description":"Рамка с дизайном"
         }
      ],
      "total_tax_amount":1800,
      "common_tax":18       
   }
}
```

 ``` {#codeblock_trx_sj2_wdc}
receipt_data: "eyAgCiAgICAgICJwb3NpdGlvbnMiOlsgIAogICAgICAgICB7ICAKICAgICAgICAg
ICAgInF1YW50aXR5IjozLAogICAgICAgICAgICAiYW1vdW50IjoxMDAwMCwKICAgICAgICAgICAgInRheCI6MTgsCiAg
ICAgICAgICAgICJ0YXhfYW1vdW50IjoxODAwLAogICAgICAgICAgICAiZGVzY3JpcHRpb24iOiLQoNCw0LzQutCwING
BINC00LjQt9Cw0LnQvdC+0LwiCiAgICAgICAgIH0KICAgICAgXSwKICAgICAgInRvdGFsX3RheF9hbW91bnQiOjE4MDAs
CiAgICAgICJjb21tb25fdGF4IjoxOCAgICAgICAKfQ"
```

|
|`recipient_address`   
 string, optional

|Название улицы и номер дома\(с обозначением корпуса или строения, где это актуально\) в адресе местонахождения получателя платежа.

 Представляют собой строку длиной не более 99 символов и являютсяобязательными при выполнении операций Visa Direct, когда передаются в запросе на выполнение списания с карты, выпущенной в Австралии, Канаде или Новой Зеландии.

 Пример: `Via Dietro Duomo 36`

|
|`recipient_card_holder`   
 string, optional  


|Имя и фамилия держателя платёжной карты, используемой получателем платежа.

 Должны соответствовать написанию, используемому непосредственно на карте, а также общим требованиям к написанию \([подробнее](ru_faq_payment_processing.md)\), не превышая при этом 255 символов.

 Пример: `Fran Petrarca`

|
|`recipient_city`   
 string, optional

|Название города \(или иного населённого пункта\) в адресе местонахождения получателя платежа.

 Представляет собой строку длиной не более 25 символов.

 Пример: `Padova`

|
|`recipient_country`   
 string, optional  


|Код страны в адресе местонахождения получателя платежа.

 Указывается в формате ISO 3166-1 alpha-2.

 Шаблон: `^[A-Z]{2}$`

 Пример: `IT`

|
|`recipient_day_of_birth`  
 string, optional  


|Дата рождения получателя платежа.

 Должна указываться в формате `ДД-ММ-ГГГГ` при использовании получателем карты Visa.

 Шаблон: `^\\d{2}-\\d{2}-\\d{4}$`

 Пример: `12-12-1990`

|
|`recipient_first_name`   
 string, optional

|Имя получателя платежа.

 Представляет собой строку длиной не более 255 символов.

 Пример: `Fran`

|
|`recipient_last_name`   
 string, optional

|Фамилия получателя платежа.

 Представляет собой строку длиной не более 255 символов.

 Пример: `Petrarca`

|
|`recipient_pan`   
 string, optional  


|Номер платёжной карты, используемой получателем платежа.

 Должен указываться в явном виде, без маскирования и без пробелов и иных разделительных символов.

 Шаблон: `^[0-9]{15,19}$`

 Пример: `4314220000000056`

|
|`recipient_state`   
 string, optional  


|Внутренний код региона\(штата, провинции или иной территориальной области\) в адресе местонахождения получателя выплаты \([подробнее](ru_Gate_payout.md)\).

 Представляет собой вторую часть международного кода территории \(в формате ISO 3166-2\), без двухбуквенного кода страны и разделительного дефиса, и является применимым при проведении выплат, когда передаётся в одном запросе с кодом страны в значении параметра `recipient_country` и когда код страны соответствует Канаде \(`CA`\) или США \(`US`\).

 Шаблон: `^[A-Z]+$`

 Пример: `AK`\(для Аляски, с полным кодом `US-AK`\)

|
|`recipient_state_code`   
 string, optional  


|Внутренний код региона\(штата, провинции или иной территориальной области\) в адресе местонахождения получателя перевода с использованием сервиса Mastercard MoneySend или Visa Direct \([подробнее](ru_gate_money_transfer_services.md#)\).

 Представляет собой вторую часть международного кода территории \(в формате ISO 3166-2\), без двухбуквенного кода страны и разделительного дефиса, и является применимым при выполнении операций Mastercard MoneySend и Visa Direct, когда передаётся в одном запросе с кодом страны в значении параметра `recipient_country` и когда код страны соответствует Канаде \(`CA`\) или США \(`US`\).

 Шаблон: `^[A-Z]+$`

 Пример: `ON`\(для Онтарио, с полным кодом `CA-ON`\)

|
|`recipient_wallet_id`   
 string, optional  


|Идентификатор электронного кошелька, используемого получателем платежа.

 Представляет собой строку длиной не более 64 символов. Должен указываться в явном виде, без маскирования и без дополнительных пробелов и иных разделительных символов.

 Шаблон: `^[^!@&~№{}|<>\\[\\]]*$`

 Пример: `WID20071304`

|
|`recipient_wallet_owner`   
 string, optional  


|Имя и фамилия владельца электронного кошелька, используемого получателем платежа.

 Должны соответствовать написанию, заданному в платёжной системе, не превышая при этом 255 символов.

 Шаблон: `/^[\p{L}\p{M}0-9 .'-]+$/u`

 Пример: `Fran Petrarca`

|
|`recurring`  
 string, optional

|Сведения о регистрируемой повторяемой оплате \([подробнее](ru_pp_recurring.md)\).

 При использовании JavaScript-библиотеки Ecommpay могут представлять собой JSON-объект, в других случаях должны указываться в виде URL-строки\(полученной из исходного JSON-объекта с помощью преобразования URL-encoding\).

 -   `register`, boolean — указатель необходимости зарегистрировать повторяемую оплату
-   `type`, string, `^[RCU]$` — категория регистрируемой повторяемой оплаты, с одним из следующих значений:
    -   `R` — для регулярной оплаты
    -   `C` — для экспресс-оплаты
    -   `U` — для автооплаты
-   `period`, string, `^[DWMQY]$` — указатель базового периода списаний \(для регулярной оплаты\), с одним из следующих значений:
    -   `D` — ежедневно
    -   `W` — еженедельно
    -   `M` — ежемесячно \(если установленный день отсутствует в следующем месяце, например 31, — списание происходит в последний день месяца\)
    -   `Q` — ежеквартально
    -   `Y` — ежегодно
-   `amount`, integer — фиксированная сумма последующих списаний \(для регулярной оплаты\) в дробных единицах валюты
-   `interval`, integer — множитель для кратного увеличения периода списаний \(для регулярной оплаты\), актуальный при указании параметра `period` и указываемый в виде числа от `1` до `100`
-   `time`, string, `^([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$` — время выполнения последующих списаний \(для регулярной оплаты\), актуальное при указании параметра `period` и указываемое в формате `чч:мм:сс`
-   `start_date`, string, `^([0-3]\\d-){2}[1-2]\\d{3}$` — дата первого списания \(для регулярной оплаты\), актуальная при указании параметра `scheduled_payment_id` и указываемая в формате `ДД-ММ-ГГГГ`
-   `expiry_day`, integer илиstring — номер календарного дня, в который должна быть завершена повторяемая оплата \(в виде числа от `1` до `31`, без ведущего нуля, по григорианскому календарю\)
-   `expiry_month`, integer илиstring — порядковый номер месяца, в котором должна быть завершена повторяемая оплата \(в виде числа от `1` до `12`, без ведущего нуля, по григорианскому календарю\)
-   `expiry_year`, integer — порядковый номер года, в котором должна быть завершена повторяемая оплата \(в четырёхзначном формате `ГГГГ`, по григорианскому календарю\)
-   `scheduled_payment_id`, string — идентификатор платежа, в рамках которого следует выполнять списания \(должен отличаться от идентификатора платежа, который используется для регистрации повторяемой оплаты и указывается в параметре `payment_id`\)

 ```language-json
{
    "register": true,
    "type": "U"
}
```

 ```language-json
%7B%22register%22%3Atrue%2C%22type%22%3A%22U%22%7D%2C
```

|
|`redirect`  
 integer \(boolean\*\), optional

|Указатель необходимости открытия платёжной формы в виде отдельной HTML-страницы независимо от типа используемого устройства \([подробнее](ru_PP_method_NewTab.md#)\).

 Может принимать следующие значения:

 -   `0` — для открытияплатёжной формы тем способом, который используется по умолчанию или задан через другие параметры;
-   `1` — для открытияплатёжной формы в виде отдельной HTML-страницы.

 При работе с библиотекой `merchant.js` \([подробнее](ru_pp_interaction_organisation.md#)\) значение этого параметра допустимо указывать как булево: `false` или `true`.

 Пример: `1`

|
|`redirect_fail_mode`  
 string, optional

|Указатель способа, применяемого для автоматического итогового возвращения пользователя к веб-сервису при отклонении оплаты.

 Может принимать одно из следующих значений:

 -   `iframe` — открытие страницыв объекте iframe \(работающее при открытии платёжной формы в объекте iframe или модальном окне; при открытии платёжной формы в отдельной вкладке этот способ ведёт к перенаправлению в этой же вкладке\);
-   `parent_page` — открытие страницыв используемой вкладке;
-   `blank_page` — открытие страницыв новой вкладке.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `blank_page`

|
|`redirect_fail_url`  
 string, optional

|Адрес для автоматического итогового возвращения пользователя к веб-сервису при отклонении оплаты.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `https://cosmoshop.jupiter.example/pages/failed`

|
|`redirect_on_mobile`  
 integer \(boolean\*\), optional

|Указатель необходимости открытия платёжной формы в виде отдельной HTML-страницы на мобильных устройствах \([подробнее](ru_PP_method_NewTab.md#)\).

 Может принимать следующие значения:

 -   `0` — для открытияплатёжной формы тем способом, который используется по умолчанию или задан через другие параметры;
-   `1` — для открытияплатёжной формы в виде отдельной HTML-страницы.

 При работе с библиотекой `merchant.js` \([подробнее](ru_pp_interaction_organisation.md#)\) значение этого параметра допустимо указывать как булево: `false` или `true`.

 Пример: `1`

|
|`redirect_success_mode`  
 string, optional

|Указатель способа, применяемого для автоматического итогового возвращения пользователя к веб-сервису при проведении оплаты.

 Может принимать одно из следующих значений:

 -   `iframe` — открытие страницыв объекте iframe \(работающее при открытии платёжной формы в объекте iframe или модальном окне; при открытии платёжной формы в отдельной вкладке этот способ ведёт к перенаправлению в этой же вкладке\);
-   `parent_page` — открытие страницыв используемой вкладке;
-   `blank_page` — открытие страницыв новой вкладке.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `parent_page`

|
|`redirect_success_url`  
 string, optional

|Адрес для автоматического итогового возвращения пользователя к веб-сервису при проведении оплаты.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `https://cosmoshop.jupiter.example/pages/success`

|
|`redirect_return_url`  
 string, optional

|Адрес для промежуточного возвращения к веб-сервису со страниц сторонних сервисов, таких как сервисы банков или платёжных систем.

 Может использоваться при работе с отдельными сервисами после согласования и подключения такой функциональности. Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `https://cosmoshop.jupiter.example/pages/third_party_services`

|
|`redirect_tokenize_mode`  
 string, optional

|Указатель способа, применяемого для автоматического итогового возвращения пользователя к веб-сервису при формировании токена платёжных данных в режиме Card Tokenize.

 Может принимать одно из следующих значений:

 -   `iframe` — открытие страницыв объекте iframe \(работающее при открытии платёжной формы в объекте iframe или модальном окне; при открытии платёжной формы в отдельной вкладке этот способ ведёт к перенаправлению в этой же вкладке\);
-   `parent_page` — открытие страницыв используемой вкладке.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `parent_page`

|
|`redirect_tokenize_url`  
 string, optional

|Адрес для автоматического итогового возвращения пользователя к веб-сервису при формировании токена платёжных данных в режиме Card Tokenize.

 Подробнее об управлении возможностями возвращения пользователей к веб-сервису — [в отдельной статье](ru_PP_redirect_modes.md#).

 Пример: `https://cosmoshop.jupiter.example/pages/tokenize`

|
|`region_code`  
 string, optional  


|Код страны местонахождения пользователя.

 Указывается в формате ISO 3166-1 alpha-2. В случаях, когда этот код не указывается, страна может определяться по IP-адресу пользователя или иным параметрам.

 Шаблон: `^[A-Z]{2}$`

 Пример: `FR`

|
|`sender_address`   
 string, optional

|Название улицы и номер дома\(с обозначением корпуса или строения, где это актуально\) в адресе местонахождения отправителя платежа.

 Представляет собой строку длиной не более 99 символов.

 Пример: `Via Certaldo 18`

|
|`sender_city`   
 string, optional

|Название города \(или иного населённого пункта\) в адресе местонахождения отправителя платежа.

 Представляет собой строку длиной не более 25 символов.

 Пример: `Florence`

|
|`sender_country`   
 string, optional  


|Код страны в адресе местонахождения отправителя платежа.

 Указывается в формате ISO 3166-1 alpha-2.

 Шаблон: `^[A-Z]{2}$`

 Пример: `IT`

|
|`sender_descriptor`   
 string, optional

|Сведения о мерчанте для предоставления организациям, участвующим в проведении карточных платежей, и, через них, пользователям.

 Могут быть актуальны при проведении выплат, при этом длина строки для карт платёжной системы Mastercard ограничивается 22 символами, а для карт платёжной системы Visa — 25 символами. Более подробная информация о работе с этими сведениями представлена [в отдельной статье](ru_pp_descriptor.md).

 Пример: `Cosmotour* to the Moon`

|
|`sender_first_name`   
 string, optional

|Имя отправителя платежа.

 Представляет собой строку длиной не более 255 символов.

 Пример: `Gio`

|
|`sender_last_name`   
 string, optional

|Фамилия отправителя платежа.

 Представляет собой строку длиной не более 255 символов.

 Пример: `Boccaccio`

|
|`sender_state`   
 string, optional

|Внутренний код региона\(штата, провинции или иной территориальной области\) в адресе местонахождения отправителя платежа.

 Представляет собой вторую часть международного кода территории \(в формате ISO 3166-2\), без двухбуквенного кода страны и разделительного дефиса, и является применимымв тех случаях, когда передаётся в одном запросе с кодом страны в значении параметра `sender_country`.

 Пример: `52`\(для Тосканы, с полным кодом IT‑52\)

|
|`sender_wallet_id`   
 string, optional

|Идентификатор электронного кошелька, используемого отправителем платежа.

 Представляет собой строку длиной не более 64 символов. Должен указываться в явном виде, без маскирования и без дополнительных пробелов и иных разделительных символов.

 Пример: `WID16061313`

|
|`sender_zip`   
 string, optional

|Почтовый индекс в адресе местонахождения отправителя платежа.

 Представляет собой строку длиной не более 255 символов.

 Пример: `50142`

|
|`signature`  
 string, required

|Цифровая подпись к параметрам запроса.

 Должна составляться после указания всех целевых параметров в соответствии с заданным алгоритмом \([подробнее](ru_platform_signature.md#)\).

|
|`style_id`  
 integer, optional

|Идентификатор стиля оформления платёжной формы.

 Может использоваться при работе с различными стилями оформления Payment Page \([подробнее](ru_PP__design_customisation.md#)\).

 Пример: `6123`

|
|`target_element`  
 string, optional

|Идентификатор элемента iframe \(в рамках HTML-страницы веб-сервиса\), в котором необходимо открыть платёжную форму \([подробнее](ru_PP_method_Embedded.md#)\).

 Пример: `widget-container`

|
|`uuid`   
 string, optional

|Служебный идентификатор.

 Представляет собой строку длиной не более 64 символов.Может использоваться при вызове платёжной формы в режиме Payout \(со значением, полученным в оповещении о регистрации выплаты; [подробнее](ru_pp_payout.md)\).

 Пример: `Lm3V9lmykig2d51Z/2Yrnue9+o5GTkVvY/sRDLKAnSS+AagnGCJ1nsPg==`

|

**На уровень выше:**[Payment Page](ru_PP_about.md)