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 Info - Request
  • Response
  • Response message

Was this helpful?

  1. Service Catalogue
  2. VIBAN Services

VIBAN Info

Virtual IBAN Info service description

PreviousVIBAN ModifyNextVIBAN Close

Last updated 1 year ago

Was this helpful?

Virtual IBAN Info - Request

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

Service is used to request Virtual IBAN data. Response message structure is slightly different for private and legal persons.

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

<VibanInfoRequest>

[1..1]

++MasterAccount

<MasterAccount>

Master account IBAN (must belong to PSP).

[1..1]

++VirtualIBAN

<VirtualIBAN>

Virtual IBAN (must be issued under MasterAccount specified).

Samples

<?xml version="1.0" encoding="UTF-8"?>
<VibanInfoRequest>
  <MasterAccount>EE837700771001625166</MasterAccount>
  <VirtualIBAN>EE717777000200014007</VirtualIBAN>
</VibanInfoRequest>

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_INFO

Body

XML structure description:

MULT.
MESSAGE ELEMENT
XML TAG
Description

[1..1]

+MessageRoot

<VibanInfoResponse>

[0..1]

++ClientReference

<ClientReference>

Customer reference defined by Payment Service Provider.

[1..1]

++VirtualIBAN

<VirtualIBAN>

[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', 'ON_HOLD', 'PENDING', 'REJECTED', 'BLOCKED' or 'CLOSED'.

[0..1]

++DateActivated

<DateActivated>

Optional. Added if Virtual IBAN has been in activated.

[0..1]

++DateClosed

<DateClosed>

Optional. Added if Virtual IBAN has beel closed.

Samples

<?xml version="1.0" encoding="UTF-8"?>
<VibanInfoResponse>
  <ClientReference>12345678</ClientReference>
  <VirtualIBAN>EE717777000200014007</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>
  <!--Optional:-->
  <DateActivated>2018-01-01+02:00</DateActivated>
  <!--Optional:-->
  <DateClosed>2018-05-22+03:00</DateClosed>
</VibanInfoResponse>
<?xml version="1.0" encoding="UTF-8"?>
<VibanInfoResponse>
  <ClientReference>12345678</ClientReference>
  <VirtualIBAN>EE717777000200014007</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>
  <!--Optional:-->
  <DateActivated>2018-01-01+02:00</DateActivated>
  <!--Optional:-->
  <DateClosed>2018-05-22+03:00</DateClosed>
</VibanInfoResponse>
πŸ“–
πŸ˜Άβ€πŸŒ«οΈ
490B
viban.info.request.xsd.xml
800B
viban.info.response.xsd.xml