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

Песочница

POST https://sandbox.alfabank.ru/api/semp/v1/agreement-pages

Пром

POST https://baas.alfabank.ru/api/semp/v1/agreement-pages

Scope

as-operation-with-selfemployed

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

HEADERS

Атрибут

Описание

Authorization

stringoptional

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

stringoptional

application/json

Content-Type

stringoptional

application/json

BODY

Атрибут

Описание

phone

stringoptional

Телефон

activities

stringoptional

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

regions

stringoptional

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

returnUrl

stringoptional

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

Пример запроса

1curl -X POST https://baas.alfabank.ru/api/semp/v1/agreement-pages \
2  -H 'Accept: application/json' \
3  -H 'Authorization: Bearer {access-token}' \
4  -H 'Content-Type: application/json' \
5  -d '{
6    "phone": "79130000011",
7    "activities": [
8      "17"
9    ],
10    "regions": [
11      "40000000"
12    ],
13    "returnUrl": "https://alfabank.ru/"
14  }'

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

Пример ответа 200 (ОК)

1{
2  "agreementPageId": "97ae89a6-2813-4d4d-a2a6-4a10adba9e1f",
3  "agreementPageLink": "https://alfabank.ru/agreement/97ae89a6-2813-4d4d-a2a6-4a10adba9e1f"
4}

agreementPageId

stringoptional

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

agreementPageLink

stringoptional

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

Пример ответа 200 (ОК)

1{
2  "agreementPageId": "97ae89a6-2813-4d4d-a2a6-4a10adba9e1f",
3  "agreementPageLink": "https://alfabank.ru/agreement/97ae89a6-2813-4d4d-a2a6-4a10adba9e1f"
4}

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}

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}

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}

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}

Нет тела ответа

error

stringrequired

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

error_description

stringoptional

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

Пример ошибки 500 (Internal Server Error)

1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}

Нет тела ответа

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