Запросы API v1.0.0

Store API v1.0.0

Документация перемещена

Информация на этой странице не обновляется и может быть устаревшей. Наиболее полная и актуальная версия документации для разработчиков доступна по новому адресу:

https://developers.koshelek.app

Регистрация Store

HTTP-метод: POST

URL: /api/v1/configuration/brand/store

Описание

Партнёр использует этот запрос для регистрации магазина (одного или нескольких) в сервисе Кошелёк Pay.

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

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

Тело запроса передаётся в виде объекта JSON следующей структуры:

Поле Тип Обязательно Значение

Поле	Тип	Обязательно	Значение
`brandId`	String	Да	Идентификатор бренда ТСП (UUID).
`stores`	Array[Object]	Да	Массив, содержащий информацию о регистрируемых магазинах (см. ниже: Массив `stores`).

brandId

String

Да

Идентификатор бренда ТСП (UUID).

stores

Array[Object]

Да

Массив, содержащий информацию о регистрируемых магазинах (см. ниже: Массив stores).

Массив `stores`

Массив содержит информацию о регистрируемых магазинах, где каждый магазин представлен в виде объекта следующей структуры:

Поле Тип Обязательно Значение

Поле	Тип	Обязательно	Значение
`storeNumber`	String	Да	Идентификатор магазина, присвоенный ТСП (UUID).
`legalId`	String	Да	Внутренний идентификатор юридического лица ТСП в сервисе Кошелёк Pay (UUID).
`city`	String	Да	Город фактического адреса ТСП.
`address`	String	Да	Фактический адрес ТСП.
`phone`	String	Да	Контактный номер телефона ТСП.
`countryCode`	String	Нет	Код страны регистрации ТСП (ISO 3166 Alpha-2).
`countrySubDivisionCode`	String	Нет	Код региона регистрации ТСП (ISO 3166-2:RU).
`mcc`	String	Нет	Код MCC (Merchant Category Code).
`zip`	String	Да	Индекс.
`paymentMethods`	Array[Enum]	Нет	Метод оплаты через Koshelek Pay, доступный в магазине. Доступные значения: `SBP` `DOLYAME` Если не заполнено: значение наследуется для данного магазина от общих настроек бренда.
`sbpMerchantId`	String	Нет	Идентификатор магазина в СБП.
`status`	Enum	Нет	Статус магазина. Доступные значения: `ACTIVE` (значение по умолчанию); `INACTIVE`.

storeNumber

String

Да

Идентификатор магазина, присвоенный ТСП (UUID).

legalId

String

Да

Внутренний идентификатор юридического лица ТСП в сервисе Кошелёк Pay (UUID).

city

String

Да

Город фактического адреса ТСП.

address

String

Да

Фактический адрес ТСП.

phone

String

Да

Контактный номер телефона ТСП.

countryCode

String

Нет

Код страны регистрации ТСП (ISO 3166 Alpha-2).

countrySubDivisionCode

String

Нет

Код региона регистрации ТСП (ISO 3166-2:RU).

mcc

String

Нет

Код MCC (Merchant Category Code).

zip

String

Да

Индекс.

paymentMethods

Array[Enum]

Нет

Метод оплаты через Koshelek Pay, доступный в магазине. Доступные значения:

SBP
DOLYAME

Если не заполнено: значение наследуется для данного магазина от общих настроек бренда.

sbpMerchantId

String

Нет

Идентификатор магазина в СБП.

status

Enum

Нет

Статус магазина. Доступные значения:

ACTIVE (значение по умолчанию);
INACTIVE.

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

{
  "brandId": "1a01ab77-2d71-4dc5-8148-1580be9a44c3",
  "stores": [
    {
      "storeNumber": "777",
      "legalId": "2f00d067-3d92-48cb-8973-cee7821035da",
      "city": "Москва",
      "address": "Лермонтова 38",
      "phone": "995598928",
      "countryCode": "RU",
      "countrySubDivisionCode": "RU-MOW",
      "mcc": "5661",
      "zip": "125212",
      "paymentMethods": [
        "DOLYAME"
      ]
    },
    {
      "storeNumber": "666",
      "legalId": "2f00d067-3d92-48cb-8973-cee7821035da",
      "city": "Санкт-Петербург",
      "address": "Лермонтова 38",
      "phone": "995598928",
      "countryCode": "RU",
      "countrySubDivisionCode": "RU-SPE",
      "mcc": "5661",
      "zip": "125212",
      "paymentMethods": [
        "SBP"
      ],
      "sbpMerchantId": "MA0000421504"
    }
  ]
}

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

