Account Statement

Account Statement service description

Request

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

Account Statement provides a list of incoming and outgoing transactions and payments with additional details. It can be requested for one Customer Account for the specified period.

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.

Example

Account statement request for a full day.

  • Prtry=DATE is used to request day-based reporting

  • Time elements are not included and are not evaluated

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

HTTP Header Message-Response-Type: ACCOUNT_STATEMENT

file-download
64KB
camt.053.001.02.xsd schema

Body

Message root

INDEX
MESSAGE ELEMENT
XML TAG

[1..1]

MessageRoot

<BkToCstmrStmt>

Group header

MULT.
MESSAGE ELEMENT
XML TAG
DESCRIPTION

[1..1]

+GroupHeader

<GrpHdr>

[1..1]

++MessageIdentification

<MsgId>

Unique message identifier generated by requesting party. Maximum length 35 characters.

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

For long account statements containing larger number of transactions pagination can be used - one Account Statement response receives more then one response in the queue. Then this optional block is used. Current pagination limit is 10k transactions.

[0..1]

+++PageNumber

<PgNb>

Sequence number of current paginated long account statement portion.

[0..1]

+++LastPageIndicator

<LastPgInd>

Indicator if current account statement portion is the last one - true/false.

Statement

MULT.
OR
MESSAGE ELEMENT
XML TAG
DESCRIPTION

[1..n]

+Statement

<Stmt>

[1..1]

++Identification

<Id>

Unique identification provided by LHV. Identification is generated from the value of GrpHdr.MsgId and the currency for which this Statement block is generated.

[0..1]

++ElectronicSequenceNumber

<ElctrncSeqNb>

Not used.

[0..1]

++LegalSequenceNumber

<LglSeqNb>

Not used.

[1..1]

++CreationDateTime

<CreDtTm>

Date and time when the account statement is generated at LHV.

[1..1]

++FromToDate

<FrToDt>

[1..1]

+++FromDateTime

<FrDtTm>

Start date of the reporting period.

[1..1]

+++ToDateTime

<ToDtTm>

End date of the reporting period.

[1..1]

++Account

<Acct>

[1..1]

+++Identification

<Id>

[1..1]

++++IBAN

<IBAN>

IBAN for which this statement block is generated.

[0..1]

+++Currency

<Ccy>

Account currency for which this statement block is generated.

[0..1]

+++Servicer

<Svcr>

Full information about LHV.

[1..1]

++++FinancialInstitutionIdentification

<FinInstnId>

[0..1]

+++++BIC

<BIC>

LHVBGB2L

[0..1]

+++++Name

<Nm>

LHV BANK LIMITED

[0..1]

+++++PostalAddress

<PstlAdr>

LHV Bank address

[0..1]

++RelatedAccount

<RltdAcct>

Not used.

[1..n]

++Balance

<Bal>

[1..1]

+++Type

<Tp>

[1..1]

++++CodeOrProprietary

<CdOrPrtry>

[1..1]

+++++Code

<Cd>

See the codes in Balance Type Codes

[0..1]

+++CreditLine

<CdtLine>

Not used.

[1..1]

+++Amount

<Amt>

Balance amount.

[1..1]

+++CreditDebitIndicator

<CdtDbtInd>

See the codes in Balance Type Codes

[1..1]

+++Date

<Dt>

[1..1]

++++Date

<Dt>

Balance date

[1..1]

++TransactionsSummary

<TxsSummry>

[0..1]

+++TotalEntries

<TtlNtries>

Not used.

[1..1]

+++TotalCreditEntries

<TtlCdtNtries>

[0..1]

++++NumberOfEntries

<NbOfNtries>

Number of credit entries in a given Statement block.

[1..1]

++++Sum

<Sum>

Sum of all credit entries in a given statement block.

[1..1]

+++TotalDebitEntries

<TtlDbtNtries>

[0..1]

++++NumberOfEntries

<NbOfNtries>

Number of debit ebtries in a given Statement block.

[1..1]

++++Sum

<Sum>

Sum of all debit entries in a given Statement block.

[0..n]

++Entry

<Ntry>

[0..1]

+++EntryReference

<NtryRef>

Not used.

[1..1]

+++Amount

<Amt>

Transaction amount (may be zero).

[1..1]

