VIBAN Info

Virtual IBAN Info service description

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

viban.info.request.xsd.xml

490B

Open

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

Request VIBAN Info

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

Response

Headers

Name	Value
Content-Type	application/xml
X-Bank-Code	LHVUK, LHVEE

Body

viban.info.response.xsd.xml

800B

Open

202

Request accepted - no content

403

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

Private person

<?xml version="1.0" encoding="UTF-8"?>
<VibanInfoResponse>
  <ClientReference>12345678</ClientReference>
  <VirtualIBAN>GB88LHVB01020000000002</VirtualIBAN>
  <User>
  	<Person>
  	  <Name>Donald Duck</Name>
  	  <BirthDate>1908-11-29</BirthDate>
  	  <BirthCountry>DE</BirthCountry>
  	  <Residency>DE</Residency>
  	  <DocumentNumber>A942819</DocumentNumber>
  	</Person>
  	<Address>
  		<Country>GB</Country>
  		<StreetNo>88 High Holborn</StreetNo>
  		<CityCounty>London</CityCounty>
  	</Address>
  </User>
  <Status>ACTIVE</Status>
  <!--Optional:-->
  <DateActivated>2018-01-01+02:00</DateActivated>
  <!--Optional:-->
  <DateClosed>2018-05-22+03:00</DateClosed>
</VibanInfoResponse>

Legal person

<?xml version="1.0" encoding="UTF-8"?>
<VibanInfoResponse>
  <ClientReference>12345678</ClientReference>
  <VirtualIBAN>GB88LHVB01020000000002</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>