Обновить REST-обработчик платежной системы sale.paysystem.handler.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
pay_systemКто может выполнять метод: администратор CRM (право «Разрешить изменять настройки»)
Метод обновляет REST-обработчик платежной системы.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
Идентификатор REST-обработчика |
|
|
FIELDS* |
Набор значений для обновления (подробное описание приведено ниже) |
Параметр FIELDS
|
Название |
Описание |
|
NAME |
Название обработчика |
|
CODE |
Уникальный код обработчика в системе |
|
SETTINGS |
Настройки обработчика. Формат аналогичен формату в sale.paysystem.handler.add |
|
SORT |
Сортировка |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":3,"FIELDS":{"CODE":"newresthandlercode","NAME":"Новое название обработчика","SORT":200,"SETTINGS":{"CURRENCY":["RUB","BYN"],"FORM_DATA":{"ACTION_URI":"http://example.com/payment_form.php","METHOD":"POST","PARAMS":{"serviceid":"REST_SERVICE_ID_2","invoiceNumber":"PAYMENT_ID_2","Sum":"PAYMENT_SHOULD_PAY_2","customer":"PAYMENT_BUYER_ID_2"},"CODES":{"REST_SERVICE_ID_2":{"NAME":"Номер магазина","DESCRIPTION":"Номер магазина","SORT":"100"},"REST_SERVICE_KEY_2":{"NAME":"Секретный ключ","DESCRIPTION":"Секретный ключ","SORT":"300"},"PAYMENT_ID_2":{"NAME":"Номер оплаты","SORT":"400","GROUP":"PAYMENT","DEFAULT":{"PROVIDER_KEY":"PAYMENT","PROVIDER_VALUE":"ACCOUNT_NUMBER"}},"PAYMENT_SHOULD_PAY_2":{"NAME":"Сумма оплаты","SORT":"600","GROUP":"PAYMENT","DEFAULT":{"PROVIDER_KEY":"PAYMENT","PROVIDER_VALUE":"SUM"}},"PS_CHANGE_STATUS_PAY_2":{"NAME":"Автоматическая смена статуса оплаты","SORT":"700","INPUT":{"TYPE":"Y/N"}},"PAYMENT_BUYER_ID_2":{"NAME":"Код покупателя","SORT":"1000","GROUP":"PAYMENT","DEFAULT":{"PROVIDER_KEY":"ORDER","PROVIDER_VALUE":"USER_ID"}}}}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.handler.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":3,"FIELDS":{"CODE":"newresthandlercode","NAME":"Новое название обработчика","SORT":200,"SETTINGS":{"CURRENCY":["RUB","BYN"],"FORM_DATA":{"ACTION_URI":"http://example.com/payment_form.php","METHOD":"POST","PARAMS":{"serviceid":"REST_SERVICE_ID_2","invoiceNumber":"PAYMENT_ID_2","Sum":"PAYMENT_SHOULD_PAY_2","customer":"PAYMENT_BUYER_ID_2"},"CODES":{"REST_SERVICE_ID_2":{"NAME":"Номер магазина","DESCRIPTION":"Номер магазина","SORT":"100"},"REST_SERVICE_KEY_2":{"NAME":"Секретный ключ","DESCRIPTION":"Секретный ключ","SORT":"300"},"PAYMENT_ID_2":{"NAME":"Номер оплаты","SORT":"400","GROUP":"PAYMENT","DEFAULT":{"PROVIDER_KEY":"PAYMENT","PROVIDER_VALUE":"ACCOUNT_NUMBER"}},"PAYMENT_SHOULD_PAY_2":{"NAME":"Сумма оплаты","SORT":"600","GROUP":"PAYMENT","DEFAULT":{"PROVIDER_KEY":"PAYMENT","PROVIDER_VALUE":"SUM"}},"PS_CHANGE_STATUS_PAY_2":{"NAME":"Автоматическая смена статуса оплаты","SORT":"700","INPUT":{"TYPE":"Y/N"}},"PAYMENT_BUYER_ID_2":{"NAME":"Код покупателя","SORT":"1000","GROUP":"PAYMENT","DEFAULT":{"PROVIDER_KEY":"ORDER","PROVIDER_VALUE":"USER_ID"}}}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.paysystem.handler.update
// 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
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'sale.paysystem.handler.update',
params: {
ID: 3,
FIELDS: {
CODE: 'newresthandlercode',
NAME: 'New handler name',
SORT: 200,
SETTINGS: {
CURRENCY: ['RUB', 'BYN'],
FORM_DATA: {
ACTION_URI: 'http://example.com/payment_form.php',
METHOD: 'POST',
PARAMS: {
serviceid: 'REST_SERVICE_ID_2',
invoiceNumber: 'PAYMENT_ID_2',
Sum: 'PAYMENT_SHOULD_PAY_2',
customer: 'PAYMENT_BUYER_ID_2',
},
},
CODES: {
REST_SERVICE_ID_2: {
NAME: 'Store number',
DESCRIPTION: 'Store number',
SORT: '100',
},
REST_SERVICE_KEY_2: {
NAME: 'Secret key',
DESCRIPTION: 'Secret key',
SORT: '300',
},
PAYMENT_ID_2: {
NAME: 'Payment number',
SORT: '400',
GROUP: 'PAYMENT',
DEFAULT: {
PROVIDER_KEY: 'PAYMENT',
PROVIDER_VALUE: 'ACCOUNT_NUMBER',
},
},
PAYMENT_SHOULD_PAY_2: {
NAME: 'Payment amount',
SORT: '600',
GROUP: 'PAYMENT',
DEFAULT: {
PROVIDER_KEY: 'PAYMENT',
PROVIDER_VALUE: 'SUM',
},
},
PS_CHANGE_STATUS_PAY_2: {
NAME: 'Automatic payment status change',
SORT: '700',
INPUT: {
TYPE: 'Y/N',
},
},
PAYMENT_BUYER_ID_2: {
NAME: 'Customer code',
SORT: '1000',
GROUP: 'PAYMENT',
DEFAULT: {
PROVIDER_KEY: 'ORDER',
PROVIDER_VALUE: 'USER_ID',
},
},
},
},
},
},
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('Handler updated:', 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 updatePaySystemHandler() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.paysystem.handler.update',
params: {
ID: 3,
FIELDS: {
CODE: 'newresthandlercode',
NAME: 'New handler name',
SORT: 200,
SETTINGS: {
CURRENCY: ['RUB', 'BYN'],
FORM_DATA: {
ACTION_URI: 'http://example.com/payment_form.php',
METHOD: 'POST',
PARAMS: {
serviceid: 'REST_SERVICE_ID_2',
invoiceNumber: 'PAYMENT_ID_2',
Sum: 'PAYMENT_SHOULD_PAY_2',
customer: 'PAYMENT_BUYER_ID_2',
},
},
CODES: {
REST_SERVICE_ID_2: {
NAME: 'Store number',
DESCRIPTION: 'Store number',
SORT: '100',
},
REST_SERVICE_KEY_2: {
NAME: 'Secret key',
DESCRIPTION: 'Secret key',
SORT: '300',
},
PAYMENT_ID_2: {
NAME: 'Payment number',
SORT: '400',
GROUP: 'PAYMENT',
DEFAULT: {
PROVIDER_KEY: 'PAYMENT',
PROVIDER_VALUE: 'ACCOUNT_NUMBER',
},
},
PAYMENT_SHOULD_PAY_2: {
NAME: 'Payment amount',
SORT: '600',
GROUP: 'PAYMENT',
DEFAULT: {
PROVIDER_KEY: 'PAYMENT',
PROVIDER_VALUE: 'SUM',
},
},
PS_CHANGE_STATUS_PAY_2: {
NAME: 'Automatic payment status change',
SORT: '700',
INPUT: {
TYPE: 'Y/N',
},
},
PAYMENT_BUYER_ID_2: {
NAME: 'Customer code',
SORT: '1000',
GROUP: 'PAYMENT',
DEFAULT: {
PROVIDER_KEY: 'ORDER',
PROVIDER_VALUE: 'USER_ID',
},
},
},
},
},
},
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('Handler updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updatePaySystemHandler)
</script>
try {
$response = $b24Service
->core
->call(
'sale.paysystem.handler.update',
[
'ID' => 3,
'FIELDS' => [
'CODE' => 'newresthandlercode',
'NAME' => 'Новое название обработчика',
'SORT' => 200,
'SETTINGS' => [
'CURRENCY' => ['RUB', 'BYN'],
'FORM_DATA' => [
'ACTION_URI' => 'http://example.com/payment_form.php',
'METHOD' => 'POST',
'PARAMS' => [
'serviceid' => 'REST_SERVICE_ID_2',
'invoiceNumber' => 'PAYMENT_ID_2',
'Sum' => 'PAYMENT_SHOULD_PAY_2',
'customer' => 'PAYMENT_BUYER_ID_2',
],
],
'CODES' => [
'REST_SERVICE_ID_2' => [
'NAME' => 'Номер магазина',
'DESCRIPTION' => 'Номер магазина',
'SORT' => '100',
],
'REST_SERVICE_KEY_2' => [
'NAME' => 'Секретный ключ',
'DESCRIPTION' => 'Секретный ключ',
'SORT' => '300',
],
'PAYMENT_ID_2' => [
'NAME' => 'Номер оплаты',
'SORT' => '400',
'GROUP' => 'PAYMENT',
'DEFAULT' => [
'PROVIDER_KEY' => 'PAYMENT',
'PROVIDER_VALUE' => 'ACCOUNT_NUMBER',
],
],
'PAYMENT_SHOULD_PAY_2' => [
'NAME' => 'Сумма оплаты',
'SORT' => '600',
'GROUP' => 'PAYMENT',
'DEFAULT' => [
'PROVIDER_KEY' => 'PAYMENT',
'PROVIDER_VALUE' => 'SUM',
],
],
'PS_CHANGE_STATUS_PAY_2' => [
'NAME' => 'Автоматическая смена статуса оплаты',
'SORT' => '700',
'INPUT' => [
'TYPE' => 'Y/N',
],
],
'PAYMENT_BUYER_ID_2' => [
'NAME' => 'Код покупателя',
'SORT' => '1000',
'GROUP' => 'PAYMENT',
'DEFAULT' => [
'PROVIDER_KEY' => 'ORDER',
'PROVIDER_VALUE' => 'USER_ID',
],
],
],
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating payment system handler: ' . $e->getMessage();
}
BX24.callMethod(
"sale.paysystem.handler.update",
{
'ID': 3,
'FIELDS': {
'CODE': 'newresthandlercode',
'NAME': 'Новое название обработчика',
'SORT': 200,
'SETTINGS': {
"CURRENCY": [
"RUB", "BYN"
],
"FORM_DATA": {
"ACTION_URI": "http://example.com/payment_form.php",
"METHOD": "POST",
"PARAMS": {
"serviceid": "REST_SERVICE_ID_2",
"invoiceNumber": "PAYMENT_ID_2",
"Sum": "PAYMENT_SHOULD_PAY_2",
"customer": "PAYMENT_BUYER_ID_2"
}
},
"CODES": {
"REST_SERVICE_ID_2": {
"NAME": "Номер магазина",
"DESCRIPTION": "Номер магазина",
"SORT": "100"
},
"REST_SERVICE_KEY_2": {
"NAME": "Секретный ключ",
"DESCRIPTION": "Секретный ключ",
"SORT": "300"
},
"PAYMENT_ID_2": {
"NAME": "Номер оплаты",
"SORT": "400",
"GROUP": "PAYMENT",
"DEFAULT": {
"PROVIDER_KEY": "PAYMENT",
"PROVIDER_VALUE": "ACCOUNT_NUMBER"
}
},
"PAYMENT_SHOULD_PAY_2": {
"NAME": "Сумма оплаты",
"SORT": "600",
"GROUP": "PAYMENT",
"DEFAULT": {
"PROVIDER_KEY": "PAYMENT",
"PROVIDER_VALUE": "SUM"
}
},
"PS_CHANGE_STATUS_PAY_2": {
"NAME": "Автоматическая смена статуса оплаты",
"SORT": "700",
"INPUT": {
"TYPE": "Y/N"
}
},
"PAYMENT_BUYER_ID_2": {
"NAME": "Код покупателя",
"SORT": "1000",
"GROUP": "PAYMENT",
"DEFAULT": {
"PROVIDER_KEY": "ORDER",
"PROVIDER_VALUE": "USER_ID"
}
}
}
}
}
}
,
function (result) {
if (result.error()) {
console.error(result.error());
}
else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.paysystem.handler.update',
[
'ID' => 3,
'FIELDS' => [
'CODE' => 'newresthandlercode',
'NAME' => 'Новое название обработчика',
'SORT' => 200,
'SETTINGS' => [
'CURRENCY' => ['RUB', 'BYN'],
'FORM_DATA' => [
'ACTION_URI' => 'http://example.com/payment_form.php',
'METHOD' => 'POST',
'PARAMS' => [
'serviceid' => 'REST_SERVICE_ID_2',
'invoiceNumber' => 'PAYMENT_ID_2',
'Sum' => 'PAYMENT_SHOULD_PAY_2',
'customer' => 'PAYMENT_BUYER_ID_2'
]
],
'CODES' => [
'REST_SERVICE_ID_2' => [
'NAME' => 'Номер магазина',
'DESCRIPTION' => 'Номер магазина',
'SORT' => '100'
],
'REST_SERVICE_KEY_2' => [
'NAME' => 'Секретный ключ',
'DESCRIPTION' => 'Секретный ключ',
'SORT' => '300'
],
'PAYMENT_ID_2' => [
'NAME' => 'Номер оплаты',
'SORT' => '400',
'GROUP' => 'PAYMENT',
'DEFAULT' => [
'PROVIDER_KEY' => 'PAYMENT',
'PROVIDER_VALUE' => 'ACCOUNT_NUMBER'
]
],
'PAYMENT_SHOULD_PAY_2' => [
'NAME' => 'Сумма оплаты',
'SORT' => '600',
'GROUP' => 'PAYMENT',
'DEFAULT' => [
'PROVIDER_KEY' => 'PAYMENT',
'PROVIDER_VALUE' => 'SUM'
]
],
'PS_CHANGE_STATUS_PAY_2' => [
'NAME' => 'Автоматическая смена статуса оплаты',
'SORT' => '700',
'INPUT' => [
'TYPE' => 'Y/N'
]
],
'PAYMENT_BUYER_ID_2' => [
'NAME' => 'Код покупателя',
'SORT' => '1000',
'GROUP' => 'PAYMENT',
'DEFAULT' => [
'PROVIDER_KEY' => 'ORDER',
'PROVIDER_VALUE' => 'USER_ID'
]
]
]
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": true,
"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 |
Результат обновления REST-обработчика |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400, 403
{
"error": "ERROR_HANDLER_NOT_FOUND",
"error_description": "Handler not found"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Статус |
|
|
Доступ запрещен. Приложение пытается изменить обработчик, добавленный другим приложением, либо недостаточно прав для обновления обработчика |
403 |
|
|
Не указано значение поля |
400 |
|
|
Обработчик с указанным |
400 |
|
|
Прочие ошибки. Подробную информацию об ошибке смотрите в |
400 |
|
|
Неожиданный ответ сервера. Одна из возможных причин — попытка указать обработчику неуникальный параметр |
400 |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить REST-обработчик платежной системы sale.paysystem.handler.add
- Получить список REST-обработчиков платежной системы sale.paysystem.handler.list
- Удалить REST-обработчик платежной системы sale.paysystem.handler.delete
- Добавить платежную систему sale.paysystem.add
- Изменить платежную систему sale.paysystem.update
- Получить список платежных систем sale.paysystem.list
- Получить настройки платежной системы sale.paysystem.settings.get
- Обновить настройки платежной системы sale.paysystem.settings.update
- Удалить платежную систему sale.paysystem.delete
- Оплатить заказ через конкретную платежную систему sale.paysystem.pay.payment
- Получить настройки платежной системы для конкретной оплаты sale.paysystem.settings.payment.get