Read Balance

get https://test-openbanking.tbcbank.ge/0.6/v1/accounts/{account-id}/balances

Reads account data from a given account addressed by "account-id".

Remark: This account-id can be a tokenised identification due to data protection reason since the path
information might be logged on intermediary servers within the ASPSP sphere.
This account-id then can be retrieved by the "GET Account List" call.

The account-id is constant at least throughout the lifecycle of a given consent.

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

account-id

string

required

This identification is denoting the addressed account.
The account-id is retrieved by using a "Read Account List" call.
The account-id is the "id" attribute of the account structure.
Its value is constant at least throughout the lifecycle of a given consent.

Headers

X-Request-ID

uuid

required

ID of the request, unique to the call, as determined by the initiating party.

Digest

string

Is contained if and only if the "Signature" element is contained in the header of the request.

Signature

string

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate

string

The certificate used for signing the request, in base64 encoding.
Must be contained if a signature is contained.

Consent-ID

string

required

This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

PSU-IP-Address

string

The forwarded IP Address header field consists of the corresponding HTTP request
IP Address field between PSU and TPP.
It shall be contained if and only if this request was actively initiated by the PSU.

PSU-IP-Port

string

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept

string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Charset

string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Encoding

string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Language

string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-User-Agent

string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method

string

HTTP method used at the PSU ? TPP interface, if available.
Valid values are:

GET
POST
PUT
PATCH
DELETE

PSU-Device-ID

uuid

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available.
UUID identifies either a device or a device dependant application installation.
In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location

string

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Responses

Response body

object

account

object

Reference to an account by either

IBAN, of a payment accounts, or
BBAN, for payment accounts if there is no IBAN, or
the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or
the Primary Account Number (PAN) of a card in a masked form, or
an alias to access a payment account via a registered mobile phone number (MSISDN).

iban

string

IBAN of an account

bban

string

Basic Bank Account Number (BBAN) Identifier

This data element can be used in the body of the Consent Request
Message for retrieving Account access Consent from this Account. This
data elements is used for payment Accounts which have no IBAN.
ISO20022: Basic Bank Account Number (BBAN).

Identifier used nationally by financial institutions, i.e., in individual countries,
generally as part of a National Account Numbering Scheme(s),
which uniquely identifies the account of a customer.

pan

string

length ≤ 35

Primary Account Number according to ISO/IEC 7812.

maskedPan

string

length ≤ 35

Masked Primary Account Number

msisdn

string

length ≤ 35

Mobile phone number.

currency

string

ISO 4217 Alpha 3 currency code

balances

array of objects

required

A list of balances regarding this account, e.g. the current balance, the last booked balance.
The list migght be restricted to the current ballance.

balances*

object

balanceAmount

object

required

balanceType

string

required

The following balance types are defined:

"closingBooked":
Balance of the account at the end of the pre-agreed account reporting period.
It is the sum of the opening booked balance at the beginning of the period and all entries booked
to the account during the pre-agreed account reporting period.

For card-accounts, this is composed of
- invoiced, but not yet paid entries
"expected":
Balance composed of booked entries and pending items known at the time of calculation,
which projects the end of day balance if everything is booked on the account and no other entry is posted.

For card accounts, this is composed of
- invoiced, but not yet paid entries,
- not yet invoiced but already booked entries and
- pending items (not yet booked)
For card-accounts:

"money to spend with the value of a pre-approved credit limit on the card account"
"openingBooked":
Book balance of the account at the beginning of the account reporting period.
It always equals the closing book balance from the previous report.
"interimAvailable":
Available balance calculated in the course of the account ?servicer?s business day,
at the time specified, and subject to further changes during the business day.
The interim balance is calculated on the basis of booked credit and debit items during the calculation
time/period specified.

For card-accounts, this is composed of
- invoiced, but not yet paid entries,
- not yet invoiced but already booked entries
"interimBooked":
Balance calculated in the course of the account servicer's business day, at the time specified,
and subject to further changes during the business day.
The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period
specified.
"forwardAvailable":
Forward available balance of money that is at the disposal of the account owner on the date specified.
"nonInvoiced":
Only for card accounts, to be checked yet.

closingBooked expected openingBooked interimAvailable interimBooked forwardAvailable nonInvoiced

