Перейти к содержанию

Баланс

Во всех запросах необходимо передавать заголовки запроса:

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

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

Получение баланса банка

Метод: GET

  • Production: https://api.pay.kvell.group/v1/balance/{account_id}/bank
  • Stage: https://api.pay.stage.kvell.group/v1/balance/{account_id}/bank

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

Название
 Тип данных Обязательно Описание
account_id string Да Идентификатор терминала. Необходимо уточнять у менеджера.
instrument string Нет Тип платежного инструмента. По умолчанию: card

Возможные значения параметра instrument:

Значение Описание
card Выплата на карту (по умолчанию)
sbp Выплата через СБП
prepaid Выплата на предоплаченную карту
sbpb2b Выплата через СБП B2B
smartcontract Выплата через номинальный счёт

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

GET /v1/balance/{account_id}/bank?instrument=card

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

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

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

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

{
  "amount": 0 // cумма баланса в копейках
}

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

Получение внутреннего баланса

Метод: GET

  • Production: https://api.pay.kvell.group/v1/balance/{account_id}
  • Stage: https://api.pay.stage.kvell.group/v1/balance/{account_id}

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

Название
 Тип данных Обязательно Описание
account_id string Да Идентификатор терминала. Необходимо уточнять у менеджера.

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

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

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

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

{
  "id": 0,
  "is_active": true,
  "amount": 0 // cумма баланса в копейках
}

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