Параметры вызова платёжной формы

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

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

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

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

Параметр Описание

account_token
string, optional

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

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

Пример: 42ab631449a78914502803aed8a0e5a728d558035d29a56f4dcc136c6bfc3021

addendum_data
string, optional

«Длинная запись» о бронировании услуг для учёта на стороне платёжной системы (подробнее).

Представляет собой строку, полученную в результате кодирования исходного JSON-объекта с применением алгоритма Base64. Может использоваться при оплате услуг организаций, работающих в туристической отрасли, в том числе для повышения безопасности и получения преференций при проведении платежей (подробнее). Применяется в соответствии с правилами платёжных систем Mastercard и Visa.

Рис. 1. Пример исходного JSON-объекта
{
  "lodging": {
    "customer_service_toll_free_number": "88005553535", // Телефон поддержки клиентов отеля 
    "guest_name": "John Smith",        // Ф.И.О. гостя
    "check_in_date": "10-12-2019",     // Дата въезда в отель
    "check_out_date": "22-12-2019",    // Дата выезда из отеля
    "folio_number": "56265655ABC",     // Номер бронирования
    "fire_safety_act_indicator": true, // Класс пожарной безопасности отеля
    "room": {            // Объект с параметрами номера
      "rate": 12,                 // Стоимость суток проживания
      "number_of_nights": "12"    // Количество ночей
    },
    "charges": {            // Объект с суммами сборов
      "transportation": 1200,       // Сбор за услуги трансфера
      "internet_access": 4500       // Сбор за доступ к Интернету
    }
   }
}
Рис. 2. Пример соответствующей строки
ewogImxvZGdpbmciOiB7CiAgImN1c3RvbWVyX3NlcnZpY2VfdG9sbF9mcmVlX251bWJlciI6ICI4ODAwNTU1Mz
UzNSIsCiAgImd1ZXN0X25hbWUiOiAiSm9obiBTbWl0aCIsCiAgImNoZWNrX2luX2RhdGUiOiAiMTAtMTItMjAx
OSIsCiAgImNoZWNrX291dF9kYXRlIjogIjIyLTEyLTIwMTkiLAogICJmb2xpb19udW1iZXIiOiAiNTYyNjU2NT
VBQkMiLAogICJmaXJlX3NhZmV0eV9hY3RfaW5kaWNhdG9yIjogdHJ1ZSwKICAicm9vbSI6IHsKICAicmF0ZSI6
IDEyLAogICJudW1iZXJfb2ZfbmlnaHRzIjogIjEyIgogIH0sCiAgImNoYXJnZXMiOiB7CiAgInRyYW5zcG9ydG
F0aW9uIjogMTIwMCwKICAiaW50ZXJuZXRfYWNjZXNzIjogNDUwMAogIH0KIH0KfQ==

avs_post_code
string, optional

Почтовый индекс пользователя, используемый для проверки Address Verification ServiceAVS.

Пример: WS13 6LG

avs_street_address
string, optional

Адрес пользователя, используемый для проверки Address Verification ServiceAVS.

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

Пример: 4 Breadmarket Street

baseUrl
string, optional

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

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

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

best_before
string, optional

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

Может представлять собой запись в формате ГГГГ-ММ-ДДTчч:мм:сс±чч или ГГГГ-ММ-ДДTчч:мм:сс±чч:мм.

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

billing_address
string, optional

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

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

Пример: 33 Store Street

billing_city
string, optional

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

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

Пример: London

billing_country
string, optional

Код страны в расчётном адресе пользователя (в формате ISO 3166-1 alpha-2).

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

Пример: GB

billing_postal
string, optional

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

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

Пример: BR1 1AA

billing_region
string, optional

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

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

Пример: Dorset

billing_region_code
string, optional

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

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

Пример: DOR

booking_info
string, optional

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

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

