sale.paysystem.settings.update
Обновить настройки платежной системы
Описание
Метод обновляет настройки платежной системы. Структура настроек задается при добавлении обработчика платежной системы в методе sale.paysystem.handler.add в ключе CODES параметра SETTINGS.
Параметры
ID
sale_paysystem.ID
обязательный
Идентификатор платежной системы, для которой нужно получить настройки
PERSON_TYPE_ID
sale_person_type.id
необязательный
Идентификатор типа плательщика, для которого нужно получить настройки
SETTINGS
object
обязательный
Настройки, которые нужно обновить. Ключами выступают названия настроек, значениями — объекты, структура которых описана ниже
Параметр SETTINGS
TYPE
string
необязательный
Источник значения параметра
VALUE
string
необязательный
Код параметра у источника либо значение параметра (для TYPE="VALUE")
Примеры запроса
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 -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
// 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.settings.update',
params: {
ID: 11,
PERSON_TYPE_ID: 1,
SETTINGS: {
REST_SERVICE_KEY_IFRAME: {
TYPE: 'VALUE',
VALUE: 'NEW_KEY',
},
},
},
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('Settings 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 updatePaySystemSettings() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.paysystem.settings.update',
params: {
ID: 11,
PERSON_TYPE_ID: 1,
SETTINGS: {
REST_SERVICE_KEY_IFRAME: {
TYPE: 'VALUE',
VALUE: 'NEW_KEY',
},
},
},
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('Settings updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updatePaySystemSettings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
settings = {
"REST_SERVICE_KEY_IFRAME": {
"TYPE": "VALUE",
"VALUE": "NEW_KEY",
},
}
try:
bitrix_response = client.sale.paysystem.settings.update(
sale_payment_id=11,
person_type_id=1,
settings=settings,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'sale.paysystem.settings.update',
[
'ID' => 11,
'PERSON_TYPE_ID' => 1,
'SETTINGS' => [
'REST_SERVICE_KEY_IFRAME' => [
'TYPE' => 'VALUE',
'VALUE' => 'NEW_KEY',
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating payment system settings: ' . $e->getMessage();
}
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());
}
}
);
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 '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.paysystem.settings.update", b24.Params{
"ID": 11,
"PERSON_TYPE_ID": 1,
"SETTINGS": b24.Params{
"REST_SERVICE_KEY_IFRAME": b24.Params{
"TYPE": "VALUE",
"VALUE": "NEW_KEY",
},
},
})
if err != nil {
return fmt.Errorf("sale.paysystem.settings.update: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
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
{
"error": "ERROR_CHECK_FAILURE",
"error_description": "Pay system not found"
}
| Код | Описание | Значение |
|---|---|---|
ACCESS_DENIED |
Недостаточно прав для чтения настроек | 403 |
ERROR_CHECK_FAILURE |
Не указано значение одного из обязательных полей либо не найдена указанная платежная система (детали смотрите в описании ошибки) | 400 |
ERROR_HANDLER_NOT_FOUND |
Не указано значение поля SETTINGS либо передан пустой объект |
400 |

