sale.paysystem.settings.update

Scope: pay_system Права на выполнение: администратор

Описание и параметры

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

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

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

Параметр	Описание
ID* `sale_paysystem.ID`	Идентификатор платежной системы, для которой нужно получить настройки
PERSON_TYPE_ID `sale_person_type.id`	Идентификатор типа плательщика, для которого нужно получить настройки
SETTINGS* `object`	Настройки, которые нужно обновить. Ключами выступают названия настроек, значениями — объекты, структура которых описана ниже

Параметр SETTINGS

Параметр	Описание
TYPE `string`	Источник значения параметра
VALUE `string`	Код параметра у источника либо значение параметра (для `TYPE="VALUE"`)

Примеры кода

cURL (Webhook)

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":11,"PERSON_TYPE_ID":1,"SETTINGS":{"REST_SERVICE_KEY_IFRAME":{"TYPE":"VALUE","VALUE":"NEW_KEY"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.settings.update

cURL (OAuth)

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":11,"PERSON_TYPE_ID":1,"SETTINGS":{"REST_SERVICE_KEY_IFRAME":{"TYPE":"VALUE","VALUE":"NEW_KEY"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.paysystem.settings.update

BX24.callMethod('sale.paysystem.settings.update', {
	'ID': 11,
	'PERSON_TYPE_ID': 1,
	'SETTINGS': {
		'REST_SERVICE_KEY_IFRAME': {
			'TYPE': 'VALUE',
			'VALUE': 'NEW_KEY',
		}
	}
}, 
function(result) 
{ 
	if(result.error()) 
		console.error(result.error()); 
	else 
	{ 
		console.dir(result.data()); 
	} 
} 
);

PHP

require_once('crest.php');

$result = CRest::call(
	'sale.paysystem.settings.update',
	[
		'ID' => 11,
		'PERSON_TYPE_ID' => 1,
		'SETTINGS' => [
			'REST_SERVICE_KEY_IFRAME' => [
				'TYPE' => 'VALUE',
				'VALUE' => 'NEW_KEY',
			]
		]
	]
);

echo '';
print_r($result);
echo '';

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

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

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`	Результат обновления настроек платежной системы
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	Не указано значение одного из обязательных полей либо не найдена указанная платежная система (детали смотрите в описании ошибки)	400
ERROR_HANDLER_NOT_FOUND	Не указано значение поля `SETTINGS` либо передан пустой объект	400

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

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.