Перейти к основному содержимому

Счета

Получение счетов​

Возвращает список счетов организации с текущими балансами. Требует доступ org.accounts.read и scope legal в токене.

Запрос​

Метод: GET URL: https://b2b.selfwork.ru/openapi/v2/organisation/{organisationId}/accounts

Path Parameters​

ПараметрТипОбязательное полеПримерОписание
organisationIdstring (uuid)Да550e8400-e29b-41d4-a716-446655440000ID организации

Пример запроса​

curl -X 'GET' \
"https://b2b.selfwork.ru/openapi/v2/organisation/550e8400-e29b-41d4-a716-446655440000/accounts" \
-H "accept: application/json" \
-H "Authorization: Bearer ВАШ_API_КЛЮЧ"

Пример успешного ответа​

{
"requestId": "97c5678a-8c6a-4688-8452-68ab606fe049",
"result": [
{
"id": "019d0abb-b34b-7fcc-94a7-873f55b527f8",
"name": "Рублевый счет",
"type": "INTERNAL",
"currency": "RUB",
"mainFlag": "Y",
"balance": {
"balance": 21123,
"reserved": 5000,
"updated": "2024-05-22T21:11:28.970Z"
}
}
],
"success": true
}

Описание полей ответа​

ПолеТипОписание
requestIdstringУникальный идентификатор запроса
successbooleanСтатус выполнения запроса (true/false)
resultarrayМассив счетов организации
idstringИдентификатор счёта (строка)
namestringНазвание счёта
typestringТип счёта: INTERNAL, EXTERNAL
currencystringКод валюты счёта (например, RUB)
mainFlagstringФлаг основного счёта (Y / N)
balanceobjectБаланс счёта (см. ниже)

Поля баланса счёта (balance)​

ПолеТипОписание
balancenumberДоступный остаток в копейках: можно направить на выплаты
reservednumberСумма, зарезервированная под операции в обработке, в копейках
updatedstringДата и время последнего изменения остатков (ISO 8601)

Возможные ошибки​

CodeОписание
VALIDATION_ERRORОшибка валидации
FORBIDDEN_ERRORОшибка авторизации
UNKNOWN_ERRORОшибка сервера