Request payment status verification
- 17 Sep 2024
- 140 Minutes to read
- Print
- DarkLight
Request payment status verification
- Updated on 17 Sep 2024
- 140 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/pacs028/v01
Creates a request to verify the status of a payment using the pacs.028.001.01 message format.
Header parameters
X-Client-Id
stringRequired
Client ID header
SCA-Token
stringRequired
JWT token for payload validation
Body parameters
object
Document following ISO20022 pacs.028.001.01 rules
fitoFIPmtStsReq
object (FIToFIPaymentStatusRequestV01)
Scope The FinancialInstitutionToFinancialInstitutionPaymentStatusRequest message is sent by the debtor agent to the creditor agent, directly or through other agents and/or a payment clearing and settlement system. It is used to request a FIToFIPaymentStatusReport message containing information on the status of a previously sent instruction. Usage The FIToFIPaymentStatusRequest message is exchanged between agents to request status information about instructions previously sent. Its usage will always be governed by a bilateral agreement between the agents. The FIToFIPaymentStatusRequest message can be used to request information about the status (e.g. rejection, acceptance) of a credit transfer instruction, a direct debit instruction, as well as other intra-agent instructions (for example FIToFIPaymentCancellationRequest). The FIToFIPaymentStatusRequest message refers to the original instruction(s) by means of references only or by means of references and a set of elements from the original instruction. The FIToFIPaymentStatusRequest message can be used in domestic and cross-border scenarios.
grpHdr
object (GroupHeader53) Required
Set of characteristics shared by all individual transactions included in the message.
msgId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
creDtTm
string Required
a particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. note on the time format:
- beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
- fractions of second in time format decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
instgAgt
object (BranchAndFinancialInstitutionIdentification5)
Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
finInstnId
object (FinancialInstitutionIdentification8) Required
Set of elements used to identify a financial institution.
BICFI
string
Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
object
cd
string Required
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length5
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
brnchId
object (BranchData2)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
instdAgt
object (BranchAndFinancialInstitutionIdentification5)
Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
finInstnId
object (FinancialInstitutionIdentification8) Required
Set of elements used to identify a financial institution.
BICFI
string
Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
object
cd
string Required
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length5
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
brnchId
object (BranchData2)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
orgnlGrpInf
Array of object (OriginalGroupInformation27)
Original group information concerning the group of transactions, to which the status request message refers to.
object
Set of elements used to provide information on the original group, to which the message refers.
orgnlMsgId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
orgnlMsgNmId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
orgnlCreDtTm
string
a particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. note on the time format:
- beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
- fractions of second in time format decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
orgnlNbOfTxs
string
Specifies a numeric string with a maximum length of 15 digits.
Pattern[0-9]{1,15}
orgnlCtrlSum
number
Number of objects represented as a decimal number, for example 0.75 or 45.6.
Maximum9.99999999999999999
txInf
Array of object (PaymentTransaction73)
Information concerning the original transaction, to which the status request message refers.
object
Provides further details on the original transactions, to which the status report message refers.
stsReqId
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
orgnlGrpInf
object (OriginalGroupInformation3)
Unique and unambiguous identifier of the group of transactions as assigned by the original instructing party.
orgnlMsgId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
orgnlMsgNmId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
orgnlCreDtTm
string
a particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. note on the time format:
- beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
- fractions of second in time format decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
orgnlInstrId
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
orgnlEndToEndId
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
orgnlTxId
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
accptncDtTm
string
a particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. note on the time format:
- beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
- fractions of second in time format decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
clrSysRef
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
instgAgt
object (BranchAndFinancialInstitutionIdentification5)
Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
finInstnId
object (FinancialInstitutionIdentification8) Required
Set of elements used to identify a financial institution.
BICFI
string
Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
object
cd
string Required
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length5
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
brnchId
object (BranchData2)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
instdAgt
object (BranchAndFinancialInstitutionIdentification5)
Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
finInstnId
object (FinancialInstitutionIdentification8) Required
Set of elements used to identify a financial institution.
BICFI
string
Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
object
cd
string Required
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length5
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
brnchId
object (BranchData2)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
orgnlTxRef
object (OriginalTransactionReference24)
Key elements used to refer the original transaction.
intrBkSttlmAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
amt
object (AmountType4Choice)
Specifies the amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
OneOf
object
instdAmt
object (ActiveOrHistoricCurrencyAndAmount) Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
object
eqvtAmt
object (EquivalentAmount2) Required
Amount of money to be moved between the debtor and creditor, expressed in the currency of the debtor's account, and the currency in which the amount is to be moved.
amt
object (ActiveOrHistoricCurrencyAndAmount) Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
ccyOfTrf
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
intrBkSttlmDt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
reqdColltnDt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
reqdExctnDt
object (DateAndDateTimeChoice)
Choice between a date or a date and time format.
OneOf
object
dt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
object
dtTm
string Required
a particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. note on the time format:
- beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
- fractions of second in time format decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
cdtrSchmeId
object (PartyIdentification43)
Set of elements used to identify a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
id
object (Party11Choice)
Nature or use of the account.
OneOf
object
orgId
object (OrganisationIdentification8) Required
Unique and unambiguous way to identify an organisation.
anyBIC
string
Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
othr
Array of object (GenericOrganisationIdentification1)
Unique identification of an organisation, as assigned by an institution, using an identification scheme.
object
Information related to an identification of an organisation.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (OrganisationIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external organisation identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
object
prvtId
object (PersonIdentification5) Required
Unique and unambiguous way to identify a person.
dtAndPlcOfBirth
object (DateAndPlaceOfBirth)
Date and place of birth of a person.
birthDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
prvcOfBirth
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
cityOfBirth
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfBirth
string Required
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
othr
Array of object (GenericPersonIdentification1)
Unique identification of a person, as assigned by an institution, using an identification scheme.
object
Information related to an identification of a person.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (PersonIdentificationSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external person identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfRes
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
ctctDtls
object (ContactDetails2)
Communication device number or electronic address used for communication.
nmPrfx
string
Specifies the terms used to formally address a person.
Valid values[ "DOCT", "MIST", "MISS", "MADM" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Min length1
Max length2048
othr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
sttlmInf
object (SettlementInstruction4)
Provides further details on the settlement of the instruction.
sttlmMtd
string Required
Specifies the method used to settle the credit transfer instruction.
Valid values[ "INDA", "INGA", "COVE", "CLRG" ]
sttlmAcct
object (CashAccount24)
Provides the details to identify an account.
id
object (AccountIdentification4Choice) Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
object
IBAN
string Required
The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard "Banking and related financial services - International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard.
Pattern[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
object
othr
object (GenericAccountIdentification1) Required
Information related to a generic account identification.
id
string Required
Specifies a character string with a maximum length of 34 characters.
Min length1
Max length34
schmeNm
object (AccountSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
object
cd
string Required
Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
clrSys
object (ClearingSystemIdentification3Choice)
Specifies the clearing system identification.
OneOf
object
cd
string Required
Specifies the cash clearing system, as published in an external cash clearing system code list. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length3
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
instgRmbrsmntAgt
object (BranchAndFinancialInstitutionIdentification5)
Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
finInstnId
object (FinancialInstitutionIdentification8) Required
Set of elements used to identify a financial institution.
BICFI
string
Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
object
cd
string Required
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length5
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
brnchId
object (BranchData2)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
instgRmbrsmntAgtAcct
object (CashAccount24)
Provides the details to identify an account.
id
object (AccountIdentification4Choice) Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
object
IBAN
string Required
The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard "Banking and related financial services - International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard.
Pattern[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
object
othr
object (GenericAccountIdentification1) Required
Information related to a generic account identification.
id
string Required
Specifies a character string with a maximum length of 34 characters.
Min length1
Max length34
schmeNm
object (AccountSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
object
cd
string Required
Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
instdRmbrsmntAgt
object (BranchAndFinancialInstitutionIdentification5)
Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
finInstnId
object (FinancialInstitutionIdentification8) Required
Set of elements used to identify a financial institution.
BICFI
string
Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
object
cd
string Required
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length5
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
brnchId
object (BranchData2)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
instdRmbrsmntAgtAcct
object (CashAccount24)
Provides the details to identify an account.
id
object (AccountIdentification4Choice) Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
object
IBAN
string Required
The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard "Banking and related financial services - International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard.
Pattern[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
object
othr
object (GenericAccountIdentification1) Required
Information related to a generic account identification.
id
string Required
Specifies a character string with a maximum length of 34 characters.
Min length1
Max length34
schmeNm
object (AccountSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
object
cd
string Required
Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
thrdRmbrsmntAgt
object (BranchAndFinancialInstitutionIdentification5)
Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
finInstnId
object (FinancialInstitutionIdentification8) Required
Set of elements used to identify a financial institution.
BICFI
string
Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
object
cd
string Required
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length5
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
brnchId
object (BranchData2)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
thrdRmbrsmntAgtAcct
object (CashAccount24)
Provides the details to identify an account.
id
object (AccountIdentification4Choice) Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
object
IBAN
string Required
The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard "Banking and related financial services - International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard.
Pattern[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
object
othr
object (GenericAccountIdentification1) Required
Information related to a generic account identification.
id
string Required
Specifies a character string with a maximum length of 34 characters.
Min length1
Max length34
schmeNm
object (AccountSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
object
cd
string Required
Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
pmtTpInf
object (PaymentTypeInformation25)
Set of elements used to provide further details of the type of payment.
instrPrty
string
Specifies the priority level of an event.
Valid values[ "HIGH", "NORM" ]
clrChanl
string
Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.
Valid values[ "RTGS", "RTNS", "MPNS", "BOOK" ]
svcLvl
object (ServiceLevel8Choice)
Specifies the service level of the transaction.
OneOf
object
cd
string Required
Specifies the external service level code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
lclInstrm
object (LocalInstrument2Choice)
Set of elements that further identifies the type of local instruments being requested by the initiating party.
OneOf
object
cd
string Required
Specifies the external local instrument code in the format of character string with a maximum length of 35 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length35
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
seqTp
string
Specifies the type of the current transaction that belongs to a sequence of transactions.
Valid values[ "FRST", "RCUR", "FNAL", "OOFF", "RPRE" ]
ctgyPurp
object (CategoryPurpose1Choice)
specifies the high level purpose of the instruction based on a set of pre-defined categories. usage: This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain.
OneOf
object
cd
string Required
Specifies the category purpose, as published in an external category purpose code list. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
pmtMtd
string
Specifies the transfer method that will be used to transfer an amount of money.
Valid values[ "CHK", "TRF", "DD", "TRA" ]
mndtRltdInf
object (MandateRelatedInformation11)
Provides further details related to a direct debit mandate signed between the creditor and the debtor.
mndtId
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
dtOfSgntr
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
amdmntInd
A flag indicating a True or False value.
OneOf
boolean
boolean
integer
integer
Minimum0
Maximum1
amdmntInfDtls
object (AmendmentInformationDetails11)
Provides further details on the list of direct debit mandate elements that have been modified when the amendment indicator has been set.
orgnlMndtId
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
orgnlCdtrSchmeId
object (PartyIdentification43)
Set of elements used to identify a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
id
object (Party11Choice)
Nature or use of the account.
OneOf
object
orgId
object (OrganisationIdentification8) Required
Unique and unambiguous way to identify an organisation.
anyBIC
string
Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
othr
Array of object (GenericOrganisationIdentification1)
Unique identification of an organisation, as assigned by an institution, using an identification scheme.
object
Information related to an identification of an organisation.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (OrganisationIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external organisation identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
object
prvtId
object (PersonIdentification5) Required
Unique and unambiguous way to identify a person.
dtAndPlcOfBirth
object (DateAndPlaceOfBirth)
Date and place of birth of a person.
birthDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
prvcOfBirth
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
cityOfBirth
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfBirth
string Required
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
othr
Array of object (GenericPersonIdentification1)
Unique identification of a person, as assigned by an institution, using an identification scheme.
object
Information related to an identification of a person.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (PersonIdentificationSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external person identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfRes
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
ctctDtls
object (ContactDetails2)
Communication device number or electronic address used for communication.
nmPrfx
string
Specifies the terms used to formally address a person.
Valid values[ "DOCT", "MIST", "MISS", "MADM" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Min length1
Max length2048
othr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
orgnlCdtrAgt
object (BranchAndFinancialInstitutionIdentification5)
Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
finInstnId
object (FinancialInstitutionIdentification8) Required
Set of elements used to identify a financial institution.
BICFI
string
Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
object
cd
string Required
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length5
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
brnchId
object (BranchData2)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
orgnlCdtrAgtAcct
object (CashAccount24)
Provides the details to identify an account.
id
object (AccountIdentification4Choice) Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
object
IBAN
string Required
The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard "Banking and related financial services - International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard.
Pattern[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
object
othr
object (GenericAccountIdentification1) Required
Information related to a generic account identification.
id
string Required
Specifies a character string with a maximum length of 34 characters.
Min length1
Max length34
schmeNm
object (AccountSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
object
cd
string Required
Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
orgnlDbtr
object (PartyIdentification43)
Set of elements used to identify a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
id
object (Party11Choice)
Nature or use of the account.
OneOf
object
orgId
object (OrganisationIdentification8) Required
Unique and unambiguous way to identify an organisation.
anyBIC
string
Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
othr
Array of object (GenericOrganisationIdentification1)
Unique identification of an organisation, as assigned by an institution, using an identification scheme.
object
Information related to an identification of an organisation.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (OrganisationIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external organisation identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
object
prvtId
object (PersonIdentification5) Required
Unique and unambiguous way to identify a person.
dtAndPlcOfBirth
object (DateAndPlaceOfBirth)
Date and place of birth of a person.
birthDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
prvcOfBirth
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
cityOfBirth
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfBirth
string Required
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
othr
Array of object (GenericPersonIdentification1)
Unique identification of a person, as assigned by an institution, using an identification scheme.
object
Information related to an identification of a person.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (PersonIdentificationSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external person identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfRes
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
ctctDtls
object (ContactDetails2)
Communication device number or electronic address used for communication.
nmPrfx
string
Specifies the terms used to formally address a person.
Valid values[ "DOCT", "MIST", "MISS", "MADM" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Min length1
Max length2048
othr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
orgnlDbtrAcct
object (CashAccount24)
Provides the details to identify an account.
id
object (AccountIdentification4Choice) Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
object
IBAN
string Required
The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard "Banking and related financial services - International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard.
Pattern[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
object
othr
object (GenericAccountIdentification1) Required
Information related to a generic account identification.
id
string Required
Specifies a character string with a maximum length of 34 characters.
Min length1
Max length34
schmeNm
object (AccountSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
object
cd
string Required
Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
orgnlDbtrAgt
object (BranchAndFinancialInstitutionIdentification5)
Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
finInstnId
object (FinancialInstitutionIdentification8) Required
Set of elements used to identify a financial institution.
BICFI
string
Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
object
cd
string Required
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length5
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
brnchId
object (BranchData2)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
orgnlDbtrAgtAcct
object (CashAccount24)
Provides the details to identify an account.
id
object (AccountIdentification4Choice) Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
object
IBAN
string Required
The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard "Banking and related financial services - International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard.
Pattern[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
object
othr
object (GenericAccountIdentification1) Required
Information related to a generic account identification.
id
string Required
Specifies a character string with a maximum length of 34 characters.
Min length1
Max length34
schmeNm
object (AccountSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
object
cd
string Required
Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
orgnlFnlColltnDt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
orgnlFrqcy
object (Frequency36Choice)
Choice of format for a frequency, for example, the frequency of payment.
OneOf
object
tp
string Required
Specifies the regularity of an event.
Valid values[ "YEAR", "MNTH", "QURT", "MIAN", "WEEK", "DAIL", "ADHO", "INDA", "FRTN" ]
object
prd
object (FrequencyPeriod1) Required
Defines a frequency in terms on counts per period for a specific period type.
tp
string Required
Specifies the regularity of an event.
Valid values[ "YEAR", "MNTH", "QURT", "MIAN", "WEEK", "DAIL", "ADHO", "INDA", "FRTN" ]
cntPerPrd
number Required
Number of objects represented as a decimal number, for example 0.75 or 45.6.
Maximum9.99999999999999999
object
ptInTm
object (FrequencyAndMoment1) Required
Defines a frequency in terms a specific moment within a specified period type.
tp
string Required
Specifies the regularity of an event.
Valid values[ "YEAR", "MNTH", "QURT", "MIAN", "WEEK", "DAIL", "ADHO", "INDA", "FRTN" ]
ptInTm
string Required
Specifies a numeric string with an exact length of 2 digits.
Pattern[0-9]{2}
orgnlRsn
object (MandateSetupReason1Choice)
Specifies the reason for the setup of the mandate.
OneOf
object
cd
string Required
Specifies the external mandate setup reason code in the format of character string with a maximum length of 4 characters. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
orgnlTrckgDays
string
Specifies a numeric string with an exact length of 2 digits.
Pattern[0-9]{2}
elctrncSgntr
string
Specifies a character string with a maximum length of 1025 characters.
Min length1
Max length1025
frstColltnDt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
fnlColltnDt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
frqcy
object (Frequency36Choice)
Choice of format for a frequency, for example, the frequency of payment.
OneOf
object
tp
string Required
Specifies the regularity of an event.
Valid values[ "YEAR", "MNTH", "QURT", "MIAN", "WEEK", "DAIL", "ADHO", "INDA", "FRTN" ]
object
prd
object (FrequencyPeriod1) Required
Defines a frequency in terms on counts per period for a specific period type.
tp
string Required
Specifies the regularity of an event.
Valid values[ "YEAR", "MNTH", "QURT", "MIAN", "WEEK", "DAIL", "ADHO", "INDA", "FRTN" ]
cntPerPrd
number Required
Number of objects represented as a decimal number, for example 0.75 or 45.6.
Maximum9.99999999999999999
object
ptInTm
object (FrequencyAndMoment1) Required
Defines a frequency in terms a specific moment within a specified period type.
tp
string Required
Specifies the regularity of an event.
Valid values[ "YEAR", "MNTH", "QURT", "MIAN", "WEEK", "DAIL", "ADHO", "INDA", "FRTN" ]
ptInTm
string Required
Specifies a numeric string with an exact length of 2 digits.
Pattern[0-9]{2}
rsn
object (MandateSetupReason1Choice)
Specifies the reason for the setup of the mandate.
OneOf
object
cd
string Required
Specifies the external mandate setup reason code in the format of character string with a maximum length of 4 characters. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
trckgDays
string
Specifies a numeric string with an exact length of 2 digits.
Pattern[0-9]{2}
rmtInf
object (RemittanceInformation11)
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system.
ustrd
Array of string (Max140Text)
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
strd
Array of object (StructuredRemittanceInformation13)
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.
object
Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.
rfrdDocInf
Array of object (ReferredDocumentInformation7)
Provides the identification and the content of the referred document.
object
Set of elements used to identify the documents referred to in the remittance information.
tp
object (ReferredDocumentType4)
Specifies the type of the document referred in the remittance information.
cdOrPrtry
object (ReferredDocumentType3Choice) Required
Specifies the type of the document referred in the remittance information.
OneOf
object
cd
string Required
Specifies a type of financial or commercial document.
Valid values[ "MSIN", "CNFA", "DNFA", "CINV", "CREN", "DEBN", "HIRI", "SBIN", "CMCN", "SOAC", "DISP", "BOLD", "VCHR", "AROI", "TSUT", "PUOR" ]
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nb
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
rltdDt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
lineDtls
Array of object (DocumentLineInformation1)
Set of elements used to provide the content of the referred document line.
object
Provides document line information.
id
Array of object (DocumentLineIdentification1) Required
Provides identification of the document line.
Min items1
object
Identifies the documents referred to in the remittance information.
tp
object (DocumentLineType1)
Specifies the type of the document line identification.
cdOrPrtry
object (DocumentLineType1Choice) Required
Specifies the type of the document line identification.
OneOf
object
cd
string Required
Specifies the document line type as published in an external document type code list.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nb
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
rltdDt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
desc
string
Specifies a character string with a maximum length of 2048 characters.
Min length1
Max length2048
amt
object (RemittanceAmount3)
Nature of the amount and currency on a document referred to in the remittance section, typically either the original amount due/payable or the amount actually remitted for the referenced document.
duePyblAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
dscntApldAmt
Array of object (DiscountAmountAndType1)
Amount of discount to be applied to the amount due and payable to the creditor.
object
Specifies the amount with a specific type.
tp
object (DiscountAmountType1Choice)
Specifies the amount type.
OneOf
object
cd
string Required
Specifies the nature, or use, of the amount in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
amt
object (ActiveOrHistoricCurrencyAndAmount) Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
cdtNoteAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
taxAmt
Array of object (TaxAmountAndType1)
Amount of the tax.
object
Specifies the amount with a specific type.
tp
object (TaxAmountType1Choice)
Specifies the amount type.
OneOf
object
cd
string Required
Specifies the nature, or use, of the amount in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
amt
object (ActiveOrHistoricCurrencyAndAmount) Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
adjstmntAmtAndRsn
Array of object (DocumentAdjustment1)
Specifies detailed information on the amount and reason of the adjustment.
object
Set of elements used to provide information on the amount and reason of the document adjustment.
amt
object (ActiveOrHistoricCurrencyAndAmount) Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
cdtDbtInd
string
Specifies if an operation is an increase or a decrease.
Valid values[ "CRDT", "DBIT" ]
rsn
string
Specifies a character string with a maximum length of 4 characters.
Min length1
Max length4
addtlInf
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
rmtdAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
rfrdDocAmt
object (RemittanceAmount2)
Nature of the amount and currency on a document referred to in the remittance section, typically either the original amount due/payable or the amount actually remitted for the referenced document.
duePyblAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
dscntApldAmt
Array of object (DiscountAmountAndType1)
Amount specified for the referred document is the amount of discount to be applied to the amount due and payable to the creditor.
object
Specifies the amount with a specific type.
tp
object (DiscountAmountType1Choice)
Specifies the amount type.
OneOf
object
cd
string Required
Specifies the nature, or use, of the amount in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
amt
object (ActiveOrHistoricCurrencyAndAmount) Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
cdtNoteAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
taxAmt
Array of object (TaxAmountAndType1)
Quantity of cash resulting from the calculation of the tax.
object
Specifies the amount with a specific type.
tp
object (TaxAmountType1Choice)
Specifies the amount type.
OneOf
object
cd
string Required
Specifies the nature, or use, of the amount in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
amt
object (ActiveOrHistoricCurrencyAndAmount) Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
adjstmntAmtAndRsn
Array of object (DocumentAdjustment1)
Specifies detailed information on the amount and reason of the document adjustment.
object
Set of elements used to provide information on the amount and reason of the document adjustment.
amt
object (ActiveOrHistoricCurrencyAndAmount) Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
cdtDbtInd
string
Specifies if an operation is an increase or a decrease.
Valid values[ "CRDT", "DBIT" ]
rsn
string
Specifies a character string with a maximum length of 4 characters.
Min length1
Max length4
addtlInf
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
rmtdAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
cdtrRefInf
object (CreditorReferenceInformation2)
Reference information provided by the creditor to allow the identification of the underlying documents.
tp
object (CreditorReferenceType2)
Specifies the type of creditor reference.
cdOrPrtry
object (CreditorReferenceType1Choice) Required
Specifies the type of document referred by the creditor.
OneOf
object
cd
string Required
Specifies a type of financial or commercial document.
Valid values[ "RADM", "RPIN", "FXDR", "DISP", "PUOR", "SCOR" ]
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ref
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
invcr
object (PartyIdentification43)
Set of elements used to identify a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
id
object (Party11Choice)
Nature or use of the account.
OneOf
object
orgId
object (OrganisationIdentification8) Required
Unique and unambiguous way to identify an organisation.
anyBIC
string
Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
othr
Array of object (GenericOrganisationIdentification1)
Unique identification of an organisation, as assigned by an institution, using an identification scheme.
object
Information related to an identification of an organisation.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (OrganisationIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external organisation identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
object
prvtId
object (PersonIdentification5) Required
Unique and unambiguous way to identify a person.
dtAndPlcOfBirth
object (DateAndPlaceOfBirth)
Date and place of birth of a person.
birthDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
prvcOfBirth
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
cityOfBirth
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfBirth
string Required
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
othr
Array of object (GenericPersonIdentification1)
Unique identification of a person, as assigned by an institution, using an identification scheme.
object
Information related to an identification of a person.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (PersonIdentificationSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external person identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfRes
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
ctctDtls
object (ContactDetails2)
Communication device number or electronic address used for communication.
nmPrfx
string
Specifies the terms used to formally address a person.
Valid values[ "DOCT", "MIST", "MISS", "MADM" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Min length1
Max length2048
othr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
invcee
object (PartyIdentification43)
Set of elements used to identify a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
id
object (Party11Choice)
Nature or use of the account.
OneOf
object
orgId
object (OrganisationIdentification8) Required
Unique and unambiguous way to identify an organisation.
anyBIC
string
Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
othr
Array of object (GenericOrganisationIdentification1)
Unique identification of an organisation, as assigned by an institution, using an identification scheme.
object
Information related to an identification of an organisation.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (OrganisationIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external organisation identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
object
prvtId
object (PersonIdentification5) Required
Unique and unambiguous way to identify a person.
dtAndPlcOfBirth
object (DateAndPlaceOfBirth)
Date and place of birth of a person.
birthDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
prvcOfBirth
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
cityOfBirth
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfBirth
string Required
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
othr
Array of object (GenericPersonIdentification1)
Unique identification of a person, as assigned by an institution, using an identification scheme.
object
Information related to an identification of a person.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (PersonIdentificationSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external person identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfRes
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
ctctDtls
object (ContactDetails2)
Communication device number or electronic address used for communication.
nmPrfx
string
Specifies the terms used to formally address a person.
Valid values[ "DOCT", "MIST", "MISS", "MADM" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Min length1
Max length2048
othr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
taxRmt
object (TaxInformation4)
Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.
cdtr
object (TaxParty1)
Details about the entity involved in the tax paid or to be paid.
taxId
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
regnId
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
taxTp
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
dbtr
object (TaxParty2)
Details about the entity involved in the tax paid or to be paid.
taxId
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
regnId
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
taxTp
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
authstn
object (TaxAuthorisation1)
Details of the authorised tax paying party.
titl
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
ultmtDbtr
object (TaxParty2)
Details about the entity involved in the tax paid or to be paid.
taxId
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
regnId
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
taxTp
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
authstn
object (TaxAuthorisation1)
Details of the authorised tax paying party.
titl
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
admstnZone
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
refNb
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
mtd
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ttlTaxblBaseAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
ttlTaxAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
dt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
seqNb
integer
Number of objects represented as an integer.
Maximum999999999999999999
rcrd
Array of object (TaxRecord1)
Record of tax details.
object
Set of elements used to define the tax record.
tp
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctgy
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctgyDtls
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
dbtrSts
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
certId
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
frmsCd
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
prd
object (TaxPeriod1)
Period of time details related to the tax payment.
yr
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
tp
string
Specifies the period related to the tax payment.
Valid values[ "MM01", "MM02", "MM03", "MM04", "MM05", "MM06", "MM07", "MM08", "MM09", "MM10", "MM11", "MM12", "QTR1", "QTR2", "QTR3", "QTR4", "HLF1", "HLF2" ]
frToDt
object (DatePeriodDetails)
Range of time defined by a start date and an end date.
frDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
toDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
taxAmt
object (TaxAmount1)
Set of elements used to provide information on the tax amount(s) of tax record.
rate
number
Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%.
Maximum9.9999999999
taxblBaseAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
ttlAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
dtls
Array of object (TaxRecordDetails1)
Set of elements used to provide details on the tax period and amount.
object
Provides information on the individual tax amount(s) per period of the tax record.
prd
object (TaxPeriod1)
Period of time details related to the tax payment.
yr
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
tp
string
Specifies the period related to the tax payment.
Valid values[ "MM01", "MM02", "MM03", "MM04", "MM05", "MM06", "MM07", "MM08", "MM09", "MM10", "MM11", "MM12", "QTR1", "QTR2", "QTR3", "QTR4", "HLF1", "HLF2" ]
frToDt
object (DatePeriodDetails)
Range of time defined by a start date and an end date.
frDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
toDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
amt
object (ActiveOrHistoricCurrencyAndAmount) Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
addtlInf
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
grnshmtRmt
object (Garnishment1)
Provides remittance information about a payment for garnishment-related purposes.
tp
object (GarnishmentType1) Required
Specifies the type of garnishment.
cdOrPrtry
object (GarnishmentType1Choice) Required
Specifies the type of garnishment.
OneOf
object
cd
string Required
Specifies the garnishment type as published in an external document type code list.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
grnshee
object (PartyIdentification43)
Set of elements used to identify a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
id
object (Party11Choice)
Nature or use of the account.
OneOf
object
orgId
object (OrganisationIdentification8) Required
Unique and unambiguous way to identify an organisation.
anyBIC
string
Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
othr
Array of object (GenericOrganisationIdentification1)
Unique identification of an organisation, as assigned by an institution, using an identification scheme.
object
Information related to an identification of an organisation.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (OrganisationIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external organisation identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
object
prvtId
object (PersonIdentification5) Required
Unique and unambiguous way to identify a person.
dtAndPlcOfBirth
object (DateAndPlaceOfBirth)
Date and place of birth of a person.
birthDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
prvcOfBirth
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
cityOfBirth
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfBirth
string Required
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
othr
Array of object (GenericPersonIdentification1)
Unique identification of a person, as assigned by an institution, using an identification scheme.
object
Information related to an identification of a person.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (PersonIdentificationSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external person identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfRes
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
ctctDtls
object (ContactDetails2)
Communication device number or electronic address used for communication.
nmPrfx
string
Specifies the terms used to formally address a person.
Valid values[ "DOCT", "MIST", "MISS", "MADM" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Min length1
Max length2048
othr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
grnshmtAdmstr
object (PartyIdentification43)
Set of elements used to identify a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
id
object (Party11Choice)
Nature or use of the account.
OneOf
object
orgId
object (OrganisationIdentification8) Required
Unique and unambiguous way to identify an organisation.
anyBIC
string
Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
othr
Array of object (GenericOrganisationIdentification1)
Unique identification of an organisation, as assigned by an institution, using an identification scheme.
object
Information related to an identification of an organisation.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (OrganisationIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external organisation identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
object
prvtId
object (PersonIdentification5) Required
Unique and unambiguous way to identify a person.
dtAndPlcOfBirth
object (DateAndPlaceOfBirth)
Date and place of birth of a person.
birthDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
prvcOfBirth
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
cityOfBirth
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfBirth
string Required
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
othr
Array of object (GenericPersonIdentification1)
Unique identification of a person, as assigned by an institution, using an identification scheme.
object
Information related to an identification of a person.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (PersonIdentificationSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external person identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfRes
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
ctctDtls
object (ContactDetails2)
Communication device number or electronic address used for communication.
nmPrfx
string
Specifies the terms used to formally address a person.
Valid values[ "DOCT", "MIST", "MISS", "MADM" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Min length1
Max length2048
othr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
refNb
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
dt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
rmtdAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Minimum0
Maximum9999999999999.99999
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
fmlyMdclInsrncInd
A flag indicating a True or False value.
OneOf
boolean
boolean
integer
integer
Minimum0
Maximum1
mplyeeTermntnInd
A flag indicating a True or False value.
OneOf
boolean
boolean
integer
integer
Minimum0
Maximum1
addtlRmtInf
Array of string (Max140Text)
Additional information, in free text form, to complement the structured remittance information.
Max items3
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
ultmtDbtr
object (PartyIdentification43)
Set of elements used to identify a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
id
object (Party11Choice)
Nature or use of the account.
OneOf
object
orgId
object (OrganisationIdentification8) Required
Unique and unambiguous way to identify an organisation.
anyBIC
string
Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
othr
Array of object (GenericOrganisationIdentification1)
Unique identification of an organisation, as assigned by an institution, using an identification scheme.
object
Information related to an identification of an organisation.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (OrganisationIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external organisation identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
object
prvtId
object (PersonIdentification5) Required
Unique and unambiguous way to identify a person.
dtAndPlcOfBirth
object (DateAndPlaceOfBirth)
Date and place of birth of a person.
birthDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
prvcOfBirth
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
cityOfBirth
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfBirth
string Required
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
othr
Array of object (GenericPersonIdentification1)
Unique identification of a person, as assigned by an institution, using an identification scheme.
object
Information related to an identification of a person.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (PersonIdentificationSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external person identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfRes
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
ctctDtls
object (ContactDetails2)
Communication device number or electronic address used for communication.
nmPrfx
string
Specifies the terms used to formally address a person.
Valid values[ "DOCT", "MIST", "MISS", "MADM" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Min length1
Max length2048
othr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
dbtr
object (PartyIdentification43)
Set of elements used to identify a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
id
object (Party11Choice)
Nature or use of the account.
OneOf
object
orgId
object (OrganisationIdentification8) Required
Unique and unambiguous way to identify an organisation.
anyBIC
string
Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
othr
Array of object (GenericOrganisationIdentification1)
Unique identification of an organisation, as assigned by an institution, using an identification scheme.
object
Information related to an identification of an organisation.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (OrganisationIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external organisation identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
object
prvtId
object (PersonIdentification5) Required
Unique and unambiguous way to identify a person.
dtAndPlcOfBirth
object (DateAndPlaceOfBirth)
Date and place of birth of a person.
birthDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
prvcOfBirth
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
cityOfBirth
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfBirth
string Required
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
othr
Array of object (GenericPersonIdentification1)
Unique identification of a person, as assigned by an institution, using an identification scheme.
object
Information related to an identification of a person.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (PersonIdentificationSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external person identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfRes
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
ctctDtls
object (ContactDetails2)
Communication device number or electronic address used for communication.
nmPrfx
string
Specifies the terms used to formally address a person.
Valid values[ "DOCT", "MIST", "MISS", "MADM" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Min length1
Max length2048
othr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
dbtrAcct
object (CashAccount24)
Provides the details to identify an account.
id
object (AccountIdentification4Choice) Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
object
IBAN
string Required
The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard "Banking and related financial services - International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard.
Pattern[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
object
othr
object (GenericAccountIdentification1) Required
Information related to a generic account identification.
id
string Required
Specifies a character string with a maximum length of 34 characters.
Min length1
Max length34
schmeNm
object (AccountSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
object
cd
string Required
Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
dbtrAgt
object (BranchAndFinancialInstitutionIdentification5)
Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
finInstnId
object (FinancialInstitutionIdentification8) Required
Set of elements used to identify a financial institution.
BICFI
string
Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
object
cd
string Required
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length5
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
brnchId
object (BranchData2)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
dbtrAgtAcct
object (CashAccount24)
Provides the details to identify an account.
id
object (AccountIdentification4Choice) Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
object
IBAN
string Required
The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard "Banking and related financial services - International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard.
Pattern[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
object
othr
object (GenericAccountIdentification1) Required
Information related to a generic account identification.
id
string Required
Specifies a character string with a maximum length of 34 characters.
Min length1
Max length34
schmeNm
object (AccountSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
object
cd
string Required
Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
cdtrAgt
object (BranchAndFinancialInstitutionIdentification5)
Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.
finInstnId
object (FinancialInstitutionIdentification8) Required
Set of elements used to identify a financial institution.
BICFI
string
Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)
Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
object
cd
string Required
Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length5
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
brnchId
object (BranchData2)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
cdtrAgtAcct
object (CashAccount24)
Provides the details to identify an account.
id
object (AccountIdentification4Choice) Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
object
IBAN
string Required
The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard "Banking and related financial services - International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard.
Pattern[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
object
othr
object (GenericAccountIdentification1) Required
Information related to a generic account identification.
id
string Required
Specifies a character string with a maximum length of 34 characters.
Min length1
Max length34
schmeNm
object (AccountSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
object
cd
string Required
Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
cdtr
object (PartyIdentification43)
Set of elements used to identify a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
id
object (Party11Choice)
Nature or use of the account.
OneOf
object
orgId
object (OrganisationIdentification8) Required
Unique and unambiguous way to identify an organisation.
anyBIC
string
Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
othr
Array of object (GenericOrganisationIdentification1)
Unique identification of an organisation, as assigned by an institution, using an identification scheme.
object
Information related to an identification of an organisation.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (OrganisationIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external organisation identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
object
prvtId
object (PersonIdentification5) Required
Unique and unambiguous way to identify a person.
dtAndPlcOfBirth
object (DateAndPlaceOfBirth)
Date and place of birth of a person.
birthDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
prvcOfBirth
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
cityOfBirth
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfBirth
string Required
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
othr
Array of object (GenericPersonIdentification1)
Unique identification of a person, as assigned by an institution, using an identification scheme.
object
Information related to an identification of a person.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (PersonIdentificationSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external person identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfRes
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
ctctDtls
object (ContactDetails2)
Communication device number or electronic address used for communication.
nmPrfx
string
Specifies the terms used to formally address a person.
Valid values[ "DOCT", "MIST", "MISS", "MADM" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Min length1
Max length2048
othr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
cdtrAcct
object (CashAccount24)
Provides the details to identify an account.
id
object (AccountIdentification4Choice) Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
object
IBAN
string Required
The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard "Banking and related financial services - International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard.
Pattern[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
object
othr
object (GenericAccountIdentification1) Required
Information related to a generic account identification.
id
string Required
Specifies a character string with a maximum length of 34 characters.
Min length1
Max length34
schmeNm
object (AccountSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
object
cd
string Required
Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
ultmtCdtr
object (PartyIdentification43)
Set of elements used to identify a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
pstlAdr
object (PostalAddress6)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
string
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
dept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
subDept
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
strtNm
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Min length1
Max length16
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
Max items7
string
Specifies a character string with a maximum length of 70characters.
Min length1
Max length70
id
object (Party11Choice)
Nature or use of the account.
OneOf
object
orgId
object (OrganisationIdentification8) Required
Unique and unambiguous way to identify an organisation.
anyBIC
string
Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".
Pattern[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}
othr
Array of object (GenericOrganisationIdentification1)
Unique identification of an organisation, as assigned by an institution, using an identification scheme.
object
Information related to an identification of an organisation.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (OrganisationIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
object
cd
string Required
Specifies the external organisation identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
object
prvtId
object (PersonIdentification5) Required
Unique and unambiguous way to identify a person.
dtAndPlcOfBirth
object (DateAndPlaceOfBirth)
Date and place of birth of a person.
birthDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
prvcOfBirth
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
cityOfBirth
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfBirth
string Required
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
othr
Array of object (GenericPersonIdentification1)
Unique identification of a person, as assigned by an institution, using an identification scheme.
object
Information related to an identification of a person.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
schmeNm
object (PersonIdentificationSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
object
cd
string Required
Specifies the external person identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Min length1
Max length4
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
issr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
ctryOfRes
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
ctctDtls
object (ContactDetails2)
Communication device number or electronic address used for communication.
nmPrfx
string
Specifies the terms used to formally address a person.
Valid values[ "DOCT", "MIST", "MISS", "MADM" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Min length1
Max length140
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Min length1
Max length2048
othr
string
Specifies a character string with a maximum length of 35 characters.
Min length1
Max length35
splmtryData
Array of object (SupplementaryData1)
Additional information that cannot be captured in the structured elements and/or any other specific block.
object
Additional information that can not be captured in the structured fields and/or any other specific block.
plcAndNm
string
Specifies a character string with a maximum length of 350 characters.
Min length1
Max length350
envlp
object (SupplementaryDataEnvelope1) Required
Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.
splmtryData
Array of object (SupplementaryData1)
Additional information that cannot be captured in the structured elements and/or any other specific block.
object
Additional information that can not be captured in the structured fields and/or any other specific block.
plcAndNm
string
Specifies a character string with a maximum length of 350 characters.
Min length1
Max length350
envlp
object (SupplementaryDataEnvelope1) Required
Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.
Responses
200
OK - The operation is idempotent, and the same payment status verification request has been submitted successfully previously.
object
data
object (Data)
paymentsHubId
string
paymentId
string
status
string
creationDateTime
string
201
Created - The payment status verification request has been submitted successfully.
object
data
object (Data)
paymentsHubId
string
paymentId
string
status
string
creationDateTime
string
400
Bad request
object
Example{ "errors": [ { "code": "400", "message": "Bad Request", "level": "Error", "description": "Validation error message." } ] }
401
Unauthorized
object
Example{ "errors": [ { "code": "401", "message": "Unauthorized", "level": "Error", "description": "Authorization error message." } ] }
403
Forbidden
object
Example{ "errors": [ { "code": "403", "message": "Forbidden", "level": "Error", "description": "Access error message." } ] }
404
Not found
object
Example{ "errors": [ { "code": "404", "message": "Not Found", "level": "Error", "description": "Not found error message." } ] }
406
Not Acceptable
object
Example{ "errors": [ { "code": "406", "message": "Not Acceptable", "level": "Error", "description": "Not acceptable error message." } ] }
415
Unsupported media type
object
Example{ "errors": [ { "code": "415", "message": "Unsupported Media Type", "level": "Error", "description": "Unsupported type error message." } ] }
429
Too Many Requests
object
Example{ "errors": [ { "code": "429", "message": "Too Many Requests", "level": "Error", "description": "Too many requests error message." } ] }
500
Internal server error
object
Example{ "errors": [ { "code": "500", "message": "Internal Server Error", "level": "Error", "description": "Server error message." } ] }
503
Service unavailable
object
Example{ "errors": [ { "code": "503", "message": "Service Unavailable", "level": "Error", "description": "Unavailability error message." } ] }
504
Gateway timeout
object
Example{ "errors": [ { "code": "504", "message": "Gateway Timeout", "level": "Error", "description": "Timeout error message." } ] }
Was this article helpful?
