LogoLogo
Connect
Connect
  • 🏡Welcome to LHV Connect API
  • 📺News and Updates
    • 📈Performance and Stats
    • 🔔Notice of Change
  • 🧭Quick Start Guide
  • 🎥Connect Fundamentals
    • Authentication and Certificates
    • Environments
    • Messaging Pattern
    • Service Provider model
    • Technical limitations
    • Encoding and Languages
    • Response Compression
    • Dates and Time Zones
    • Response Codes and Error handling
    • Onboarding
    • Live Proving
    • LHV UK and Estonia integrations
    • FAQ and Tips
  • 📖Service Catalogue
    • 💚Heartbeat
      • Heartbeat - GET
      • Heartbeat Advanced - GET
    • 📩Messages Services
      • Get next message
      • Get list of messages
      • Get list of messages V2
      • Get message by response ID
      • Count number of messages
      • Mark message as processed
      • Mark batch of messages as processed
      • Mark batch of messages as processed V2
      • Messages Metadata
      • Get compressed message for testing
    • 💰Account Information Services
      • Account Balance
      • Account Statement
      • Transaction Notification
        • Incoming Bacs Credit Notification
    • 💸Payment Initiation Services
      • Pain.001.001.09
      • Pain.002.001.10
      • Samples
      • Authentication methods
      • Payment Scheme Selection
      • Payment Return Initiation
      • Payments Service Idempotency
      • Payments Originating Overseas
      • Legacy documents
        • pain.001.001.03 format
    • ✅Confirmation of Payee Services
      • Confirmation of Payee - Requester
      • Confirmation of Payee - Responder
    • 😶‍🌫️VIBAN Services
      • VIBAN Open
      • VIBAN Bulk Open
      • VIBAN Modify
      • VIBAN Info
      • VIBAN Close
      • VIBAN Notification
    • 🔗Indirect Scheme Access
      • Agency Account Synchronization
      • RTF - Routing Table Files message
      • 🧾Payment Collection Services
        • 💷Bacs Direct Debit
          • Bacs Direct Debit Mandate Initiation Request
          • Bacs Direct Debit Mandate Initiation Response
          • Bacs Direct Debit Mandate Initiation Response Confirmation
          • Bacs Direct Debit Mandate Cancellation Request
          • Bacs Direct Debit Mandate Cancellation Response
          • Direct Debit Incoming Collection Notification Request
          • Direct Debit Collection Notification Response
          • Direct Debit Collection Notification Response Confirmation
          • Direct Debit Reversal Notification Request
          • Examples
    • 📨Webhooks
      • Webhook Format and Processing
      • Managing Webhook Configurations
      • Webhook Security
      • Webhook Metadata
      • Full Bodied Webhooks
  • 🗓️Reference
    • Glossary
    • Code Reference Tables
      • Balance Type Codes
      • Credit and Debit Transaction Codes
      • Payment Scheme Codes
      • Direct Debit Scheme Codes
      • Payment Reject Codes
      • Payment Return Codes
      • Bacs Direct Debit Mandate Reject Codes
      • Bacs Direct Debit Reject Codes
      • Bacs Direct Debit Reversal Reason
      • Bank Transaction Codes
      • Transaction Purpose Codes
      • Category Purpose Codes
      • Private Person Identification Codes
      • Organisation Identification Type Codes
      • Payment Priority Codes
      • Charges Bearer Codes
  • ☎️Support
    • Contact
Powered by GitBook
On this page
  • Use Cases for Metadata
  • List of Services and related Metadata fields

Was this helpful?

  1. Service Catalogue
  2. Messages Services

Messages Metadata

Connect Messages includes a metadata capability that enhances the efficiency of message processing for customers. When enabled, this feature embeds key variables related to the message content.

  • Metadata fields are shared both by Messages Services services and Webhook Metadata

  • Currently we are supporting Metadata fields on Get list of messages V2 service and only for LHV UK.

Metadata in Connect Messages and Webhooks provides a streamlined way to surface key pieces of information directly in the message structure. These values, such as account numbers, transaction references, and other identifiers, are extracted from larger XML or JSON message bodies and made readily accessible in the API response or webhook payload.

The purpose of including metadata is to enhance the usability and efficiency of the API by giving customers direct access to critical information without the need to parse complex and often sizable message payloads. This approach addresses customer feedback and is designed to make the API more intuitive, faster, and easier to integrate with.