+++CreditDebitIndicator

<CdtDbtInd>

[0..1]

+++ReversalIndicator

<RvslInd>

When set to True, then corresponding entry is a reversal of a previously booked entry.

[1..1]

+++Status

<Sts>

BOOK

[1..1]

+++BookingDate

<BookgDt>

[1..1]

++++Date

<Dt>

Booking date.

[1..1]

+++ValueDate

<ValDt>

[1..1]

++++DateTime

<DtTm>

Transaction date with time.

[1..1]

+++AccountServicerReference

<AcctSvcrRef>

Unique payment ID assigned by the bank.

[1..1]

+++BankTransactionCode

<BkTxCd>

[1..1]

++++Domain

<Domn>

[1..1]

+++++Code

<Cd>

See the codes in Bank Transaction Codes

[1..1]

+++++Family

<Fmly>

[1..1]

++++++Code

<Cd>

See the codes in Bank Transaction Codes

[1..1]

++++++SubFamilyCode

<SubFmlyCd>

See the codes in Bank Transaction Codes

[0..1]

++++Proprietary

<Prtry>

[1..1]

+++++Code

<Cd>

Payment scheme code, see in Payment Scheme Codes

[0..1]

+++AdditionalInformationIndicator

<AddtlInfInd>

Not used.

[1..n]

+++EntryDetails

<NtryDtls>

[0..1]

++++Batch

<Btch>

Not used.

[0..n]

++++TransactionDetails

<TxDtls>

[1..1]

+++++References

<Refs>

[0..1]

++++++MessageIdentification

<MsgId>

Not used.

[0..1]

++++++AccountServicerReference

<AcctSvcrRef>

Unique payment ID assigned by the bank.

[0..1]

++++++PaymentInformationIdentification

<PmtInfId>

Unique identification assigned by a sending party. For outgoing payment, reference to the original Pain.001.001.09 message value PmtInf.PmtInfId.

[0..1]

++++++InstructionIdentification

<InstrId>

Payment order number.

[0..1]

++++++EndToEndIdentification

<EndToEndId>

[0..1]

++++++TransactionIdentification

<TxId>

Not used.

[0..1]

+++++RelatedParties

<RltdPties>

[0..1]

++++++InitiatingParty

<InitgPty>

Not used.

[0..1]

++++++Debtor

<Dbtr>

Included for credit entries and for debit entries on the VIBAN / Indirect Scheme Participant account.

Omitted for other debit entries.

[0..1]

+++++++Name

<Nm>

Debtor’s name.

[0..1]

++++++++Country

<Ctry>

Debtor’s country ISO code.

[0..7]

++++++++AddressLine

<AdrLine>

Debtor’s address.

[0..1]

+++++++Identification

<Id>

If account statement was requested for VIBAN / Indirect Scheme Participant master account this tag will be empty for debit transaction.

[1..1]

{Or

++++++++OrganisationIdentification

<OrgId>

[0..1]

+++++++++BICOrBEI

<BICOrBEI>

Debtor’s BIC or BEI.

[0..n]

+++++++++Other

<Othr>

[1..1]

++++++++++Identification

<Id>

Debtor’s identification.

[1..1]

Or}

++++++++PrivateIdentification

<PrvtId>

[0..1]

+++++++++DateAndPlaceOfBirth

<DtAndPlcOfBirth>

[1..1]

++++++++++BirthDate

<BirthDt>

Debtor’s birth date.

[1..1]

++++++++++CityOfBirth

<CityOfBirth>

Debtor’s city of birth.

[1..1]

++++++++++CountryOfBirth

<CtryOfBirth>

Debtor’s country of birth.

[0..n]

+++++++++Other

<Othr>

[1..1]

++++++++++Identification

<Id>

Debtor’s identification.

[0..1]

++++++++++SchemeName

<SchmeNm>

[1..1]

+++++++++++Code

<Cd>

See the supported values in Private Person Identification Codes

[0..1]

++++++DebtorAccount

<DbtrAcct>

Included for credit entries and for debit entries on the VIBAN / Indirect Scheme Participant account.

[1..1]

+++++++Identification

<Id>

[1..1]

{Or

++++++++IBAN

<IBAN>

Debtor’s IBAN.

[1..1]

Or}

++++++++Other

<Othr>

