Получение данных ТСП в СБП

Песочница

GET https://sandbox.alfabank.ru/api/jp/v1/merchants/{merchantId}

Пром

GET https://baas.alfabank.ru/api/jp/v1/merchants/{merchantId}

Scope

sbp_terminals_reg

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

HEADERS

Атрибут

Описание

Authorization

stringrequired

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

stringrequired

application/json

PATH

Атрибут

Описание

merchantId

stringrequired

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

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

Язык

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

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

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

1{
2  "merchantId": "MA0000002752",
3  "brandName": "Технониколь",
4  "mcc": "4816",
5  "qrType": "static",
6  "status": "2",
7  "address": {
8    "zip": "125362",
9    "country": "RU",
10    "region": "45",
11    "settlementType": "г.",
12    "settlement": "Москва",
13    "streetType": "ул.",
14    "street": "Подмосковная",
15    "house": "21"
16  },
17  "terminals": [
18    {
19      "termNo": "9008056701",
20      "status": "1"
21    }
22  ]
23}

BODY

атрибут

описание

merchantId

stringoptional

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

brandName

stringoptional

Название магазина

mcc

stringoptional

MCC-код магазина

qrType

stringoptional

Тип QR-кода

status

stringoptional

Код текущего статуса ТСП. Принимает возможные значения:

•

1 - новый;
•

2 - зарегистрирован;
•

3 - на удаление

objectoptional

Информация о фактическом адресе

zip

stringoptional

Индекс

country

stringoptional

Код страны

region

stringoptional

Код региона по ОКТМО (первые два символа)

settlementType

stringoptional

Тип населённого пункта

settlement

stringoptional

Наименование населённого пункта

streetType

stringoptional

Тип улицы

street

stringoptional

Наименование улицы

house

stringoptional

Номер дома

array of objectsoptional

Данные о терминалах

termNo

stringoptional

Номер терминала

status

stringoptional

Код текущего статуса терминала. Принимает возможные значения:

•

1 - открыт;
•

2 - закрыт;
•

3 - заблокирован

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

1{
2  "merchantId": "MA0000002752",
3  "brandName": "Технониколь",
4  "mcc": "4816",
5  "qrType": "static",
6  "status": "2",
7  "address": {
8    "zip": "125362",
9    "country": "RU",
10    "region": "45",
11    "settlementType": "г.",
12    "settlement": "Москва",
13    "streetType": "ул.",
14    "street": "Подмосковная",
15    "house": "21"
16  },
17  "terminals": [
18    {
19      "termNo": "9008056701",
20      "status": "1"
21    }
22  ]
23}

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;
•

forbidden - у пользователя нет доступа на получение информации о запрашиваемом торгово-сервисном предприятии (ТСП)

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}

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