Песочница
POST https://sandbox.alfabank.ru/api/jp/v1/terminals
Пром
POST https://baas.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
stringrequired
Регистрационный номер ЮЛ в СБП
merchantId
stringrequired
Регистрационный номер ТСП в СБП
accountNumber
stringrequired
Номер счёта в Банке-участнике СБП
status
stringoptional
Статус терминала. Возможные значения:
-
•
Open- открыт, доступен для выполнения операций; -
•
Close- закрыт, выполнение операций невозможно; -
•
Block- заблокирован, выполнение операций невозможно
Пример запроса
Язык
1curl --location 'https://baas.alfabank.ru/api/jp/v1/terminals' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6 "legalId": "LA0000004756",
7 "merchantId": "MA0000002752",
8 "accountNumber": "40201810100000012345",
9 "status": "Open"
10}'Параметры ответа
Пример ответа 200 (OK)
1{
2 "termNo": "9008056701",
3 "status": "Executed"
4}
BODY
атрибут
описание
termNo
stringoptional
Номер терминала
status
stringrequired
Статус обработки запроса:
-
•
Rejected- отказ в обработке; -
•
Postponed- отложен; -
•
Accepted- принят к обработке; -
•
Executed- исполнен
Пример ответа 200 (OK)
1{
2 "termNo": "9008056701",
3 "status": "Executed"
4}
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}
Нет тела ответа