Изменить платежную систему sale.paysystem.update

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: pay_system

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

Метод изменяет платежную систему.

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

Обязательные параметры отмечены *

Название
тип

Описание

ID*
sale_paysystem.ID

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

FIELDS
object

Объект, содержащий новые значения полей (подробное описание приведено ниже)

Параметр FIELDS

Название
тип

Описание

NAME
string

Название платежной системы

DESCRIPTION
string

Описание платежной системы

PERSON_TYPE_ID
sale_person_type.id

Идентификатор типа плательщика

BX_REST_HANDLER
sale_paysystem_handler.CODE

Код REST-обработчика, указанный при добавлении обработчика методом sale.paysystem.handler.add

ACTIVE
string

Индикатор активности платежной системы. Возможные значения:

  • Y — да
  • N — нет

LOGOTYPE
string

Логотип платежной системы (картинка в формате Base64)

NEW_WINDOW
string

Флаг, отвечающий за настройку «Открывать в новом окне». Возможные значения:

  • Y — да
  • N — нет

XML_ID
string

Внешний идентификатор платежной системы

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":12,"FIELDS":{"NAME":"Новое название платёжной системы","DESCRIPTION":"Новое описание платёжной системы","PERSON_TYPE_ID":1,"BX_REST_HANDLER":"resthandlercode","ACTIVE":"Y","NEW_WINDOW":"N","LOGOTYPE":"/* base64 image */"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":12,"FIELDS":{"NAME":"Новое название платёжной системы","DESCRIPTION":"Новое описание платёжной системы","PERSON_TYPE_ID":1,"BX_REST_HANDLER":"resthandlercode","ACTIVE":"Y","NEW_WINDOW":"N","LOGOTYPE":"/* base64 image */"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.paysystem.update
        
try
        {
        	const response = await $b24.callMethod(
        		'sale.paysystem.update',
        		{
        			"ID": 12,
        			"FIELDS": {
        				"NAME": "Новое название платёжной системы",
        				"DESCRIPTION": "Новое описание платёжной системы",
        				"PERSON_TYPE_ID": 1,
        				"BX_REST_HANDLER": 'resthandlercode',
        				"ACTIVE": 'Y',
        				'NEW_WINDOW': 'N',
        				'LOGOTYPE': '/* base64 image */',
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.paysystem.update',
                    [
                        'ID'          => 12,
                        'FIELDS'      => [
                            'NAME'           => 'Новое название платёжной системы',
                            'DESCRIPTION'    => 'Новое описание платёжной системы',
                            'PERSON_TYPE_ID' => 1,
                            'BX_REST_HANDLER' => 'resthandlercode',
                            'ACTIVE'         => 'Y',
                            'NEW_WINDOW'     => 'N',
                            'LOGOTYPE'       => '/* base64 image */',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating payment system: ' . $e->getMessage();
        }
        
BX24.callMethod('sale.paysystem.update',
        {
            "ID": 12,
            "FIELDS": {
                "NAME": "Новое название платёжной системы",
                "DESCRIPTION": "Новое описание платёжной системы",
                "PERSON_TYPE_ID": 1,
                "BX_REST_HANDLER": 'resthandlercode',
                "ACTIVE": 'Y',
                'NEW_WINDOW': 'N',
                'LOGOTYPE': '/* base64 image */',
            }
        }, 
            function(result) 
            { 
                if(result.error()) 
                { 
                    console.error(result.error()); 
                } 
                else 
                { 
                    console.info(result.data()); 
                } 
            } 
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.paysystem.update',
            [
                'ID' => 12,
                'FIELDS' => [
                    'NAME' => 'Новое название платёжной системы',
                    'DESCRIPTION' => 'Новое описание платёжной системы',
                    'PERSON_TYPE_ID' => 1,
                    'BX_REST_HANDLER' => 'resthandlercode',
                    'ACTIVE' => 'Y',
                    'NEW_WINDOW' => 'N',
                    'LOGOTYPE' => '/* base64 image */',
                ]
            ]
        );
        
        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_HANDLER_NOT_FOUND",
            "error_description": "Handler not found"
        }

Название
тип

Описание

error
string

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

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Статус

ACCESS_DENIED

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

403

ERROR_HANDLER_NOT_FOUND

Обработчик, указанный в параметре BX_REST_HANDLER, не найден

400

ERROR_PERSON_TYPE_NOT_FOUND

Тип плательщика, указанный в параметре PERSON_TYPE_ID, не найден

400

ERROR_PAY_SYSTEM_NOT_FOUND

Платежная система с указанным ID не найдена

400

ERROR_CHECK_FAILURE

Не указан параметр ID

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Добавить платежную систему
Следующая
Получить список платежных систем