.. meta::
   :description: Endpoint API /api/v2/get-balance/merchant Payneteasy: получение текущего баланса Торговца по всем endpoint через API в разрезе валют.

.. _api_v2_get_balance_merchant:

/api/v2/get-balance/merchant
#############################


.. role:: ex

.. role:: code


Введение
^^^^^^^^^^^^

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

.. _api_v2_get_balance_merchant_request_url:

API URL
^^^^^^^^

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

.. list-table::
   :widths: 50, 50
   :header-rows: 1
   :class: longtable

   * - Интеграционная среда
     - Производственная среда
   * - :ex:`https://sandbox.payneteasy.ru/paynet/api/v2/get-balance/merchant/MERCHANTLOGIN`
     - :ex:`https://gate.payneteasy.ru/paynet/api/v2/get-balance/merchant/MERCHANTLOGIN`

.. _api_v2_get_balance_merchant_request_parameters:

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

.. note::
  | Запрос должен иметь content-type=application/x-www-form-urlencoded и :ref:`заголовки авторизации<HMAC-SHA1>`.

.. list-table::
  :widths: 25, 45, 25
  :header-rows: 1
  :class: longtable

  * - Название параметра
    - Описание
    - Значение
  * - :code:`balance-name`
    - Название баланса. Если параметр не указан, в результате будут возвращены все доступные балансы.
    - | ``Необходимость``: Опционально
      | ``Тип``: String
      | ``Длина``: 128

.. _get-balance_response_parameters_merchant:

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

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

.. list-table::
   :widths: 25, 75
   :header-rows: 1
   :class: longtable

   * - Параметры ответа
     - Описание
   * - :code:`name`
     - Название баланса.
   * - :code:`amount`
     - Текущий баланс с учётом STH и Rolling reserve.
   * - :code:`online-balance-live-amount`
     - Текущий баланс, рассчитанный по конфигурации без учёта STH и Rolling reserve. Live = current - STH - RR.
   * - :code:`total-short-term-hold-amount`
     - Текущая сумма удержания на основе :ex:`Date bumping function`.
   * - :code:`total-rolling-reserve-amount`
     - Текущая сумма, рассчитанная на основе удержания тарифного плана.
   * - :code:`currency`
     - Валюта, используемая для выбранного баланса.
   * - :code:`amount-buffer-hold`
     - Рассчитанная сумма для исходящих операций без финального статуса.

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

.. code-block:: guess

  POST /paynet/api/v2/get-balance/merchant/balance_test_merchant14 HTTP/1.1
  Host: sandbox.payneteasy.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

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

.. code-block:: javascript

  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
    }
  ]

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

.. code-block:: text

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

.. raw:: html
    :file: ../_static/Postman/Postman_get_balance_merchant.html

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

.. raw:: html
    :file: ../_static/examples/get_balance_Merchant_debug.html