.. meta::
   :description: API баланса учётной записи в SBC: получение текущего баланса торговца или конечной точки через конечную точку get-balance с деталями ответа по валютам.

.. _get-balance:

Описание: Account balance
################


.. role:: ex

.. role:: code

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

API Get Balance помогают Присоединяющейся стороне проверить текущие балансы, настроенные в Платёжном Шлюзе. Балансы можно запрашивать по Endpoint (для конкретного провайдера), по Merchant (конкретный баланс или все балансы) и по Manager (конкретный баланс или все балансы). Кроме того, пользователи с учётной записью Manager могут загружать корректировки баланса через API.


Get Balance Flow
^^^^^^^^^^^^^^^^

.. uml::
  :align: center

  skinparam roundcorner 20
  skinparam sequenceArrowThickness 1
  skinparam maxmessagesize 1200
  skinparam sequenceParticipant underline
  participant "Connecting Party" as A
  participant SBC as B
  autonumber
  A --> B: /api/v2/get-balance/
  activate B
  A <-- B: balance amount
  deactivate B

| (1) Для реализации запроса get balance by Endpoint см. :ref:`/api/v2/get-balance/<api_v2_get_balance>`.

Get Balance Merchant Flow
^^^^^^^^^^^^^^^^^^^^^^^^^

.. uml::
  :align: center

  skinparam roundcorner 20
  skinparam sequenceArrowThickness 1
  skinparam maxmessagesize 1200
  skinparam sequenceParticipant underline
  participant "Connecting Party" as A
  participant SBC as B
  autonumber
  A --> B: /api/v2/get-balance/merchant/
  activate B
  A <-- B: get balance by Merchant
  deactivate B

| (1) Для реализации запроса get balance by Merchant см. :ref:`/api/v2/get-balance/merchant/<api_v2_get_balance_merchant>`.

Get Balance Manager Flow
^^^^^^^^^^^^^^^^^^^^^^^^

.. uml::
  :align: center

  skinparam roundcorner 20
  skinparam sequenceArrowThickness 1
  skinparam maxmessagesize 1200
  skinparam sequenceParticipant underline
  participant "Connecting Party" as A
  participant SBC as B
  autonumber
  A --> B: /api/v2/get-balance/manager/
  activate B
  A <-- B: get balance by Manager
  deactivate B

| (1) Для реализации запроса get balance by Manager см. :ref:`/api/v2/get-balance/manager/<api_v2_get_balance_manager>`.

Get Balance Adjustments Flow
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. uml::
  :align: center

  skinparam roundcorner 20
  skinparam sequenceArrowThickness 1
  skinparam maxmessagesize 1200
  skinparam sequenceParticipant underline
  participant "Connecting Party" as A
  participant SBC as B
  autonumber
  A --> B: /registry/upload/
  activate B
  A <-- B: Get Balance Adjustments
  deactivate B

| (1) Для реализации запроса Get Balance Adjustments см. :ref:`Get Balance Adjustments<balance_example>`.