Рис. 3. Пример исходного JSON-объекта
"booking_info": {
    "firstname": "William",
    "surname": "Herschel",
    "email": "rsfellow@mail.com",
    "start_date": "12-08-2026",
    "end_date": "13-08-2026",
    "description": "Sideris music festival full pass",
    "total": 200000,
    "pax": 4,
    "reference": "musicfestlink",
    "id": "83"
}
Рис. 4. Пример соответствующей строки
ewogICAgImZpcnN0bmFtZSI6ICJXaWxsaWFtIiwKICAgICJzdXJuYW1lIjogIkhlcnNjaGVsIiwKICAgICJlbWFpbCI6ICJyc2ZlbGxvd0BtYWlsLmNvbSIsCiAgICAic3RhcnRfZGF0ZSI6ICIxMi0wOC0yMDI2IiwKICAgICJlbmRfZGF0ZSI6ICIxMy0wOC0yMDI2IiwKICAgICJkZXNjcmlwdGlvbiI6ICJTaWRlcmlzIG11c2ljIGZlc3RpdmFsIGZ1bGwgcGFzcyIsCiAgICAidG90YWwiOiAyMDAwMDAsCiAgICAicGF4IjogNCwKICAgICJyZWZlcmVuY2UiOiAibXVzaWNmZXN0bGluayIsCiAgICAiaWQiOiAiODMiCn0=

card_holder
string, optional

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

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

Пример: John Doe

card_operation_type
string, optional

Указатель варианта проведения оплаты с прямым использованием платёжной карты — в одну или две стадии. при работе с Payment Page 4‑го и более ранних поколений:

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

  • sale — для оплаты в одну стадию (с незамедлительным списанием средств; подробнее);
  • auth — для оплаты в две стадии (с предварительной блокировкой и последующим списанием средств; подробнее).

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

Может использоваться при работе с Payment Page 4‑го и более ранних поколений.

Пример: auth

close_on_missclick
integer (boolean*), optional

Указатель действия при щелчке за пределами формы, открытой в модальном окне.:

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

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

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

Пример: 1

css_modal_wrap
string, optional

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

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

Пример: CosmoshopModal

customer_address
string, optional

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

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

Пример: Main Street, 12

customer_account_info
string, optional

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

Представляет собой строку, полученную в результате кодирования исходного JSON-объекта с применением алгоритма Base64.

Рис. 5. Пример исходного 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"
    }
  }
}
Рис. 6. Пример соответствующей строки
eyAKICAiY3VzdG9tZXIiOnsgCiAgICAiYWRkcmVzc19tYXRjaCI6IlkiLAogICAgImhvbWVfcGhvbmUiOiI3OTEwNTIxMTExMSIsCiAgICAid29ya19waG9uZSI6Ijc0OTU1MjExMTExIiwKICAgICJhY2NvdW50Ijp7IAogICAgICAiYWRkaXRpb25hbCI6ImdhbWVyMTIzNDUiLAogICAgICAiYWdlX2luZGljYXRvciI6IjAxIiwKICAgICAgImRhdGUiOiIwMS0xMC0yMDIyIiwKICAgICAgImNoYW5nZV9pbmRpY2F0b3IiOiIwMSIsCiAgICAgICJjaGFuZ2VfZGF0ZSI6IjAxLTEwLTIwMjIiLAogICAgICAicGFzc19jaGFuZ2VfaW5kaWNhdG9yIjoiMDEiLAogICAgICAicGFzc19jaGFuZ2VfZGF0ZSI6IjAxLTEwLTIwMjIiLAogICAgICAicHVyY2hhc2VfbnVtYmVyIjoxMiwKICAgICAgInByb3Zpc2lvbl9hdHRlbXB0cyI6MTYsCiAgICAgICJhY3Rpdml0eV9kYXkiOjIyLAogICAgICAiYWN0aXZpdHlfeWVhciI6MjIyMiwKICAgICAgInBheW1lbnRfYWdlX2luZGljYXRvciI6IjAxIiwKICAgICAgInBheW1lbnRfYWdlIjoiMDEtMTAtMjAyMiIsCiAgICAgICJzdXNwaWNpb3VzX2FjdGl2aXR5IjoiMDEiLAogICAgICAiYXV0aF9tZXRob2QiOiIwMSIsCiAgICAgICJhdXRoX3RpbWUiOiIwMS0xMC0yMDIyMTM6MTIiLAogICAgICAiYXV0aF9kYXRhIjoibG9naW5fMDEwMiIKICAgIH0KICB9Cn0==

