pain.001.001.03 format | Documentation for LHV CONNECT

HV is using custom version of pain.001.001.03 which is compliant with and has less restrictions than 1.4 version of the Estonian Banking Association implementation of pain.001.001.03. See more at . LHV custom XSD is more restrictive that generic ISO 20022 XSD. Any XML file valid according to LHV custom XSD is also valid to generic pain.001.001.03.

Generic pain.001.001.03 message xml schema file is available at .

XML rules

Multiplicity (MULT.) Informs how many times an element can or must be used, as defined by ISO standard.

1..1 One occurrence (required)
1..n One or several occurrences (value for “n” represents total number of occurrences)
1..3 Minimum one occurrence must be used and maximum 3 occurrences can be used. Note: True value of “n” represents unlimited number of occurrences.
0..1 None or one occurrence to be used (optional)
0..n None or several occurrences can be used (value for “n” represents total number of occurrences). Note: True value of “n” represents unlimited number of occurrences.

Message structure

Group Header – mandatory, occurs once. Payment Information – mandatory and repetitive. Contains information related to mostly the debit side of the payment. Credit Transfer Transaction Information – mandatory and repetitive. Contains information related to the payment(s) included in the message.

Message root

MULT.

MESSAGE ELEMENT

XML TAG

[1..1]

+MessageRoot

Group header

INDEX

MULT.

MESSAGE ELEMENT

XML TAG

LHV REQUIREMENT

1.0

[1..1]

+GroupHeader

1.1

[1..1]

++MessageIdentification

<MsgId>

See for idempotency details.

1.2

[1..1]

++CreationDateTime

1.6

[1..1]

++NumberOfTransactions

Number of payments in all Payment Information blocks included in this message. If this number is not correct, the file upload will be cancelled.

1.7

[1..1]

++ControlSum

Control sum of all individual amounts for all Payment Information blocks included in this message, irrespective of currencies. If this number is not correct, the file upload will be cancelled.

1.8

[1..1]

++PaymentTypeInformation

Set of elements used to specify the type of payment.

1.8

[1..1]

+++ServiceLevel

Agreement of rules according to which the payment must be processed. Pre-agreed customer-to-bank conditions apply.

1.8

[1..1]

++++Prtry

<Prtry>

Specifies a pre-agreed service or level of service between the parties, as a proprietary code. Allowed values: INST, SEPA, FAST, ALL - equals as uploaded without interface type. Other values return validation error.

1.8

[1..1]

++InitiatingParty

Party initiating the payment to an agent. In the payment context, this can either be the debtor or a party that initiates the payment on behalf of the debtor or creditor.

1.8

[0..1]

+++Name

<Nm>

Initiating party name.

1.8

[0..1]

+++PostalAddress

1.8

[0..1]

++++TownName

<TwnNm>

Initiating party address town.

1.8

[0..1]

++++Country

<Ctry>

Initiating party address country ISO code.

1.8

[0..1]

+++Identification

<Id>

1.8

{Or

++++OrganisationIdentification

<OrgId>

1.8

{{Or

+++++BICOrBEI

Initiating party BIC code.

1.8

Or}}

+++++Other

<Othr>

1.8

[1..1]

++++++Identification

<Id>

1.8

[0..1]

++++++SchemeName

1.8

[1..1]

+++++++Code

<Cd>

1.8

Or}

++++PrivateIdentification

1.8

{Or

+++++DateAndPlaceOfBirth

1.8

[1..1]

++++++BirthDate

1.8

[1..1]

++++++CityOfBirth

1.8

[1..1]

++++++CountryOfBirth

1.8

Or}

+++++Other

<Othr>

1.8

[1..1]

++++++Identification

<Id>

1.8

[0..1]

++++++SchemeName

1.8

{Or

+++++++Code

<Cd>

1.8

Or}

+++++++Proprietary

<Prtry>

1.8

[0..1]

+++CountryOfResidence

Initiating party country of residence

1.9

[0..1]

++ForwardingAgent

Financial institution that receives the instruction from the initiating party and forwards it to the next agent in the payment chain for execution.

1.9

[1..1]

+++FinancialInstitutionIdentification

1.9

