B2BH2H

Добавление терминала к ТСП

Пром POST https://baas.alfabank.ru/api/jp/v1/terminals

Песочница POST https://sandbox.alfabank.ru/api/jp/v1/terminals

Scope

sbp_terminals_reg

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

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

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

Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

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

Регистрационный номер ЮЛ в СБП

merchantId
stringrequired

Регистрационный номер магазина в СБП

accountNumber
stringrequired

Номер счета в Банке-участнике СБП

status
stringoptional

Статус терминала. Возможные значения: Open - Открыт; Close - Закрыт; Block - Заблокирован

Пример запроса
curl -X POST https://baas.alfabank.ru/api/jp/v1/terminals \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "legalId": "LA0000004756",
    "merchantId": "MA0000002752",
    "accountNumber": "40201810100000012345",
    "status": "Open"
  }'

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

Пример ответа 200 (ОК)
{
    "termNo": "9008056701",
    "status": "Executed"
}
termNo
stringoptional

Идентификатор терминала

status
stringrequired

Статус обработки запроса. Принимает возможные значения: Rejected - Отказ в обработке; Postponed - Отложен; Accepted - Принят к обработке; Executed - Исполнен

Пример ответа 200 (ОК)
{
    "termNo": "9008056701",
    "status": "Executed"
}
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"
}
Нет тела ответа

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