sale.paysystem.settings.invoice.get
Получить настройки платежной системы для конкретного счета
Описание
Метод возвращает настройки платежной системы для конкретного счета (старая версия).
Параметры
INVOICE_ID
integer
обязательный
Идентификатор счета старой версии. Для получения информации по счетам используется сервис crm.invoice.*
PAY_SYSTEM_ID
sale_paysystem.ID
необязательный
Идентификатор платежной системы
BX_REST_HANDLER
sale_paysystem.ACTION_FILE
необязательный
Символьный идентификатор обработчика платежной системы
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"INVOICE_ID":10,"PAY_SYSTEM_ID":11}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paysystem.settings.invoice.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"INVOICE_ID":10,"PAY_SYSTEM_ID":11,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.paysystem.settings.invoice.get
// 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.invoice.get',
params: {
INVOICE_ID: 10,
PAY_SYSTEM_ID: 11,
},
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:', 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 getInvoicePaySystemSettings() {
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.invoice.get',
params: {
INVOICE_ID: 10,
PAY_SYSTEM_ID: 11,
},
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:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getInvoicePaySystemSettings)
</script>
try {
$response = $b24Service
->core
->call(
'sale.paysystem.settings.invoice.get',
[
'INVOICE_ID' => 10,
'PAY_SYSTEM_ID' => 11,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting invoice settings: ' . $e->getMessage();
}
BX24.callMethod('sale.paysystem.settings.invoice.get', {
"INVOICE_ID": 10,
"PAY_SYSTEM_ID": 11
},
function(result)
{
if(result.error())
{
console.error(result.error());
}
else
{
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.paysystem.settings.invoice.get',
[
'INVOICE_ID' => 10,
'PAY_SYSTEM_ID' => 11
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.paysystem.settings.invoice.get", b24.Params{
"INVOICE_ID": 10,
"PAY_SYSTEM_ID": 11,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.paysystem.settings.invoice.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)
Ответ
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
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_CHECK_FAILURE",
"error_description": "Pay system not found"
}
| Код | Описание | Значение |
|---|---|---|
ACCESS_DENIED |
Недостаточно прав для получения настроек | 403 |
ERROR_CHECK_FAILURE |
Не указано значение одного из обязательных полей либо не найдена платежная система с указанным ID или bx_rest_handler (детали смотрите в описании ошибки) |
400 |
ERROR_INTERNAL_INVOICE_NOT_FOUND |
Не найден указанный счет | 400 |