HTTP Status Code: 200

Запрос выполнен успешно. Тело ответа содержит данные, полученные в запросе, а также параметры с результатами регистрации (storeId, result) — в виде объекта JSON следующей структуры:

Поле Тип Обязательно Значение

Поле	Тип	Обязательно	Значение
`brandId`	String	Да	Идентификатор бренда ТСП (UUID).
`stores`	Array[Object]	Да	Массив, содержащий информацию о регистрации магазинов (см. ниже: Массив `stores`).
`result`	Object	Да	Объект, содержащий результаты обработки запроса (см. Объект `result`).

brandId

String

Да

Идентификатор бренда ТСП (UUID).

stores

Array[Object]

Да

Массив, содержащий информацию о регистрации магазинов (см. ниже: Массив stores).

result

Object

Да

Объект, содержащий результаты обработки запроса (см. Объект result).

Массив `stores`

Массив содержит данные, полученные в запросе, а также параметр storeId, присвоенный Кошельком.

Поле Тип Обязательно Значение

Поле	Тип	Обязательно	Значение
`storeNumber`	String	Да	Идентификатор магазина, присвоенный ТСП (UUID).
`legalId`	String	Да	Внутренний идентификатор юридического лица ТСП в сервисе Кошелёк Pay (UUID).
`storeId`	String	Да	Идентификатор ТСП, присвоенный Кошельком.
`city`	String	Да	Город фактического адреса ТСП.
`address`	String	Да	Фактический адрес ТСП.
`phone`	String	Да	Контактный номер телефона ТСП.
`countryCode`	String	Да, если было получено в запросе	Код страны регистрации ТСП (ISO 3166 Alpha-2).
`countrySubDivisionCode`	String	Да, если было получено в запросе	Код региона регистрации ТСП (ISO 3166-2:RU).
`mcc`	String	Да, если было получено в запросе	Код MCC (Merchant Category Code).
`zip`	String	Да	Индекс.
`paymentMethods`	Array[Enum]	Да, если было получено в запросе	Метод оплаты через Koshelek Pay, доступный в магазине. Доступные значения: `SBP` `DOLYAME`
`sbpMerchantId`	String	Да, если было получено в запросе	Идентификатор магазина в СБП.

storeNumber

String

Да

Идентификатор магазина, присвоенный ТСП (UUID).

legalId

String

Да

Внутренний идентификатор юридического лица ТСП в сервисе Кошелёк Pay (UUID).

storeId

String

Да

Идентификатор ТСП, присвоенный Кошельком.

city

String

Да

Город фактического адреса ТСП.

address

String

Да

Фактический адрес ТСП.

phone

String

Да

Контактный номер телефона ТСП.

countryCode

String

Да, если было получено в запросе

Код страны регистрации ТСП (ISO 3166 Alpha-2).

countrySubDivisionCode

String

Да, если было получено в запросе

Код региона регистрации ТСП (ISO 3166-2:RU).

mcc

String

Да, если было получено в запросе

Код MCC (Merchant Category Code).

zip

String

Да

Индекс.

paymentMethods

Array[Enum]

Да, если было получено в запросе

Метод оплаты через Koshelek Pay, доступный в магазине. Доступные значения:

SBP
DOLYAME

sbpMerchantId

String

Да, если было получено в запросе

Идентификатор магазина в СБП.

Пример тела ответа

{
  "brandId": "1a01ab77-2d71-4dc5-8148-1580be9a44c3",
  "stores": [
    {
      "store": {
        "storeId": "c3257989-2f57-48e5-9e20-94732ed6c4de",
        "storeNumber": "777",
        "legalId": "2f00d067-3d92-48cb-8973-cee7821035da",
        "city": "Батумск",
        "address": "Лермонтова 38",
        "phone": "995598928",
        "countryCode": "RU",
        "countrySubDivisionCode": "77",
        "mcc": "5661",
        "zip": "125212",
        "status": "ACTIVE",
        "paymentMethods": [
          "DOLYAME"
        ]
      },
      "result": {
        "storeId": "c3257989-2f57-48e5-9e20-94732ed6c4de",
        "status": "ACTIVE",
        "codes": [
          {
            "code": "000",
            "details": "Запрос выполнен успешно"
          }
        ]
      }
    },
    {
      "store": null,
      "result": {
        "storeId": null,
        "status": "ERROR",
        "codes": [
          {
            "code": "003",
            "details": "ЮЛ/ИП с таким legalId не существует "
          }
        ]
      }
    }
  ]
}

