View as Markdown

Available Balance

This method allows retrieving a current and an available balance of a bank account.

Query params

accountNumberrequiredstring

An account number.

currencyrequiredstring

An account currency code in the ISO 4217 format (e.g.: USD, GEL)

initStatementBalanceoptionalboolean

Optional. When true, the response additionally contains the StatementBalance field.

REQUEST

GET api/accounts/{accountNumber}/{currency}

Response

AvailableBalancedecimal number

An available balance on the account.

CurrentBalancedecimal number

A current balance on the account.

StatementBalancedecimal number

The previous statement balance. Returned only when the initStatementBalance query parameter is set to true.

JSON

{
  "AvailableBalance": 1.0,
  "CurrentBalance": 2.0
}

XML

<AccountBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CIBApi.Models">
  <AvailableBalance>1</AvailableBalance>
  <CurrentBalance>2</CurrentBalance>
</AccountBalance>