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
      • Get list of requests
      • Get request by request 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
  • Virtual IBAN Open - Request
  • Response
  • Response message

Was this helpful?

  1. Service Catalogue
  2. VIBAN Services

VIBAN Open

Virtual IBAN Open service description

PreviousVIBAN ServicesNextVIBAN Bulk Open

Last updated 1 year ago

Was this helpful?

Virtual IBAN Open - Request

POST https://connect.lhv.com/viban/open

Service is used to request new Virtual IBAN opening. Only one Virtual IBAN can be opened with one service request. It is mandatory to fill in minimal data set about Virtual IBAN owner and request message structure is slightly different for private and legal persons. After receiving the request, background check is done by LHV for Virtual IBAN owner (the check is done in less than a second).

  • If check is OK, then Virtual IBAN is activated at once.

  • If check is not OK, then Virtual IBAN will remain in status ON_HOLD until decision about Virtual IBAN opening is made. CONNECT customer will be informed about the decision (status ACTIVE or REJECTED) via service Status notification.

Headers

Name
Value

Content-Type

application/xml

Client-Code

customer value

Client-Country

customer value

Body

XML structure description:

MULT.
MESSAGE ELEMENT
XML TAG
Description

[1..1]

+MessageRoot

<VibanOpenRequest>

[1..1]

++MasterAccount

<MasterAccount>

Master account IBAN (must belong to PSP).

[0..1]

++ClientReference

<ClientReference>

Customer reference defined by Payment Service Provider. Can be used to avoid opening duplicate VIBANs.

[1..1]

++User

<User>

[0..1]

+++Person

<Person>

Element of choice, used if Virtual IBAN owner is private person.

[1..1]

++++Name

<Name>

First and last name of private person.

[1..1]

++++BirthDate

<BirthDate>

Birth date of private person (YYYY-MM-DD).

[0..1]

++++BirthCountry

<BirthCountry>

Country of birth of private person (ISO 3166-1 alpha-2).

[1..1]

++++Residency

<Residency>

Country of residence of private person (ISO 3166-1 alpha-2).

[0..1]

++++DocumentNumber

<DocumentNumber>

Document number of private person.

[0..1]

+++Company

<Company>

Element of choice, used if Virtual IBAN owner is legal person.

[1..1]

++++Name

<Name>

Name of company.

[1..1]

++++CountryOfOrigin

<CountryOfOrigin>

Country of origin of legal person (ISO 3166-1 alpha-2).

[1..1]

++++TaxResidency

<TaxResidency>

Tax residency of legal person (ISO 3166-1 alpha-2).

[1..1]

++++RegistrationNumber

<RegistrationNumber>

Registration number of legal person.

[1..1]

++++Representative

<Representative>

[1..1]

+++++Name

<Name>

First and last name of representative.

[1..1]

+++++BirthDate

<BirthDate>

Birth date of representative, YYYY-MM-DD.

[1..1]

+++++Residency

<Residency>

Country of residence of representative (ISO 3166-1 alpha-2).

[1..1]

+++Address

<Address>

Address of virtual IBAN use

[1..1]

++++Country

<Country>

Address country (ISO 3166-1 alpha-2).

[1..1]

++++StreetNo

<StreetNo>

Street address.

[1..1]

++++CityCounty

<CityCounty>

City, county.

Samples

<?xml version="1.0" encoding="UTF-8"?>
<VibanOpenRequest>
  <MasterAccount>EE837700771001625166</MasterAccount>
  <ClientReference>12345678</ClientReference>
  <User>
    <Person>
      <Name>Donald Duck</Name>
      <BirthDate>1988-11-29</BirthDate>
      <BirthCountry>DE</BirthCountry>
      <Residency>DE</Residency>
      <DocumentNumber>A942819</DocumentNumber>
    </Person>
    <Address>
      <Country>EE</Country>
      <StreetNo>Majaka 47-10</StreetNo>
      <CityCounty>Xiao, Neverland</CityCounty>
    </Address>
  </User>
</VibanOpenRequest>
<?xml version="1.0" encoding="UTF-8"?>
<VibanOpenRequest>
  <MasterAccount>EE837700771001625166</MasterAccount>
  <ClientReference>12345678</ClientReference>
  <User>
    <Company>
      <Name>UK Ltd Version 2.0</Name>
      <CountryOfOrigin>GB</CountryOfOrigin>
      <TaxResidency>GB</TaxResidency>
      <RegistrationNumber>1849203</RegistrationNumber>
      <Representative>
        <Name>Harry Potter</Name>
        <BirthDate>2001-01-01</BirthDate>
        <Residency>GB</Residency>
      </Representative>
    </Company>
    <Address>
      <Country>GB</Country>
      <StreetNo>Waterloo Bridge 13</StreetNo>
      <CityCounty>London, Cold</CityCounty>
    </Address>
  </User>