Получение данных о Store

HTTP-метод: GET

URL: /api/v1/configuration/brand/store

Описание

Используя этот метод, партнёр может запросить данные ранее зарегистрированного магазина (или нескольких магазинов).

Запрос данных о магазине доступен только идентификаторам, ассоциированным с данным brandId.

Результатом выполнения операции будет являться:

информация о магазине (или описание, почему ее нет);
в случае ошибки — код ошибки и описание.

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

Query-параметры запроса

Параметр Тип Обязательно Значение

Параметр	Тип	Обязательно	Значение
`brandId`	String	Да	Идентификатор бренда ТСП.
`storeIds`	String	Нет	Список идентификаторов магазинов, для которых запрашиваются данные.

brandId

String

Да

Идентификатор бренда ТСП.

storeIds

String

Нет

Список идентификаторов магазинов, для которых запрашиваются данные.

Проверить валидность и доступность бренда для учётной записи можно, отправив запрос с пустым списком идентификаторов storeIds: если бренд доступен, то придёт ответ с пустым списком магазинов.

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

Отсутствуют.

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

/api/v1/configuration/brand/store?brandId=1a01ab77-2d71-4dc5-8148-1580be9a44c3&storeIds=2deadedc-df08-4693-9706-ee1d2c65ccb2&storeIds=ce83862c-714a-48bb-9ecb-6235aa856cac&storeIds=47c8c1f9-4b4a-48a4-aacb-52946f1a7731

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

HTTP Status Code: 200

Запрос выполнен успешно. Тело ответа — объект JSON следующей структуры:

Поле Тип Обязательно Значение

Поле	Тип	Обязательно	Значение
`brandId`	String	Да	Идентификатор бренда (UUID).
`stores`	Array[Object]	Да	Массив, содержащий информацию магазинах (см. выше: Массив `stores`).

brandId

String

Да

Идентификатор бренда (UUID).

stores

Array[Object]

Да

Массив, содержащий информацию магазинах (см. выше: Массив stores).

Пример тела ответа

{
  "brandId": "1a01ab77-2d71-4dc5-8148-1580be9a44c3",
  "stores": [
    {
      "store": {
        "storeId": "2deadedc-df08-4693-9706-ee1d2c65ccb2",
        "legalId": "2f00d067-3d92-48cb-8973-cee7821035da",
        "city": "Москва",
        "address": "Москва, Головинское ш., 5, БЦ «Водный»",
        "phone": "88002001063",
        "countryCode": "RU",
        "countrySubDivisionCode": "77",
        "mcc": "5661",
        "zip": "125212",
        "status": "ACTIVE",
        "paymentMethods": [
          " SBP",
          "DOLYAME"
        ]
      },
      "result": {
        "storeId": "2deadedc-df08-4693-9706-ee1d2c65ccb2",
        "status": "ACTIVE",
        "codes": [
          {
            "code": "000",
            "details": "Запрос выполнен успешно"
          }
        ]
      }
    },
    {
      "store": {
        "storeId": "ce83862c-714a-48bb-9ecb-6235aa856cac",
        "legalId": "2f00d067-3d92-48cb-8973-cee7821035da",
        "city": "Москва",
        "address": "Москва, Джавахарлала Неру площадь, д. 1",
        "phone": "88002001063",
        "countryCode": "RU",
        "countrySubDivisionCode": "77",
        "mcc": "5661",
        "zip": "119311",
        "status": "ACTIVE",
        "paymentMethods": [
          "SBP",
          "DOLYAME"
        ]
      },
      "result": {
        "storeId": "ce83862c-714a-48bb-9ecb-6235aa856cac",
        "status": "ACTIVE",
        "codes": [
          {
            "code": "000",
            "details": "Запрос выполнен успешно"
          }
        ]
      }
    },
    {
      "store": {
        "storeId": "47c8c1f9-4b4a-48a4-aacb-52946f1a7731",
        "legalId": "2f00d067-3d92-48cb-8973-cee7821035da",
        "city": "Екатеринбург",
        "address": "Екатеринбург, ул. 8 Марта, стр. 46",
        "phone": "88002001063",
        "countryCode": "RU",
        "countrySubDivisionCode": "66",
        "mcc": "5661",
        "zip": "620014",
        "status": "ACTIVE",
        "paymentMethods": [
          "SBP",
          "DOLYAME"
        ]
      },
      "result": {
        "storeId": "47c8c1f9-4b4a-48a4-aacb-52946f1a7731",
        "status": "ACTIVE",
        "codes": [
          {
            "code": "000",
            "details": "Запрос выполнен успешно"
          }
        ]
      }
    }
  ]
}

