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
  • Service description
  • Request
  • Response

Was this helpful?

  1. Service Catalogue
  2. Messages Services

Get list of messages

Service description

Use this service to get a list of pending messages. You can use this service to request a number of messages at the same time and actually process them in separate threads.

Use in combination with Mark batch of messages as processed

Use additional filters where needed.

  • By default 10 messages are returned. The optional limit parameter changes this. See parameters section.

  • Messages are ordered starting from the oldest.

  • The same header values are accepted as for GET /messages/next service - including Filter-Response-Type and Service Provider options.

Request

GET https://connect.lhv.com/messages

Parameters

Name
Value
Description

Limit

integer

Number of messages to return.

Headers

Name
Value
Description

Client-Code

customer value

For Service Providers only. Company registration code of the Service Provider or its customer. When using the Service Provider own value also related customers messages are returned by default - see also Filter-Service-Provider for more options.

Client-Country

customer value

For Service Providers only. Should match the value of Client-CodeA

Filter-Service-Provider

true / false or 1/0

Add this optional header to select service provider messages only when using Service Provider own value for Client-Code. Values: 1/true (filter is on) or 0/false (filter is off). This can be used by service providers to select only their own company messages in the queue. By default when Client-Code is the service provider itself, it returns the messages of all customers. Has no effect when Client-Code is not service provider.

Filter-Response-Type

CREDIT_DEBIT_NOTIFICATION, PAYMENT etc.

Add this optional header to filter specific service messages. The value can be any Message-Response-Type (e.g., ACCOUNT_STATEMENT, CREDIT_DEBIT_NOTIFICATION, PAYMENT). Using this parameter enables parallel processing of payment responses and debit-credit notifications separately. This allows immediate consumption of payment responses, even if there are thousands of pending notifications in the queue.

Body

JSon with a list of messages metadata - type, timing, reference ID's.

Response

Headers

Name
Value
Description

Content-Type

application/json

Format of the message body

X-Bank-Code

LHVUK, LHVEE

LHV Bank entity

Client-Code

customer value

When using service provider model - customer entity related to the message

Client-Country

customer value

When using service provider model - customer entity related to the message

Body

OK

{
    "messages": [
        {
            "messageResponseId": "RES27dc481c24af499d8cab27ec8099a4d2",
            "messageRequestId": "REQ06d2e575a6c94061b7235ca160350680",
            "messageResponseType": "ACCOUNT_STATEMENT",
            "clientCode": "123123123",
            "clientCountry": "GB",
            "messageCreatedTime": "2024-05-23T16:51:30.939+01:00",
            "bankCode": "LHVUK"
        },
        {
            "messageResponseId": "RES271840cbb3b74578b04cbc4d97540680",
            "messageRequestId": "REQd6112ff55e824170b592e0ae79f917fe",
            "messageResponseType": "VIBAN_INFO",
            "clientCode": "123123123",
            "clientCountry": "GB",
            "messageCreatedTime": "2024-05-23T16:52:20.562+01:00",
            "bankCode": "LHVUK"
        },
        {
            "messageResponseId": "RES6bd75393a14f4c1fbcb4f3f5327c092f",
            "messageRequestId": "REQ2bda6fb658ce4ffdaa1bd4827310f6c2",
            "messageResponseType": "PAYMENT",
            "clientCode": "123123123",
            "clientCountry": "GB",
            "messageCreatedTime": "2024-05-23T16:52:00.339+01:00",
            "bankCode": "LHVUK"
        }
    ]
}

No content

Error code and description

<Errors>
    <Error>
        <ErrorCode>FORBIDDEN</ErrorCode>
        <Description>User doesn't exist</Description>
    </Error>
</Errors>

PreviousGet next messageNextGet list of messages V2

Last updated 10 months ago

Was this helpful?

📖
📩