Получить список платежных систем sale.paysystem.list

Scope: pay_system

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

Метод возвращает список платежных систем.

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

Название
тип

Описание

SELECT
array

Массив, содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_paysystem).

Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля платежных систем

FILTER
object

Объект для фильтрации выбранных платежных систем в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Возможные значения для field соответствуют полям объекта sale_paysystem.

Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • @ — IN, в качестве значения передается массив
  • !@ — NOT IN, в качестве значения передаётся массив
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, начинающиеся с «мол»
    • "%мол" — ищет значения, заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где «мол» может быть в любой позиции
  • %= — LIKE (аналогично =%)
  • !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
  • !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, не начинающиеся с «мол»
    • "%мол" — ищет значения, не заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
  • !%= — NOT LIKE (аналогично !=%)
  • = — равно, точное совпадение (используется по умолчанию)
  • != — не равно
  • ! — не равно

ORDER
object

Объект для сортировки выбранных платежных систем в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Возможные значения для field соответствуют полям объекта sale_paysystem.

Возможные значения для order:

  • ASC — в порядке возрастания
  • DESC — в порядке убывания

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"SELECT":["ID","PERSON_TYPE_ID","NAME","PSA_NAME","SORT","DESCRIPTION","ACTION_FILE","RESULT_FILE","NEW_WINDOW","TARIF","PS_MODE","HAVE_PAYMENT","HAVE_ACTION","HAVE_RESULT","HAVE_PREPAY","HAVE_PRICE","HAVE_RESULT_RECEIVE","ENCODING","ACTIVE","ALLOW_EDIT_PAYMENT","IS_CASH","AUTO_CHANGE_1C","CAN_PRINT_CHECK","ENTITY_REGISTRY_TYPE","XML_ID"],"FILTER":{"@ID":[117,118]},"ORDER":{"SORT":"ASC","ID":"DESC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"SELECT":["ID","PERSON_TYPE_ID","NAME","PSA_NAME","SORT","DESCRIPTION","ACTION_FILE","RESULT_FILE","NEW_WINDOW","TARIF","PS_MODE","HAVE_PAYMENT","HAVE_ACTION","HAVE_RESULT","HAVE_PREPAY","HAVE_PRICE","HAVE_RESULT_RECEIVE","ENCODING","ACTIVE","ALLOW_EDIT_PAYMENT","IS_CASH","AUTO_CHANGE_1C","CAN_PRINT_CHECK","ENTITY_REGISTRY_TYPE","XML_ID"],"FILTER":{"@ID":[117,118]},"ORDER":{"SORT":"ASC","ID":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.paysystem.list
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'sale.paysystem.list',
            {
              SELECT: [
                "ID",
                "PERSON_TYPE_ID",
                "NAME",
                "PSA_NAME",
                "SORT",
                "DESCRIPTION",
                "ACTION_FILE",
                "RESULT_FILE",
                "NEW_WINDOW",
                "TARIF",
                "PS_MODE",
                "HAVE_PAYMENT",
                "HAVE_ACTION",
                "HAVE_RESULT",
                "HAVE_PREPAY",
                "HAVE_PRICE",
                "HAVE_RESULT_RECEIVE",
                "ENCODING",
                "ACTIVE",
                "ALLOW_EDIT_PAYMENT",
                "IS_CASH",
                "AUTO_CHANGE_1C",
                "CAN_PRINT_CHECK",
                "ENTITY_REGISTRY_TYPE",
                "XML_ID",
              ],
              FILTER: {
                "@ID": [117, 118],
              },
              ORDER: {
                SORT: "ASC",
                ID: "DESC",
              },
            },
            (progress) => { console.log('Progress:', progress) }
          );
          const items = response.getData() || [];
          for (const entity of items) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
          const generator = $b24.fetchListMethod('sale.paysystem.list', {
            SELECT: [
              "ID",
              "PERSON_TYPE_ID",
              "NAME",
              "PSA_NAME",
              "SORT",
              "DESCRIPTION",
              "ACTION_FILE",
              "RESULT_FILE",
              "NEW_WINDOW",
              "TARIF",
              "PS_MODE",
              "HAVE_PAYMENT",
              "HAVE_ACTION",
              "HAVE_RESULT",
              "HAVE_PREPAY",
              "HAVE_PRICE",
              "HAVE_RESULT_RECEIVE",
              "ENCODING",
              "ACTIVE",
              "ALLOW_EDIT_PAYMENT",
              "IS_CASH",
              "AUTO_CHANGE_1C",
              "CAN_PRINT_CHECK",
              "ENTITY_REGISTRY_TYPE",
              "XML_ID",
            ],
            FILTER: {
              "@ID": [117, 118],
            },
            ORDER: {
              SORT: "ASC",
              ID: "DESC",
            },
          }, 'ID');
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity); }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
          const response = await $b24.callMethod('sale.paysystem.list', {
            SELECT: [
              "ID",
              "PERSON_TYPE_ID",
              "NAME",
              "PSA_NAME",
              "SORT",
              "DESCRIPTION",
              "ACTION_FILE",
              "RESULT_FILE",
              "NEW_WINDOW",
              "TARIF",
              "PS_MODE",
              "HAVE_PAYMENT",
              "HAVE_ACTION",
              "HAVE_RESULT",
              "HAVE_PREPAY",
              "HAVE_PRICE",
              "HAVE_RESULT_RECEIVE",
              "ENCODING",
              "ACTIVE",
              "ALLOW_EDIT_PAYMENT",
              "IS_CASH",
              "AUTO_CHANGE_1C",
              "CAN_PRINT_CHECK",
              "ENTITY_REGISTRY_TYPE",
              "XML_ID",
            ],
            FILTER: {
              "@ID": [117, 118],
            },
            ORDER: {
              SORT: "ASC",
              ID: "DESC",
            },
          }, 0);
          const result = response.getData().result || [];
          for (const entity of result) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.paysystem.list',
                    [
                        'SELECT' => [
                            "ID",
                            "PERSON_TYPE_ID",
                            "NAME",
                            "PSA_NAME",
                            "SORT",
                            "DESCRIPTION",
                            "ACTION_FILE",
                            "RESULT_FILE",
                            "NEW_WINDOW",
                            "TARIF",
                            "PS_MODE",
                            "HAVE_PAYMENT",
                            "HAVE_ACTION",
                            "HAVE_RESULT",
                            "HAVE_PREPAY",
                            "HAVE_PRICE",
                            "HAVE_RESULT_RECEIVE",
                            "ENCODING",
                            "ACTIVE",
                            "ALLOW_EDIT_PAYMENT",
                            "IS_CASH",
                            "AUTO_CHANGE_1C",
                            "CAN_PRINT_CHECK",
                            "ENTITY_REGISTRY_TYPE",
                            "XML_ID",
                        ],
                        'FILTER' => [
                            "@ID" => [117, 118],
                        ],
                        'ORDER' => [
                            'SORT' => "ASC",
                            'ID'   => "DESC",
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching paysystem list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sale.paysystem.list', {
                SELECT: [
                    "ID",
                    "PERSON_TYPE_ID",
                    "NAME",
                    "PSA_NAME",
                    "SORT",
                    "DESCRIPTION",
                    "ACTION_FILE",
                    "RESULT_FILE",
                    "NEW_WINDOW",
                    "TARIF",
                    "PS_MODE",
                    "HAVE_PAYMENT",
                    "HAVE_ACTION",
                    "HAVE_RESULT",
                    "HAVE_PREPAY",
                    "HAVE_PRICE",
                    "HAVE_RESULT_RECEIVE",
                    "ENCODING",
                    "ACTIVE",
                    "ALLOW_EDIT_PAYMENT",
                    "IS_CASH",
                    "AUTO_CHANGE_1C",
                    "CAN_PRINT_CHECK",
                    "ENTITY_REGISTRY_TYPE",
                    "XML_ID",
                ],
                FILTER: {
                    "@ID": [117, 118],
                },
                ORDER: {
                    SORT: "ASC",
                    ID: "DESC",
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.paysystem.list',
            [
                'SELECT' => [
                    "ID",
                    "PERSON_TYPE_ID",
                    "NAME",
                    "PSA_NAME",
                    "SORT",
                    "DESCRIPTION",
                    "ACTION_FILE",
                    "RESULT_FILE",
                    "NEW_WINDOW",
                    "TARIF",
                    "PS_MODE",
                    "HAVE_PAYMENT",
                    "HAVE_ACTION",
                    "HAVE_RESULT",
                    "HAVE_PREPAY",
                    "HAVE_PRICE",
                    "HAVE_RESULT_RECEIVE",
                    "ENCODING",
                    "ACTIVE",
                    "ALLOW_EDIT_PAYMENT",
                    "IS_CASH",
                    "AUTO_CHANGE_1C",
                    "CAN_PRINT_CHECK",
                    "ENTITY_REGISTRY_TYPE",
                    "XML_ID",
                ],
                'FILTER' => [
                    "@ID" => [117, 118],
                ],
                'ORDER' => [
                    "SORT" => "ASC",
                    "ID" => "DESC",
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result":[
                {
                    "NAME":"Новая оплата картой",
                    "PSA_NAME":"Новая оплата картой",
                    "DESCRIPTION":"Легко оплачивайте покупки картой.",
                    "ACTION_FILE":"resthandlerform",
                    "RESULT_FILE":null,
                    "NEW_WINDOW":"N",
                    "PS_MODE":null,
                    "HAVE_PAYMENT":"N",
                    "HAVE_ACTION":"N",
                    "HAVE_RESULT":"N",
                    "HAVE_PREPAY":"N",
                    "HAVE_PRICE":"N",
                    "HAVE_RESULT_RECEIVE":"Y",
                    "ENCODING":null,
                    "ACTIVE":"Y",
                    "ALLOW_EDIT_PAYMENT":"Y",
                    "IS_CASH":"N",
                    "AUTO_CHANGE_1C":"N",
                    "CAN_PRINT_CHECK":"N",
                    "ENTITY_REGISTRY_TYPE":"ORDER",
                    "XML_ID":"my_ps_id",
                    "ID":118,
                    "PERSON_TYPE_ID":3,
                    "SORT":100,
                    "TARIFF":null
                },
                {
                    "NAME":"Оплата картой",
                    "PSA_NAME":"Оплата картой",
                    "DESCRIPTION":"Легко оплачивайте покупки картой.",
                    "ACTION_FILE":"resthandlerform",
                    "RESULT_FILE":null,
                    "NEW_WINDOW":"Y",
                    "PS_MODE":"",
                    "HAVE_PAYMENT":"N",
                    "HAVE_ACTION":"N",
                    "HAVE_RESULT":"N",
                    "HAVE_PREPAY":"N",
                    "HAVE_PRICE":"N",
                    "HAVE_RESULT_RECEIVE":"Y",
                    "ENCODING":"windows-1251",
                    "ACTIVE":"Y",
                    "ALLOW_EDIT_PAYMENT":"Y",
                    "IS_CASH":"N",
                    "AUTO_CHANGE_1C":"N",
                    "CAN_PRINT_CHECK":"N",
                    "ENTITY_REGISTRY_TYPE":"ORDER",
                    "XML_ID":"my_ps_id",
                    "ID":117,
                    "PERSON_TYPE_ID":3,
                    "SORT":100,
                    "TARIFF":null
                }
            ],
            "time":{
                "start":1714993577.419989,
                "finish":1714993577.621777,
                "duration":0.20178794860839844,
                "processing":0.027898073196411133,
                "date_start":"2024-05-06T14:06:17+03:00",
                "date_finish":"2024-05-06T14:06:17+03:00"
            }
        }
        

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

Название
тип

Описание

result
sale_paysystem[]

Массив объектов с информацией о выбранных платежных системах

time
time

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

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

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

{
            "error":"ACCESS_DENIED",
            "error_description":"Access denied!"
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Статус

ERROR_CHECK_FAILURE

Ошибка валидации входящих параметров (детали смотрите в описании ошибки)

400

ACCESS_DENIED

Недостаточно прав для получения списка платежных систем

403

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

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

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

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