метод REST scope: pay_system

sale.paysystem.add

Добавить платежную систему

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

Описание

Метод добавляет платежную систему.

Параметры

NAME string обязательный

Название платежной системы

DESCRIPTION string необязательный

Описание платежной системы

PERSON_TYPE_ID sale_person_type.id обязательный

Идентификатор типа плательщика

BX_REST_HANDLER sale_paysystem_handler.CODE обязательный

Код REST-обработчика, указанный при добавлении обработчика методом sale.paysystem.handler.add

ACTIVE string необязательный

Индикатор активности платежной системы. Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию N

SETTINGS object необязательный

Список значений настроек обработчика в формате {"field_1": "value_1", ... "field_N": "value_N"}, где field — название настройки, а value — объект, содержащий ключи TYPE и VALUE (описание смотрите ниже).

Структура настроек задается при добавлении обработчика платежной системы в методе sale.paysystem.handler.add в ключе CODES параметра SETTINGS

ENTITY_REGISTRY_TYPE string необязательный

Привязка платежной системы:
- ORDER — значение для заказов магазина, сделок, смарт-процессов
- CRM_INVOICE — значение для счетов CRM
- CRM_QUOTE — значение для коммерческих предложений CRM

Если не передано, то по умолчанию CRM_INVOICE.

Тип плательщика PERSON_TYPE_ID должен относиться к тому же типу привязки

LOGOTYPE string необязательный

Логотип платежной системы (картинка в формате Base64)

NEW_WINDOW string необязательный

Флаг, отвечающий за настройку «Открывать в новом окне». Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию N

XML_ID string необязательный

Внешний идентификатор платежной системы. Может быть использован как дополнительный параметр для фильтрации в sale.paysystem.list

Возможные значения ключа TYPE

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

Параметры

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

Свойства счета

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

Оплата

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

Пользователь

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

Произвольное значение типа строка

Y\N необязательный

Флажок

Возможные значения ключа VALUE

ORDER необязательный
  • ID — идентификатор
  • ACCOUNT_NUMBER — номер заказа
  • ORDER_TOPIC — тема
  • DATE_INSERT — дата заказа
  • DATE_INSERT_DATE — дата заказа без времени
  • DATE_BILL — дата и время выставления
  • DATE_BILL_DATE — дата выставления
  • DATE_PAY_BEFORE — срок оплаты
  • SHOULD_PAY — сумма счета
  • CURRENCY — валюта
  • PRICE — стоимость заказа
  • PRICE_DELIVERY — стоимость доставки
  • DISCOUNT_VALUE — величина скидки
  • USER_ID — код покупателя
  • PAY_SYSTEM_ID — код платежной системы
  • DELIVERY_ID — код службы доставки
  • TAX_VALUE — налог
  • USER_DESCRIPTION — комментарий
PAYMENT необязательный
  • ID — идентификатор
  • ACCOUNT_NUMBER — номер оплаты
  • DATE_BILL — дата и время выставления
  • DATE_BILL_DATE — дата выставления без времени
  • SUM — сумма счета
  • CURRENCY — валюта
  • PAID — оплачено
  • DATE_PAID — дата оплаты
  • PAY_SYSTEM_ID — код платежной системы
  • PAY_VOUCHER_NUM — номер ваучера
  • PAY_VOUCHER_DATE — дата ваучера
  • DATE_PAY_BEFORE — оплатить до
  • XML_ID — индентификатор XML
  • PAY_SYSTEM_NAME — название платежной системы
  • COMPANY_ID — код компании
  • PAY_RETURN_NUM — номер возврата
  • PAY_RETURN_DATE — дата возврата
  • PAY_RETURN_COMMENT — коментарий возврата
USER необязательный
  • ID — код покупателя,
  • LOGIN — логин
  • NAME — имя
  • SECOND_NAME — отчество
  • LAST_NAME — фамилия
  • EMAIL — EMail
  • PERSONAL_PROFESSION — профессия
  • PERSONAL_WWW — персональный веб-сайт
  • PERSONAL_ICQ — номер ICQ
  • PERSONAL_GENDER — пол
  • PERSONAL_FAX — номер факса
  • PERSONAL_MOBILE — номер телефона
  • PERSONAL_STREET — адрес
  • PERSONAL_MAILBOX — почтовый ящик
  • PERSONAL_CITY — город
  • PERSONAL_STATE — штат
  • PERSONAL_ZIP — индекс
  • PERSONAL_COUNTRY — страна
  • WORK_COMPANY — компания
  • WORK_DEPARTMENT — отдел
  • WORK_POSITION — должность
  • WORK_WWW — сайт компании
  • WORK_PHONE — рабочий телефон
  • WORK_FAX — рабочий факс
  • WORK_STREET — адрес компании
  • WORK_MAILBOX — рабочий почтовый ящик
  • WORK_CITY — город компании
  • WORK_STATE — штат компании
  • WORK_ZIP — индекс компании
  • WORK_COUNTRY — страна компании

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"NAME":"Оплата картой","DESCRIPTION":"Легко оплачивайте покупки картой.","XML_ID":"my_ps_id","PERSON_TYPE_ID":1,"BX_REST_HANDLER":"resthandlercode","ACTIVE":"Y","ENTITY_REGISTRY_TYPE":"ORDER","LOGOTYPE":"/* base64 image */","NEW_WINDOW":"N","SETTINGS":{"REST_SERVICE_ID":{"TYPE":"VALUE","VALUE":"SERVICE ID VALUE"},"REST_SERVICE_KEY":{"TYPE":"VALUE","VALUE":"KEY ID VALUE"},"PAYMENT_ID":{"TYPE":"PAYMENT","VALUE":"ACCOUNT_NUMBER"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.add

Ответ

HTTP-статус: 200

{
    "result": 1,
    "time": {
        "start": 1712132792.910734,
        "finish": 1712132793.530359,
        "duration": 0.6196250915527344,
        "processing": 0.032338857650756836,
        "date_start": "2024-04-03T10:26:32+02:00",
        "date_finish": "2024-04-03T10:26:33+02:00",
        "operating_reset_at": 1705765533,
        "operating": 3.3076241016387939
    }
}

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

result integer

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

time time

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

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

HTTP-статус: 400

{
    "error": "ERROR_CHECK_FAILURE",
    "error_description": "Parameter NAME is not defined"
}
Код Описание Значение
ACCESS_DENIED Недостаточно прав для добавления платежной системы 403
ERROR_CHECK_FAILURE Не указано значение обязательного поля либо значение одного из полей указано неверно 400
ERROR_PAY_SYSTEM_ADD Прочие ошибки. Подробную информацию об ошибке смотрите в error_description 400
ERROR_HANDLER_NOT_FOUND Обработчик, указанный в параметре BX_REST_HANDLER, не найден 400
ERROR_PERSON_TYPE_NOT_FOUND Тип плательщика, указанный в параметре PERSON_TYPE_ID, не найден 400

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

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