3.6. /api/v2/get-balance/merchant

Introduction

Get Balance by Merchant is initiated through HTTPS POST request by using URLs and the parameters specified below. Use OAuth HMAC-SHA1 for authentication. See Statuses. Also can be viewed on UI. Please contact support managers to enable this feature.

API URLs

Integration

Production

https://sandbox.billblend.com/checkout/api/v2/get-balance/merchant/MERCHANTLOGIN

https://pay.billblend.com/checkout/api/v2/get-balance/merchant/MERCHANTLOGIN

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.

amount-buffer-hold

Calculated amount for OUT operations without final status.

Request Example

POST /checkout/api/v2/get-balance/merchant/balance_test_merchant14 HTTP/1.1
Host: sandbox.billblend.com
User-Agent: curl/7.83.0
Accept: */*
Authorization: OAuth realm="",oauth_version="1.0",oauth_consumer_key="balance_test_merchant14",oauth_timestamp="1686924613",oauth_nonce="qoJPcins4Aw",oauth_signature_method="HMAC-SHA1",oauth_signature="M6fTXbI0tFz4Dy7YEL3SBzCN1I0%3D"
Content-Length: 161
Content-Type: application/x-www-form-urlencoded
Connection: close

balance-name=saa
&oauth_consumer_key=balance_test_merchant14
&oauth_nonce=qoJPcins4Aw
&oauth_signature_method=HMAC-SHA1
&oauth_timestamp=1686924613
&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":"Test1",
    "amount":8854.000,
    "online-balance-live-amount":8854.000,
    "total-short-term-hold-amount":0.000,
    "total-rolling-reserve-amount":0.000,
    "currency":"AUD",
    "amount-buffer-hold":0.000
  }
]

Fail 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

...
<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