Обновление данных Store

HTTP-метод: PUT

URL: /api/v1/configuration/brand/store

Описание

Используя этот метод, партнёр может обновить данные магазина (например, если необходимо изменить номер телефона или статус подключения магазина к Кошелёк Pay).

Обновление данных возможно только для зарегистрированных магазинов (см. Регистрация Store).

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

В запросе для каждого магазина передаются только те поля, значения которых требуется обновить.

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

Тело запроса передается в виде объекта JSON следующей структуры:

Параметр Тип Обязательно Значение

Параметр	Тип	Обязательно	Значение
`brandId`	String	Да	Идентификатор бренда ТСП.
`stores`	Array[Object]	Да	Массив, содержащий информацию о магазинах (см. ниже: Массив `stores`).

brandId

String

Да

Идентификатор бренда ТСП.

stores

Array[Object]

Да

Массив, содержащий информацию о магазинах (см. ниже: Массив stores).

Массив `stores`

Массив содержит информацию о магазинах, которую требуется обновить. Каждый магазин представлен в виде JSON-объекта следующей структуры:

Поле Тип Обязательно Значение

Поле	Тип	Обязательно	Значение
`storeNumber`	String	Нет	Идентификатор магазина, присвоенный ТСП (UUID).
`storeId`	String	Да	Идентификатор ТСП, присвоенный Кошельком.
`legalId`	String	Нет	Внутренний идентификатор юридического лица ТСП в сервисе Кошелёк Pay (UUID).
`city`	String	Нет	Город фактического адреса ТСП.
`address`	String	Нет	Фактический адрес ТСП.
`phone`	String	Нет	Контактный номер телефона ТСП.
`countryCode`	String	Нет	Код страны регистрации ТСП (ISO 3166 Alpha-2).
`countrySubDivisionCode`	String	Нет	Код региона регистрации ТСП (ISO 3166-2:RU).
`mcc`	String	Нет	Код MCC (Merchant Category Code).
`zip`	String	Нет	Индекс.
`paymentMethods`	Array[Enum]	Нет	Метод оплаты через Koshelek Pay, доступный в магазине. Доступные значения: `SBP` `DOLYAME` Если не заполнено: значение наследуется для данного магазина от общих настроек бренда.
`sbpMerchantId`	String	Нет	Идентификатор магазина в СБП.
`status`	String[Enum]	Нет	Статус магазина. Доступные значения: `ACTIVE` (значение по умолчанию); `INACTIVE`.

storeNumber

String

Нет

Идентификатор магазина, присвоенный ТСП (UUID).

storeId

String

Да

Идентификатор ТСП, присвоенный Кошельком.

legalId

String

Нет

Внутренний идентификатор юридического лица ТСП в сервисе Кошелёк Pay (UUID).

city

String

Нет

Город фактического адреса ТСП.

address

String

Нет

Фактический адрес ТСП.

phone

String

Нет

Контактный номер телефона ТСП.

countryCode

String

Нет

Код страны регистрации ТСП (ISO 3166 Alpha-2).

countrySubDivisionCode

String

Нет

Код региона регистрации ТСП (ISO 3166-2:RU).

mcc

String

Нет

Код MCC (Merchant Category Code).

zip

String

Нет

Индекс.

paymentMethods

Array[Enum]

Нет

Метод оплаты через Koshelek Pay, доступный в магазине. Доступные значения:

SBP
DOLYAME

Если не заполнено: значение наследуется для данного магазина от общих настроек бренда.

sbpMerchantId

String

Нет

Идентификатор магазина в СБП.

status

String[Enum]

Нет

Статус магазина. Доступные значения:

ACTIVE (значение по умолчанию);
INACTIVE.

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

{
  "brandId": "1a01ab77-2d71-4dc5-8148-1580be9a44c3",
  "stores":
    [
      {
          "storeId": "8fa6e6c1-cf24-42cf-9c23-3dfe1051ca25",
          "status": "INACTIVE"
      }
    ]
}

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

HTTP Status Code: 200

Запрос выполнен успешно. Тело ответа содержит данные, полученные в запросе, а также параметры с результатами обработки запроса:

Поле Тип Обязательно Значение

Поле	Тип	Обязательно	Значение
`brandId`	String	Да	Идентификатор бренда ТСП (UUID).
`stores`	Array[Object]	Да	Массив, содержащий информацию о регистрации магазинов (см. ниже: Массив `stores`).
`result`	Object	Да	Объект, содержащий результаты обработки запроса (см. Объект `result`).

