Account Balance

Account Balance service description

Request

POST https://connect.lhv.com/account-balance

Account Balance provides actual and free balance information for any existing currencies on Customer account. It can be requested for one Customer Account at a time. Balances are provided real-time on the moment of generating the response. With optional Prtry parameter now also Payment limits info can be requested - both total and free limits for Daily and Monthly periods.

circle-info

Both Account Statement and Account Balance request share the same ISO 20022 Account Report Request camt.060.001.03 XML format.

Depending on the service different values in the Request can be used to get data for different periods or details. Some of these affect only Statements or Balances responses.

file-download
21KB
camt.060.001.03 XSD schema

Headers

Name
Value

Content-Type

application/xml

Client-Code

customer value

Client-Country

customer value

Body

XML structure description:

Message root

INDEX
MESSAGE ELEMENT
XML TAG

[1..1]

MessageRoot

<AcctRptgReq>

Group header and Reporting Request

MULT.
MESSAGE ELEMENT
XML TAG
DESCRIPTION

[1..1]

+GroupHeader

<GrpHdr>

[1..1]

++MessageIdentification

<MsgId>

Unique message identifier generated by requesting party.

[1..1]

++CreationDateTime

<CreDtTm>

[1..1]

+ReportingRequest

<RptgReq>

[0..1]

++Identification

<Id>

[1..1]

++RequestedMessageNameIdentification

<ReqdMsgNmId>

Supported values:

  • 'camt.053.001.02' – Used for account statement requests

    • Endpoint: POST /account-statement

  • 'camt.052.001.06' – Used for account balance requests

    • Endpoint: POST /account-balance

[0..1]

++Account

<Acct>

[1..1]

+++Identification

<Id>

[1..1]

++++IBAN

<IBAN>

  • IBAN of the account to which the report request applies.

  • When using VIBAN or Indirect Scheme Participant account services, the master account IBAN must be provided.

    • VIBANs or Indirect Scheme Participant accounts are displayed only in the account statement report and are not accepted in the request.

[1..1]

++AccountOwner

<AcctOwnr>

[1..1]

+++Party

<Pty>

Values are ignored.

[0..1]

++ReportingPeriod

<RptgPrd>

[1..1]

+++FromToDate

<FrToDt>

Date filters apply only to statement requests; balance requests always return real-time data.

[1..1]

++++FromDate

<FrDt>

  • Statement request:

    • Account statement FromDate in ISO 8601 date format (YYYY-MM-DD).

    • Must not be later than ToDate.

    • Used together with ToDate to define the requested reporting period.

  • Balance request:

    • Value is ignored. Balance responses always return real-time balances, independent of the provided date.

[1..1]

++++ToDate

<ToDt>

  • Statement request:

    • Account statement ToDate in ISO 8601 date format (YYYY-MM-DD).

    • Must not be earlier than FromDate.

    • If a future date is provided, the system uses the current day as the effective end date.

  • Balance request:

    • Value is ignored. Balance responses always return real-time balances, independent of the provided date.

[1..1]

+++FromToTime

<FrToTm>

Time filters apply only to statement requests; balance requests always return real-time data.

  • Values are ignored if Requested Balance Type (ReqdBalTp) block is not added or if ReqdBalTp.CdOrPrtry.Cd.Prtry = 'DATE'.

  • Values are used when ReqdBalTp.CdOrPrtry.Cd.Prtry = 'DATETIME'

[1..1]

+++FromTime

<FrTm>

  • Statement request:

    • Account statement FromTime in ISO 8601 time format with UTC offset (e.g. 11:00:00+02:00).

    • Inclusive.

    • Used together with ToTime when the reporting period type is set to 'DATETIME'.

  • Balance request:

    • Value is ignored. Balance responses always return real-time balances, independent of the provided time range.

[1..1]

+++ToTime

<ToTm>

  • Statement request:

    • Account statement ToTime in ISO 8601 time format with UTC offset (e.g. 11:00:00+02:00).

    • Exclusive.

    • Used together with FromTime when the reporting period type is set to 'DATETIME'.

  • Balance request:

    • Value is ignored. Balance responses always return real-time balances, independent of the provided time range.

