Получить настройки платежной системы для конкретного счета sale.paysystem.settings.invoice.get

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

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

Scope: pay_system

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

Метод возвращает настройки платежной системы для конкретного счета (старая версия).

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

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

Название
тип

Описание

INVOICE_ID*
integer

Идентификатор счета старой версии. Для получения информации по счетам используется сервис crm.invoice.*

PAY_SYSTEM_ID
sale_paysystem.ID

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

BX_REST_HANDLER
sale_paysystem.ACTION_FILE

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

Обязательно передавать либо параметр PAY_SYSTEM_ID, либо BX_REST_HANDLER:

  • при передаче PAY_SYSTEM_ID используется платежная система с указанным идентификтором
  • при передаче BX_REST_HANDLER используется первая найденная платежная система с указанным обработчиков

При передаче обоих параметров приоритет имеет параметр PAY_SYSTEM_ID.

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"INVOICE_ID":10,"PAY_SYSTEM_ID":11}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.settings.invoice.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"INVOICE_ID":10,"PAY_SYSTEM_ID":11,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.paysystem.settings.invoice.get
// 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

// Shape of the payload returned in result (match the "response handling" section of the page)
type PaySystemSettingsResult = Record<string, string>

try {
  const response = await $b24.actions.v2.call.make<PaySystemSettingsResult>({
    method: 'sale.paysystem.settings.invoice.get',
    params: {
      INVOICE_ID: 10,
      PAY_SYSTEM_ID: 11,
    },
    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('Pay system settings:', 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 getInvoicePaySystemSettings() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.paysystem.settings.invoice.get',
        params: {
          INVOICE_ID: 10,
          PAY_SYSTEM_ID: 11,
        },
        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('Pay system settings:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getInvoicePaySystemSettings)
</script>
try {
    $response = $b24Service
        ->core
        ->call(
            'sale.paysystem.settings.invoice.get',
            [
                'INVOICE_ID'    => 10,
                'PAY_SYSTEM_ID' => 11,
            ]
        );

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

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Data: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting invoice settings: ' . $e->getMessage();
}
BX24.callMethod('sale.paysystem.settings.invoice.get', {
        "INVOICE_ID": 10,
        "PAY_SYSTEM_ID": 11
    }, 
    function(result) 
    { 
        if(result.error()) 
        {
            console.error(result.error()); 
        }
        else 
        { 
            console.dir(result.data()); 
        } 
    } 
);
require_once('crest.php');

$result = CRest::call(
    'sale.paysystem.settings.invoice.get',
    [
        'INVOICE_ID' => 10,
        'PAY_SYSTEM_ID' => 11
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.paysystem.settings.invoice.get", b24.Params{
	"INVOICE_ID":    10,
	"PAY_SYSTEM_ID": 11,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("sale.paysystem.settings.invoice.get: %w", err)
}

var item struct {
	RestServiceIDIframe  string `json:"REST_SERVICE_ID_IFRAME"`
	RestServiceKeyIframe string `json:"REST_SERVICE_KEY_IFRAME"`
	PsWorkModeIframe     string `json:"PS_WORK_MODE_IFRAME"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.RestServiceIDIframe, item.RestServiceKeyIframe)

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

HTTP-статус: 200

{
    "result": {
        "REST_SERVICE_ID_IFRAME": "snum",
        "REST_SERVICE_KEY_IFRAME": "skey",
        "PS_WORK_MODE_IFRAME": "REGULAR"
    },
    "time": {
        "start": 1712135335.026931,
        "finish": 1712135335.407762,
        "duration": 0.3808310031890869,
        "processing": 0.0336611270904541,
        "date_start": "2024-04-03T11:08:55+02:00",
        "date_finish": "2024-04-03T11:08:55+02:00",
        "operating_reset_at": 1705765533,
        "operating": 3.3076241016387939
    }
}

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

Название
тип

Описание

result
object

Корневой элемент ответа.

Ключами объекта являются коды параметров, указанные при добавлении обработчика через sale.paysystem.handler.add в параметре CODES.

Значениями объекта являются значения параметров:

  • либо заполненные пользователем вручную при создании платежной системы
  • либо указанные при добавлении платежной системы через sale.paysystem.add

time
time

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

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

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

{
    "error": "ERROR_CHECK_FAILURE",
    "error_description": "Pay system not found"
}

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Статус

ACCESS_DENIED

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

403

ERROR_CHECK_FAILURE

Не указано значение одного из обязательных полей либо не найдена платежная система с указанным ID или bx_rest_handler (детали смотрите в описании ошибки)

400

ERROR_INTERNAL_INVOICE_NOT_FOUND

Не найден указанный счет

400

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

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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