customer_account_number
string, optional

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

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

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

customer_birthplace
string, optional

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

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

Пример: London

customer_city
string, optional

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

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

Пример: London

customer_country
string, optional

Код страны в адресе проживания пользователя (в формате ISO 3166-1 alpha-2).

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

Пример: GB

customer_day_of_birth
string, optional

Дата рождения пользователя в формате ДД-ММ-ГГГГ.

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

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

customer_email
string, optional

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

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

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

customer_first_name
string, optional

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

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

Пример: Jane

customer_id
string, required

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

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

Пример: customer_112

customer_last_name
string, optional

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

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

Пример: Smith

customer_middle_name
string, optional

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

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

Пример: Mary

customer_mpi_result
string, optional

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

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

Рис. 7. Пример исходного JSON-объекта
{ 
  "customer":{ 
    "mpi_result":{ 
      "acs_operation_id":"00000000-0005-5a5a-8000-016d3ea31d54",
      "authentication_flow":"01",
      "authentication_timestamp":"202210101050"
    }
  }
}
Рис. 8. Пример соответствующей строки
eyAKICAiY3VzdG9tZXIiOnsgCiAgICAibXBpX3Jlc3VsdCI6eyAKICAgICAgImFjc19vcGVyYXRpb25faWQiOiIwMDAwMDAwMC0wMDA1LTVhNWEtODAwMC0wMTZkM2VhMzFkNTQiLAogICAgICAiYXV0aGVudGljYXRpb25fZmxvdyI6IjAxIiwKICAgICAgImF1dGhlbnRpY2F0aW9uX3RpbWVzdGFtcCI6IjIwMjIxMDEwMTA1MCIKICAgIH0KICB9Cn0==

customer_phone
string, optional

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

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

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

В общем случае должен включать код страны и содержать не менее 4 и не более 24 цифр.

Пример: 443031237300

customer_security_code
string, optional

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

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

Пример: 852923

customer_shipping
string, optional

Информация о доставке товара или услуги пользователю (подробнее).

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

Рис. 9. Пример исходного 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_code":"VL",
      "name_indicator":"01"
    }
  }
}
Рис. 10. Пример соответствующей строки
eyAKICAiY3VzdG9tZXIiOnsgCiAgICAic2hpcHBpbmciOnsgCiAgICAgICJ0eXBlIjoiMDEiLAogICAgICAiZGVsaXZlcnlfdGltZSI6IjAxIiwKICAgICAgImRlbGl2ZXJ5X2VtYWlsIjoidGVzdEBnbWFpbC5jb20iLAogICAgICAiYWRkcmVzc191c2FnZV9pbmRpY2F0b3IiOiIwMSIsCiAgICAgICJhZGRyZXNzX3VzYWdlIjoiMDEtMTAtMjAyMiIsCiAgICAgICJjaXR5IjoiTW9zY293IiwKICAgICAgImNvdW50cnkiOiJSVSIsCiAgICAgICJhZGRyZXNzIjoiTGVuaW5hIHN0cmVldCAxMiIsCiAgICAgICJwb3N0YWwiOiIxMDkxMTEiLAogICAgICAicmVnaW9uX2NvZGUiOiJSVSIsCiAgICAgICJuYW1lX2luZGljYXRvciI6IjAxIgogICAgfQogIH0KfQ====

customer_ssn
integer, optional

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

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

Пример: 1984

customer_state
string, optional

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

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

Пример: Greater London

customer_street
string, optional

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

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

Пример: Main

customer_zip
string, optional

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

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

Пример: 75001

debt_account
string, optional

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

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

Пример: an9876170i

force_acs_new_window
integer (boolean*), optional

Указатель необходимости использования отдельной вкладки при перенаправлении пользователя к стороннему сервису (подробнее).:

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

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

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

Пример: 1

force_payment_method
string, optional

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

Может принимать значения в соответствии со справочником.

Пример: paypal-wallet

force_payment_group
string, optional

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

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

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

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

Пример: openbanking

force_payment_method_subtype
string, optional

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

Может принимать значения в соответствии со справочником.

Пример: mastercard

hide
string, optional

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