[1..1]

+++Type

<Tp>

‘ALLL’

[0..1]

++Requested Balance Type

<ReqdBalTp>

Provides details on the requested balance reporting.

[1..1]

+++Code or Proprietary

<CdOrPrtry>

[1..1]

++++Code

<Cd>

Not used

[1..1]

++++Proprietary

<Prtry>

  • Statement request:

    • 'DATE' – Statement is generated based on FromDate and ToDate only. FromTime and ToTime are ignored.

    • 'DATETIME' – Statement is generated using FromDate / ToDate together with FromTime and ToTime.

  • Balance request:

    • PAYMENT_LIMITS – Balance response additionally includes payment limits information.

Samples

Account balance request example (without limits):

Response

Headers

Name
Value

Content-Type

application/xml

X-Bank-Code

LHVUK, LHVEE

Body

circle-check

Response Message

Response message is created and can be requests by the Messages services - Messages Services

circle-info

Response message format is ISO standard camt.052.001.06

HTTP Header Message-Response-Type: ACCOUNT_BALANCE

file-download
97KB
camt.052.001.06.xsd schema

Body

Message root

INDEX
MESSAGE ELEMENT
XML TAG

[1..1]

MessageRoot

<BkToCstmrAcctRpt>

Group header

MULT.
MESSAGE ELEMENT
XML TAG
DESCRIPTION

[1..1]

+GroupHeader

<GrpHdr>

[1..1]

++MessageIdentification

<MsgId>

Unique message identifier generated by LHV.

[1..1]

++CreationDateTime

<CreDtTm>

Date and time when the account statement message is created at LHV.

[0..1]

++MessageRecipient

<MsgRcpt>

Not used.

[0..1]

++MessagePagination

<MsgPgntn>

Not used.

Report

MULT.
MESSAGE ELEMENT
XML TAG
DESCRIPTION

[1..n]

+Report

<Rpt>

Report block is generated per every account and currency.

[1..1]

++Identification

<Id>

Unique identification generated by LHV.

[1..1]

++CreationDateTime

<CreDtTm>

Creation date and time.

[0..1]

++FromToDate

<FrToDt>

Period for what this report is generated.

[1..1]

+++FromDateTime

<FrDtTm>

From date and time in camt.060.001.02 request.

[1..1]

+++ToDateTime

<ToDtTm>

To date and time in camt.060.001.02 request.

[1..1]

++Account

<Acct>

[1..1]

+++Identification

<Id>

[1..1]

++++IBAN

<IBAN>

Account number for what this report is generated.

[0..1]

+++Currency

<Ccy>

Currency of this report block.

[0..n]

++Balance

<Bal>

Report has two balances: current booked balance and current available balance.

[1..1]

+++Type

<Tp>

[1..1]

++++CodeOrProprietary

<CdOrPrtry>

[0..1]

+++++Code

<Cd>

ITAV for current available balance; ITBD for interim booked balance.

[0..1]

+++++Proprietary

<Prtry>

PAYMENT_LIMIT_MONTHLY_TOTAL - total Monthly limit; PAYMENT_LIMIT_MONTHLY_FREE free Monthly limit. PAYMENT_LIMIT_DAILY_TOTAL - total Daily limit; PAYMENT_LIMIT_DAILY_FREE free Daily limit.

[1..1]

+++Amount

<Amt>

Balance amount.

[1..1]

+++CreditDebitIndicator

<CdtDbtInd>

[1..1]

+++Date

<Dt>

[1..1]

++++Date

<Dt>

Date of the balance.

[0..n]

++Entry

<Ntry>

Entry data is not returned.

Samples

Sample has balances in EUR and GBP. Payment limits are in EUR.

Error codes

Service specific errors

ERROR CODE
DESCRIPTION

errStatement_NoAccess

No access to the account.

Last updated

Was this helpful?