метод REST scope: pay_system

sale.paysystem.list

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

Кто может выполнять: администратор 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

Ответ

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

{
    "error":"ACCESS_DENIED",
    "error_description":"Access denied!"
}
Код Описание Значение
ERROR_CHECK_FAILURE Ошибка валидации входящих параметров (детали смотрите в описании ошибки) 400
ACCESS_DENIED Недостаточно прав для получения списка платежных систем 403

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.