[1..1]

+++++++++Identification

<Id>

Debtor’s bank account number which is not IBAN. For Faster Payments (incoming): UK sort code + account nr (14 characters)

[0..1]

++++++UltimateDebtor

<UltmtDbtr>

[0..1]

+++++++Name

<Nm>

Ultimate debtor’s name.

[0..1]

+++++++Identification

<Id>

[1..1]

{Or

++++++++OrganisationIdentification

<OrgId>

[0..1]

+++++++++BICOrBEI

<BICOrBEI>

Ultimate debtor’s BIC or BEI.

[0..n]

+++++++++Other

<Othr>

[1..1]

++++++++++Identification

<Id>

Ultimate debtor’s identification.

[1..1]

Or}

++++++++PrivateIdentification

<PrvtId>

[0..1]

+++++++++DateAndPlaceOfBirth

<DtAndPlcOfBirth>

[1..1]

++++++++++BirthDate

<BirthDt>

Ultimate debtor’s birth date.

[1..1]

++++++++++CityOfBirth

<CityOfBirth>

Ultimate debtor’s city of birth.

[1..1]

++++++++++CountryOfBirth

<CtryOfBirth>

Ultimate debtor’s country of birth.

[0..n]

+++++++++Other

<Othr>

[1..1]

++++++++++Identification

<Id>

Ultimate debtor’s identification.

[0..1]

++++++++++SchemeName

<SchmeNm>

[1..1]

+++++++++++Code

<Cd>

See the supported values in Private Person Identification Codes

[0..1]

++++++Creditor

<Cdtr>

Included for debit entries and for credit entries on the VIBAN / Indirect Scheme Participant account.

[0..1]

+++++++Name

<Nm>

Creditor’s name.

[0..1]

+++++++PostalAddress

<PstlAdr>

[0..1]

++++++++Country

<Ctry>

Creditor’s country ISO code.

[0..1]

++++++++AddressLine

<AdrLine>

Creditor’s address.

[0..1]

+++++++Identification

<Id>

If account statement was requested for VIBAN / Indirect Scheme Participant account master account this tag will be empty for credit transaction

[1..1]

{Or

++++++++OrganisationIdentification

<OrgId>

[0..1]

+++++++++BICOrBEI

<BICOrBEI>

Creditor’s BIC or BEI.

[0..n]

+++++++++Other

<Othr>

[1..1]

++++++++++Identification

<Id>

Creditor’s identification.

[1..1]

Or}

++++++++PrivateIdentification

<PrvtId>

[0..1]

+++++++++DateAndPlaceOfBirth

<DtAndPlcOfBirth>

[1..1]

++++++++++BirthDate

<BirthDt>

Creditor’s birth date.

[1..1]

++++++++++CityOfBirth

<CityOfBirth>

Creditor’s city of birth.

[1..1]

++++++++++CountryOfBirth

<CtryOfBirth>

Creditor’s country of birth.

[0..n]

+++++++++Other

<Othr>

[1..1]

++++++++++Identification

<Id>

Creditor’s identification.

[0..1]

++++++++++SchemeName

<SchmeNm>

[1..1]

+++++++++++Code

<Cd>

See the supported values in Private Person Identification Codes

[0..1]

++++++CreditorAccount

<CdtrAcct>

Included for debit entries and for credit entries on the VIBAN / Indirect Scheme Participant account.

[1..1]

+++++++Identification

<Id>

[0..1]

{Or

++++++++IBAN

<IBAN>

Creditor’s IBAN. UK Faster Payments (outgoing) - when also payment request contained IBAN.

[0..1]

Or}

++++++++Other

<Othr>

[1..1]

+++++++++Identification

<Id>

Creditor’s account number which is not IBAN. UK Faster Payments (outgoing) - when also payment request contained sort code + domestic account nr. For Faster Payments (incoming): UK sort code + account nr (14 characters)

[0..1]

++++++UltimateCreditor

<UltmtCdtr>

[0..1]

+++++++Name

<Nm>

Ultimate creditor’s name.

[0..1]

+++++++Identification

<Id>

[1..1]

{Or

++++++++OrganisationIdentification

<OrgId>

[0..1]

+++++++++BICOrBEI

<BICOrBEI>

Ultimate creditor’s BIC or BEI.

[0..n]

+++++++++Other

<Othr>

[1..1]

++++++++++Identification

<Id>

Ultimate creditor’s identification.

[1..1]

Or}

