метод REST scope: pay_system

sale.paysystem.settings.invoice.get

Получить настройки платежной системы для конкретного счета

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

Описание

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

Параметры

INVOICE_ID integer обязательный

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

PAY_SYSTEM_ID sale_paysystem.ID необязательный

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

BX_REST_HANDLER sale_paysystem.ACTION_FILE необязательный

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

Примеры запроса

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

Ответ

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

{
    "error": "ERROR_CHECK_FAILURE",
    "error_description": "Pay system not found"
}
Код Описание Значение
ACCESS_DENIED Недостаточно прав для получения настроек 403
ERROR_CHECK_FAILURE Не указано значение одного из обязательных полей либо не найдена платежная система с указанным ID или bx_rest_handler (детали смотрите в описании ошибки) 400
ERROR_INTERNAL_INVOICE_NOT_FOUND Не найден указанный счет 400

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

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