sale.paysystem.settings.get

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

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

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

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

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

Параметр	Описание
ID* `sale_paysystem.ID`	Идентификатор платежной системы, для которой нужно получить настройки
PERSON_TYPE_ID* `sale_person_type.id`	Идентификатор типа плательщика, для которого нужно получить настройки. Для получения настроек по умолчанию передайте `0`

Примеры кода

cURL (Webhook)

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

cURL (OAuth)

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

BX24.callMethod('sale.paysystem.settings.get', {
	'ID': 11,
	'PERSON_TYPE_ID': 1,
}, 
	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.get',
	[
		'ID' => 11,
		'PERSON_TYPE_ID' => 1
	]
);

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

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

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

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 либо указанные при выполнении метода sale.paysystem.settings.update
time `time`	Информация о времени выполнения запроса

result
object

Корневой элемент ответа.

Ключами объекта являются коды параметров, указанные при добавлении обработчика через sale.paysystem.handler.add в параметре CODES.

Значениями объекта являются значения параметров:

либо заполненные пользователем вручную при создании платежной системы
либо указанные при добавлении платежной системы через sale.paysystem.add
либо указанные при выполнении метода sale.paysystem.settings.update

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

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

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

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

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

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