3.8. /api/v2/get-balance/manager

Введение

Запрос баланса менеджером инициируется через HTTPS POST запрос с использованием URL и параметров, указанных ниже. Для аутентификации используется OAuth HMAC-SHA1. См. Статусы. Также доступно в UI. Для подключения данной функциональности обратитесь в службу технической поддержки.

API URL

Примечание

Путь API URL не должен быть задан фиксированным значением, т.к. он может быть изменён позднее.

Интеграционная среда

Производственная среда

https://sandbox.sbctech.ru/paynet/api/v2/get-balance/manager/MANAGERLOGIN

https://gate.sbctech.ru/paynet/api/v2/get-balance/manager/MANAGERLOGIN

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

Примечание

Запрос должен иметь content-type=application/x-www-form-urlencoded и заголовки авторизации.

Название параметра

Описание

Значение

balance-name

Название баланса. Если параметр не указан, в результате будут возвращены все доступные балансы.
Необходимость: Опционально
Тип: String
Длина: 128

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

Примечание

Ответ имеет заголовок Content-Type: text/html;charset=utf-8. Все поля имеют кодировку x-www-form-urlencoded, с символом (0xA) в конце значения каждого параметра.

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

Описание

name

Название баланса.

amount

Текущий баланс с учётом STH и Rolling reserve.

online-balance-live-amount

Текущий баланс, рассчитанный по конфигурации без учёта STH и Rolling reserve. Live = current - STH - RR.

total-short-term-hold-amount

Текущая сумма удержания на основе Date bumping function.

total-rolling-reserve-amount

Текущая сумма, рассчитанная на основе удержания тарифного плана.

currency

Валюта, используемая для выбранного баланса.

merchantLogin

Логин Торговца для данного баланса.

amount-buffer-hold

Рассчитанная сумма для исходящих операций без финального статуса.

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

POST /paynet/api/v2/get-balance/manager/BalanceTestManager HTTP/1.1
Host: sandbox.sbctech.ru
User-Agent: curl/7.83.0
Accept: */*
Authorization: OAuth realm="",oauth_version="1.0",oauth_consumer_key="BalanceTestManager",oauth_timestamp="1686924196",oauth_nonce="sT33IbJ4QHs",oauth_signature_method="HMAC-SHA1",oauth_signature="LyKy7M8P%2F%2FZxyLnh7ULW405ODVs%3D"
Content-Length: 156
Content-Type: application/x-www-form-urlencoded
Connection: close

balance-name=saa
&oauth_consumer_key=BalanceTestManager
&oauth_nonce=sT33IbJ4QHs
&oauth_signature_method=HMAC-SHA1
&oauth_timestamp=1686924196
&oauth_version=1.0

Пример успешного ответа

HTTP/1.1 200
Server: server
Date: Tue, 16 May 2023 08:06:05 GMT
Content-Length: 192
Connection: close
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000
Strict-Transport-Security: max-age=31536000

[
  {
    "name":"saa",
    "amount":219.500,
    "online-balance-live-amount":219.500,
    "total-short-term-hold-amount":0.000,
    "total-rolling-reserve-amount":0.000,
    "currency":"USD",
    "merchantLogin":"balance_test_merchant14",
    "externalMerchantIdentifier":null,
    "amount-buffer-hold":0.000
  }
]

Пример неуспешного ответа

HTTP/1.1 403
Server: server
Date: Fri, 16 Jun 2023 13:23:37 GMT
Content-Type: text/html
Content-Length: 735
Connection: close
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000

...
<body>
    <p>Access is denied</p>
</body>

Коллекция Postman

Конструктор запросов

HTTP method
url
parameters
version
consumer key
consumer secret
timestamp

nonce

signature method

normalized parameters
signature base string
signature
authorization header