Получить доступный баланс

Метод возвращает информацию о доступном балансе для выплат и о замороженном балансе по кассе. Для детализированного просмотра операций и истории баланса используйте личный кабинет.

POST https://api.hh-processing.com/api/v1/balance/info

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

Тело запроса содержит объект general.

  • general  — информация по заявке.

    • project_id  — идентификатор кассы, полученный от HighHelp в процессе интеграции.
      (string) (<= 32 символа)

Поля, помеченные , являются обязательными.

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

curl https://api.hh-processing.com/api/v1/balance/info \
  -X POST \
  -H 'x-access-timestamp: 1706182847' \
  -H 'x-access-merchant-id: 8b03432e-385b-4670-8d06-064591096795' \
  -H 'x-access-signature: fe99035f86fa436181717b302b95bacff1' \
  -H 'x-access-token: fe99035f86fa436181717b302b95bacff1' \
  -H 'content-type: application/json' \
  -d '{
    "general": {
      "project_id": "57aff4db-b45d-42bf-bc5f-b7a499a01782"
    }
  }'

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

{
  "balance": [
    {
      "currency": "UZS",
      "amount": 3018900,
      "locked_amount": 0
    },
    {
      "currency": "RUB",
      "amount": 1343800,
      "locked_amount": 1755400
    }
  ]
}

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

  • balance  — массив объектов, описывающих балансы кассы по доступным валютам.

    • currency  — код валюты баланса в формате ISO 4217 alpha-3.
      (string) (regex: ^[A-Z]{3}$)
      Подробнее см. раздел Коды валют.

    • amount  — доступный баланс кассы в указанной валюте. Значение указывается в дробных единицах валюты.
      (integer) (1 <= X <= 10000000000000)
      Подробнее см. раздел Коды валют.

    • locked_amount  — замороженный баланс кассы в указанной валюте. Замороженная часть используется для незавершенных операций (например, выплат). Значение указывается в дробных единицах валюты.
      (integer) (1 <= X <= 10000000000000)
      Подробнее см. раздел Коды валют.

Поля, помеченные , являются обязательными.