[0..1]

++++BIC

<BIC>

Forwarding agent BIC code.

1.9

[0..1]

++++Name

<Nm>

Forwarding agent name.

1.9

[0..1]

++++PostalAddress

1.9

[0..1]

+++++TownName

<TwnNm>

Forwarding agent address town.

1.9

[0..1]

+++++Country

<Ctry>

Forwarding agent address country ISO code.

Payment information

INDEX

MULT.

MESSAGE ELEMENT

XML TAG

LHV REQUIREMENT

2.0

[1..n]

+PaymentInformation

2.1

[1..1]

++PaymentInformationIdentification

Uniquely identifies the payment information group within this message.

2.2

[1..1]

++PaymentMethod

Only the value TRF (credit transfer) is allowed here. If any other value is entered, it will be ignored.

2.3

[0..1]

++BatchBooking

Not used.

2.4

[1..1]

++NumberOfTransactions

Number of payment included in the current Payment Information block. If this number is not correct, the file upload will be cancelled.

2.5

[1..1]

++ControlSum

Control sum of all individual amounts in the current Payment Information block, irrespective of currencies. If this number is not correct, the file upload will be cancelled.

2.6

[0..1]

++PaymentTypeInformation

2.7

[0..1]

+++InstructionPriority

2.8

[0..1]

+++ServiceLevel

2.9

[1..1]

++++Code

<Cd>

2.11

[0..1]

+++LocalInstrument

2.12

{Or

++++Code

<Cd>

2.13

Or}

++++Proprietary

<Prtry>

Payment priority information. The value here applies to all payments included in the current Payment Information block. See the supported values in .

2.14

[0..1]

+++CategoryPurpose

2.15

[1..1]

++++Code

<Cd>

See the supported values in .

2.17

[1..1]

++Requested Execution Date

Date on which the debtor’s account is debited.

2.19

[1..1]

++Debtor

<Dbtr>

Party from whose account the amount of payment is to be debited. If a different party’s information is entered, it will be ignored.

2.19

[1..1]

+++Name

<Nm>

Debtor’s name. For Virtual IBAN or indirect agent - the holder name (not the master account owner). Debtor name is mandatory if payment is initiated from indirect agent's existing accounts.

2.19

[0..1]

+++PostalAddress

If payment is initiated with indirect agent's existing accounts, following rule applies: (Town Name and Country) or (Country and Address Line) are required.

2.19

[0..1]

++++TownName

<TwnNm>

See rule in PostalAddress.

2.19

[0..1]

++++Country

<Ctry>

Debtor’s country ISO code. For agency banking account - the holder country. See rule in PostalAddress.

2.19

[0..2]

++++AddressLine

Debtor’s address. For agency banking account - the holder address. See rule in PostalAddress.

2.19

[0..1]

+++Identification

<Id>

For Virtual IBAN - do not use

2.19

{Or

++++OrganisationIdentification

<OrgId>

2.19

{{Or

+++++BICOrBEI

Debtor’s BIC or BEI code.

2.19

Or}}

+++++Other

<Othr>

2.19

[1..1]

++++++Identification

<Id>

Organisation’s identification code.

2.19

[0..1]

++++++SchemeName

2.19

[1..1]

+++++++Code

<Cd>

See the supported values in .

2.19

Or}

++++PrivateIdentification

2.19

{Or

+++++DateAndPlaceOfBirth

2.19

[1..1]

++++++BirthDate

Debtor’s birth date.

2.19

[1..1]

++++++CityOfBirth

Debtor’s city of birth.

2.19

[1..1]

++++++CountryOfBirth

Debtor’s birth country ISO code.

2.19

Or}

+++++Other

<Othr>

2.19

[1..1]

++++++Identification

<Id>

Debtor’s identification code.

2.19

[0..1]

++++++SchemeName

2.19

[1..1]

+++++++Code

<Cd>

See the supported values in .

2.20

[1..1]

++DebtorAccount

Debtor’s account. Can be client account where payment amount is debited, Virtual IBAN, or Indirect Agency account (both LHV and client generated accounts).

2.20

[1..1]

+++Identification

<Id>

2.20

