3.9. /api/v2/get-balance/merchant

Введение

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

API URL

Примечание

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

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

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

https://sandbox.sbctech.ru/paynet/api/v2/get-balance/merchant/MERCHANTLOGIN

https://gate.sbctech.ru/paynet/api/v2/get-balance/merchant/MERCHANTLOGIN

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

Примечание

Запрос должен иметь 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

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

amount-buffer-hold

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

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

POST /paynet/api/v2/get-balance/merchant/balance_test_merchant14 HTTP/1.1
Host: sandbox.sbctech.ru
User-Agent: curl/7.83.0
Accept: */*
Authorization: OAuth realm="",oauth_version="1.0",oauth_consumer_key="balance_test_merchant14",oauth_timestamp="1686924613",oauth_nonce="qoJPcins4Aw",oauth_signature_method="HMAC-SHA1",oauth_signature="M6fTXbI0tFz4Dy7YEL3SBzCN1I0%3D"
Content-Length: 161
Content-Type: application/x-www-form-urlencoded
Connection: close

balance-name=saa
&oauth_consumer_key=balance_test_merchant14
&oauth_nonce=qoJPcins4Aw
&oauth_signature_method=HMAC-SHA1
&oauth_timestamp=1686924613
&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":"Test1",
    "amount":8854.000,
    "online-balance-live-amount":8854.000,
    "total-short-term-hold-amount":0.000,
    "total-rolling-reserve-amount":0.000,
    "currency":"AUD",
    "amount-buffer-hold":0.000
  }
]

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

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

...
<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