.. _get-balance:

Account balance
################

.. toctree::
  :maxdepth: 1

.. contents::
  :local:

.. role:: ex

.. role:: code

Introduction
^^^^^^^^^^^^

Get balance APIs help Connecting Party to check current balances configured in Payment Gateway. Balances can be requested by Endpoint (for specific provider), by Merchant (specific balance or all balances) and by Manager (specific balance or all balances). Additionally, users with Manager account are able to upload balance adjustments by 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 Payneteasy as B
  autonumber
  A --> B: /api/v2/get-balance/
  activate B
  A <-- B: balance amount
  deactivate B

| (1) To implement get balance by Endpoint request see :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 Payneteasy as B
  autonumber
  A --> B: /api/v2/get-balance/merchant/
  activate B
  A <-- B: get balance by Merchant
  deactivate B

| (1) To implement get balance by Merchant request see :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 Payneteasy as B
  autonumber
  A --> B: /api/v2/get-balance/manager/
  activate B
  A <-- B: get balance by Manager
  deactivate B

| (1) To implement get balance by Manager request see :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 Payneteasy as B
  autonumber
  A --> B: /registry/upload/
  activate B
  A <-- B: Get Balance Adjustments
  deactivate B

| (1) To implement Get Balance Adjustments request see :ref:`Get Balance Adjustments<balance_example>`.