метод REST scope: pay_system

sale.paysystem.settings.update

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

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

Описание

Метод обновляет настройки платежной системы. Структура настроек задается при добавлении обработчика платежной системы в методе sale.paysystem.handler.add в ключе CODES параметра SETTINGS.

Параметры

ID sale_paysystem.ID обязательный

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

PERSON_TYPE_ID sale_person_type.id необязательный

Идентификатор типа плательщика, для которого нужно получить настройки

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

Настройки, которые нужно обновить. Ключами выступают названия настроек, значениями — объекты, структура которых описана ниже

Параметр SETTINGS

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

Источник значения параметра

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

Код параметра у источника либо значение параметра (для TYPE="VALUE")

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":11,"PERSON_TYPE_ID":1,"SETTINGS":{"REST_SERVICE_KEY_IFRAME":{"TYPE":"VALUE","VALUE":"NEW_KEY"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.settings.update

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1712135335.026931,
        "finish": 1712135335.407762,
        "duration": 0.3808310031890869,
        "processing": 0.0336611270904541,
        "date_start": "2024-04-03T11:08:55+02:00",
        "date_finish": "2024-04-03T11:08:55+02:00",
        "operating_reset_at": 1705765533,
        "operating": 3.3076241016387939
    }
}

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

result boolean

Результат обновления настроек платежной системы

time time

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

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

HTTP-статус: 400

{
    "error": "ERROR_CHECK_FAILURE",
    "error_description": "Pay system not found"
}
Код Описание Значение
ACCESS_DENIED Недостаточно прав для чтения настроек 403
ERROR_CHECK_FAILURE Не указано значение одного из обязательных полей либо не найдена указанная платежная система (детали смотрите в описании ошибки) 400
ERROR_HANDLER_NOT_FOUND Не указано значение поля SETTINGS либо передан пустой объект 400

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.