Добавить платежную систему sale.paysystem.add

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

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

Scope: pay_system

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

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

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

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

Название
тип

Описание

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 — нет

Если не передано, то по умолчанию N

SETTINGS
object

Список значений настроек обработчика в формате {"field_1": "value_1", ... "field_N": "value_N"}, где field — название настройки, а value — объект, содержащий ключи TYPE и VALUE (описание смотрите ниже).

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

ENTITY_REGISTRY_TYPE
string

Привязка платежной системы:

  • ORDER — значение для заказов магазина, сделок, смарт-процессов
  • CRM_INVOICE — значение для счетов CRM
  • CRM_QUOTE — значение для коммерческих предложений CRM

Если не передано, то по умолчанию CRM_INVOICE.

Тип плательщика PERSON_TYPE_ID должен относиться к тому же типу привязки

LOGOTYPE
string

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

NEW_WINDOW
string

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

  • Y — да
  • N — нет

Если не передано, то по умолчанию N

XML_ID
string

Внешний идентификатор платежной системы. Может быть использован как дополнительный параметр для фильтрации в sale.paysystem.list

Возможные значения ключа TYPE

Название

Описание

ORDER

Параметры

PROPERTY

Свойства счета

PAYMENT

Оплата

USER

Пользователь

VALUE

Произвольное значение типа строка

Y\N

Флажок

Возможные значения ключа VALUE

Название

Описание

ORDER

  • ID — идентификатор
  • ACCOUNT_NUMBER — номер заказа
  • ORDER_TOPIC — тема
  • DATE_INSERT — дата заказа
  • DATE_INSERT_DATE — дата заказа без времени
  • DATE_BILL — дата и время выставления
  • DATE_BILL_DATE — дата выставления
  • DATE_PAY_BEFORE — срок оплаты
  • SHOULD_PAY — сумма счета
  • CURRENCY — валюта
  • PRICE — стоимость заказа
  • PRICE_DELIVERY — стоимость доставки
  • DISCOUNT_VALUE — величина скидки
  • USER_ID — код покупателя
  • PAY_SYSTEM_ID — код платежной системы
  • DELIVERY_ID — код службы доставки
  • TAX_VALUE — налог
  • USER_DESCRIPTION — комментарий

PAYMENT

  • ID — идентификатор
  • ACCOUNT_NUMBER — номер оплаты
  • DATE_BILL — дата и время выставления
  • DATE_BILL_DATE — дата выставления без времени
  • SUM — сумма счета
  • CURRENCY — валюта
  • PAID — оплачено
  • DATE_PAID — дата оплаты
  • PAY_SYSTEM_ID — код платежной системы
  • PAY_VOUCHER_NUM — номер ваучера
  • PAY_VOUCHER_DATE — дата ваучера
  • DATE_PAY_BEFORE — оплатить до
  • XML_ID — индентификатор XML
  • PAY_SYSTEM_NAME — название платежной системы
  • COMPANY_ID — код компании
  • PAY_RETURN_NUM — номер возврата
  • PAY_RETURN_DATE — дата возврата
  • PAY_RETURN_COMMENT — коментарий возврата

