Skip to main content
GET
Получить список блокировок баланса

Авторизации

Authorization
string
header
обязательно

Токен доступа, полученный через POST /auth (client_id + client_secret). Действителен в течение 300 секунд.

Заголовки

X-Sub-Account
string

Reference субсчёта, в котором должна выполняться операция. Если заголовок не передан, операция выполняется в основном аккаунте; зарезервированное значение principal также указывает на основной аккаунт и равнозначно отсутствию заголовка. Принимается всеми эндпоинтами, кроме POST /auth и самих эндпоинтов /sub-accounts, которые всегда работают с основным аккаунтом.

Возможные ошибки: 404 SUB_ACCOUNT_NOT_FOUND, 403 SUB_ACCOUNT_FORBIDDEN, 403 SUB_ACCOUNT_SUSPENDED.

Требует, чтобы у учётных данных был включён доступ к субсчетам (Настройки → Интеграция → Учётные данные API). По умолчанию он выключен и не заменяется никаким разрешением, даже FULL_ACCESS: без него ответ — 403 SUB_ACCOUNT_FORBIDDEN.

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
Пример:

"loja-centro"

Параметры запроса

status
enum<string>

Фильтрует блокировки по статусу. Если параметр опущен, возвращаются все блокировки аккаунта.

Доступные опции:
awaiting_response,
defended,
approved,
rejected

Ответ

Список блокировок баланса аккаунта

items
object[]
обязательно

Список блокировок баланса аккаунта

total
integer
обязательно

Общее количество возвращённых блокировок

Пример:

3