Лимиты

Установка лимитов по API. Также настройку лимитов можно осуществить через личный кабинет мерчанта. Для выплат существует 3 типа лимитов:

order - лимит на транзакцию
day - суточный лимит на магазин
month - месячный лимит на магазин

Тип лимита уникален на один магизин.

Заголовки запроса

Название	Тип данных	Обязательно	Описание
`X-Api-Key`	string	Да	Уникальный идентификатор магазина
`X-Signature`	string	Да	Подпись запроса

Список лимитов

URL

Метод: GET

Production: https://api.baas.kvell.group/v1/points/limits
Stage: https://api.baas.stage.kvell.group/v1/points/limits

Формирование подписи

Подпись X-Signature формируется конкатенацией X-Api-Key и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{secret_key})

где secret_key - секретный ключ, который находится в настройках магазина мерчанта.

Ответ запроса

200: OK422: Validation error

[
  {
    "id": 2,
    "amount": 1000,
    "type": "month"
  }
]

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

Создать лимит

URL

Метод: POST

Production: https://api.baas.kvell.group/v1/points/limits
Stage: https://api.baas.stage.kvell.group/v1/points/limits

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

Название	Тип данных	Обязательно	Описание
`amount`	int	Да	Сумма лимита в копейках
`type`	string enum	Да	Тип лимита: `order`, `day`, `month`

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

{
  "amount": 1000,
  "type": "order"
}

Формирование подписи

Подпись X-Signature формируется конкатенацией X-Api-Key, amount, type и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{amount}{type}{secret_key})

где secret_key - секретный ключ, который находится в настройках магазина мерчанта.

Ответ запроса

200: OK422: Validation error

{
  "id":40,
  "amount": 1000,
  "type": "order"
}

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

Получить лимит

URL

Метод: GET

Production: https://api.baas.kvell.group/v1/points/limits/{limit_id}
Stage: https://api.baas.stage.kvell.group/v1/points/limits/{limit_id}

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

Название	Тип данных	Описание
`limit_id`	string	Идентификатор полученный при создании лимита `id`

Формирование подписи

Подпись X-Signature формируется конкатенацией X-Api-Key, limit_id и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{limit_id}{secret_key})

где secret_key - секретный ключ, который находится в настройках магазина мерчанта.

Ответ запроса

200: OK422: Validation error

{
  "id":40,
  "amount": 1000,
  "type": "order"
}

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

Редактировать лимит

URL

Метод: PATCH

Production: https://api.baas.kvell.group/v1/points/limits/{limit_id}
Stage: https://api.baas.stage.kvell.group/v1/points/limits/{limit_id}

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

Название	Тип данных	Описание
`limit_id`	string	Идентификатор полученный при создании лимита `id`

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

Название	Тип данных	Обязательно	Описание
`amount`	int	Да	Сумма лимита в копейках
`type`	string enum	Да	Тип лимита: `order`, `day`, `month`

Формирование подписи

Подпись X-Signature формируется конкатенацией X-Api-Key, limit_id и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{limit_id}{secret_key})

где secret_key - секретный ключ, который находится в настройках магазина мерчанта.

Ответ запроса

200: OK422: Validation error

{
  "id":40,
  "amount": 1000,
  "type": "order"
}

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}

Удалить лимит

URL

Метод: DELETE

Production: https://api.baas.kvell.group/v1/points/limits/{limit_id}
Stage: https://api.baas.stage.kvell.group/v1/points/limits/{limit_id}

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

Название	Тип данных	Описание
`limit_id`	string	Идентификатор полученный при создании лимита `id`

Формирование подписи

Подпись X-Signature формируется конкатенацией X-Api-Key, limit_id и secret_key. Формируется sha256 от полученной строки:

sha256({x-api-key}{limit_id}{secret_key})

где secret_key - секретный ключ, который находится в настройках магазина мерчанта.

Ответ запроса

204: No content422: Validation error

Успех, нет контента.

{
  "errors": [
    {
      "message": "string",
      "code": 0
    }
  ]
}