creditLimitIncluded

boolean

A flag indicating if the credit limit of the corresponding account
is included in the calculation of the balance, where applicable.

lastChangeDateTime

date-time

This data element might be used to indicate e.g. with the expected or booked balance that no action is known
on the account, which is not yet booked.

referenceDate

date

Reference date of the balance

lastCommittedTransaction

string

length ≤ 35

"entryReference" of the last commited transaction to support the TPP in identifying whether all
PSU transactions are already known.

Headers

object

X-Request-ID

uuid

ID of the request, unique to the call, as determined by the initiating party.

Response body

object

tppMessages

array of objects

tppMessages

object

category

string

required

Category of the TPP message category

ERROR WARNING

code

string

required

Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST).

FORMAT_ERROR PARAMETER_NOT_CONSISTENT PARAMETER_NOT_SUPPORTED SERVICE_INVALID RESOURCE_UNKNOWN RESOURCE_EXPIRED RESOURCE_BLOCKED TIMESTAMP_INVALID PERIOD_INVALID SCA_METHOD_UNKNOWN CONSENT_UNKNOWN SESSIONS_NOT_SUPPORTED

path

string

text

string

length ≤ 500

Additional explaining text to the TPP.

_links

object

A _link object with all availabel link types

scaRedirect

object

Link to a resource

scaOAuth

object

Link to a resource

startAuthorisation

object

Link to a resource

startAuthorisationWithPsuIdentification

object

Link to a resource

updatePsuIdentification

object

Link to a resource

startAuthorisationWithProprietaryData

object

Link to a resource

updateProprietaryData

object

Link to a resource

startAuthorisationWithPsuAuthentication

object

Link to a resource

updatePsuAuthentication

object

Link to a resource

startAuthorisationWithEncryptedPsuAuthentication

object

Link to a resource

updateEncryptedPsuAuthentication

object

Link to a resource

updateAdditionalPsuAuthentication

object

Link to a resource

updateAdditionalEncryptedPsuAuthentication

object

Link to a resource

startAuthorisationWithAuthenticationMethodSelection

object

Link to a resource

selectAuthenticationMethod

object

Link to a resource

startAuthorisationWithTransactionAuthorisation

object

Link to a resource

authoriseTransaction

object

Link to a resource

self

object

Link to a resource

status

object

Link to a resource

scaStatus

object

Link to a resource

account

object

Link to a resource

balances

object

Link to a resource

transactions

object

Link to a resource

transactionDetails

object

Link to a resource

cardAccount

object

Link to a resource

cardTransactions

object

Link to a resource

first

object

Link to a resource

object

Link to a resource

object

Link to a resource

last

object

Link to a resource

download

object

Link to a resource

Headers

object

Location

url

Location of the created resource.

X-Request-ID

uuid

ID of the request, unique to the call, as determined by the initiating party.

Response body

object

tppMessages

array of objects

tppMessages

object

category

string

required

Category of the TPP message category

ERROR WARNING

code

string

required

Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED).

CERTIFICATE_INVALID ROLE_INVALID CERTIFICATE_EXPIRED CERTIFICATE_BLOCKED CERTIFICATE_REVOKE CERTIFICATE_MISSING SIGNATURE_INVALID SIGNATURE_MISSING CORPORATE_ID_INVALID PSU_CREDENTIALS_INVALID CONSENT_INVALID CONSENT_EXPIRED TOKEN_UNKNOWN TOKEN_INVALID TOKEN_EXPIRED

path

string

text

string

length ≤ 500

Additional explaining text to the TPP.

_links

object

A _link object with all availabel link types

scaRedirect

object

Link to a resource

scaOAuth

object

Link to a resource

startAuthorisation

object

Link to a resource

startAuthorisationWithPsuIdentification

object

Link to a resource

updatePsuIdentification

object

Link to a resource

startAuthorisationWithProprietaryData

object

Link to a resource

updateProprietaryData

object

Link to a resource

startAuthorisationWithPsuAuthentication

object

Link to a resource

updatePsuAuthentication

object

Link to a resource

startAuthorisationWithEncryptedPsuAuthentication

object

Link to a resource

updateEncryptedPsuAuthentication

object

Link to a resource

updateAdditionalPsuAuthentication

object

Link to a resource

