3.10. /api/v2/get-balance/manager

Introduction

Get Balance by Manager is initiated through HTTPS POST request by using URLs and the parameters specified below. Use OAuth HMAC-SHA1 for authentication. See Статусы. Also can be viewed on UI. Please contact technical support to enable this feature.

API URLs

Note

Путь API URL не должен быть жёстко задан, т.к. он может быть изменён позднее.

Integration

Production

https://sandbox.payneteasy.com/paynet/api/v2/get-balance/manager/MANAGERLOGIN

https://gate.payneteasy.com/paynet/api/v2/get-balance/manager/MANAGERLOGIN

Request Parameters

Note

Request must have content-type=application/x-www-form-urlencoded and Authorization headers.

Parameter Name

Description

Value

balance-name

Balance name. If this parameter is omitted, the result will give all available balances.
Necessity: Optional
Type: String
Length: 128

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.

Response Parameters

Description

name

Balance name.

amount

Current balance including STH and Rolling reserve.

online-balance-live-amount

Current balance calculated from configuration excluding STH and Rolling reserve. Live = current - STH - RR.

total-short-term-hold-amount

Current amount of hold based on Date bumping function.

total-rolling-reserve-amount

Current amount calculated from rate plan hold.

currency

Currency used for selected balance.

merchantLogin

Merchant login for the balance.

amount-buffer-hold

Calculated amount for OUT operations without final status.

Request Example

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

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

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

Request Builder

HTTP method
url
parameters
version
consumer key
consumer secret
timestamp

nonce

signature method

normalized parameters
signature base string
signature
authorization header