Получение статуса электронного реестра на открытие счетов

Песочница

GET https://sandbox.alfabank.ru/api/jp/v1/salary-project/accounts/applications/{applicationId}

Пром

GET https://baas.alfabank.ru/api/jp/v1/salary-project/accounts/applications/{applicationId}

Scope

salary-project

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

HEADERS

Атрибут

Описание

Authorization

stringrequired

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

stringrequired

application/json

PATH

Атрибут

Описание

applicationId

stringrequired

Внешний ID запроса

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

Язык

1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v1/salary-project/accounts/applications/{applicationId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'

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

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

1{
2  "orderType": "OPEN",
3  "applicationId": "7421w6f13a01983593e8dffb71fa6d15",
4  "applicationCreatedAt": "2000-01-23T04:56:07.000+00:00",
5  "registryNumber": "1",
6  "registryCreatedAt": "2000-01-23T04:56:07.000+00:00",
7  "status": "RCVD",
8  "statusDescription": "Получено",
9  "contractNumber": "005V4Z",
10  "organization": {
11    "country": "RU",
12    "inn": "0178827953",
13    "fullname": "Общество с ограниченной ответственностью \"Тест Альфа-Линк ЗУП\""
14  },
15  "rowsCount": 1,
16  "employees": [
17    [
18      {
19        "lastName": "Григорьев",
20        "firstName": "Вениамин",
21        "middleName": "Федосьевич",
22        "account": {
23          "number": "40702810680060657001",
24          "statusDescription": "Получено банком",
25          "status": "RCVD"
26        },
27        "npp": "1"
28      },
29      {
30        "lastName": "Григорьев",
31        "firstName": "Вениамин",
32        "middleName": "Федосьевич",
33        "account": {
34          "number": "40702810680060657001",
35          "statusDescription": "Получено банком",
36          "status": "RCVD"
37        },
38        "npp": "1"
39      }
40    ]
41  ]
42}

BODY

атрибут

описание

orderType

stringrequired

Тип заявки

applicationId

stringrequired

Внешний ID запроса

applicationCreatedAt

stringrequired

Дата создания запроса

registryNumber

stringrequired

Номер реестра

registryCreatedAt

stringrequired

Дата создания реестра

status

stringrequired

Статус сообщения (заявки на открытие ЛС)

statusDescription

stringoptional

Описание статуса сообщения (заявки на открытие ЛС)

contractNumber

stringrequired

Номер договора зарплатного проекта

objectoptional

Информация об организации

fullname

stringrequired

Полное название

country

stringrequired

Страна

inn

stringrequired

ИНН

rowsCount

integeroptional

Количество сотрудников

array of objectsoptional

Массив данных сотрудников

npp

stringrequired

НПП сотрудника (Идентификатор строки заявки на открытие ЛС для одного сотрудника)

lastName

stringrequired

Фамилия

firstName

stringrequired

Имя

middleName

stringoptional

Отчество

objectoptional

Сведения об открытом счёте

number

stringrequired

Открытый лицевой счёт сотрудника

status

stringrequired

Статус открытия ЛС сотрудника

statusDescription

stringoptional

Описание статуса открытия ЛС сотрудника

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

1{
2  "orderType": "OPEN",
3  "applicationId": "7421w6f13a01983593e8dffb71fa6d15",
4  "applicationCreatedAt": "2000-01-23T04:56:07.000+00:00",
5  "registryNumber": "1",
6  "registryCreatedAt": "2000-01-23T04:56:07.000+00:00",
7  "status": "RCVD",
8  "statusDescription": "Получено",
9  "contractNumber": "005V4Z",
10  "organization": {
11    "country": "RU",
12    "inn": "0178827953",
13    "fullname": "Общество с ограниченной ответственностью \"Тест Альфа-Линк ЗУП\""
14  },
15  "rowsCount": 1,
16  "employees": [
17    [
18      {
19        "lastName": "Григорьев",
20        "firstName": "Вениамин",
21        "middleName": "Федосьевич",
22        "account": {
23          "number": "40702810680060657001",
24          "statusDescription": "Получено банком",
25          "status": "RCVD"
26        },
27        "npp": "1"
28      },
29      {
30        "lastName": "Григорьев",
31        "firstName": "Вениамин",
32        "middleName": "Федосьевич",
33        "account": {
34          "number": "40702810680060657001",
35          "statusDescription": "Получено банком",
36          "status": "RCVD"
37        },
38        "npp": "1"
39      }
40    ]
41  ]
42}

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

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}

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