updateAdditionalEncryptedPsuAuthentication

object

Link to a resource

startAuthorisationWithAuthenticationMethodSelection

object

Link to a resource

selectAuthenticationMethod

object

Link to a resource

startAuthorisationWithTransactionAuthorisation

object

Link to a resource

authoriseTransaction

object

Link to a resource

self

object

Link to a resource

status

object

Link to a resource

scaStatus

object

Link to a resource

account

object

Link to a resource

balances

object

Link to a resource

transactions

object

Link to a resource

transactionDetails

object

Link to a resource

cardAccount

object

Link to a resource

cardTransactions

object

Link to a resource

first

object

Link to a resource

object

Link to a resource

object

Link to a resource

last

object

Link to a resource

download

object

Link to a resource

Headers

object

Location

url

Location of the created resource.

X-Request-ID

uuid

ID of the request, unique to the call, as determined by the initiating party.

Response body

object

tppMessages

array of objects

tppMessages

object

category

string

required

Category of the TPP message category

ERROR WARNING

code

string

required

Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN).

CONSENT_UNKNOWN SERVICE_BLOCKED RESOURCE_UNKNOWN RESOURCE_EXPIRED

path

string

text

string

length ≤ 500

Additional explaining text to the TPP.

_links

object

A _link object with all availabel link types

scaRedirect

object

Link to a resource

scaOAuth

object

Link to a resource

startAuthorisation

object

Link to a resource

startAuthorisationWithPsuIdentification

object

Link to a resource

updatePsuIdentification

object

Link to a resource

startAuthorisationWithProprietaryData

object

Link to a resource

updateProprietaryData

object

Link to a resource

startAuthorisationWithPsuAuthentication

object

Link to a resource

updatePsuAuthentication

object

Link to a resource

startAuthorisationWithEncryptedPsuAuthentication

object

Link to a resource

updateEncryptedPsuAuthentication

object

Link to a resource

updateAdditionalPsuAuthentication

object

Link to a resource

updateAdditionalEncryptedPsuAuthentication

object

Link to a resource

startAuthorisationWithAuthenticationMethodSelection

object

Link to a resource

selectAuthenticationMethod

object

Link to a resource

startAuthorisationWithTransactionAuthorisation

object

Link to a resource

authoriseTransaction

object

Link to a resource

self

object

Link to a resource

status

object

Link to a resource

scaStatus

object

Link to a resource

account

object

Link to a resource

balances

object

Link to a resource

transactions

object

Link to a resource

transactionDetails

object

Link to a resource

cardAccount

object

Link to a resource

cardTransactions

object

Link to a resource

first

object

Link to a resource

object

Link to a resource

object

Link to a resource

last

object

Link to a resource

download

object

Link to a resource

Headers

object

Location

url

Location of the created resource.

X-Request-ID

uuid

ID of the request, unique to the call, as determined by the initiating party.

Response body

object

tppMessages

array of objects

tppMessages

object

category

string

required

Category of the TPP message category

ERROR WARNING

code

string

required

Message codes defined for AIS for HTTP Error code 404 (NOT FOUND).

RESOURCE_UNKNOWN

path

string

text

string

length ≤ 500

Additional explaining text to the TPP.

_links

object

A _link object with all availabel link types

scaRedirect

object

Link to a resource

scaOAuth

object

Link to a resource

startAuthorisation

object

Link to a resource

startAuthorisationWithPsuIdentification

object

Link to a resource

updatePsuIdentification

object

Link to a resource

startAuthorisationWithProprietaryData

object

Link to a resource

updateProprietaryData

object

Link to a resource

startAuthorisationWithPsuAuthentication

object

Link to a resource

updatePsuAuthentication

object

Link to a resource

startAuthorisationWithEncryptedPsuAuthentication

object

Link to a resource

updateEncryptedPsuAuthentication

object

Link to a resource

updateAdditionalPsuAuthentication

object

Link to a resource

updateAdditionalEncryptedPsuAuthentication

object

Link to a resource

startAuthorisationWithAuthenticationMethodSelection

object

Link to a resource

selectAuthenticationMethod

object

Link to a resource

startAuthorisationWithTransactionAuthorisation

object

Link to a resource

authoriseTransaction

object

Link to a resource

self

object

Link to a resource

status

