API service endpoints

This section describes the HighHelp API auxiliary endpoints that are used regardless of payment and payout scenarios.

Cash balance

Endpoint returns information about the available balance for payments and the frozen cash balance. For a detailed view of transactions and balance history, use your personal account.

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

Request parameters

The request body contains an objectgeneral.

general — information about the application.
- project_id — checkout ID received from HighHelp during the integration process.
  (string) (<= 32)

Fields marked, are mandatory.

Example request

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: SIGNATURE' \
  -H 'x-access-token: API_KEY' \
  -H 'content-type: application/json' \
  -d '{
    "general": {
      "project_id": "57aff4db-b45d-42bf-bc5f-b7a499a01782"
    }
  }'

Sample answer

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

Response Options

balance — an array of objects describing cash register balances for available currencies.
- currency — balance currency code in the formatISO 4217 alpha-3.
  (string) (regex: ^[A-Z]{3}$)
  For more details, see sectionCurrency codes.
- amount — available cash balance in the specified currency. The value is indicated in fractional currency units.
  (integer) (1 <= X <= 10000000000000)
  For more details, see sectionCurrency codes.
- locked_amount — frozen cash balance in the specified currency. The frozen part is used for unfinished transactions (for example, payments). The value is indicated in fractional currency units.
  (integer) (1 <= X <= 10000000000000)
  For more details, see sectionCurrency codes.

Fields marked, are mandatory.

List of banks

Endpoint returns a list of banks. Fieldsymbolfrom the response is used when creating requests for both payment and disbursement.

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

Request parameters

The request body contains an objectgeneral.

general — information about the application.
- project_id — checkout ID received from HighHelp during the integration process.
  (string) (<= 32)

Fields marked, are mandatory.

Example request

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: SIGNATURE' \
  -H 'x-access-token: API_KEY' \
  -H 'content-type: application/json' \
  -d '{
    "general": {
      "project_id": "57aff4db-b45d-42bf-bc5f-b7a499a01782"
    }
  }'

Sample answer

[ { "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" } ]

Response Options

id — bank identifier.
(string) (<= 32)
name — name of the bank.
(string) (<= 64)
symbol — symbolic code of the bank. Used when creating requests.
(string) (<= 64)
sbp_code — bank code in the fast payment system.
(string) (<= 12)
(regex: ^\d{12}$)
is_sbp_bank — a sign of the bank’s participation in the fast payments system.
(boolean)
country_code — country code in the formatISO 3166-1 alpha-2.
(string) (regex: ^[A-Z]{2}$)

Fields marked, are mandatory.

If the bank is not a participant in the fast payment system (is_sbp_bank=false), it cannot be used to create requests for payment using the methodsbp-p2p.