B2BH2H

Получение списка заявок на резервирование счета эскроу

Пром GET https://baas.alfabank.ru/api/jp/v1/escrow-orders

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

Scope

escrow

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

HEADERS
Атрибут
Описание
Authorization
stringrequired

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

Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

QUERY
Атрибут
Описание
filterFromDate
stringrequired

Дата начала периода создания заявки

filterToDate
stringrequired

Дата окончания периода создания заявки

filterStatuses
stringoptional

Статусы заявки на резервирование счета эскроу. Возможные значения: DRAFT - Черновик; VERIFICATION - На обработке; CLIENT_CANCELLED - Отменена клиентом; VERIFICATION_ERROR - Отклонена банком; SIGNING - На подписи у депонента; WAITING_DDU - Ожидает регистрации ДДУ; EXECUTED - Исполнена

limit
stringoptional

Количество объектов на одной странице

offset
stringoptional

Количество объектов в списке, которые необходимо пропустить

Пример запроса
curl -X GET https://baas.alfabank.ru/api/jp/v1/escrow-orders \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token} \
  -H 'Content-Type: application/json'

Параметры ответа

Пример ответа 200 (ОК)
{
  "pagination": {
    "limit": 10,
    "offset": 0,
    "totalCount": 25
  },
  "items": [
    {
      "referenceID": "EA10509220000013",
      "creationDate": "2021-12-10",
      "status": "VERIFICATION",
      "fullNameDepositor": "Королёв Митрофан Гертрудович",
      "buildingPermitNumber": "61-310-998601-2022",
      "escrowAccount": {
        "amount": 6000000.12,
        "currency": "RUR",
        "accountNumber": 40702810701300000000
      }
    }
  ]
}
objectoptional

Информация о пагинации

limit
integeroptional

Количество объектов на одной странице

offset
integeroptional

Количество объектов в списке, которые необходимо пропустить

totalCount
integeroptional

Общее количество записей

ARRAY OF OBJECToptional

Заявки на резервирование счета эскроу

referenceID
stringrequired

Номер заявки на резервирование счета эскроу

creationDate
stringrequired

Дата создания заявки

status
stringrequired

Статусы заявки на резервирование счета эскроу. Принимает возможные значения: DRAFT - Черновик; VERIFICATION - На обработке; CLIENT_CANCELLED - Отменена клиентом; VERIFICATION_ERROR - Отклонена банком; SIGNING - На подписи у депонента; WAITING_DDU - Ожидает регистрации ДДУ; EXECUTED - Исполнена

fullNameDepositor
stringrequired

ФИО депонента

buildingPermitNumber
stringrequired

Номер РНС

objectrequired

Счет эскроу

amount
numberrequired

Депонируемая сумма

currency
stringrequired

Валюта. Принимает возможные значения: RUR - Рублевая валюта

accountNumber
stringrequired

Номер счета эскроу

Пример ответа 200 (ОК)
{
  "pagination": {
    "limit": 10,
    "offset": 0,
    "totalCount": 25
  },
  "items": [
    {
      "referenceID": "EA10509220000013",
      "creationDate": "2021-12-10",
      "status": "VERIFICATION",
      "fullNameDepositor": "Королёв Митрофан Гертрудович",
      "buildingPermitNumber": "61-310-998601-2022",
      "escrowAccount": {
        "amount": 6000000.12,
        "currency": "RUR",
        "accountNumber": 40702810701300000000
      }
    }
  ]
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса

error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
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"
}
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"
}
error
stringrequired

Код ошибки. Принимает возможные значения: unknown_endpoint - Эндпоинт не найден или неактивен

error_description
stringoptional

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

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

Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

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

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

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