.. meta::
   :description: /api/v2/get-balance API endpoint SBC: получает текущий баланс endpoint по ID с деталями ответа по каждой валюте для сверки.

.. _api_v2_get_balance:

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


.. role:: ex

.. role:: code


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

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

.. _api_v2_get_balance_request_url:

API URL
^^^^^^^^

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

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

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

.. _api_v2_get_balance_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-provider`
    - Введите поставщика баланса.
    - | ``Необходимость``: Обязательно
      | ``Тип``: String
      | ``Длина``: 128

.. _get-balance_response_parameters:

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

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

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

   * - Параметры ответа
     - Описание
   * - :code:`balance-amount`
     - Описание: Current balance.

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

.. code-block:: http

  POST /paynet/api/v2/get-balance/ 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_signature_method="HMAC-SHA1",oauth_signature="hSXMSUPP%2FIGYOOWpU4LVx0mu7SA%3D"
  Content-Length: 108
  Content-Type: application/x-www-form-urlencoded
  Connection: close

  balance-provider=Test
  &oauth_consumer_key=balance_test_merchant14
  &oauth_nonce=2xGTFuAgetE
  &oauth_signature_method=HMAC-SHA1
  &oauth_timestamp=1686923599
  &oauth_version=1.0

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

.. code-block:: http

  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

  [
    {
      "balance-amount":29.99,
    }
  ]

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

.. code-block:: http

   HTTP/1.1 200
   Server: server
   Date: Fri, 16 Jun 2023 13:53:43 GMT
   Content-Length: 42
   Connection: close
   X-XSS-Protection: 1
   X-Content-Type-Options: nosniff
   Strict-Transport-Security: max-age=31536000
   Strict-Transport-Security: max-age=31536000

   error-message=Unknown balance provider saa

Коллекция Postman
^^^^^^^^^^^^^^^^^^

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

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

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