B2BH2H

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

Пром GET https://baas.alfabank.ru/api/jp/v1/merchants/{merchantId}

Песочница GET https://sandbox.alfabank.ru/api/jp/v1/merchants/{merchantId}

Scope

sbp_terminals_reg

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

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

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

Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

PATH
Атрибут
Описание
merchantId
stringrequired

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

Пример запроса
curl -X GET https://baas.alfabank.ru/api/jp/v1/merchants/{merchantId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -H 'Content-Type: application/json'

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

Пример ответа 200 (ОК)
{
    "legalId": "LA0000004756",
    "name": "ООО \"ТехноНИКОЛЬ-Строительные Системы\"",
    "type": "ООО",
    "inn": "7706812159",
    "kpp": "770501001",
    "ogrn": "1147746831352",
    "contractNumber": "СБПС2В-20200911",
    "contractDate": "2020-09-11",
    "status": "2",
    "address": {
        "zip": "125362",
        "country": "RU",
        "region": "45",
        "settlementType": "г.",
        "settlement": "Москва",
        "streetType": "ул.",
        "street": "Подмосковная",
        "house": "21"
    },
    "accounts": [
        {
            "memberId": "600000000015",
            "accountNumber": "40201810100000012345",
            "type": "LegalAct",
            "forB2C": "1"
        }
    ],
    "merchants": [
        {
            "merchantId": "MA0000002752",
            "status": "2"
        }
    ]
}
merchantId
stringoptional

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

brandName
stringoptional

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

mcc
stringoptional

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

qrType
stringoptional

Тип QR-кода

status
stringoptional

Код текущего статуса ТСП

objectoptional

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

zip
stringoptional

Индекс

country
stringoptional

Код страны

region
stringoptional

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

settlementType
stringoptional

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

settlement
stringoptional

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

streetType
stringoptional

Тип улицы

street
stringoptional

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

house
stringoptional

Номер дома

array of objectoptional

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

termNo
stringoptional

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

status
stringoptional

Код текущего статуса терминала. Принимает возможные значения: 1 - Открыт; 2 - Закрыт; 3 - Заблокирован

Пример ответа 200 (ОК)
{
    "legalId": "LA0000004756",
    "name": "ООО \"ТехноНИКОЛЬ-Строительные Системы\"",
    "type": "ООО",
    "inn": "7706812159",
    "kpp": "770501001",
    "ogrn": "1147746831352",
    "contractNumber": "СБПС2В-20200911",
    "contractDate": "2020-09-11",
    "status": "2",
    "address": {
        "zip": "125362",
        "country": "RU",
        "region": "45",
        "settlementType": "г.",
        "settlement": "Москва",
        "streetType": "ул.",
        "street": "Подмосковная",
        "house": "21"
    },
    "accounts": [
        {
            "memberId": "600000000015",
            "accountNumber": "40201810100000012345",
            "type": "LegalAct",
            "forB2C": "1"
        }
    ],
    "merchants": [
        {
            "merchantId": "MA0000002752",
            "status": "2"
        }
    ]
}
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

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

error_description
stringoptional

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

Пример ошибки 409 (Conflict)
{
  "error": "conflict",
  "error_description": "Payment with this externalId already exists"
}
Нет тела ответа
error
stringrequired

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

error_description
stringoptional

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

Пример ошибки 500 (Internal Server Error)
{
  "error": "internal_error",
  "error_description": "Internal server error"
}
Нет тела ответа

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