{Or

++++IBAN

<IBAN>

Debtor’s IBAN or Virtual IBAN.

2.20

{Or

++++Other

<Othr>

Debtor's non-IBAN account number (for example, UK account number).

2.20

Or}}

+++++Identification

<Id>

Account number.

2.20

[0..1]

+++Currency

<Ccy>

Not required to be filled in. The payment will be made in the currency of the payment amount. If there are not enough funds available on the account, a relevant error message will appear.

2.21

[1..1]

++ DebtorAgent

Debtor’s bank information.

2.21

[1..1]

+++FinancialInstitutionIdentification

2.21

[1..1]

++++BIC

<BIC>

If the LHV BIC is faulty or missing, it will be replaced with the correct code.

2.23

[0..1]

++UltimateDebtor

Used for SEPA payments or Faster Payments Payments Originated Overseas (FPSPOO). Third party acting as the actual owner of the funds or initiating the payment. If ultimate debtor information is filled in at the Payment Information level, it will apply to all payments included in this block. Usage rule: Only to be used if different from the creditor.

2.23

[0..1]

+++Name

<Nm>

Ultimate debtor’s name.

2.23

[0..1]

+++PostalAddress

Ultimate debtor's postal address. In case of FPSPOO, either ultimate debtor town name and country, or country and address line is mandatory.

2.23

[0..1]

++++TownName

<TwnNm>

Ultimate debtor's postal address town. In case of FPSPOO and town name is filled, then country must be filled.

2.23

[0..1]

++++Country

<Ctry>

Ultimate debtor's address country ISO code. In case of FPSPOO, country is mandatory to fill with either town name or address line.

2.23

[0..2]

++++AddressLine

Ultimate debtor’s full postal address (street/road, number of house, town up to 140 characters). In case of FPSPOO and address line is filled, country must be filled.

2.23

[0..1]

+++Identification

<Id>

2.23

{Or

++++OrganisationIdentification

<OrgId>

2.23

{{Or

+++++BICOrBEI

Ultimate debtor’s BIC or BEI code. BIC is mandatory in case of FPSPOO - must be owned by the institution which provides the account to the Ultimate debtor and must be a non GB BIC.

2.23

Or}}

+++++Other

<Othr>

2.23

[1..1]

++++++Identification

<Id>

Organisation’s identification code. Mandatory in case of FPSPOO - referring to Ultimate debtor’s account number and can be in IBAN or in other format.

2.23

[0..1]

++++++SchemeName

2.23

[1..1]

+++++++Code

<Cd>

See the supported values in

2.23

Or}

++++PrivateIdentification

2.23

{Or

+++++DateAndPlaceOfBirth

2.23

[1..1]

++++++BirthDate

Ultimate debtor’s birth date.

2.23

[0..1]

++++++ProvinceOfBirth

Ultimate debtor’s province of birth.

2.23

[1..1]

++++++CityOfBirth

Ultimate debtor’s city of birth.

2.23

[1..1]

++++++CountryOfBirth

Ultimate debtor’s birth country ISO code.

2.23

Or}

+++++Other

<Othr>

2.23

[1..1]

++++++Identification

<Id>

Ultimate debtor’s identification code.

2.23

[0..1]

++++++SchemeName

2.23

[1..1]

+++++++Code

<Cd>

See the supported values in .

2.23

[0..1]

+++CountryOfResidence

Ultimate debtor’s country of residence.

2.24

[0..1]

++ChargesBearer

See the supported values in .

2.25

[0..1]

++ChargesAccount

LHV does not support charge debiting from other than debtor’s account.

2.25

[1..1]

+++Identification

<Id>

2.25

[1..1]

++++IBAN

<IBAN>

2.25

[0..1]

+++Currency

<Ccy>

2.27

[1..n]

++CreditTransferTransactionInformation

<CdtTrfTxInf>

This block contains a set of elements providing information on the payment(s) included in the message.

2.28

[1..1]

+++PaymentIdentification

<PmtId>

2.29

[0..1]

++++InstructionIdentification

Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction.

2.30

[1..1]

++++EndToEndIdentification

Unique identification assigned by the initiating party to unumbiguously identify the transaction.

1.8