Use Cases for Metadata

  • Routing and Linking: Metadata enables quick routing of messages in customer systems. For instance, an IBAN can be used to associate messages with specific accounts, while the account service reference (AcctSvcrRef) provides a unique transaction identifier for reconciliation.

  • Event Triggering: Webhook consumers can trigger business workflows based on metadata fields without needing to inspect the entire message content.

List of Services and related Metadata fields

Message

List of fields

Account Balance

CAMT.052

  • Reports (several blocks per currency)

    • Acct.IBAN: BkToCstmrAcctRpt.Rpt.Acct.Id.IBAN (Account IBAN)

    • Acct.Ccy: BkToCstmrStmt.Stmt.Acct.Ccy (Account currency)

Account Statement

CAMT.053

  • Statements (several blocks per currency)

    • Acct.IBAN: BkToCstmrStmt.Stmt.Acct.Id.IBAN (Account IBAN)

    • Acct.Ccy: BkToCstmrStmt.Stmt.Acct.Ccy (Account currency)

    • TtlCdtNtries.NbOfNtries: BkToCstmrStmt.Stmt.TtlCdtNtries.NbOfNtries (Total number of credit entries)

    • TtlDbtNtries.NbOfNtries: BkToCstmrStmt.Stmt.TtlDbtNtries.NbOfNtries (Total number of debit entries)

Transaction Notification

CAMT.054

Only one transaction:

  • Acct.IBAN: BkToCstmrDbtCdtNtfctn.Ntfctn.Acct.Id.IBAN (Transaction account)

  • AcctSvcrRef: BkToCstmrDbtCdtNtfctn.Ntfctn.Ntry.AcctSvcrRef (Transaction account services reference)

  • CdtDbtInd: BkToCstmrDbtCdtNtfctn.Ntfctn.Ntry.CdtDbtInd (Credit or debit indicator)

  • DbtrAcct.IBAN: BkToCstmrDbtCdtNtfctn.Ntfctn.Ntry.NtryDtls.RltdPties.DbtrAcct.Id.IBAN (Debtor account IBAN or BBAN)

    • or DbtrAcct.Id: BkToCstmrDbtCdtNtfctn.Ntfctn.Ntry.NtryDtls.RltdPties.DbtrAcct.Id.Othr.Id

  • CdtrAcct.IBAN: BkToCstmrDbtCdtNtfctn.Ntfctn.Ntry.NtryDtls.RltdPties.CdtrAcct.Id.IBAN (Creditor account IBAN or BBAN)

    • or CdtrAcct.Id: BkToCstmrDbtCdtNtfctn.Ntfctn.Ntry.NtryDtls.RltdPties.CdtrAcct.Id.Othr.Id

Payment Initiation

PAIN.002

  • GrpSts: CstmrPmtStsRpt.OrgnlGrpInfAndSts.GrpSts (Group status, general status of all payments)

  • OrgnlMsgId: CstmrPmtStsRpt.OrgnlGrpInfAndSts.OrgnlMsgId (Original PAIN.001 message ID)

Payments (can be many):

  • DebtorAcct.IBAN: CstmrPmtStsRpt.OrgnlPmtInfAndSts.OrgnlDbtrAcct.Id.IBAN (Debtor account IBAN or BBAN)

  • CreditorAcct.IBAN: CstmrPmtStsRpt.OrgnlPmtInfAndSts.TxInfAndSts.CdtrAcct.Id.IBAN (Creditor account IBAN or BBAN)

  • TxSts: CstmrPmtStsRpt.OrgnlPmtInfAndSts.TxInfAndSts.TxSts (Transaction status)

  • AcctSvcrRef: CstmrPmtStsRpt.OrgnlPmtInfAndSts.TxInfAndSts.AcctSvcrRef (Account servicer reference)

VIBAN Services

(custom XML)

  • MasterAccount: <MessageType>Response.MasterAccount

  • VirtualIBAN: <MessageType>Response.VirtualIBAN

  • ClientReference: <MessageType>Response.ClientReference

  • Status: <MessageType>Response.Status

CoP Requester

(custom JSon)

  • OriginalMessageId: OriginalMessageId

  • ReasonCode: Data.ReasonCode

  • Description: Data.Description

Agency Account Synchronization

(custom XML or JSon)

  • AccountNo: Accounts.Data.Identification

  • Status: Accounts.Data.Status

PreviousMark batch of messages as processed V2NextGet compressed message for testing

Last updated 5 months ago

Was this helpful?

📖
📩