object

Link to a resource

scaStatus

object

Link to a resource

account

object

Link to a resource

balances

object

Link to a resource

transactions

object

Link to a resource

transactionDetails

object

Link to a resource

cardAccount

object

Link to a resource

cardTransactions

object

Link to a resource

first

object

Link to a resource

object

Link to a resource

object

Link to a resource

last

object

Link to a resource

download

object

Link to a resource

Headers

object

Location

url

Location of the created resource.

X-Request-ID

uuid

ID of the request, unique to the call, as determined by the initiating party.

Response body

object

tppMessages

array of objects

tppMessages

object

category

string

required

Category of the TPP message category

ERROR WARNING

code

string

required

Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED).

SERVICE_INVALID

path

string

text

string

length ≤ 500

Additional explaining text to the TPP.

_links

object

A _link object with all availabel link types

scaRedirect

object

Link to a resource

scaOAuth

object

Link to a resource

startAuthorisation

object

Link to a resource

startAuthorisationWithPsuIdentification

object

Link to a resource

updatePsuIdentification

object

Link to a resource

startAuthorisationWithProprietaryData

object

Link to a resource

updateProprietaryData

object

Link to a resource

startAuthorisationWithPsuAuthentication

object

Link to a resource

updatePsuAuthentication

object

Link to a resource

startAuthorisationWithEncryptedPsuAuthentication

object

Link to a resource

updateEncryptedPsuAuthentication

object

Link to a resource

updateAdditionalPsuAuthentication

object

Link to a resource

updateAdditionalEncryptedPsuAuthentication

object

Link to a resource

startAuthorisationWithAuthenticationMethodSelection

object

Link to a resource

selectAuthenticationMethod

object

Link to a resource

startAuthorisationWithTransactionAuthorisation

object

Link to a resource

authoriseTransaction

object

Link to a resource

self

object

Link to a resource

status

object

Link to a resource

scaStatus

object

Link to a resource

account

object

Link to a resource

balances

object

Link to a resource

transactions

object

Link to a resource

transactionDetails

object

Link to a resource

cardAccount

object

Link to a resource

cardTransactions

object

Link to a resource

first

object

Link to a resource

object

Link to a resource

object

Link to a resource

last

object

Link to a resource

download

object

Link to a resource

Headers

object

Location

url

Location of the created resource.

X-Request-ID

uuid

ID of the request, unique to the call, as determined by the initiating party.

Response body

object

tppMessages

array of objects

tppMessages

object

category

string

required

Category of the TPP message category

ERROR WARNING

code

string

required

Message codes defined for AIS for HTTP Error code 406 (NOT ACCEPTABLE).

REQUESTED_FORMATS_INVALID

path

string

text

string

length ≤ 500

Additional explaining text to the TPP.

_links

object

A _link object with all availabel link types

scaRedirect

object

Link to a resource

scaOAuth

object

Link to a resource

startAuthorisation

object

Link to a resource

startAuthorisationWithPsuIdentification

object

Link to a resource

updatePsuIdentification

object

Link to a resource

startAuthorisationWithProprietaryData

object

Link to a resource

updateProprietaryData

object

Link to a resource

startAuthorisationWithPsuAuthentication

object

Link to a resource

updatePsuAuthentication

object

Link to a resource

startAuthorisationWithEncryptedPsuAuthentication

object

Link to a resource

updateEncryptedPsuAuthentication

object

Link to a resource

updateAdditionalPsuAuthentication

object

Link to a resource

updateAdditionalEncryptedPsuAuthentication

object

Link to a resource

startAuthorisationWithAuthenticationMethodSelection

object

Link to a resource

selectAuthenticationMethod

object

Link to a resource

startAuthorisationWithTransactionAuthorisation

object

Link to a resource

authoriseTransaction

object

Link to a resource

self

object

Link to a resource

status

object

Link to a resource

scaStatus

object

Link to a resource

account

object

Link to a resource

balances

object

Link to a resource

transactions

object

Link to a resource

transactionDetails

object

Link to a resource

cardAccount

object

Link to a resource

cardTransactions

object

Link to a resource

first

object

Link to a resource

object

Link to a resource

object

Link to a resource

last

object

Link to a resource

download

object

Link to a resource

Headers

object

Location

url

