B2B

Создание ссылки для оформления соглашения с Альфа-Банком

Пром POST https://baas.alfabank.ru/api/semp/v1/agreement-pages

Песочница POST https://sandbox.alfabank.ru/api/semp/v1/agreement-pages

Scope

as-operation-with-selfemployed

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

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

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

Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

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

Телефон

activities
stringrequired

Идентификатор вида деятельности

regions
stringrequired

ОКТМО региона ведения деятельности

returnUrl
stringrequired

URL-адрес на который перенаправляется ФЛ после оформления соглашений

Пример запроса
curl -X POST https://baas.alfabank.ru/api/semp/v1/agreement-pages \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token} \
  -H 'Content-Type: application/json' \
  -d '{
    "phone": "79130000011",
    "activities": [
      "17"
    ],
    "regions": [
      "40000000"
    ],
    "returnUrl": "https://alfabank.ru/"
  }'

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

Пример ответа 200 (ОК)
{
  "agreementPageId": "97ae89a6-2813-4d4d-a2a6-4a10adba9e1f",
  "agreementPageLink": "https://alfabank.ru/agreement/97ae89a6-2813-4d4d-a2a6-4a10adba9e1f"
}
agreementPageId
stringoptional

Идентификатор страницы подписания соглашений

agreementPageLink
stringoptional

Ссылка на страницу оформления соглашений

Пример ответа 200 (ОК)
{
  "agreementPageId": "97ae89a6-2813-4d4d-a2a6-4a10adba9e1f",
  "agreementPageLink": "https://alfabank.ru/agreement/97ae89a6-2813-4d4d-a2a6-4a10adba9e1f"
}
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"
}
Нет тела ответа

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