Сервисные эндпоинты API

В этом разделе описаны вспомогательные эндпоинты HighHelp API, которые используются независимо от сценариев оплат и выплат.

Баланс кассы

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

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: 57aff4db-b45d-42bf-bc5f-b7a499a01782' \
  -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)
  Подробнее см. раздел Коды валют.

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

Список банков

Эндпоинт возвращает список банков. Поле symbol из ответа используется при создании заявок как на оплату, так и на выплату.

POST https://api.hh-processing.com/api/v1/bank/all

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

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

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

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

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

curl https://api.hh-processing.com/api/v1/bank/all \
  -X POST \
  -H 'x-access-timestamp: 1706182847' \
  -H 'x-access-merchant-id: 57aff4db-b45d-42bf-bc5f-b7a499a01782' \
  -H 'x-access-signature: fe99035f86fa436181717b302b95bacff1' \
  -H 'x-access-token: fe99035f86fa436181717b302b95bacff1' \
  -H 'content-type: application/json' \
  -d '{
    "general": {
      "project_id": "57aff4db-b45d-42bf-bc5f-b7a499a01782"
    }
  }'

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

[
  {
    "id": "607714dd-8cd0-4e9d-82c2-0079a13ce0e1",
    "name": "Сбербанк",
    "symbol": "sberbank",
    "sbp_code": "100000000111",
    "is_sbp_bank": true,
    "country_code": "RU"
  },
  {
    "id": "9fb71ff0-0252-4d81-9eeb-229b8c91347a",
    "name": "Свой банк",
    "symbol": "svoi-bank",
    "sbp_code": "990000000003",
    "is_sbp_bank": false,
    "country_code": "RU"
  }
]

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

id — идентификатор банка.
(string) (<= 32 символа)
name — наименование банка.
(string) (<= 64 символа)
symbol — символьный код банка. Используется при создании заявок.
(string) (<= 64 символа)
sbp_code — код банка в системе быстрых платежей.
(string) (<= 12 символов)
(regex: ^\d{12}$)
is_sbp_bank — признак участия банка в системе быстрых платежей.
(boolean)
country_code — код страны в формате ISO 3166-1 alpha-2.
(string) (regex: ^[A-Z]{2}$)

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

Если банк не является участником системы быстрых платежей (is_sbp_bank=false), его нельзя использовать для создания заявок на выплату по методу sbp-p2p.