Баланс

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

Данный API запрос возвращает информацию по доступному балансу для выплат и по замороженному балансу. Чтобы увидеть более подробную информацию по вашему балансу, вам необходимо воспользоваться админкой.

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

Параметры, которые необходимо отправить в теле запроса для получения информации по доступному балансу.

general** - информация по заявке
- project_id** - идентификатор кассы, полученный от HH в процессе интеграции.
  (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** - замороженный баланс кассы в данной валюте. Баланс замораживается при таких операциях как выплата, settlement и т.д. Сумма указывается в дробных единицах. Подробнее об этом можно прочитать в разделе "Коды валют";
  (integer) (1 <= X <= 10000000000000)

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