Коды могут указываться в соответствии со справочником.

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

identify_doc_number
string, optional

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

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

Пример: 6543234567

interface_type
string, optional

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

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

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

language_code
string, optional

Код целевого языка для отображения платёжной формы (подробнее).

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

Пример: de

merchant_callback_url
string, optional

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

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

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

merchant_data
string, optional

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

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

Рис. 11. Пример из GET-запроса без экранирования
"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"}"
Рис. 12. Пример из POST-запроса с экранированием
"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_fail_enabled
integer, optional

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

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

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

Пример: 2

merchant_fail_redirect_mode
string, optional

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

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

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

Пример: blank_page

merchant_fail_url
string, optional

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

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

merchant_return_enabled
integer, optional

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

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

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

Пример: 0

merchant_return_redirect_mode
string, optional

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

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

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

Пример: iframe

merchant_return_url
string, optional

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

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

merchant_success_enabled
integer, optional

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

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

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

Пример: 1

merchant_success_redirect_mode
string, optional

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

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

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

Пример: parent_page

merchant_success_url
string, optional

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

Пример: 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

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

  • 1 — Mail Order;
  • 2 — Telephone Order.

Пример: 2

operation_type
string, optional

Указатель варианта проведения оплаты с прямым использованием платёжной карты при работе с Payment Page 5-го поколения: — в одну или две стадии.

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

  • sale — для оплаты в одну стадию (с незамедлительным списанием средств; подробнее);

  • auth — для оплаты в две стадии (с предварительной блокировкой и последующим списанием средств; подробнее).

Может использоваться при работе с Payment Page 5-го поколения.

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

Пример: auth

payment_amount
integer, required*

Сумма платежа в дробных единицах валюты.

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

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

payment_currency
string, required*

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

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

Код валюты платежа (в формате ISO-4217 alpha-3, согласно справочнику).

Не используется в режиме Card Tokenize.

Пример: EUR

payment_description
string, optional

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

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

Пример: Thai massage session

payment_extra_param
string, optional

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

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

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

payment_id
string, required*

Идентификатор платежа в рамках проекта, длиной не более 255 символов с обеспечением регистронезависимости.

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

Пример: payment_443

payment_merchant_risk
string, optional

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

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

Рис. 13. Пример исходного 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
    }
  }
}
Рис. 14. Пример соответствующей строки
eyAKICAicGF5bWVudCI6eyAKICAgICJyZW9yZGVyIjoiMDEiLAogICAgInByZW9yZGVyX3B1cmNoYXNlIjoiMDEiLAogICAgInByZW9yZGVyX2RhdGUiOiIxMS0xMC0yMDIyIiwKICAgICJjaGFsbGVuZ2VfaW5kaWNhdG9yIjoiMDEiLAogICAgImNoYWxsZW5nZV93aW5kb3ciOiIwMSIsCiAgICAiZ2lmdF9jYXJkIjp7IAogICAgICAiYW1vdW50IjoxMjM0NSwKICAgICAgImN1cnJlbmN5IjoiVVNEIiwKICAgICAgImNvdW50IjoxCiAgICB9CiAgfQp9==

payment_methods_options
string, optional

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

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

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

project_id
integer, required

Идентификатор проекта взаимодействия веб-сервиса с платёжной платформой, полученный от ecommpay при интеграции (подробнее).

Пример: 57123

receipt_data
string, optional

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

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

Рис. 15. Пример исходного JSON-объекта
{  
   "receipt_data":{  
      "positions":[  
         {  
            "quantity":3,
            "amount":10000,
            "tax":18,
            "tax_amount":1800,
            "description":"Рамка с дизайном"
         }
      ],
      "total_tax_amount":1800,
      "common_tax":18       
   }
}
Рис. 16. Пример соответствующей строки
receipt_data: "eyAgCiAgICAgICJwb3NpdGlvbnMiOlsgIAogICAgICAgICB7ICAKICAgICAgICAgICAgInF1YW50aXR5IjozLAogICAgICAgICAgICAiYW1vdW50IjoxMDAwMCwKICAgICAgICAgICAgInRheCI6MTgsCiAgICAgICAgICAgICJ0YXhfYW1vdW50IjoxODAwLAogICAgICAgICAgICAiZGVzY3JpcHRpb24iOiLQoNCw0LzQutCwINGBINC00LjQt9Cw0LnQvdC+0LwiCiAgICAgICAgIH0KICAgICAgXSwKICAgICAgInRvdGFsX3RheF9hbW91bnQiOjE4MDAsCiAgICAgICJjb21tb25fdGF4IjoxOCAgICAgICAKfQ"