brandId

String

Да

Идентификатор бренда ТСП (UUID).

stores

Array[Object]

Да

Массив, содержащий информацию о регистрации магазинов (см. ниже: Массив stores).

result

Object

Да

Объект, содержащий результаты обработки запроса (см. Объект result).

Массив `stores`

Массив содержит данные по каждому магазину, обновлённые после обработки запроса:

Поле Тип Обязательно Значение

Поле	Тип	Обязательно	Значение
`storeNumber`	String	Да, если было получено в запросе	Идентификатор магазина, присвоенный ТСП (UUID).
`legalId`	String	Да	Внутренний идентификатор юридического лица ТСП в сервисе Кошелёк Pay (UUID).
`storeId`	String	Да, если было получено в запросе	Идентификатор ТСП, присвоенный Кошельком.
`city`	String	Да, если было получено в запросе	Город фактического адреса ТСП.
`address`	String	Да, если было получено в запросе	Фактический адрес ТСП.
`phone`	String	Да, если было получено в запросе	Контактный номер телефона ТСП.
`countryCode`	String	Да, если было получено в запросе	Код страны регистрации ТСП (ISO 3166 Alpha-2).
`countrySubDivisionCode`	String	Да, если было получено в запросе	Код региона регистрации ТСП (ISO 3166-2:RU).
`mcc`	String	Да, если было получено в запросе	Код MCC (Merchant Category Code).
`zip`	String	Да, если было получено в запросе	Индекс.
`paymentMethods`	Array[String]	Да, если было получено в запросе	Метод оплаты через Koshelek Pay, доступный в магазине. Доступные значения: `SBP` `DOLYAME`
`sbpMerchantId`	String	Да, если было получено в запросе	Идентификатор магазина в СБП.

storeNumber

String

Да, если было получено в запросе

Идентификатор магазина, присвоенный ТСП (UUID).

legalId

String

Да

Внутренний идентификатор юридического лица ТСП в сервисе Кошелёк Pay (UUID).

storeId

String

Да, если было получено в запросе

Идентификатор ТСП, присвоенный Кошельком.

city

String

Да, если было получено в запросе

Город фактического адреса ТСП.

address

String

Да, если было получено в запросе

Фактический адрес ТСП.

phone

String

Да, если было получено в запросе

Контактный номер телефона ТСП.

countryCode

String

Да, если было получено в запросе

Код страны регистрации ТСП (ISO 3166 Alpha-2).

countrySubDivisionCode

String

Да, если было получено в запросе

Код региона регистрации ТСП (ISO 3166-2:RU).

mcc

String

Да, если было получено в запросе

Код MCC (Merchant Category Code).

zip

String

Да, если было получено в запросе

Индекс.

paymentMethods

Array[String]

Да, если было получено в запросе

Метод оплаты через Koshelek Pay, доступный в магазине. Доступные значения:

SBP
DOLYAME

sbpMerchantId

String

Да, если было получено в запросе

Идентификатор магазина в СБП.

Пример тела ответа

{
  "brandId": "1a01ab77-2d71-4dc5-8148-1580be9a44c3",
  "stores": [
    {
      "store": {
        "storeId": "8fa6e6c1-cf24-42cf-9c23-3dfe1051ca25",
        "storeNumber": "777",
        "legalId": "2f00d067-3d92-48cb-8973-cee7821035da",
        "city": "Батумск",
        "address": "Лермонтова 38",
        "phone": "995598928",
        "countryCode": "RU",
        "countrySubDivisionCode": "77",
        "mcc": "5661",
        "zip": "125212",
        "status": "INACTIVE",
        "paymentMethods": [
          "DOLYAME"
        ]
      },
      "result": {
        "storeId": "8fa6e6c1-cf24-42cf-9c23-3dfe1051ca25",
        "status": "INACTIVE",
        "codes": [
          {
            "code": "000",
            "details": "Запрос выполнен успешно"
          }
        ]
      }
    }
  ]
}

PreviousStore API v1.0.0 NextОбъекты API v1.0.0

Last updated 11 months ago

Регистрация Store

Описание

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

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

Массив stores

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

HTTP Status Code: 200

Массив stores

Получение данных о Store

Описание

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

Query-параметры запроса

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

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

HTTP Status Code: 200

Обновление данных Store

Описание

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

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

Массив stores

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

HTTP Status Code: 200

Массив stores

Массив `stores`

Массив `stores`

Массив `stores`

Массив `stores`