B2BH2H

Получение объектов и этапов строительства для отчёта по счетам эскроу

Песочница
GET https://sandbox.alfabank.ru/api/jp/v1/escrow-reports/developers/build-projects
Пром
GET https://baas.alfabank.ru/api/jp/v1/escrow-reports/developers/build-projects
Scope

escrow-reports

Описание

Метод возвращает список объектов и этапов строительства застройщика, на основе которых можно сформировать отчёт по счетам эскроу.

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

application/json

Пример запроса
Язык
1curl --location 'https://baas.alfabank.ru/api/jp/v1/escrow-reports/developers/build-projects' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "organizationName": "ООО Застройщик №1",
3  "organizationFullName": "ООО Застройщик №1",
4  "buildProjects": [
5    {
6      "buildPermitNumber": "№599-35-92-2024",
7      "projectNumber": "503-302",
8      "commercialName": "ЖК Ромашка",
9      "actualProjectCompletionDate": "2024-02-10T00:00:00.000Z",
10      "phases": [
11        {
12          "index": 1,
13          "name": "Дом",
14          "termEscrowOrder": "2024-02-10T00:00:00.000Z"
15        }
16      ]
17    }
18  ]
19}
BODY
атрибут
описание
organizationName
stringoptional

Наименование застройщика

organizationFullName
stringoptional

Полное наименование застройщика

array of objectsoptional

Информация об объектах строительства

buildPermitNumber
stringoptional

Номер РНС (разрешение на строительство)

projectNumber
stringoptional

Номер проекта строительства

commercialName
stringoptional

Коммерческое обозначение объекта

actualProjectCompletionDate
stringoptional

Дата РНС

array of objectsoptional

Этапы строительства

index
integeroptional

Порядковый номер этапа строительства в пределах проекта

name
stringoptional

Краткое имя этапа строительства

termEscrowOrder
stringoptional

Срок учёта и блокирования депонированной суммы на счёте эскроу по ДДУ

Пример ответа 200 (OK)
1{
2  "organizationName": "ООО Застройщик №1",
3  "organizationFullName": "ООО Застройщик №1",
4  "buildProjects": [
5    {
6      "buildPermitNumber": "№599-35-92-2024",
7      "projectNumber": "503-302",
8      "commercialName": "ЖК Ромашка",
9      "actualProjectCompletionDate": "2024-02-10T00:00:00.000Z",
10      "phases": [
11        {
12          "index": 1,
13          "name": "Дом",
14          "termEscrowOrder": "2024-02-10T00:00:00.000Z"
15        }
16      ]
17    }
18  ]
19}
BODY
атрибут
описание
error
stringrequired

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

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

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

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

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

  • •
    invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_token. При отзыве токена необходимо заново пройти авторизацию
error_description
stringoptional

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

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

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

  • •
    insufficient_scope - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent;
  • •
    access_denied - доступ к счёту запрещён
error_description
stringoptional

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

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

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

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

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

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

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

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

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

Пример ошибки 500 (Internal Server Error)
1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}
Нет тела ответа

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.