Location of the created resource.

X-Request-ID

uuid

ID of the request, unique to the call, as determined by the initiating party.

Response body

object

tppMessages

array of objects

tppMessages

object

category

string

required

Category of the TPP message category

ERROR WARNING

code

string

required

Message codes defined for AIS for HTTP Error code 409 (CONFLICT).

STATUS_INVALID

path

string

text

string

length ≤ 500

Additional explaining text to the TPP.

_links

object

A _link object with all availabel link types

scaRedirect

object

Link to a resource

scaOAuth

object

Link to a resource

startAuthorisation

object

Link to a resource

startAuthorisationWithPsuIdentification

object

Link to a resource

updatePsuIdentification

object

Link to a resource

startAuthorisationWithProprietaryData

object

Link to a resource

updateProprietaryData

object

Link to a resource

startAuthorisationWithPsuAuthentication

object

Link to a resource

updatePsuAuthentication

object

Link to a resource

startAuthorisationWithEncryptedPsuAuthentication

object

Link to a resource

updateEncryptedPsuAuthentication

object

Link to a resource

updateAdditionalPsuAuthentication

object

Link to a resource

updateAdditionalEncryptedPsuAuthentication

object

Link to a resource

startAuthorisationWithAuthenticationMethodSelection

object

Link to a resource

selectAuthenticationMethod

object

Link to a resource

startAuthorisationWithTransactionAuthorisation

object

Link to a resource

authoriseTransaction

object

Link to a resource

self

object

Link to a resource

status

object

Link to a resource

scaStatus

object

Link to a resource

account

object

Link to a resource

balances

object

Link to a resource

transactions

object

Link to a resource

transactionDetails

object

Link to a resource

cardAccount

object

Link to a resource

cardTransactions

object

Link to a resource

first

object

Link to a resource

object

Link to a resource

object

Link to a resource

last

object

Link to a resource

download

object

Link to a resource

Headers

object

Location

url

Location of the created resource.

X-Request-ID

uuid

ID of the request, unique to the call, as determined by the initiating party.

Response body

object

tppMessages

array of objects

tppMessages

object

category

string

required

Category of the TPP message category

ERROR WARNING

code

string

required

Message codes for HTTP Error code 429 (TOO MANY REQUESTS).

ACCESS_EXCEEDED

path

string

text

string

length ≤ 500

Additional explaining text to the TPP.

_links

object

A _link object with all availabel link types

scaRedirect

object

Link to a resource

scaOAuth

object

Link to a resource

startAuthorisation

object

Link to a resource

startAuthorisationWithPsuIdentification

object

Link to a resource

updatePsuIdentification

object

Link to a resource

startAuthorisationWithProprietaryData

object

Link to a resource

updateProprietaryData

object

Link to a resource

startAuthorisationWithPsuAuthentication

object

Link to a resource

updatePsuAuthentication

object

Link to a resource

startAuthorisationWithEncryptedPsuAuthentication

object

Link to a resource

updateEncryptedPsuAuthentication

object

Link to a resource

updateAdditionalPsuAuthentication

object

Link to a resource

updateAdditionalEncryptedPsuAuthentication

object

Link to a resource

startAuthorisationWithAuthenticationMethodSelection

object

Link to a resource

selectAuthenticationMethod

object

Link to a resource

startAuthorisationWithTransactionAuthorisation

object

Link to a resource

authoriseTransaction

object

Link to a resource

self

object

Link to a resource

status

object

Link to a resource

scaStatus

object

Link to a resource

account

object

Link to a resource

balances

object

Link to a resource

transactions

object

Link to a resource

transactionDetails

object

Link to a resource

cardAccount

object

Link to a resource

cardTransactions

object

Link to a resource

first

object

Link to a resource

object

Link to a resource

object

Link to a resource

last

object

Link to a resource

download

object

Link to a resource

Headers

object

Location

url

Location of the created resource.

X-Request-ID

uuid

ID of the request, unique to the call, as determined by the initiating party.

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://test-openbanking.tbcbank.ge/0.6/v1/accounts/account-id/balances \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

*/*

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not found

405Method Not Allowed

406Not Acceptable

408Request Timeout

409Conflict

415Unsupported Media Type

429Too Many Requests

500Internal Server Error

503Service Unavailable