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

Получить платёжную систему

GET /v1/pay-systems/:id

Получает платёжную систему по её идентификатору. Используйте метод для проверки настроек перед созданием оплаты заказа.

Скоуп: pay_system.

Параметры

Параметр Тип Обяз. Описание
id (path) integer да Положительный целочисленный идентификатор платёжной системы. Источник: Список платёжных систем

Параметры запроса после ? не принимаются.

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/pay-systems/41" \
  -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/41', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
});

console.log(await response.json());

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

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

console.log(await response.json());

Поля ответа

Поле Тип Описание
success boolean true при успешном выполнении
data object Объект платёжной системы. Полный состав — Поля платёжной системы

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

Показаны основные поля. Полный список — Поля платёжной системы.

JSON 
{
  "success": true,
  "data": {
    "id": 41,
    "name": "Оплата по счёту",
    "psaName": "Оплата по счёту",
    "description": null,
    "newWindow": "N",
    "sort": 100,
    "active": "N",
    "entityRegistryType": "ORDER",
    "personTypeId": 5,
    "xmlId": "invoice-20261014"
  }
}

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

404 — платёжная система не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Entity not found"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не является положительным целым числом в безопасном диапазоне JavaScript либо переданы параметры запроса после ?
404 ENTITY_NOT_FOUND Платёжная система с указанным id не найдена
403 BITRIX_ACCESS_DENIED Битрикс24 отказал в доступе к платёжной системе
422 BITRIX_ERROR Битрикс24 отклонил операцию. Причина указана в error.message
502 BITRIX_RESPONSE_INVALID Ответ Битрикс24 имеет некорректную структуру
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 INVALID_API_KEY API-ключ недействителен
401 TOKEN_MISSING У API-ключа нет настроенных токенов Битрикс24
403 SCOPE_DENIED У API-ключа нет скоупа pay_system

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

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