[1..1]

+++PaymentTypeInformation

Set of elements used to specify the type of payment.

1.8

[1..1]

++++ServiceLevel

Agreement of rules according to which the payment must be processed. Pre-agreed customer-to-bank conditions apply.

1.8

[1..1]

+++++Prtry

<Prtry>

2.36

[0..1]

++++LocalInstrument

2.37

{Or

+++++Code

<Cd>

2.38

Or}

+++++Proprietary

<Prtry>

Payment priority information. The value here applies to the payment included in the current Credit Transfer Transaction Information block. See the supported values in .

2.39

[0..1]

++++CategoryPurpose

2.40

[1..1]

+++++Code

<Cd>

See the supported values in .

2.42

[1..1]

+++Amount

<Amt>

2.43

{Or

++++InstructedAmount

Payment amount and the currency ordered by the initiating party. All currencies accepted by the bank for payment services are allowed. If there are not enough funds available on the account in a given currency, a relevant error message will appear.

2.44

Or}

++++EquivalentAmount

Not used.

2.51

[0..1]

+++ChargeBearer

See the supported values in .

2.70

[0..1]

+++UltimateDebtor

Used for SEPA payments or Faster Payments Payments Originated Overseas (FPSPOO). Third party acting as the actual owner of the funds or initiating the payment. If ultimate debtor information is filled in at the Credit Transfer Transaction Information level, it will apply only to the current payment. Usage rule: Only to be used if different from the debtor.

2.70

[0..1]

++++Name

<Nm>

Ultimate debtor’s name. Mandatory in case of FPSPOO.

2.70

[0..1]

++++PostalAddress

Ultimate debtor's postal address. In case of FPSPOO, either ultimate debtor town name and country, or country and address line is mandatory.

2.70

[0..1]

+++++TwnNm

<TwnNm>

Ultimate debtor's postal address town. In case of FPSPOO and town name is filled, then country must be filled.

2.70

[0..1]

+++++Ctry

<Ctry>

Ultimate debtor's address country ISO code. In case of FPSPOO, country is mandatory to fill with either town name or address line.

2.70

[0..2]

+++++AdrLine

Ultimate debtor’s full postal address (street/road, number of house, town up to 140 characters). In case of FPSPOO and address line is filled, country must be filled.

2.70

[0..1]

++++Identification

<Id>

2.70

{Or

+++++OrganisationIdentification

<OrgId>

2.70

{{Or

++++++BICOrBEI

Ultimate debtor’s BIC or BEI code. BIC is mandatory in case of FPSPOO - must be owned by the institution which provides the account to the Ultimate debtor and must be a non GB BIC.

2.70

Or}}

++++++Other

<Othr>

2.70

[1..1]

+++++++Identification

<Id>

Organisation’s identification code. Mandatory in case of FPSPOO - referring to Ultimate debtor’s account number and can be in IBAN or in other format.

2.70

[0..1]

+++++++SchemeName

2.70

[1..1]

++++++++Code

<Cd>

See the supported values in .

2.70

Or}

+++++PrivateIdentification

2.70

{Or

++++++DateAndPlaceOfBirth

2.70

[1..1]

+++++++BirthDate

Ultimate debtor’s birth date.

2.70

[0..1]

+++++++ProvinceOfBirth

2.70

[1..1]

+++++++CityOfBirth

Ultimate debtor’s city of birth.

2.70

[1..1]

+++++++CountryOfBirth

Ultimate debtor’s birth country ISO code.

2.70

Or}

++++++Other

<Othr>

2.70

[1..1]

+++++++Identification

<Id>

Ultimate debtor’s identification code.

2.70

[0..1]

+++++++SchemeName

2.70

[1..1]

++++++++Code

<Cd>

See the supported values in .

2.70

[0..1]

++++CountryOfResidence

Ultimate debtor’s country of residence.

2.71

[0..1]

+++IntermediaryAgent1

Information about the creditor’s bank’s correspondent bank. Used for foreign payments.

2.71

[1..1]

++++FinancialInstitutionIdentification

2.71

[0..1]

+++++BIC

<BIC>

Bank’s BIC code.

2.71

[0..1]