USER

  • ID — код покупателя,
  • LOGIN — логин
  • NAME — имя
  • SECOND_NAME — отчество
  • LAST_NAME — фамилия
  • EMAIL — EMail
  • PERSONAL_PROFESSION — профессия
  • PERSONAL_WWW — персональный веб-сайт
  • PERSONAL_ICQ — номер ICQ
  • PERSONAL_GENDER — пол
  • PERSONAL_FAX — номер факса
  • PERSONAL_MOBILE — номер телефона
  • PERSONAL_STREET — адрес
  • PERSONAL_MAILBOX — почтовый ящик
  • PERSONAL_CITY — город
  • PERSONAL_STATE — штат
  • PERSONAL_ZIP — индекс
  • PERSONAL_COUNTRY — страна
  • WORK_COMPANY — компания
  • WORK_DEPARTMENT — отдел
  • WORK_POSITION — должность
  • WORK_WWW — сайт компании
  • WORK_PHONE — рабочий телефон
  • WORK_FAX — рабочий факс
  • WORK_STREET — адрес компании
  • WORK_MAILBOX — рабочий почтовый ящик
  • WORK_CITY — город компании
  • WORK_STATE — штат компании
  • WORK_ZIP — индекс компании
  • WORK_COUNTRY — страна компании

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"NAME":"Оплата картой","DESCRIPTION":"Легко оплачивайте покупки картой.","XML_ID":"my_ps_id","PERSON_TYPE_ID":1,"BX_REST_HANDLER":"resthandlercode","ACTIVE":"Y","ENTITY_REGISTRY_TYPE":"ORDER","LOGOTYPE":"/* base64 image */","NEW_WINDOW":"N","SETTINGS":{"REST_SERVICE_ID":{"TYPE":"VALUE","VALUE":"SERVICE ID VALUE"},"REST_SERVICE_KEY":{"TYPE":"VALUE","VALUE":"KEY ID VALUE"},"PAYMENT_ID":{"TYPE":"PAYMENT","VALUE":"ACCOUNT_NUMBER"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"NAME":"Оплата картой","DESCRIPTION":"Легко оплачивайте покупки картой.","XML_ID":"my_ps_id","PERSON_TYPE_ID":1,"BX_REST_HANDLER":"resthandlercode","ACTIVE":"Y","ENTITY_REGISTRY_TYPE":"ORDER","LOGOTYPE":"/* base64 image */","NEW_WINDOW":"N","SETTINGS":{"REST_SERVICE_ID":{"TYPE":"VALUE","VALUE":"SERVICE ID VALUE"},"REST_SERVICE_KEY":{"TYPE":"VALUE","VALUE":"KEY ID VALUE"},"PAYMENT_ID":{"TYPE":"PAYMENT","VALUE":"ACCOUNT_NUMBER"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.paysystem.add
// 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<number>({
    method: 'sale.paysystem.add',
    params: {
      NAME: 'Card payment',
      DESCRIPTION: 'Pay for your purchases easily by card.',
      XML_ID: 'my_ps_id',
      PERSON_TYPE_ID: 1,
      BX_REST_HANDLER: 'resthandlercode',
      ACTIVE: 'Y',
      ENTITY_REGISTRY_TYPE: 'ORDER',
      LOGOTYPE: '/* base64 image */',
      NEW_WINDOW: 'N',
      SETTINGS: {
        REST_SERVICE_ID: {
          TYPE: 'VALUE',
          VALUE: 'SERVICE ID VALUE',
        },
        REST_SERVICE_KEY: {
          TYPE: 'VALUE',
          VALUE: 'KEY ID VALUE',
        },
        PAYMENT_ID: {
          TYPE: 'PAYMENT',
          VALUE: 'ACCOUNT_NUMBER',
        },
      },
    },
    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('Added payment system ID:', 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 addPaySystem() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.paysystem.add',
        params: {
          NAME: 'Card payment',
          DESCRIPTION: 'Pay for your purchases easily by card.',
          XML_ID: 'my_ps_id',
          PERSON_TYPE_ID: 1,
          BX_REST_HANDLER: 'resthandlercode',
          ACTIVE: 'Y',
          ENTITY_REGISTRY_TYPE: 'ORDER',
          LOGOTYPE: '/* base64 image */',
          NEW_WINDOW: 'N',
          SETTINGS: {
            REST_SERVICE_ID: {
              TYPE: 'VALUE',
              VALUE: 'SERVICE ID VALUE',
            },
            REST_SERVICE_KEY: {
              TYPE: 'VALUE',
              VALUE: 'KEY ID VALUE',
            },
            PAYMENT_ID: {
              TYPE: 'PAYMENT',
              VALUE: 'ACCOUNT_NUMBER',
            },
          },
        },
        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('Added payment system ID:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

settings = {
    "REST_SERVICE_ID": {
        "TYPE": "VALUE",
        "VALUE": "SERVICE ID VALUE",
    },
    "REST_SERVICE_KEY": {
        "TYPE": "VALUE",
        "VALUE": "KEY ID VALUE",
    },
    "PAYMENT_ID": {
        "TYPE": "PAYMENT",
        "VALUE": "ACCOUNT_NUMBER",
    },
}

try:
    bitrix_response = client.sale.paysystem.add(
        name="Card payment",
        description="Pay for your purchases easily by card.",
        xml_id="my_ps_id",
        person_type_id=1,
        bx_rest_handler="resthandlercode",
        active=True,
        entity_registry_type="ORDER",
        logotype="/* base64 image */",
        new_window=False,
        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.add',
            [
                'NAME'               => 'Оплата картой',
                'DESCRIPTION'        => 'Легко оплачивайте покупки картой.',
                'XML_ID'             => 'my_ps_id',
                'PERSON_TYPE_ID'     => 1,
                'BX_REST_HANDLER'    => 'resthandlercode',
                'ACTIVE'             => 'Y',
                'ENTITY_REGISTRY_TYPE' => 'ORDER',
                'LOGOTYPE'           => '/* base64 image */',
                'NEW_WINDOW'         => 'N',
                'SETTINGS'           => [
                    'REST_SERVICE_ID' => [
                        'TYPE'  => 'VALUE',
                        'VALUE' => 'SERVICE ID VALUE',
                    ],
                    'REST_SERVICE_KEY' => [
                        'TYPE'  => 'VALUE',
                        'VALUE' => 'KEY ID VALUE',
                    ],
                    'PAYMENT_ID'      => [
                        'TYPE'  => 'PAYMENT',
                        'VALUE' => 'ACCOUNT_NUMBER',
                    ],
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding payment system: ' . $e->getMessage();
}
BX24.callMethod(
    "sale.paysystem.add",
    {
        'NAME' : 'Оплата картой',
        'DESCRIPTION': 'Легко оплачивайте покупки картой.',
        'XML_ID': 'my_ps_id',
        'PERSON_TYPE_ID' : 1,
        'BX_REST_HANDLER' : 'resthandlercode',
        'ACTIVE' : 'Y',
        'ENTITY_REGISTRY_TYPE': 'ORDER',
        'LOGOTYPE': '/* base64 image */',
        'NEW_WINDOW': 'N',
        'SETTINGS' : {
            'REST_SERVICE_ID' : {
                'TYPE' : 'VALUE',
                'VALUE' : 'SERVICE ID VALUE'
            },
            'REST_SERVICE_KEY' : {
                'TYPE' : 'VALUE',
                'VALUE' : 'KEY ID VALUE'
            },
            'PAYMENT_ID': {
                'TYPE': 'PAYMENT',
                'VALUE': 'ACCOUNT_NUMBER',
            }
        }
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.info(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'sale.paysystem.add',
    [
        'NAME' => 'Оплата картой',
        'DESCRIPTION' => 'Легко оплачивайте покупки картой.',
        'XML_ID' => 'my_ps_id',
        'PERSON_TYPE_ID' => 1,
        'BX_REST_HANDLER' => 'resthandlercode',
        'ACTIVE' => 'Y',
        'ENTITY_REGISTRY_TYPE' => 'ORDER',
        'LOGOTYPE' => '/* base64 image */',
        'NEW_WINDOW' => 'N',
        'SETTINGS' => [
            'REST_SERVICE_ID' => [
                'TYPE' => 'VALUE',
                'VALUE' => 'SERVICE ID VALUE'
            ],
            'REST_SERVICE_KEY' => [
                'TYPE' => 'VALUE',
                'VALUE' => 'KEY ID VALUE'
            ],
            'PAYMENT_ID' => [
                'TYPE' => 'PAYMENT',
                'VALUE' => 'ACCOUNT_NUMBER',
            ]
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.paysystem.add", b24.Params{
	"NAME":                 "Оплата картой",
	"DESCRIPTION":          "Легко оплачивайте покупки картой.",
	"XML_ID":               "my_ps_id",
	"PERSON_TYPE_ID":       1,
	"BX_REST_HANDLER":      "resthandlercode",
	"ACTIVE":               "Y",
	"ENTITY_REGISTRY_TYPE": "ORDER",
	"LOGOTYPE":             "/* base64 image */",
	"NEW_WINDOW":           "N",
	"SETTINGS": b24.Params{
		"REST_SERVICE_ID": b24.Params{
			"TYPE":  "VALUE",
			"VALUE": "SERVICE ID VALUE",
		},
		"REST_SERVICE_KEY": b24.Params{
			"TYPE":  "VALUE",
			"VALUE": "KEY ID VALUE",
		},
		"PAYMENT_ID": b24.Params{
			"TYPE":  "PAYMENT",
			"VALUE": "ACCOUNT_NUMBER",
		},
	},
})
if err != nil {
	return fmt.Errorf("sale.paysystem.add: %w", err)
}

var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)

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

HTTP-статус: 200

{
    "result": 1,
    "time": {
        "start": 1712132792.910734,
        "finish": 1712132793.530359,
        "duration": 0.6196250915527344,
        "processing": 0.032338857650756836,
        "date_start": "2024-04-03T10:26:32+02:00",
        "date_finish": "2024-04-03T10:26:33+02:00",
        "operating_reset_at": 1705765533,
        "operating": 3.3076241016387939
    }
}

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

Название
тип

Описание

result
integer

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

time
time

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

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

HTTP-статус: 400, 403

{
    "error": "ERROR_CHECK_FAILURE",
    "error_description": "Parameter NAME is not defined"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Статус

ACCESS_DENIED

Недостаточно прав для добавления платежной системы

403

ERROR_CHECK_FAILURE

Не указано значение обязательного поля либо значение одного из полей указано неверно

400

ERROR_PAY_SYSTEM_ADD

Прочие ошибки. Подробную информацию об ошибке смотрите в error_description

400

ERROR_HANDLER_NOT_FOUND

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

400

ERROR_PERSON_TYPE_NOT_FOUND

Тип плательщика, указанный в параметре PERSON_TYPE_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

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

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