Обновить настройки платежной системы sale.paysystem.settings.update

Scope: pay_system

Кто может выполнять метод: администратор 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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

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"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.paysystem.settings.update

try
        {
        	const response = await $b24.callMethod(
        		'sale.paysystem.settings.update',
        		{
        			'ID': 11,
        			'PERSON_TYPE_ID': 1,
        			'SETTINGS': {
        				'REST_SERVICE_KEY_IFRAME': {
        					'TYPE': 'VALUE',
        					'VALUE': 'NEW_KEY',
        				}
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.paysystem.settings.update',
                    [
                        'ID'            => 11,
                        'PERSON_TYPE_ID' => 1,
                        'SETTINGS'      => [
                            'REST_SERVICE_KEY_IFRAME' => [
                                'TYPE'  => 'VALUE',
                                'VALUE' => 'NEW_KEY',
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating payment system settings: ' . $e->getMessage();
        }

BX24.callMethod('sale.paysystem.settings.update', {
            'ID': 11,
            'PERSON_TYPE_ID': 1,
            'SETTINGS': {
                'REST_SERVICE_KEY_IFRAME': {
                    'TYPE': 'VALUE',
                    'VALUE': 'NEW_KEY',
                }
            }
        }, 
        function(result) 
        { 
            if(result.error()) 
                console.error(result.error()); 
            else 
            { 
                console.dir(result.data()); 
            } 
        } 
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.paysystem.settings.update',
            [
                'ID' => 11,
                'PERSON_TYPE_ID' => 1,
                'SETTINGS' => [
                    'REST_SERVICE_KEY_IFRAME' => [
                        'TYPE' => 'VALUE',
                        'VALUE' => 'NEW_KEY',
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

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, 403

{
            "error": " ERROR_CHECK_FAILURE",
            "error_description": "Pay system not found"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Статус
`ACCESS_DENIED`	Недостаточно прав для чтения настроек	403
`ERROR_CHECK_FAILURE`	Не указано значение одного из обязательных полей либо не найдена указанная платежная система (детали смотрите в описании ошибки)	400
`ERROR_HANDLER_NOT_FOUND`	Не указано значение поля `SETTINGS` либо передан пустой объект	400

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Получить настройки платежной системы

Удалить платежную систему

Обновить настройки платежной системы sale.paysystem.settings.update

Параметры методаПараметры метода

Параметр SETTINGSПараметр SETTINGS

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

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

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение