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
  • Before you begin
  • Verifying your connection and Heartbeat request
  • Your first Account Info request and response
  • Explore and integrate other services

Was this helpful?

Quick Start Guide

Quick start guide to our API

Before you begin

Firstly, follow the guide for Onboarding to ensure that you have a valid certificate and other preconditions in place. This guide will walk you through the basics of certificates and authentication and getting up the connection.


Verifying your connection and Heartbeat request

When your certificates are set up your are ready to send your first API request! Our Heartbeat service helps you to verity that you actually have the connection up and ready to go!

For simplicity, the following request is made using cURL.

Request

curl -k -H "Client-Code: 01234567" -H "Client-Country: GB" https://connect.development.lhv.com/heartbeat --cert <path_to_certificate> --key <path_to_certificate_key> 

The -k flag allows curl to perform insecure SSL connections and transfers. It ignores SSL certificate validation errors. It's should only be used for testing purposes like in this guide

Response

<HeartBeatResponse>
    <TimeStamp>2023-12-19T12:13:49.341+00:00</TimeStamp>
</HeartBeatResponse>

Your first Account Info request and response

Now it is time to execute your first API request providing access to your accounts and financial services.

  • Please familiarize with the chapter about the Messaging Pattern

  • As a first business service we recommend Account Balance. It is one of the simplest services that provides any information about your payment accounts.


Explore and integrate other services

Now that you have verified a request/response cycle with the Connect API, it is time to proceed further and explore our other services at Service Catalogue

PreviousNotice of ChangeNextConnect Fundamentals

Last updated 1 year ago

Was this helpful?

🧭