Beruflich Dokumente
Kultur Dokumente
PAIN.001.001.03
XML File
Structure
This document is published by Bank of Ireland, and both it, and its contents, are the property of Bank of Ireland.
This document may not be reproduced or further distributed, in whole or in part, without the express written permission of Bank of Ireland.
Page 1 of 28
Code
1.1 Background
3. Fields Types
4. Usage Rules
7. File Name
9. Appendix
28
Page 2 of 28
Code
Document Overview
This document details the PAIN.001.001.03 ISO 20022 XML file format that will be
accepted by Bank of Ireland for SEPA Credit Transfers. This document was compiled
with information from:
Failure to provide files that meet this specification may results in files and/or
transactions being rejected, either by Bank of Ireland or by the beneficiary bank.
1.1 Background
SEPA aims to create a single, integrated and standardised payments market across 33
countries in Europe.
Credit Transfer Originators must be SEPA compliant by 1st February 2014 in order to
continue making electronic non-urgent euro payments (SEPA payments) in Ireland.
Further background information is available on our website: http://bankofireland.com/
SEPA
Bank of Ireland has also published a Credit Transfer Readiness Checklist on the
Bank of Ireland website. To ensure you are aware of the changes required within your
business please visit: http://bankofireland.com/SEPA
Page 3 of 28
Code
Note: Senders must ensure that the content of Identifiers/reference data elements
is restricted to the restricted basic Latin character set (across). If non supported
characters are used in these fields they may lead to rejection of files or transactions in
the payment chain.
0123456789
/?:().,+
ABCDEFGHIJKLMNOPQRSTUVWXYZ
Space
If required, the following characters can also be used in text or information fields only,
but must be provided using the XML representation shown.
Special XML Character
XML Representation
& (ampersand)
&
<
>
(double quotation)
"
(single quotation)
'
Mandatory Fields
End-to-End Identification
Message Identification
Payment Information Identification
Optional Fields
Instruction Identification
Creditor and Debtor Identification
Ultimate Debtor/Creditor Identification
Remittance Information
Proprietary Codes
e.g. AB & C Transport would populate their name in a PAIN.001, appearing as:
<Cdtr>
</Cdtr>
Page 4 of 28
Code
Field Types
4.
The following section details the type of fields that are contained in the specification
document.
For a number of fields usage rules must be followed. These are outlined throughout the
specification and failure to adhere to these usage rules will result in failed payments/
batches/files.
Usage Rules
5.
The following fields are optional to populate and may be populated at payment
information or transaction level
Payment Type Information
Charge Bearer
Page 5 of 28
Code
7.
In the TAG DEPTH column within the file format table below, each of the field name
tags are represented by a +.
File Name
The following rules apply to the file name:
TAG DEPTH
TAG STRUCTURE
1. The file name must contain the following reference PAIN001. This may appear at
the beginning or within the filename.
2. The file extension must be .xml
3. Filename must not exceed 50 characters.
4. Only alphanumeric characters must be used in the filename (preceding the file
extension .xml).
5. Must not contain spaces
<>
Example: 20130628001PAIN001.xml
++
<>
+++
<>
These + icons represent the depth of the field name tag within the document.
For example:
+ would represent a Parent Element
++ would represent the Child Element of the previous Parent Element
It is recommended that a unique file name is used for each file. For example, this can
be achieved by incorporating a date or sequence number of your own choosing.
<>
<>
<>
Page 6 of 28
Code
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
Data
Mandatory
<?xml version=1.0
encoding=UTF-8?>
<Document xmlns=urn:iso:std:iso:
20022:tech:xsd:PAIN.001.001.03
xmlns:xsi=http://www.w3.org/
2001/XMLSchema-instance>
<CstmrDrctDbtInitn>
Mandatory
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
Empty Tag
Mandatory
++
Yes
Mandatory
++
Yes
Mandatory
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 7 of 28
Code
Group Header Block this can only occur once per file
Field Name Tag
(No. references EPC Implementation Guide)
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
++
Yes
Mandatory
++
Yes
Mandatory
Initiating Party Usage Rule: BOI originators must populate the Private ID field with their OIN
1.8 Initiating Party <InitgPty>
++
Empty Tag
Mandatory
+++
Empty Tag
Mandatory
++++
Empty Tag
Mandatory
+++++
Empty Tag
Mandatory
++++++
Yes
Mandatory
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 8 of 28
Code
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
Empty Tag
Mandatory
++
Yes
Mandatory
++
Yes
Mandatory
++
Yes
Optional
++
Yes
Mandatory
++
Yes
Mandatory
Payment Type Information Usage Rule: This is optional and if used, it is recommended to be used at Payment Information level and not at Credit Transfer Transaction Information level. However, if
Instruction Priority is populated this field group must be present at Payment Information level and not at transaction information level.
2.6 Payment Type Information <PmtTpInf>
++
Empty Tag
Optional
+++
Yes
Optional
+++
Empty Tag
Optional
++++
Yes
Optional
+++
Empty Tag
Optional
++++
Yes
Optional
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 9 of 28
Code
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
++++
Yes
Optional
+++
Empty Tag
Optional
++++
Yes
Optional
++++
Yes
Optional
++
Yes
Mandatory
++
Empty Tag
Mandatory
+++
Yes
Mandatory
+++
Empty Tag
Optional
++++
Yes
Optional
Country Code
Format: [A-Z]{2,2}
ISO 3166, Alpha-2
code
++++
Yes
Optional
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 10 of 28
Code
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
Identification Usage Rule This is an optional field, if being used either Organisation Identification or Private Identification is to be populated
2.19 Identification <Id>
+++
Empty Tag
Optional
Originator ID Code
Organisation Identification Usage Rule: Either BIC or BEI or one occurrence of Other is allowed.
2.19 Organisation Identification <OrgId>
++++
Empty Tag
Optional
+++++
Yes
Optional
+++++
Empty Tag
Optional
Unique identification of an
organisation, as assigned by an
institution, using an identification
scheme.
++++++
Yes
Optional
Identification assigned by an
institution.
++++++
No
Optional
+++++++
Yes
Optional
+++++++
Yes
Optional
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 11 of 28
Code
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
++++++
Yes
Optional
Private Identification Usage Rule: Either Date and Place of Birth or one occurrence of Other is allowed
2.19 Private Identification <PrvtId>
++++
Empty Tag
Optional
+++++
Empty Tag
Optional
++++++
Yes
Optional
++++++
Yes
Optional
++++++
Yes
Optional
++++++
Yes
Optional
+++++
Empty Tag
Optional
++++++
Yes
Optional
++++++
No
Optional
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 12 of 28
Code
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
+++++++
Yes
Optional
+++++++
Yes
Optional
++++++
Yes
Optional
++
Empty Tag
Mandatory
N/A
+++
Empty Tag
Mandatory
++++
Yes
Mandatory
+++
Yes
Optional
Currency Code
Format: [A-Z]{3,3}
Valid active or historic currency codes
are registered with the ISO 4217
++
Empty Tag
Mandatory
+++
Empty Tag
Mandatory
++++
Yes
Mandatory
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 13 of 28
Code
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
Ultimate Debtor Usage Rule Ultimate Debtor is an optional field, if used can be populated at either payment information (batch) or transaction level
2.23 Ultimate Debtor <UltmtDbtr>
++
Empty Tag
Optional
+++
Yes
Optional
+++
Empty Tag
Optional
Organisation Identification Usage Rule: Either BIC or BEI or one occurrence of Other is allowed.
2.23 Organisation Identification <OrgId>
++++
Empty Tag
Optional
+++++
Yes
Optional
+++++
Empty Tag
Optional
++++++
Yes
Optional
++++++
No
Optional
+++++++
Yes
Optional
++++
Empty Tag
Optional
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 14 of 28
Code
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
+++++++
Yes
Optional
++++++
Yes
Optional
Private Identification Usage Rule: Either Date and Place of Birth or one occurrence of Other is allowed
2.23 Private Identification <PrvtId>
++++
Empty Tag
Optional
+++++
Empty Tag
Optional
++++++
Yes
Optional
++++++
Yes
Optional
++++++
Yes
Optional
++++++
Yes
Optional
+++++
Empty Tag
Optional
++++++
Yes
Optional
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 15 of 28
Code
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
++++++
No
Optional
+++++++
Yes
Optional
+++++++
Yes
Optional
++++++
Yes
Optional
Charge Bearer Usage Rule: Charge Bearer is optional and if used can be populated at payment information (recommended) or transaction level
2.24 Charge Bearer <ChrgBr>
++
Yes
Advise to populate
at pymt info level
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 16 of 28
Code
Credit Transfer Transaction Information Definition: Set of elements used to provide information on the individual transaction(s) included in the message
Field Name Tag
(No. references EPC Implementation Guide)
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
++
Empty Tag
Mandatory
+++
Empty Tag
Mandatory
++++
Yes
Optional
++++
Yes
Mandatory
Payment Type Information Usage Rule: This is optional and if used, it is recommended to be used at Payment Information level and not at Credit Transfer Transaction Information level. However, if
Instruction Priority is populated this field group must be present at Payment Information level and not at transaction information level.
2.31 Payment Type Information <PmtTpInf>
++
Empty Tag
Advise to populate
at pymt info level
+++
Empty Tag
Advise to populate
at pymt info level
++++
Yes
Advise to populate
at pymt info level
+++
Empty Tag
Advise to populate
at pymt info level
++++
Yes
Advise to populate
at pymt info level
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 17 of 28
Code
Credit Transfer Transaction Information Definition: Set of elements used to provide information on the individual transaction(s) included in the message
Field Name Tag
(No. references EPC Implementation Guide)
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
++++
Yes
Advise to populate
at pymt info level
Category Purpose Usage Rule: Depending on the agreement between the Originator and the Originator Bank, Category Purpose may be forwarded to the Beneficiary Bank
2.39 Category Purpose <CtgyPurp>
+++
Empty Tag
Advise to populate
at pymt info level
++++
Yes
Advise to populate
at pymt info level
++++
Yes
Advise to populate
at pymt info level
+++
Empty Tag
Mandatory
++++
Yes
Mandatory
Charge Bearer Usage Rule: Charge Bearer is optional and if used can be populated at payment information (recommended) or transaction level
2.51 Charge Bearer <ChrgBr>
+++
Yes
Advise to populate
at pymt info level
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 18 of 28
Code
Credit Transfer Transaction Information Definition: Set of elements used to provide information on the individual transaction(s) included in the message
Field Name Tag
(No. references EPC Implementation Guide)
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
Ultimate Debtor Usage Rule Ultimate Debtor is an optional field, if used can be populated at either payment information (batch) or transaction level
2.70 Ultimate Debtor <UltmtDbtr>
+++
Empty Tag
Optional
++++
Yes
Optional
Identification assigned by an
institution
+++
Empty Tag
Optional
Organisation Identification Usage Rule: Either BIC or BEI or one occurrence of Other is allowed.
2.70 Organisation Identification <OrgId>
++++
Empty Tag
Optional
+++++
Yes
Optional
+++++
Empty Tag
Optional
++++++
Yes
Optional
++++++
No
Optional
+++++++
Yes
Optional
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 19 of 28
Code
Credit Transfer Transaction Information Definition: Set of elements used to provide information on the individual transaction(s) included in the message
Field Name Tag
(No. references EPC Implementation Guide)
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
+++++++
Yes
Optional
++++++
Yes
Optional
Private Identification Usage Rule: Either Date and Place of Birth or one occurrence of Other is allowed
2.70 Private Identification <PrvtId>
++++
Empty Tag
Optional
+++++
Empty Tag
Optional
++++++
Yes
Optional
++++++
Yes
Optional
++++++
Yes
Optional
++++++
Yes
Optional
+++++
Empty Tag
Optional
++++++
Yes
Optional
Identification assigned by an
institution
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 20 of 28
Code
Credit Transfer Transaction Information Definition: Set of elements used to provide information on the individual transaction(s) included in the message
Field Name Tag
(No. references EPC Implementation Guide)
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
++++++
No
Optional
+++++++
Yes
Optional
+++++++
Yes
Optional
++++++
Yes
Optional
+++
Empty Tag
Mandatory
++++
Empty Tag
Mandatory
+++++
Yes
Mandatory
+++
Empty Tag
Mandatory
++++
Yes
Mandatory
++++
Empty Tag
Optional
+++++
Yes
Optional
Country Code
Format: [A-Z]{2,2}
ISO 3166, Alpha-2
code
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 21 of 28
Code
Credit Transfer Transaction Information Definition: Set of elements used to provide information on the individual transaction(s) included in the message
Field Name Tag
(No. references EPC Implementation Guide)
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
+++++
Yes
Optional
Identification Usage Rule This is an optional field group, if being used either Organisation Identification or Private Identification is to be populated
2.79 Identification <Id>
++++
Empty Tag
Optional
Organisation Identification Usage Rule: Either BIC or BEI or one occurrence of Other is allowed.
2.79 Organisation Identification <OrgId>
++++
Empty Tag
Optional
+++++
Yes
Optional
+++++
Empty Tag
Optional
++++++
Yes
Optional
++++++
No
Optional
+++++++
Yes
+++++++
Yes
Identification assigned by an
institution
Optional
Optional
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 22 of 28
Code
Credit Transfer Transaction Information Definition: Set of elements used to provide information on the individual transaction(s) included in the message
Field Name Tag
(No. references EPC Implementation Guide)
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
++++++
Yes
Optional
Private Identification Usage Rule: Either Date and Place of Birth or one occurrence of Other is allowed
2.79 Private Identification <PrvtId>
++++
Empty Tag
Optional
+++++
Empty Tag
Optional
++++++
Yes
Optional
++++++
Yes
Optional
++++++
Yes
Optional
++++++
Yes
Optional
+++++
Empty Tag
Optional
++++++
Yes
Optional
Identification assigned by an
institution
++++++
No
Optional
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 23 of 28
Code
Credit Transfer Transaction Information Definition: Set of elements used to provide information on the individual transaction(s) included in the message
Field Name Tag
(No. references EPC Implementation Guide)
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
+++++++
Yes
Optional
+++++++
Yes
Optional
++++++
Yes
Optional
+++
Empty Tag
Mandatory
++++
Empty Tag
Optional
+++++
Yes
Mandatory
+++
Empty Tag
Optional
++++
Yes
Optional
Identification Usage Rule This field is optional, if being used either Organisation Identification or Private Identification is to be populated
2.81 Identification <Id>
++++
Empty Tag
Optional
Organisation Identification Usage Rule: Either BIC or BEI or one occurrence of Other is allowed.
2.81 Organisation Identification <OrgId>
+++++
Empty Tag
Optional
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 24 of 28
Code
Credit Transfer Transaction Information Definition: Set of elements used to provide information on the individual transaction(s) included in the message
Field Name Tag
(No. references EPC Implementation Guide)
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
++++++
Yes
Optional
++++++
Empty Tag
Optional
+++++++
Yes
Optional
Identification assigned by an
institution
+++++++
No
Optional
+++++++
+
Yes
Optional
+++++++
+
Yes
Optional
+++++++
Yes
Optional
Private Identification Usage Rule: Either Date and Place of Birth or one occurrence of Other is allowed
2.81 Private Identification <PrvtId>
+++++
Empty Tag
Optional
++++++
Empty Tag
Optional
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 25 of 28
Code
Credit Transfer Transaction Information Definition: Set of elements used to provide information on the individual transaction(s) included in the message
Field Name Tag
(No. references EPC Implementation Guide)
Tag Level
Content
Mandatory/
Optional/
Conditional
Description
+++++++
Yes
Optional
+++++++
Yes
Optional
+++++++
Yes
Optional
+++++++
Yes
Optional
++++++
Empty Tag
Optional
+++++++
Yes
Optional
Identification assigned by an
institution
+++++++
No
Optional
+++++++
+
Yes
Optional
+++++++
+
Yes
Optional
+++++++
Yes
Optional
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 26 of 28
Code
Credit Transfer Transaction Information Definition: Set of elements used to provide information on the individual transaction(s) included in the message
Field Name Tag
(No. references EPC Implementation Guide)
Tag Level
Content
Mandatory/
Optional/
Conditional
+++
Empty Tag
Optional
++++
Yes
Optional
Description
Remittance Information Usage Rule: Optional field, either 1 instance of Structured or 1 instance of Unstructured, may be used
2.98 Remittance Information <RmtInf>
+++
Empty Tag
Optional
++++
Yes
Optional
++++
Yes
Optional
+++++
Empty Tag
Optional
++++++
Empty Tag
Optional
+++++++
Empty Tag
Optional
+++++++
+
Yes
Optional
+++++++
Yes
Optional
++++++
Yes
Optional
Mandatory Fields
Optional Fields
Payment Information (Batch)/Transaction Level
Page 27 of 28
Code
Disclaimer: This document is for information purposes only and no guarantee or warranty is given in respect of the accuracy or completeness of this document,
or its content, which are subject to change. Bank of Ireland accepts no liability for any losses howsoever arising in reliance on this document or its content.
Page 28 of 28
Code