Для AI-агентов: markdown этой страницы — /docs-content/entities/pay-systems/handlers.md индекс документации — /llms.txt

Список обработчиков платёжных систем

GET /v1/pay-systems/handlers

Позволяет выбрать зарегистрированный REST-обработчик для создания платёжной системы на портале Битрикс24.

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/pay-systems/handlers" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/pay-systems/handlers" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const response = await fetch('https://vibecode.bitrix24.tech/v1/pay-systems/handlers', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await response.json()
console.log(data)

JavaScript — OAuth-приложение

javascript 
const response = await fetch('https://vibecode.bitrix24.tech/v1/pay-systems/handlers', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await response.json()
console.log(data)

Поля ответа

Поле Тип Обяз. Описание
success boolean да true при успешном запросе
data array да Список зарегистрированных REST-обработчиков платёжных систем
data[].id integer нет Идентификатор обработчика
data[].name string нет Название обработчика
data[].code string нет Код обработчика
data[].sort integer нет Значение сортировки обработчика
data[].description string нет Описание обработчика
data[].settings object / array нет Определение настроек обработчика. Состав и вложенные ключи зависят от обработчика
data[].profiles array нет Определения профилей обработчика
meta object да Сведения о списке
meta.total integer да Количество обработчиков в data

Поля обработчика включаются в ответ, если присутствуют в его определении. Пустой массив data означает, что зарегистрированных REST-обработчиков нет.

Пример ответа

Показаны основные поля обработчиков. Полный состав — в таблице полей ответа.

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "code": "my_payment_handler",
      "sort": 100
    },
    {
      "id": 3,
      "code": "my_qr_handler",
      "sort": 100
    }
  ],
  "meta": {
    "total": 2
  }
}

Пример ответа при ошибке

400 — передан параметр запроса limit=1:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Handlers have no query parameters"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Переданы параметры запроса. Метод не принимает параметры
403 BITRIX_ACCESS_DENIED Битрикс24 отказал в доступе к обработчикам
422 BITRIX_ERROR Ошибка выполнения операции в Битрикс24. Подробности — в error.message
502 BITRIX_RESPONSE_INVALID Получен ответ с некорректной структурой
401 TOKEN_MISSING У ключа не настроены токены доступа к Битрикс24
403 SCOPE_DENIED Ключу не хватает скоупа pay_system

Полный список общих ошибок API — Ошибки.

Смотрите также