B2BH2H

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

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

escrow

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

application/json

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

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

filterToDate
stringrequired

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

filterStatuses
stringoptional

Статусы заявки на резервирование счёта эскроу. Возможные значения:

  • DRAFT - черновик;
  • VERIFICATION - на обработке;
  • CLIENT_CANCELLED - отменена клиентом;
  • VERIFICATION_ERROR - отклонена банком;
  • SIGNING - на подписи у депонента;
  • WAITING_DDU - ожидает регистрации ДДУ;
  • EXECUTED - исполнена
limit
stringoptional

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

offset
stringoptional

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

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v1/escrow-orders?filterFromDate={filterFromDate}&filterToDate={filterToDate}&filterStatuses={filterStatuses}&limit={limit}&offset={offset}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "pagination": {
3    "limit": 10,
4    "offset": 0,
5    "totalCount": 25
6  },
7  "items": [
8    {
9      "referenceID": "EA10509220000013",
10      "creationDate": "2021-12-10",
11      "status": "VERIFICATION",
12      "fullNameDepositor": "Королёв Митрофан Гертрудович",
13      "buildingPermitNumber": "61-310-998601-2022",
14      "escrowAccount": {
15        "amount": 6000000.12,
16        "currency": "RUR",
17        "accountNumber": "40824810906580000000"
18      }
19    }
20  ]
21}
BODY
атрибут
описание
objectoptional

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

limit
integeroptional

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

offset
integeroptional

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

totalCount
integeroptional

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

array of objectsoptional

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

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 (OK)
1{
2  "pagination": {
3    "limit": 10,
4    "offset": 0,
5    "totalCount": 25
6  },
7  "items": [
8    {
9      "referenceID": "EA10509220000013",
10      "creationDate": "2021-12-10",
11      "status": "VERIFICATION",
12      "fullNameDepositor": "Королёв Митрофан Гертрудович",
13      "buildingPermitNumber": "61-310-998601-2022",
14      "escrowAccount": {
15        "amount": 6000000.12,
16        "currency": "RUR",
17        "accountNumber": "40824810906580000000"
18      }
19    }
20  ]
21}
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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
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 - у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope;
  • 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}
Нет тела ответа

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