# sale.paysystem.settings.get

URL: https://chugunov.pro/api-bitrix24/pay-system/sale-pay-system-settings-get/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

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

## Описание

Метод возвращает настройки платежной системы. Структура настроек задается при добавлении обработчика платежной системы в методе [sale.paysystem.handler.add](https://chugunov.pro/api-bitrix24/pay-system/sale-pay-system-handler-add/) в ключе `CODES` параметра `SETTINGS`.

## Параметры

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

## Ответ

HTTP-статус: 200

```json
{
    "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](https://chugunov.pro/api-bitrix24/pay-system/sale-pay-system-handler-add/) в параметре `CODES`. 
  Значениями объекта являются значения параметров:
  - либо заполненные пользователем вручную при создании платежной системы
  - либо указанные при добавлении платежной системы через [sale.paysystem.add](https://chugunov.pro/api-bitrix24/pay-system/sale-pay-system-add/)
  - либо указанные при выполнении метода [sale.paysystem.settings.update](https://chugunov.pro/api-bitrix24/pay-system/sale-pay-system-settings-update/)
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "ERROR_CHECK_FAILURE",
    "error_description": "Pay system not found"
}
```

- `ACCESS_DENIED` — Недостаточно прав для чтения настроек. 403
- `ERROR_CHECK_FAILURE` — Не указано значение одного из обязательных полей либо не найдена указанная платежная система (детали смотрите в описании ошибки). 400

## Примеры запроса

### cURL (Webhook)

```bash
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)

```bash
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
```

### JS (TS)

```ts
// 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

// Shape of the payload returned in result (match the "response handling" section of the page)
type PaySystemSettingsResult = Record<string, string>

try {
  const response = await $b24.actions.v2.call.make<PaySystemSettingsResult>({
    method: 'sale.paysystem.settings.get',
    params: {
      ID: 11,
      PERSON_TYPE_ID: 1,
    },
    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('Pay system settings retrieved:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 getPaySystemSettings() {
    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.get',
        params: {
          ID: 11,
          PERSON_TYPE_ID: 1,
        },
        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('Pay system settings retrieved:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getPaySystemSettings)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.sale.paysystem.settings.get(
        sale_paysystem_id=11,
        person_type_id=1,
    ).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}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'sale.paysystem.settings.get',
            [
                'ID'            => 11,
                'PERSON_TYPE_ID' => 1,
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting payment system settings: ' . $e->getMessage();
}
```

### BX24.js

```js
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 CRest

```php
require_once('crest.php');

$result = CRest::call(
    'sale.paysystem.settings.get',
    [
        'ID' => 11,
        'PERSON_TYPE_ID' => 1
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.paysystem.settings.get", b24.Params{
	"ID":             11,
	"PERSON_TYPE_ID": 1,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("sale.paysystem.settings.get: %w", err)
}

var item struct {
	RestServiceIDIframe  string `json:"REST_SERVICE_ID_IFRAME"`
	RestServiceKeyIframe string `json:"REST_SERVICE_KEY_IFRAME"`
	PsWorkModeIframe     string `json:"PS_WORK_MODE_IFRAME"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.RestServiceIDIframe, item.RestServiceKeyIframe)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/pay-system/sale-pay-system-settings-get.html