recipient_address
string, optional

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

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

Пример: Via Dietro Duomo 36

recipient_card_holder
string, optional

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

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

Пример: Fran Petrarca

recipient_city
string, optional

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

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

Пример: Padova

recipient_country
string, optional

Код страны в адресе местонахождения получателя платежа (в формате ISO 3166-1 alpha-2).

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

Пример: IT

recipient_first_name
string, optional

Имя получателя платежа, длиной не более 255 символов.

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

Пример: Fran

recipient_last_name
string, optional

Фамилия получателя платежа, длиной не более 255 символов.

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

Пример: Petrarca

recipient_pan
string, optional

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

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

Пример: 4314220000000056

recipient_state
string, optional

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

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

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

recipient_wallet_id
string, optional

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

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

Пример: WID20071304

recipient_wallet_owner
string, optional

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

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

Пример: Fran Petrarca

recurring
string, optional

Сведения о регистрируемой повторяемой оплате (подробнее).

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

Рис. 17. Пример JSON-объекта
{
    "register": true,
    "type": "U"
}
Рис. 18. Пример соответствующей строки
%7B%22register%22%3Atrue%2C%22type%22%3A%22U%22%7D%2C

recurring_register
integer, optional

Указатель необходимости зарегистрировать повторяемую оплату с использованием сведений, переданных в значении параметра recurring (подробнее).:

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

  • 0 — отсутствие потребности в регистрациибез регистрации;
  • 1 — наличие потребности в регистрациис регистрацией.

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

Пример: 1

redirect
integer (boolean*), optional

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

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

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

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

Пример: 1

redirect_fail_mode
string, optional

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

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

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

Пример: blank_page

redirect_fail_url
string, optional

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

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

redirect_on_mobile
integer (boolean*), optional

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

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

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

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

Пример: 1

redirect_success_mode
string, optional

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

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

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

Пример: parent_page

redirect_success_url
string, optional

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

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

redirect_return_url
string, optional

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

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

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

redirect_tokenize_mode
string, optional

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

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

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

Пример: parent_page

redirect_tokenize_url
string, optional

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

Подробнее об управлении возможностями возвращения пользователей к веб-сервису — в отдельной статье.

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

region_code
string, optional

Код страны местонахождения пользователя (в формате ISO 3166-1 alpha-2).

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

Пример: FR

sender_address
string, optional

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

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

Пример: Via Certaldo 18

sender_city
string, optional

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

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

Пример: Florence

sender_country
string, optional

Код страны в адресе местонахождения отправителя платежа (в формате ISO 3166-1 alpha-2).

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

Пример: IT

sender_first_name
string, optional

Имя отправителя платежа, длиной не более 255 символов.

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

Пример: Gio

sender_last_name
string, optional

Фамилия отправителя платежа, длиной не более 255 символов.

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

Пример: Boccaccio

sender_state
string, optional

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

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

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

sender_wallet_id
string, optional

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

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

Пример: WID16061313

sender_zip
string, optional

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

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

Пример: 50142

signature
string, required

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

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

Подпись к параметрам запроса (подробнее).

style_id
integer, optional

Идентификатор стиля оформления платёжной формы 5‑го поколения (подробнее).

Может использоваться при работе с различными стилями оформления Payment Page 5‑го поколения (подробнее).

Пример: 6123

target_element
string, optional

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

Идентификатор элемента iframe для открытия платёжной формы (подробнее).

Пример: widget-container

terminal_id
integer, optional

Идентификатор терминала платёжной формы 4‑го и более ранних поколений (подробнее).

Может использоваться при работе с различными стилями оформления Payment Page 4‑го и более ранних поколений (подробнее).

Пример: 54

uuid
string, optional

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

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

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