B2BH2H

Получение профиля организации

Пром GET https://baas.alfabank.ru/api/v1/customer-info

Песочница GET https://sandbox.alfabank.ru/api/v1/customer-info

Scope

customer

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired

Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H

Accept
stringrequired

application/json

Пример запроса
Язык
curl --location --request GET 'https://baas.alfabank.ru/api/v1/customer-info' \
--header 'Authorization: Bearer {access-token}' \
--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
{
  "organizationId": "bca96ae8b26184217fcf75f51347bd7bd5031ea6605c434c49f85378e9509732",
  "fullName": "Общество с ограниченной ответственностью \"Ромашка\"",
  "shortName": "ООО \"Ромашка\"",
  "inn": "114693784",
  "organizationForm": {
    "fullName": "Общество с ограниченной ответственностью",
    "shortName": "ООО",
    "type": "2014",
    "code": "12300"
  },
  "kpps": [
    "2427920",
    "2427920"
  ],
  "ogrn": "1020203094163",
  "okpo": "41294456",
  "okved": "71.12",
  "type": "LEGAL",
  "phone": "79099876543",
  "email": "client@example.com",
  "category": "BANK",
  "status": "ACTIVE",
  "registrationDate": "2000-01-23T04:56:07.000Z",
  "address": {
    "area": "Тахтамукайский район",
    "building": "1",
    "city": "Майкоп",
    "country": "643",
    "flat": "123",
    "fullAddress": "Республика Адыгея, г. Майкоп, улица Депутатская, д. 3",
    "house": "3",
    "region": "Республика Адыгея",
    "settlement": "Майкоп",
    "settlementType": "г.",
    "street": "улица Депутатская",
    "zip": "385600",
    "fiasCode": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "accounts": [
    {
      "number": "40702810002300001935",
      "type": "PAYMENT",
      "typeName": "Расчётный счёт",
      "openDate": "2021-10-07T00:00:00.000Z",
      "currencyCode": "810",
      "transitAccountNumber": "40702978904100000001",
      "specConditions": [
        {
          "code": "AI12",
          "description": "Нельзя дебетовать",
          "value": false
        },
        {
          "code": "AI11",
          "description": "Нельзя кредитовать",
          "value": false
        },
        {
          "code": "AI14",
          "description": "Клиент закрыт",
          "value": false
        },
        {
          "code": "AI17",
          "description": "Счёт заблокирован",
          "value": true
        },
        {
          "code": "AI20",
          "description": "Неактивный счёт",
          "value": false
        },
        {
          "code": "AI30",
          "description": "Счёт закрыт",
          "value": false
        },
        {
          "code": "AI47",
          "description": "Внутренний счёт",
          "value": false
        },
        {
          "code": "AI82",
          "description": "Дебетование ограничено",
          "value": false
        },
        {
          "code": "AI83",
          "description": "Электронная картотека",
          "value": false
        },
        {
          "code": "AI87",
          "description": "Бумажная разновалютная картотека",
          "value": false
        }
      ],
      "clientName": "Наименование",
      "amountBalance": 810000,
      "amountTotal": 100000,
      "amountHolds": 100,
      "amountOverdraftOwnFunds": 0.8008281904610115,
      "amountOverdraftLimit": 100000,
      "blockedSums": [
        {
          "num": "112233",
          "beginDate": "2020-10-23T00:00:00.000Z",
          "cause": "Неисполнение требования об уплате налога, сбора, пени, штрафа № 53228 от 05.11.2019 г",
          "initiator": "Межрайонная ИФНС России № 51 по г. Москве",
          "sum": "988800",
          "blockType": "PARTIAL_BALANCE_BLOCK"
        }
      ],
      "bank": {
        "bic": 44525593
      }
    }
  ]
}
HEADERS
Атрибут
Описание
x-traceid
stringoptional

Идентификатор трассировки запроса

BODY
атрибут
описание
organizationId
stringrequired

Идентификатор организации

fullName
stringrequired

Полное наименование организации

shortName
stringrequired

Сокращённое наименование организации

inn
stringrequired

ИНН

objectrequired

Организационно-правовая форма

fullName
stringrequired

Организационно-правовая форма организации клиента

shortName
stringrequired

Краткое наименование ОПФ

type
stringrequired

Тип ОПФ

code
stringrequired

Код ОПФ

kpps
array of stringsrequired

Список КПП организации

ogrn
stringrequired

ОГРН

okpo
stringrequired

ОКПО

okved
stringrequired

ОКВЭД

type
stringrequired

Тип организации. Принимает возможные значения:

  • •
    LEGAL - ЮЛ;
  • •
    INDIVIDUAL - ИП
phone
stringrequired

Контактный телефон клиента

email
stringrequired

Электронная почта клиента

category
stringrequired

Категория организации. Принимает возможные значения:

  • •
    BANK - банк;
  • •
    FINANCIAL - финансовая;
  • •
    OTHER - другая
status
stringrequired

Статус организации. Принимает возможные значения:

  • •
    ACTIVE — действующая;
  • •
    LIQUIDATING — ликвидируется;
  • •
    LIQUIDATED — ликвидирована
registrationDate
stringrequired

Дата регистрации организации

objectoptional

Адрес клиента

area
stringoptional

Район

building
stringoptional

Строение, корпус

city
stringoptional

Город

country
stringoptional

Числовой код страны

flat
stringoptional

Квартира

fullAddress
stringoptional

Адрес

house
stringoptional

Дом

region
stringoptional

Полное наименование региона

settlement
stringoptional

Населенный пункт

settlementType
stringoptional

Тип населенного пункта

street
stringoptional

Улица

zip
stringoptional

Индекс

fiasCode
stringoptional

Код ФИАС

array of objectsoptional

Расчетные счета

number
stringoptional

Номер счета

type
stringoptional

Тип счёта

typeName
stringoptional

Наименование типа счёта

openDate
stringoptional

Дата открытия счёта

currencyCode
stringoptional

Цифровой код валюты

transitAccountNumber
stringoptional

Парный транзитный счет

array of objectsoptional

Спецусловия по счету

code
stringoptional

Код спецусловия. Принимает возможные значения:

  • •
    AI12 - Нельзя дебетовать;
  • •
    AI11 - Нельзя кредитовать;
  • •
    AI14 - Клиент закрыт;
  • •
    AI17 - Счёт заблокирован;
  • •
    AI20 - Неактивный счёт;
  • •
    AI30 - Счёт закрыт;
  • •
    AI47 - Внутренний счёт;
  • •
    AI82 - Дебетование ограничено;
  • •
    AI83 - Электронная картотека;
  • •
    AI87 - Бумажная разновалютная картотека
description
stringoptional

Описание спецусловия

value
booleanoptional

Текущее значение. Принимает возможные значения:

  • •
    true - выполняется условие, прописанное в code;
  • •
    false - не выполняется условие, прописанное в code
clientName
stringoptional

Клиентское наименование счёта

amountBalance
numberoptional

Текущий остаток по счёту

amountTotal
numberoptional

Сумма доступных средств (без учёта овердрафта)

amountHolds
numberoptional

Сумма зарезервированных средств (холды)

amountOverdraftOwnFunds
numberoptional

Собственные средства

amountOverdraftLimit
numberoptional

Доступный лимит средств

array of objectsoptional

Заблокированные (арестованные) суммы на счёте

num
stringoptional

Номер решения

beginDate
stringoptional

Дата начала действия ограничения

cause
stringoptional

Основание ареста

initiator
stringoptional

Наименование органа, наложившего арест

sum
stringoptional

Заблокированная (арестованная) сумма на счёте

blockType
stringoptional

Бухгалтерский режим, к которому относится данное решение. Принимает возможные значения:

  • •
    OUTGOING_LIMITATION - Полная блокировка;
  • •
    PARTIAL_BALANCE_BLOCK - Блокировка части баланса
objectoptional

Информация о банке, где выпущен счет

bic
stringoptional

БИК банка, где открыт счет

Пример ответа 200 (OK)
{
  "organizationId": "bca96ae8b26184217fcf75f51347bd7bd5031ea6605c434c49f85378e9509732",
  "fullName": "Общество с ограниченной ответственностью \"Ромашка\"",
  "shortName": "ООО \"Ромашка\"",
  "inn": "114693784",
  "organizationForm": {
    "fullName": "Общество с ограниченной ответственностью",
    "shortName": "ООО",
    "type": "2014",
    "code": "12300"
  },
  "kpps": [
    "2427920",
    "2427920"
  ],
  "ogrn": "1020203094163",
  "okpo": "41294456",
  "okved": "71.12",
  "type": "LEGAL",
  "phone": "79099876543",
  "email": "client@example.com",
  "category": "BANK",
  "status": "ACTIVE",
  "registrationDate": "2000-01-23T04:56:07.000Z",
  "address": {
    "area": "Тахтамукайский район",
    "building": "1",
    "city": "Майкоп",
    "country": "643",
    "flat": "123",
    "fullAddress": "Республика Адыгея, г. Майкоп, улица Депутатская, д. 3",
    "house": "3",
    "region": "Республика Адыгея",
    "settlement": "Майкоп",
    "settlementType": "г.",
    "street": "улица Депутатская",
    "zip": "385600",
    "fiasCode": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  },
  "accounts": [
    {
      "number": "40702810002300001935",
      "type": "PAYMENT",
      "typeName": "Расчётный счёт",
      "openDate": "2021-10-07T00:00:00.000Z",
      "currencyCode": "810",
      "transitAccountNumber": "40702978904100000001",
      "specConditions": [
        {
          "code": "AI12",
          "description": "Нельзя дебетовать",
          "value": false
        },
        {
          "code": "AI11",
          "description": "Нельзя кредитовать",
          "value": false
        },
        {
          "code": "AI14",
          "description": "Клиент закрыт",
          "value": false
        },
        {
          "code": "AI17",
          "description": "Счёт заблокирован",
          "value": true
        },
        {
          "code": "AI20",
          "description": "Неактивный счёт",
          "value": false
        },
        {
          "code": "AI30",
          "description": "Счёт закрыт",
          "value": false
        },
        {
          "code": "AI47",
          "description": "Внутренний счёт",
          "value": false
        },
        {
          "code": "AI82",
          "description": "Дебетование ограничено",
          "value": false
        },
        {
          "code": "AI83",
          "description": "Электронная картотека",
          "value": false
        },
        {
          "code": "AI87",
          "description": "Бумажная разновалютная картотека",
          "value": false
        }
      ],
      "clientName": "Наименование",
      "amountBalance": 810000,
      "amountTotal": 100000,
      "amountHolds": 100,
      "amountOverdraftOwnFunds": 0.8008281904610115,
      "amountOverdraftLimit": 100000,
      "blockedSums": [
        {
          "num": "112233",
          "beginDate": "2020-10-23T00:00:00.000Z",
          "cause": "Неисполнение требования об уплате налога, сбора, пени, штрафа № 53228 от 05.11.2019 г",
          "initiator": "Межрайонная ИФНС России № 51 по г. Москве",
          "sum": "988800",
          "blockType": "PARTIAL_BALANCE_BLOCK"
        }
      ],
      "bank": {
        "bic": 44525593
      }
    }
  ]
}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_request - Неверные входные параметры запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope
  • •
    access_denied - Доступ к счету запрещен
error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    unknown_endpoint - Эндпоинт не найден или неактивен
error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)
{
  "error": "unknown_endpoint",
  "error_description": "Endpoint is not found or not active"
}
BODY
атрибут
описание
Нет тела ответа
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
{
  "error": "internal_error",
  "error_description": "Internal server error"
}
BODY
атрибут
описание
Нет тела ответа
Создание заявки на резервирование счета эскроу c расширенными параметрамиПолучение профиля организации