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

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

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

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 -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
// 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.settings.update',
    params: {
      ID: 11,
      PERSON_TYPE_ID: 1,
      SETTINGS: {
        REST_SERVICE_KEY_IFRAME: {
          TYPE: 'VALUE',
          VALUE: 'NEW_KEY',
        },
      },
    },
    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('Settings 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 updatePaySystemSettings() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.paysystem.settings.update',
        params: {
          ID: 11,
          PERSON_TYPE_ID: 1,
          SETTINGS: {
            REST_SERVICE_KEY_IFRAME: {
              TYPE: 'VALUE',
              VALUE: 'NEW_KEY',
            },
          },
        },
        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('Settings updated:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

settings = {
    "REST_SERVICE_KEY_IFRAME": {
        "TYPE": "VALUE",
        "VALUE": "NEW_KEY",
    },
}

try:
    bitrix_response = client.sale.paysystem.settings.update(
        sale_payment_id=11,
        person_type_id=1,
        settings=settings,
    ).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.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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.paysystem.settings.update", b24.Params{
	"ID":             11,
	"PERSON_TYPE_ID": 1,
	"SETTINGS": b24.Params{
		"REST_SERVICE_KEY_IFRAME": b24.Params{
			"TYPE":  "VALUE",
			"VALUE": "NEW_KEY",
		},
	},
})
if err != nil {
	return fmt.Errorf("sale.paysystem.settings.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_CHECK_FAILURE",
    "error_description": "Pay system not found"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Статус

ACCESS_DENIED

Недостаточно прав для чтения настроек

403

ERROR_CHECK_FAILURE

Не указано значение одного из обязательных полей либо не найдена указанная платежная система (детали смотрите в описании ошибки)

400

ERROR_HANDLER_NOT_FOUND

Не указано значение поля SETTINGS либо передан пустой объект

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

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

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