метод REST scope: pay_system

sale.paysystem.handler.add

Добавить REST-обработчик платежной системы

Кто может выполнять: администратор CRM (право «Разрешить изменять настройки»)

Описание

Метод добавляет REST-обработчик платежной системы.

Параметры

NAME string обязательный

Название REST-обработчика

SORT integer необязательный

Сортировка. По умолчанию 100

CODE string обязательный

Код REST-обработчика. Должен быть уникальным среди всех обработчиков

SETTINGS object обязательный

Настройки обработчика (подробное описание приведено ниже)

Параметр SETTINGS

CODES object обязательный

Список параметров обработчика. Ключами являются коды параметров (string), значениями — описания параметров (подробное описание приведено ниже).

Значения параметров будут доступны администратору для заполнения в настройках созданной платежной системы. Их можно задать при добавлении платежной системы в методе sale.paysystem.add в параметре SETTINGS и изменить при помощи метода sale.paysystem.settings.update

FORM_DATA object необязательный

Настройки формы при использовании режима работы в форме

CHECKOUT_DATA object необязательный

Настройки режима Checkout (создание заказа на стороне сервиса и переход покупателя на эту страницу для оплаты)

IFRAME_DATA object необязательный

Настройки страницы, выводимой в iframe на сайте продавца на странице оплаты

CLIENT_TYPE string необязательный

Тип покупателей, с которыми может работать обработчик. Доступные значения:
- b2c — физические лица
- b2b — юридические лица

Значение по умолчанию b2c

CURRENCY crm_currency.CURRENCY[] необязательный

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

Параметр CODES

NAME string необязательный

Название параметра

DESCRIPTION string необязательный

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

SORT integer необязательный

Сортировка

GROUP string необязательный

Код группы, к которой относится параметр

DEFAULT object необязательный

Описание значения по умолчанию (подробное описание приведено ниже)

INPUT object необязательный

Объект, описывающий поле ввода. Структура объекта содержит параметр TYPE — тип поля. Поддерживаемые поля:
- STRING — строка
- Y/N — флажок
- ENUM — список

Параметр DEFAULT

PROVIDER_KEY string необязательный

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

PROVIDER_VALUE string необязательный

Код значения, которое будет взято у провайдера. Возможные значения ключа приведены ниже

Возможные значения ключа PROVIDER_KEY

ORDER необязательный

Заказ

PROPERTY необязательный

Свойства счета

PAYMENT необязательный

Оплата

USER необязательный

Пользователь

VALUE необязательный

Произвольное значение типа строка

Y\N необязательный

Флажок

Возможные значения ключа PROVIDER_VALUE

ORDER необязательный

ID — идентификатор (для счетов соответствует ID счета)
ACCOUNT_NUMBER — номер заказа (для счетов соответствует номеру счета)
ORDER_TOPIC — тема
DATE_INSERT — дата заказа (для счетов соответствует дате счета)
DATE_INSERT_DATE — дата заказа без времени (для счетов соответствует дате счета)
DATE_BILL — дата и время выставления
DATE_BILL_DATE — дата выставления
DATE_PAY_BEFORE — срок оплаты
SHOULD_PAY — сумма счета (для счетов соответствует сумме счета)
CURRENCY — валюта
PRICE — стоимость заказа (для счетов соответствует стоимости счета)
PRICE_DELIVERY — стоимость доставки
DISCOUNT_VALUE — величина скидки
USER_ID — код покупателя
PAY_SYSTEM_ID — код платежной системы
DELIVERY_ID — код службы доставки
TAX_VALUE — налог
USER_DESCRIPTION — комментарий

PAYMENT необязательный

ID — идентификатор
ACCOUNT_NUMBER — номер оплаты
DATE_BILL — дата и время выставления
DATE_BILL_DATE — дата выставления без времени
SUM — сумма счета
CURRENCY — валюта
PAID — оплачено
DATE_PAID — дата оплаты
PAY_SYSTEM_ID — код платежной системы
PAY_VOUCHER_NUM — номер ваучера
PAY_VOUCHER_DATE — дата ваучера
DATE_PAY_BEFORE — оплатить до
XML_ID — индентификатор XML
PAY_SYSTEM_NAME — название платежной системы
COMPANY_ID — код компании
PAY_RETURN_NUM — номер возврата
PAY_RETURN_DATE — дата возврата
PAY_RETURN_COMMENT — коментарий возврата

USER необязательный

ID — код покупателя,
LOGIN — логин
NAME — имя
SECOND_NAME — отчество
LAST_NAME — фамилия
EMAIL — EMail
PERSONAL_PROFESSION — профессия
PERSONAL_WWW — персональный веб-сайт
PERSONAL_ICQ — номер ICQ
PERSONAL_GENDER — пол
PERSONAL_FAX — номер факса
PERSONAL_MOBILE — номер телефона
PERSONAL_STREET — адрес
PERSONAL_MAILBOX — почтовый ящик
PERSONAL_CITY — город
PERSONAL_STATE — штат
PERSONAL_ZIP — индекс
PERSONAL_COUNTRY — страна
WORK_COMPANY — компания
WORK_DEPARTMENT — отдел
WORK_POSITION — должность
WORK_WWW — сайт компании
WORK_PHONE — рабочий телефон
WORK_FAX — рабочий факс
WORK_STREET — адрес компании
WORK_MAILBOX — рабочий почтовый ящик
WORK_CITY — город компании
WORK_STATE — штат компании
WORK_ZIP — индекс компании
WORK_COUNTRY — страна компании

Ответ

HTTP-статус: 200

{
    "result": 5,
    "time": {
        "start": 1712132792.910734,
        "finish": 1712132793.530359,
        "duration": 0.6196250915527344,
        "processing": 0.032338857650756836,
        "date_start": "2024-04-03T10:26:32+02:00",
        "date_finish": "2024-04-03T10:26:33+02:00",
        "operating_reset_at": 1705765533,
        "operating": 3.3076241016387939
    }
}

Возвращаемые данные

result sale_paysystem_handler.ID

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

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "ERROR_HANDLER_ALREADY_EXIST",
    "error_description": "Handler already exists!"
}

Код	Описание	Значение
`ACCESS_DENIED`	Недостаточно прав для добавления обработчика	403
`ERROR_CHECK_FAILURE`	Не указано значение обязательного поля либо значение одного из полей указано неверно	400
`ERROR_HANDLER_ALREADY_EXIST`	Обработчик с кодом, указанным в параметре `CODE`, уже существует в системе	400
`ERROR_HANDLER_ADD`	Прочие ошибки. Подробную информацию об ошибке смотрите в `error_description`	400