B2BH2H

Отправка признака регистрации ДДУ в Росреестр

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

escrow

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

application/json

PATH
Атрибут
Описание
referenceID
stringrequired

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

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

ДДУ

isRegistered
booleanrequired

Признак регистрации ДДУ в Росреестре. Возможные значения:

  • •
    true - ДДУ зарегистрирован в Росреестре;
  • •
    false - ДДУ не зарегистрирован в Росреестре
Пример запроса
Язык 
1curl --location --globoff --request PATCH 'https://baas.alfabank.ru/api/escrow-orders/{referenceID}/execute' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--data '{
5  "equalityAgreement": {
6    "isRegistered": true
7  }
8}'
Параметры ответа
1Нет тела ответа
Нет тела ответа
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}
Нет тела ответа

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

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