Изменить платежную систему 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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make<boolean>({
    method: 'sale.paysystem.update',
    params: {
      ID: 12,
      FIELDS: {
        NAME: 'New payment system name',
        DESCRIPTION: 'New payment system description',
        PERSON_TYPE_ID: 1,
        BX_REST_HANDLER: 'resthandlercode',
        ACTIVE: 'Y',
        NEW_WINDOW: 'N',
        LOGOTYPE: '/* base64 image */',
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Payment system updated:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function updatePaySystem() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.paysystem.update',
        params: {
          ID: 12,
          FIELDS: {
            NAME: 'New payment system name',
            DESCRIPTION: 'New payment system description',
            PERSON_TYPE_ID: 1,
            BX_REST_HANDLER: 'resthandlercode',
            ACTIVE: 'Y',
            NEW_WINDOW: 'N',
            LOGOTYPE: '/* base64 image */',
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Payment system updated:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updatePaySystem)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

fields = {
    "NAME": "New payment system name",
    "DESCRIPTION": "New payment system description",
    "PERSON_TYPE_ID": 1,
    "BX_REST_HANDLER": "resthandlercode",
    "ACTIVE": "Y",
    "NEW_WINDOW": "N",
    "LOGOTYPE": "/* base64 image */",
}

try:
    bitrix_response = client.sale.paysystem.update(
        bitrix_id=12,
        fields=fields,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.paysystem.update", b24.Params{
	"ID": 12,
	"FIELDS": b24.Params{
		"NAME":            "Новое название платёжной системы",
		"DESCRIPTION":     "Новое описание платёжной системы",
		"PERSON_TYPE_ID":  1,
		"BX_REST_HANDLER": "resthandlercode",
		"ACTIVE":          "Y",
		"NEW_WINDOW":      "N",
		"LOGOTYPE":        "/* base64 image */",
	},
})
if err != nil {
	return fmt.Errorf("sale.paysystem.update: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

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
string

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

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

Код

Описание

Статус

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-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

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

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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