</VibanOpenRequest>

Response

Headers

Name
Value

Content-Type

application/xml

X-Bank-Code

LHVUK, LHVEE

Body

Request accepted - no content

Error code and description

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

Response message

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

HTTP Header Message-Response-Type: VIBAN_OPEN

Body

MULT.
MESSAGE ELEMENT
XML TAG
Description

[1..1]

+MessageRoot

<VibanOpenResponse>

[1..1]

++MasterAccount

<MasterAccount>

[0..1]

++ClientReference

<ClientReference>

Customer reference defined by Payment Service Provider.

[1..1]

++VirtualIBAN

<VirtualIBAN>

Virtual IBAN that was generated.

[1..1]

++User

<User>

[0..1]

+++Person

<Person>

Element of choice, used if Virtual IBAN owner is private person.

[1..1]

++++Name

<Name>

First and last name of private person.

[1..1]

++++BirthDate

<BirthDate>

Birth date of private person (YYYY-MM-DD).

[0..1]

++++BirthCountry

<BirthCountry>

Country of birth of private person (ISO 3166-1 alpha-2).

[1..1]

++++Residency

<Residency>

Country of residence of private person (ISO 3166-1 alpha-2).

[0..1]

++++DocumentNumber

<DocumentNumber>

Document number of private person.

[0..1]

+++Company

<Company>

Element of choice, used if Virtual IBAN owner is legal person.

[1..1]

++++Name

<Name>

Name of company.

[1..1]

++++CountryOfOrigin

<CountryOfOrigin>

Country of origin of legal person (ISO 3166-1 alpha-2).

[1..1]

++++TaxResidency

<TaxResidency>

Tax residency of legal person (ISO 3166-1 alpha-2).

[1..1]

++++RegistrationNumber

<RegistrationNumber>

Registration number of legal person.

[1..1]

++++Representative

<Representative>

[1..1]

+++++Name

<Name>

First and last name of representative.

[1..1]

+++++BirthDate

<BirthDate>

Birth date of representative, YYYY-MM-DD.

[1..1]

+++++Residency

<Residency>

Country of residence of representative (ISO 3166-1 alpha-2).

[1..1]

+++Address

<Address>

[1..1]

++++Country

<Country>

Address country (ISO 3166-1 alpha-2).

[1..1]

++++StreetNo

<StreetNo>

Street address.

[1..1]

++++CityCounty

<CityCounty>

City, county.

[1..1]

++Status

<Status>

Status of Virtual IBAN: 'ACTIVE' or 'ON_HOLD'.

Samples

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<VibanOpenResponse>
    <MasterAccount>EE837700771001625166</MasterAccount>
    <ClientReference>12345678</ClientReference>
    <VirtualIBAN>EE867777000202527783</VirtualIBAN>
    <User>
        <Person>
          <Name>Donald Duck</Name>
          <BirthDate>1908-11-29</BirthDate>
          <BirthCountry>DE</BirthCountry>
          <Residency>DE</Residency>
          <DocumentNumber>A942819</DocumentNumber>
        </Person>
        <Address>
            <Country>EE</Country>
            <StreetNo>Majaka 47-10</StreetNo>
            <CityCounty>Xiao, Neverland</CityCounty>
        </Address>
    </User>
    <Status>ACTIVE</Status>
</VibanOpenResponse>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<VibanOpenResponse>
    <MasterAccount>EE837700771001625166</MasterAccount>
    <ClientReference>12345678</ClientReference>
    <VirtualIBAN>EE497777000202527770</VirtualIBAN>
    <User>
        <Company>
            <Name>UK Ltd Version 2.0</Name>
            <CountryOfOrigin>GB</CountryOfOrigin>
            <TaxResidency>GB</TaxResidency>
            <RegistrationNumber>1849203</RegistrationNumber>
            <Representative>
                <Name>Harry Potter</Name>
                <BirthDate>2001-01-01</BirthDate>
                <Residency>GB</Residency>
            </Representative>
        </Company>
        <Address>
            <Country>GB</Country>
            <StreetNo>Waterloo Bridge 13</StreetNo>
            <CityCounty>London, Cold</CityCounty>
        </Address>
    </User>
    <Status>ACTIVE</Status>
</VibanOpenResponse>
πŸ“–
πŸ˜Άβ€πŸŒ«οΈ
574B
viban.open.request.xsd.xml
XML schema
695B
viban.open.response.xsd.xml
XML schema