Обновить REST-обработчик платежной системы sale.paysystem.handler.update

Scope: pay_system

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

Метод обновляет REST-обработчик платежной системы.

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

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

Название `тип`	Описание
ID* `sale_paysystem_handler.ID`	Идентификатор REST-обработчика
FIELDS* `object`	Набор значений для обновления (подробное описание приведено ниже)

Параметр FIELDS

Название `тип`	Описание
NAME `string`	Название обработчика
CODE `string`	Уникальный код обработчика в системе
SETTINGS `object`	Настройки обработчика. Формат аналогичен формату в sale.paysystem.handler.add
SORT `integer`	Сортировка

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.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"
        							}
        						}
        					}
        				}
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

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 `boolean`	Результат обновления REST-обработчика
time `time`	Информация о времени выполнения запроса

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

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

{
            "error": "ERROR_HANDLER_NOT_FOUND",
            "error_description": "Handler not found"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание	Статус
`ACCESS_DENIED`	Доступ запрещен. Приложение пытается изменить обработчик, добавленный другим приложением, либо недостаточно прав для обновления обработчика	403
`ERROR_CHECK_FAILURE`	Не указано значение поля `ID` либо `FIELDS`	400
`ERROR_HANDLER_NOT_FOUND`	Обработчик с указанным `ID` не найден	400
`ERROR_HANDLER_UPDATE`	Прочие ошибки. Подробную информацию об ошибке смотрите в `error_description`	400
`ERROR_UNEXPECTED_ANSWER`	Неожиданный ответ сервера. Одна из возможных причин — попытка указать обработчику неуникальный параметр `CODE`, уже существующий у другого обработчика	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	Превышен лимит на интенсивность запросов
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Добавить REST-обработчик платежной системы

Получить список REST-обработчиков платежной системы

Обновить REST-обработчик платежной системы sale.paysystem.handler.update

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

Параметр FIELDSПараметр FIELDS

Примеры кодаПримеры кода

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

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

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

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

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

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