+++++ClearingSystemMemberIdentification

2.71

[0..1]

++++++ClearingSystemIdentification

2.71

[1..1]

+++++++Code

<Cd>

For the clearing system’s identification code see the External Code Sets spreadsheet on the ISO website.

2.71

[1..1]

++++++MemberIdentification

<MmbId>

Identification of the creditor's bank's correspondent bank in a clearing system.

2.71

[0..1]

+++++Name

<Nm>

Name of the creditor’s bank’s correspondent bank. Used when the BIC or the clearing system’s member identification is not known to the initiating party.

2.71

[0..1]

+++++PostalAddress

2.71

[0..1]

++++++Country

<Ctry>

Country ISO code of the creditor’s bank’s correspondent bank.

2.71

[0..2]

++++++AddressLine

Country address of the creditor’s bank’s correspondent bank.

2.72

[0..1]

+++IntermediaryAgent1Account

Not used.

2.72

[1..1]

++++Identification

<Id>

2.72

{Or

+++++IBAN

<IBAN>

2.72

Or}

+++++Other

<Othr>

2.72

[1..1]

++++++Identification

<Id>

2.77

[0..1]

+++CreditorAgent

Creditor agent’s information is required for SWIFT payments.

2.77

[1..1]

++++FinancialInstitutionIdentification

2.77

[0..1]

+++++BIC

<BIC>

Creditor’s bank’s BIC.

2.77

[0..1]

+++++ClearingSystemMemberIdentification

2.77

[0..1]

++++++ClearingSystemIdentification

2.77

[1..1]

+++++++Code

<Cd>

For the clearing system’s identification code see the External Code Sets spreadsheet on the ISO website. Use GBDSC when using UK sort code and domestic account nr separately.

2.77

[1..1]

++++++MemberIdentification

<MmbId>

Creditor’s bank identification in a clearing system. Use UK sort code when using UK sort code and domestic account nr separately.

2.77

[0..1]

+++++Name

<Nm>

Creditor's bank name. Usage rule: The name is limited to 70 characters in length. Used when the BIC or the clearing system’s member identification is not known to the initiating party.

2.77

[0..1]

+++++PostalAddress

2.77

[0..1]

++++++Country

<Ctry>

Creditor’s bank’s country ISO code.

2.77

[0..2]

++++++AddressLine

Creditor’s bank’s address.

2.78

[0..1]

+++CreditorAgentAccount

2.78

[1..1]

++++Identification

<Id>

2.78

{Or

+++++IBAN

<IBAN>

2.78

Or}

+++++Other

<Othr>

2.78

[1..1]

++++++Identification

<Id>

2.79

[1..1]

+++Creditor

<Cdtr>

Creditor’s information.

2.79

[1..1]

++++Name

<Nm>

Creditor’s name.

2.79

[0..1]

++++PostalAddress

Creditor’s address.

2.79

[0..1]

+++++Country

<Ctry>

2.79

[0..2]

+++++AddressLine

2.79

[0..1]

++++Identification

<Id>

Creditor’s identification.

2.79

{Or

+++++OrganisationIdentification

<OrgId>

2.79

{{Or

++++++BICOrBEI

Creditor’s BIC or BEI code.

2.79

Or}}

++++++Other

<Othr>

2.79

[1..1]

+++++++Identification

<Id>

Organisation’s identification code.

2.79

[0..1]

+++++++SchemeName

2.79

1..1

++++++++Code

<Cd>

See the supported values in .

2.79

Or}

+++++PrivateIdentification

2.79

{Or

++++++DateAndPlaceOfBirth

2.79

[1..1]

+++++++BirthDate

Creditor’s birth date.

2.79

[1..1]

+++++++CityOfBirth

Creditor’s city of birth.

2.79

[1..1]

+++++++CountryOfBirth

Creditor’s birth country ISO code.

2.79

Or}

++++++Other

<Othr>

2.79

[1..1]

+++++++Identification

<Id>

Creditor’s identification.

2.79

[0..1]

+++++++SchemeName

2.79

[1..1]

++++++++Code

<Cd>

See the supported values in .

2.80

[1..1]

+++CreditorAccount

Creditor’s account.

