.. _api_v2_get_balance_manager:

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

.. toctree::
  :maxdepth: 1

.. contents::
  :local:

.. role:: ex

.. role:: code


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

Get Balance by Manager is initiated through :code:`HTTPS POST` request by using :ref:`URLs<api_v2_get_balance_manager_request_url>` and the :ref:`parameters<api_v2_get_balance_manager_request_parameters>` specified below. Use :ref:`OAuth HMAC-SHA1<HMAC-SHA1>` for authentication. See :ref:`statuses`. Also can be viewed on UI. Please contact technical support to enable this feature.

.. _api_v2_get_balance_manager_request_url:

API URLs
^^^^^^^^

.. note::
    | The path in API URL should not be hardcoded, as it may be changed in future.
.. list-table::
   :widths: 50, 50
   :header-rows: 1
   :class: longtable

   * - Integration
     - Production
   * - :ex:`https://sandbox.payneteasy.com/paynet/api/v2/get-balance/manager/MANAGERLOGIN`
     - :ex:`https://gate.payneteasy.com/paynet/api/v2/get-balance/manager/MANAGERLOGIN`


.. _api_v2_get_balance_manager_request_parameters:

Request Parameters
^^^^^^^^^^^^^^^^^^

.. note::
  | Request must have content-type=application/x-www-form-urlencoded and :ref:`Authorization headers<HMAC-SHA1>`.

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

  * - Parameter Name
    - Description
    - Value
  * - :code:`balance-name`
    - Balance name. If this parameter is omitted, the result will give all available balances.
    - | ``Necessity``: Optional
      | ``Type``: String
      | ``Length``: 128

.. _get-balance_response_parameters_manager:

Response Parameters
^^^^^^^^^^^^^^^^^^^

.. note::
  | Response has Content-Type: text/html;charset=utf-8 header. All fields are x-www-form-urlencoded, with (0xA) character at the end of each parameter’s value.

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

   * - Response Parameters
     - Description
   * - :code:`name`
     - Balance name.
   * - :code:`amount`
     - Current balance including STH and Rolling reserve.
   * - :code:`online-balance-live-amount`
     - Current balance calculated from configuration excluding STH and Rolling reserve. Live = current - STH - RR.
   * - :code:`total-short-term-hold-amount`
     - Current amount of hold based on :code:`Date bumping function`.
   * - :code:`total-rolling-reserve-amount`
     - Current amount calculated from rate plan hold.
   * - :code:`currency`
     - Currency used for selected balance.
   * - :code:`merchantLogin`
     - Merchant login for the balance.
   * - :code:`amount-buffer-hold`
     - Calculated amount for OUT operations without final status.

Request Example
^^^^^^^^^^^^^^^^

.. code-block:: guess

  POST /paynet/api/v2/get-balance/manager/BalanceTestManager HTTP/1.1
  Host: sandbox.payneteasy.com
  User-Agent: curl/7.83.0
  Accept: */*
  Authorization: OAuth realm="",oauth_version="1.0",oauth_consumer_key="BalanceTestManager",oauth_timestamp="1686924196",oauth_nonce="sT33IbJ4QHs",oauth_signature_method="HMAC-SHA1",oauth_signature="LyKy7M8P%2F%2FZxyLnh7ULW405ODVs%3D"
  Content-Length: 156
  Content-Type: application/x-www-form-urlencoded
  Connection: close

  balance-name=saa
  &oauth_consumer_key=BalanceTestManager
  &oauth_nonce=sT33IbJ4QHs
  &oauth_signature_method=HMAC-SHA1
  &oauth_timestamp=1686924196
  &oauth_version=1.0

Success Response Example
^^^^^^^^^^^^^^^^^^^^^^^^

.. 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":"saa",
      "amount":219.500,
      "online-balance-live-amount":219.500,
      "total-short-term-hold-amount":0.000,
      "total-rolling-reserve-amount":0.000,
      "currency":"USD",
      "merchantLogin":"balance_test_merchant14",
      "externalMerchantIdentifier":null,
      "amount-buffer-hold":0.000
    }
  ]

Fail Response Example
^^^^^^^^^^^^^^^^^^^^^

.. code-block:: text

  HTTP/1.1 403
  Server: server
  Date: Fri, 16 Jun 2023 13:23:37 GMT
  Content-Type: text/html
  Content-Length: 735
  Connection: close
  X-XSS-Protection: 1
  X-Content-Type-Options: nosniff
  Strict-Transport-Security: max-age=31536000

  ...
  <body>
      <p>Access is denied</p>
  </body>

Postman Collection
^^^^^^^^^^^^^^^^^^

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

Request Builder
^^^^^^^^^^^^^^^

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