B2BH2H

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

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

escrow

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

application/json

Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
objectrequired

Данные депонента

lastName
stringrequired

Фамилия депонента

firstName
stringrequired

Имя депонента

middleName
stringoptional

Отчество депонента

birthdate
stringrequired

Дата рождения депонента

identityDocumentType
stringrequired

Тип ДУЛа. Возможные значения:

  • 001 - паспорт гражданина РФ;
  • 002 - загранпаспорт гражданина РФ
identityDocumentSeries
stringrequired

Серия ДУЛ депонента

dateIssuedId
stringrequired

Дата выдачи ДУЛ депонента

phoneNumber
stringrequired

Мобильный телефон депонента

objectrequired

Счёт эскроу

amount
floatrequired

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

currency
stringrequired

Валюта. Возможные значения:

  • RUR - рублёвая валюта
objectrequired

Объект строительства

type
stringrequired

Тип объекта недвижимости. Возможные значения:

  • FLAT - квартира;
  • PARKING - машиноместо;
  • PANTRY - кладовая;
  • NON_RESIDENTIAL_PREMISES - нежилое помещение;
  • GARAGE - гараж;
  • COMMERCIAL_PREMISES - коммерческое помещение;
  • APARTMENTS - апартаменты;
  • ROOM - комната;
  • RESIDENTIAL-PREMISES - жилой дом
flat
stringrequired

Номер квартиры объекта строительства

objectrequired

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

buildingPermitNumber
stringrequired

Номер РНС объекта строительства из метода Получение списка объектов строительства застройщика

objectrequired

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

index
integerrequired

Порядковый номер этапа в пределах объекта строительства из метода Получение списка объектов строительства застройщика

objectrequired

ДДУ

number
stringrequired

Номер ДДУ

date
stringrequired

Дата подписания ДДУ

Пример запроса
Язык
1curl --location 'https://baas.alfabank.ru/api/escrow-orders' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "depositor": {
7    "lastName": "Федькин",
8    "firstName": "Ратибор",
9    "middleName": "Васильевич",
10    "birthdate": "1990-08-30",
11    "identityDocumentType": "001",
12    "identityDocumentSeries": "5516",
13    "dateIssuedId": "2020-01-01",
14    "phoneNumber": "75453333435"
15  },
16  "escrowAccount": {
17    "amount": 112500,
18    "currency": "RUR"
19  },
20  "estateObject": {
21    "type": "APARTMENTS",
22    "flat": 1,
23    "buildProject": {
24      "buildingPermitNumber": "61-310-998601-2022",
25      "phases": {
26        "index": 1
27      }
28    }
29  },
30  "equalityAgreement": {
31    "number": "5555",
32    "date": "2020-01-01"
33  }
34}'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "referenceID": "EA10509220000013"
3}
BODY
атрибут
описание
referenceID
stringrequired

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

Пример ответа 200 (OK)
1{
2  "referenceID": "EA10509220000013"
3}
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

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

  • conflict - не удалось идентифицировать депонента. Необходимо отправить сканы документов в банк
error_description
stringoptional

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

Пример ошибки 409 (Conflict)
1{
2  "error": "conflict",
3  "error_description": "The data of the depositor is not uniquely defined"
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}
Нет тела ответа

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