2.80

[1..1]

++++Identification

<Id>

2.80

{Or

+++++IBAN

<IBAN>

Creditor’s IBAN. Omit for Faster Payments when using UK domestic account nr.

2.80

Or}

+++++Other

<Othr>

2.80

[1..1]

++++++Identification

<Id>

Creditor’s account number. Use for domestic UK account nr - separate from sort code (8 char) or concatenated (14 char)

2.80

[0..1]

++++++SchemeName

2.80

[1..1]

+++++++Code

<Cd>

Use BBAN when using concatenated UK domestic accountr nr (14 characters), omit when using UK account nr and UK sort code separately.

2.81

[0..1]

+++UltimateCreditor

SEPA specific information. Ultimate creditor is the ultimate creditor of the payment.

2.81

[0..1]

++++Name

<Nm>

Ultimate creditor’s name.

2.81

[0..1]

++++Identification

<Id>

2.81

{Or

+++++OrganisationIdentification

<OrgId>

2.81

{{Or

++++++BICOOrBEI

Ultimate creditor’s BIC or BEI.

2.81

Or}}

++++++Other

<Othr>

2.81

[1..1]

+++++++Identification

<Id>

Ultimate creditor’s organisation identification.

2.81

[0..1]

+++++++SchemeName

2.81

[1..1]

++++++++Code

<Cd>

See the supported values in .

2.81

Or}

+++++PrivateIdentification

2.81

{Or

++++++DateAndPlaceOfBirth

2.81

[1..1]

+++++++BirthDate

Ultimate creditor’s birth date.

2.81

[1..1]

+++++++CityOfBirth

Ultimate creditor’s city of birth.

2.81

[1..1]

+++++++CountryOfBirth

Ultimate creditor’s birth country ISO code.

2.81

Or}

++++++Other

<Othr>

2.81

[1..1]

+++++++Identification

<Id>

Ultimate creditor’s identification.

2.81

[0..1]

+++++++SchemeName

2.81

[1..1]

++++++++Code

<Cd>

See the supported values in .

2.85

[0..1]

+++InstructionForDebtorAgent>

<InstrForDbtrAgt

Used for referencing return payment for FPS or SEPA (Inst). Format: 'RTRN:00000002:12345678' where RTRN is code for return; 00000002 is ; 12345678 is Account Servicer Reference of original incoming payment to be returned.

2.86

[0..1]

+++Purpose

<Purp>

SEPA specific information. Reason for the payment.

2.87

[1..1]

++++Code

<Cd>

See the supported codes in .

2.89

[0..10]

+++RegulatoryReporting

Information about the declaration of payments.

2.89

[0..1]

++++Authority

2.89

[0..1]

+++++Country

<Ctry>

2.89

[0..n]

++++Details

<Dtls>

2.89

[0..1]

+++++Type

<Tp>

2.89

[0..1]

+++++Country

<Ctry>

2.89

[0..1]

+++++Code

<Cd>

2.89

[0..1]

+++++Information

<Inf>

Specification of the balance of payment code 900.

2.98

[0..1]

+++RemittanceInformation

Used to enter the payment description (unstructured) and the reference number (structured). It is mandatory to provide one or the other. If both structured and unstructured information is filled in, the creditor reference under the structured information will be lifted to the unstructured information tag in accordance with the EACT standard for unstructured remittance information formatting rules. If the remittance information will, as a result, be longer than 140 characters, the bank will deliver only the first 140 characters of the remittance information. Reference number (structured) must comply with or

2.99

[0..1]

++++Unstructured

<Ustrd>

Payment description is entered here.

2.100

[0..1]

++++Structured

<Strd>

2.120

[0..1]

+++++CreditorReferenceInformation

2.121

[0..1]

++++++Type

<Tp>

2.122

[1..1]

+++++++CodeOrProprietary

2.123

[1..1]

++++++++Code

<Cd>

Only the value SCOR is allowed here. If any other value is entered, it will be ignored.

2.125

[0..1]

+++++++Issuer

<Issr>

2.126

[0..1]

++++++Reference

<Ref>

Payment reference number is entered here. Mandatory for FPS - text value up to 18 symbols long.