++++++++PrivateIdentification

<PrvtId>

[0..1]

+++++++++DateAndPlaceOfBirth

<DtAndPlcOfBirth>

[1..1]

++++++++++BirthDate

<BirthDt>

Ultimate creditor’s birth date.

[1..1]

++++++++++CityOfBirth

<CityOfBirth>

Ultimate creditor’s city of birth.

[1..1]

++++++++++CountryOfBirth

<CtryOfBirth>

Ultimate creditor’s country of birth.

[0..n]

+++++++++Other

<Othr>

[1..1]

++++++++++Identification

<Id>

Ultimate creditor’s identification.

[0..1]

++++++++++SchemeName

<SchmeNm>

[1..1]

+++++++++++Code

<Cd>

See the supported values in Private Person Identification Codes

[0..1]

+++++RelatedAgents

<RltdAgts>

[0..1]

++++++DebtorAgent

<DbtrAgt>

[1..1]

+++++++FinancialInstitutionIdentification

<FinInstnId>

[0..1]

++++++++BIC

<BIC>

BIC of the debtor’s bank.

[0..1]

++++++++Name

<Nm>

Name of the debtor’s bank.

[0..1]

++++++CreditorAgent

<CdtrAgt>

[1..1]

+++++++FinancialInstitutionIdentification

<FinInstnId>

[0..1]

++++++++BIC

<BIC>

BIC of the creditor’s bank.

[0..1]

++++++++Name

<Nm>

Name of the creditor’s bank.

[0..1]

++++++IntermediaryAgent1

<IntrmyAgt1>

Not used.

[0..1]

++++++IntermediaryAgent2

<IntrmyAgt2>

Not used.

[0..1]

++++++IntermediaryAgent3

<IntrmyAgt3>

[1..1]

+++++++FinancialInstitutionIdentification

<FinInstnId>

[0..1]

++++++++BIC

<BIC>

BIC of the creditor’s correspondent bank.

[0..1]

++++++++Name

<Nm>

Name of the creditor’s correspondent bank.

[0..1]

+++++Purpose

<Purp>

[1..1]

{Or

++++++Code

<Cd>

See the codes in Transaction Purpose Codes

[1..1]

Or}

++++++Proprietary

<Prtry>

[0..10]

+++++RelatedRemittanceInformation

<RltdRmtInf>

Not used.

[0..1]

+++++RemittanceInformation

<RmtInf>

[0..n]

++++++Unstructured

<Ustrd>

Payment description.

[0..n]

++++++Structured

<Strd>

[0..n]

+++++++CreditorReferenceInformation

<CdtrRefInf>

[0..1]

++++++++Type

<Tp>

[1..1]

+++++++++CodeOrProprietary

<CdOrPrtry>

[1..1]

{Or

++++++++++Code

<Cd>

SCOR

[1..1]

Or}

++++++++++Proprietary

<Prtry>

[0..1]

+++++++++Issuer

<Issr>

[0..1]

++++++++Reference

<Ref>

Payment reference number.

[0..1]

+++++ReturnInformation

<RtrInf>

Return information. Element is present when RvslInd is True. Provides details about the return, including the reason code (if available) and original payment reference.

[0..1]

++++++Reason

<Rsn>

[1..1]

{Or

+++++++Code

<Cd>

NARR if AdditionalInformation is filled.

[1..1]

Or}

+++++++Proprietary

<Prtry>

[0..n]

++++++AdditionalInformation

<AddtlInf>

Contains return reason code. The value is a scheme-specific code, see codes in Payment Return Codes

[0..n]

++++++AdditionalInformation

<AddtlInf>

Contains original payment Account Servicer Reference. The value follows the format ORIG:{reference}, for example: ORIG:C9512AB4B85A4410A73BA8E94DDED3A9.

Example

Sample of a statement containing:

  • two currencies

  • no pagination

Error codes

Service specific errors

ERROR CODE
DESCRIPTION

errStatement_NoAccess

No access to the account.

errStatement_PeriodLong

Period is too long.

errStatement_PeriodInvalid

From date cannot be later than to date.

Last updated

Was this helpful?