Creates a credit transfer with pre-execution initiator to make a payment (pain001/v09).

Prev Next
Post
/pre-execution/pain001/v09

Creates a credit transfer to make a payment pre-execution initiator using the pain.001.001.09 message format.

Header parameters
X-Client-Id
string

Client ID header

Example0123
SCA-Token
stringRequired

JWT token for payload validation

ExampleeyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.KMUFsIDTnFmyG3nMiGM6H9FNFUROf3wh7SmqJp-QV30
Body parameters
Expand All
object
cstmrCdtTrfInitn
object (CustomerCreditTransferInitiationV09) Required

Scope The CustomerCreditTransferInitiation message is sent by the initiating party to the forwarding agent or debtor agent. It is used to request movement of funds from the debtor account to a creditor. Usage The CustomerCreditTransferInitiation message can contain one or more customer credit transfer instructions. The CustomerCreditTransferInitiation message is used to exchange:

  • One or more instances of a credit transfer initiation;
  • Payment transactions that result in book transfers at the debtor agent or payments to another financial institution;
  • Payment transactions that result in an electronic cash transfer to the creditor account or in the emission of a cheque. The message can be used in a direct or a relay scenario:
  • In a direct scenario, the message is sent directly to the debtor agent. The debtor agent is the account servicer of the debtor.
  • In a relay scenario, the message is sent to a forwarding agent. The forwarding agent acts as a concentrating financial institution. It will forward the CustomerCreditTransferInitiation message to the debtor agent. The message can also be used by an initiating party that has authority to send the message on behalf of the debtor. This caters for example for the scenario of a payments factory initiating all payments on behalf of a large corporate. The CustomerCreditTransferInitiation message can be used in domestic and cross-border scenarios. The CustomerCreditTransferInitiation message must not be used by the debtor agent to execute the credit transfer instruction(s). The FIToFICustomerCreditTransfer message must be used instead.
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.

grpHdr
object (GroupHeader85) Required

Set of characteristics shared by all individual transactions included in the message.

ctrlSum
number

Number of objects represented as a decimal number, for example 0.75 or 45.6.

Maximum10
creDtTm
string (date-time) 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:

  1. beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
  2. 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.
msgId
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
fwdgAgt
object (BranchAndFinancialInstitutionIdentification6)

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

finInstnId
object (FinancialInstitutionIdentification18) Required

Specifies the details to identify a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
bicfi
string

Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([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.

mmbId
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
clrSysId
object (ClearingSystemIdentification2Choice)

Choice of a clearing system identifier.

OneOf
object
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.

Valid values[ "MA", "ATBLZ", "AUBSB", "CACPA", "CHBCC", "CHSIC", "CNAPS", "DEBLZ", "ESNCC", "GBDSC", "GRBIC", "HKNCC", "IENCC", "INFSC", "ITNCC", "JPZGN", "NZNCC", "PLKNR", "PTNCC", "RUCBC", "SESBA", "SGIBG", "THCBC", "TWNCC", "USABA", "USPID", "ZANCC", "NZRSA", "MZBMO", "CNCIP", "KRBOK", "BRISP", "NACSC", "ZWTSS", "AD", "EGNCC", "AE", "AF", "AI", "AL", "AM", "AO", "AR", "AS", "AW", "AZ", "BA", "BD", "BG", "BH", "BI", "BL", "BM", "BN", "BO", "BS", "BT", "BW", "BY", "BZ", "CD", "CL", "CO", "CR", "CV", "CW", "CY", "CZ", "DO", "DZ", "EC", "EE", "GE", "GH", "GN", "GT", "GY", "HN", "HR", "HT", "HU", "ID", "IL", "IQ", "IS", "JM", "JO", "KE", "KG", "KH", "KM", "KW", "KZ", "LB", "LK", "LR", "LS", "LT", "LV", "LY", "MD", "ME", "MG", "MK", "MN", "MO", "MR", "MT", "MU", "MW", "MX", "MY", "NG", "NI", "NP", "OM", "PA", "PE", "PG", "PH", "PK", "PS", "PY", "QA", "RO", "RS", "RW", "SA", "SC", "SD", "SI", "SK", "SL", "ST", "SV", "SZ", "TJ", "TL", "TM", "TN", "TR", "TT", "TZ", "UA", "UG", "UY", "UZ", "VA", "VE", "VN", "XK", "ZM", "MARPA", "MARAC" ]
object
object
prtry
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
othr
object (GenericFinancialIdentification1)

Information related to an identification of a financial institution.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
brnchId
object (BranchData3)

Information that locates and identifies a specific branch of a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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
authstn
Array of object (Authorisation1Choice)

User identification or any user key to be used to check whether the initiating party is allowed to initiate transactions from the account specified in the message.

Usage: The content is not of a technical nature, but reflects the organisational structure at the initiating side. The authorisation element can typically be used in relay scenarios, payment initiations, payment returns or payment reversals that are initiated on behalf of a party different from the initiating party.

Max items2
object

Provides the details on the user identification or any user key that allows to check if the initiating party is allowed to issue the transaction.

OneOf
object
object
cd
string Required

Specifies the level of approval depending on a number of factors, including payment type, threshold amount or local country or operations practice.

Valid values[ "AUTH", "FDET", "FSUM", "ILEV" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 128 characters.

Min length1
Max length128
nbOfTxs
string Required

Specifies a numeric string with a maximum length of 15 digits.

Pattern[0-9]{1,15}
initgPty
object (PartyIdentification135) Required

Specifies the identification of a person or an organisation.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
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 (Contact4)

Specifies the details of the contact person.

nmPrfx
string

Specifies the terms used to formally address a person.

Valid values[ "DOCT", "MADM", "MISS", "MIST", "MIKS" ]
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}
dept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
prefrdMtd
string

Preferred method used to reach the individual contact within an organisation.

Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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}
emailPurp
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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}
rspnsblty
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
jobTitl
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
emailAdr
string

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
nm
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
othr
Array of object (OtherContact1)

Contact details in another form.

object

Communication device number or electronic address used for communication.

id
string

Specifies a character string with a maximum length of 128 characters.

Min length1
Max length128
chanlTp
string Required

Specifies a character string with a maximum length of 4 characters.

Min length1
Max length4
id
object (Party38Choice)

Nature or use of the account.

OneOf
object
object
orgId
object (OrganisationIdentification29) 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: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "BANK", "CBID", "CHID", "CINC", "COID", "CUST", "DUNS", "EMPL", "GS1G", "SREN", "SRET", "TXID", "BDID", "BOID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
object
object
prvtId
object (PersonIdentification13) Required

Unique and unambiguous way to identify a person.

dtAndPlcOfBirth
object (DateAndPlaceOfBirth1)

Date and place of birth of a person.

cityOfBirth
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prvcOfBirth
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
birthDt
string (xs:date) 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))?
Example2002-09-24Z
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "ARNU", "CCPT", "CUST", "DRLC", "EMPL", "NIDN", "SOSE", "TELE", "TXID", "POID", "BANK" ]
object
object
prtry
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
pmtInf
Array of object (PaymentInstruction30) Required

Set of characteristics that applies to the debit side of the payment transactions included in the credit transfer initiation.

Min items1
object

Characteristics that apply to the debit side of the payment transactions included in the credit transfer initiation.

ctrlSum
number

Number of objects represented as a decimal number, for example 0.75 or 45.6.

Maximum10
dbtrAgtAcct
object (CashAccount38)

Provides the details to identify an account.

tp
object (CashAccountType2Choice)

Nature or use of the account.

OneOf
object
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.

Valid values[ "CACC", "CARD", "CASH", "CHAR", "CISH", "COMM", "CPAC", "LLSV", "LOAN", "MGLD", "MOMA", "NREX", "ODFT", "ONDP", "OTHR", "SACC", "SLRY", "SVGS", "TAXE", "TRAN", "TRAS", "VACC", "NFCA" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prxy
object (ProxyAccountIdentification1)

Information related to a proxy identification of the account.

tp
object (ProxyAccountType1Choice)

Specifies the scheme used for the identification of an account alias.

OneOf
object
object
cd
string Required

Specifies the external proxy account type code, as published in the proxy account type external code set. External code sets can be downloaded from www.iso20022.org.

Valid values[ "TELE", "EMAL", "DNAM", "CINC", "COTX", "COID", "CUST", "DRLC", "EIDN", "EWAL", "PVTX", "LEIC", "MBNO", "NIDN", "CCPT", "SHID", "SOSE", "TOKN", "UBIL", "VIPN", "BIID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
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}
id
object (AccountIdentification4Choice) Required

Specifies the unique identification of an account as assigned by the account servicer.

OneOf
object
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
object
othr
object (GenericAccountIdentification1) Required

Information related to a generic account identification.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "AIIN", "BBAN", "CUID", "UPIC" ]
object
object
prtry
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 70characters.

Min length1
Max length70
dbtrAcct
object (CashAccount38) Required

Provides the details to identify an account.

tp
object (CashAccountType2Choice)

Nature or use of the account.

OneOf
object
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.

Valid values[ "CACC", "CARD", "CASH", "CHAR", "CISH", "COMM", "CPAC", "LLSV", "LOAN", "MGLD", "MOMA", "NREX", "ODFT", "ONDP", "OTHR", "SACC", "SLRY", "SVGS", "TAXE", "TRAN", "TRAS", "VACC", "NFCA" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prxy
object (ProxyAccountIdentification1)

Information related to a proxy identification of the account.

tp
object (ProxyAccountType1Choice)

Specifies the scheme used for the identification of an account alias.

OneOf
object
object
cd
string Required

Specifies the external proxy account type code, as published in the proxy account type external code set. External code sets can be downloaded from www.iso20022.org.

Valid values[ "TELE", "EMAL", "DNAM", "CINC", "COTX", "COID", "CUST", "DRLC", "EIDN", "EWAL", "PVTX", "LEIC", "MBNO", "NIDN", "CCPT", "SHID", "SOSE", "TOKN", "UBIL", "VIPN", "BIID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
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}
id
object (AccountIdentification4Choice) Required

Specifies the unique identification of an account as assigned by the account servicer.

OneOf
object
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
object
othr
object (GenericAccountIdentification1) Required

Information related to a generic account identification.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "AIIN", "BBAN", "CUID", "UPIC" ]
object
object
prtry
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 70characters.

Min length1
Max length70
chrgsAcct
object (CashAccount38)

Provides the details to identify an account.

tp
object (CashAccountType2Choice)

Nature or use of the account.

OneOf
object
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.

Valid values[ "CACC", "CARD", "CASH", "CHAR", "CISH", "COMM", "CPAC", "LLSV", "LOAN", "MGLD", "MOMA", "NREX", "ODFT", "ONDP", "OTHR", "SACC", "SLRY", "SVGS", "TAXE", "TRAN", "TRAS", "VACC", "NFCA" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prxy
object (ProxyAccountIdentification1)

Information related to a proxy identification of the account.

tp
object (ProxyAccountType1Choice)

Specifies the scheme used for the identification of an account alias.

OneOf
object
object
cd
string Required

Specifies the external proxy account type code, as published in the proxy account type external code set. External code sets can be downloaded from www.iso20022.org.

Valid values[ "TELE", "EMAL", "DNAM", "CINC", "COTX", "COID", "CUST", "DRLC", "EIDN", "EWAL", "PVTX", "LEIC", "MBNO", "NIDN", "CCPT", "SHID", "SOSE", "TOKN", "UBIL", "VIPN", "BIID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
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}
id
object (AccountIdentification4Choice) Required

Specifies the unique identification of an account as assigned by the account servicer.

OneOf
object
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
object
othr
object (GenericAccountIdentification1) Required

Information related to a generic account identification.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "AIIN", "BBAN", "CUID", "UPIC" ]
object
object
prtry
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 70characters.

Min length1
Max length70
pmtTpInf
object (PaymentTypeInformation26)

Provides further details of the type of payment.

svcLvl
Array of object (ServiceLevel8Choice)

Agreement under which or rules under which the transaction should be processed.

object

Specifies the service level of the transaction.

OneOf
object
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.

Valid values[ "BKTR", "G001", "G002", "G003", "G004", "NPCA", "NUGP", "NURG", "PRPT", "SDVA", "SEPA", "SVDE", "URGP", "URNS", "INST", "SRTP", "SVAT", "G006", "G007", "G005", "G009", "WFSM", "EOLO", "SPLI" ]
object
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
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.

Valid values[ "0090", "0091", "0092", "0002", "0221", "0224", "0226", "0225", "0222", "0227", "0220", "0223", "0001", "0000", "BTR", "CKS", "CTR", "CTP", "DEP", "FFR", "FFS", "SVC", "DRW", "DRB", "DRC", "DDMC", "DDMP", "DDMU", "BPA", "IPA", "TRF", "82", "83", "CPP", "RTR", "GST", "DDT", "RDD", "CHN", "STR", "SDD", "SRT", "SRD", "SCN", "SGT", "CARD", "05", "04", "ISE", "BSE", "58", "19", "ASTI", "BACP", "MANP", "SBTI", "85", "08", "89", "60", "RIBA", "RIDO", "RIDV", "IDEAL", "INSTNT01", "INSTTC01", "INSTIDEAL", "INSTNT01IDEAL", "INSTTC01IDEAL", "NLDO", "NLUP", "SDN", "ACCEPT", "ICMC", "NLGOV", "IN", "ONCL", "PERI", "SDCL", "DDNR", "DDFA", "CORE", "B2BAMIPM", "B2B", "CR1AMIPM", "CORAMIPM", "COR1", "FADAMIPM", "CLSCCPERX", "CLSCCPLCH", "INST", "ADD", "UDD", "CCI", "IAT", "CCD", "CTX", "PPD", "CIE", "RCK", "ARC", "WEB", "POP", "POS", "TEL", "ITP", "CTP", "MDP", "IMD", "SOP", "FDP" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "BONU", "CASH", "CBLK", "CCRD", "CORT", "DCRD", "DIVI", "DVPM", "EPAY", "FCIN", "FCOL", "GP2P", "GOVT", "HEDG", "ICCP", "IDCP", "INTC", "INTE", "LBOX", "LOAN", "MP2B", "MP2P", "OTHR", "PENS", "RPRE", "RRCT", "RVPM", "SALA", "SECU", "SSBE", "SUPP", "TAXS", "TRAD", "TREA", "VATX", "WHLD", "SWEP", "TOPG", "ZABA", "VOST", "FCDT", "CIPC", "CONC", "CGWV", "SAVG", "CTDF" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
instrPrty
string

Specifies the priority level of an event.

Valid values[ "HIGH", "NORM" ]
poolgAdjstmntDt
string (xs:date)

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))?
Example2002-09-24Z
instrForDbtrAgt
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
ultmtDbtr
object (PartyIdentification135)

Specifies the identification of a person or an organisation.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
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 (Contact4)

Specifies the details of the contact person.

nmPrfx
string

Specifies the terms used to formally address a person.

Valid values[ "DOCT", "MADM", "MISS", "MIST", "MIKS" ]
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}
dept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
prefrdMtd
string

Preferred method used to reach the individual contact within an organisation.

Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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}
emailPurp
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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}
rspnsblty
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
jobTitl
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
emailAdr
string

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
nm
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
othr
Array of object (OtherContact1)

Contact details in another form.

object

Communication device number or electronic address used for communication.

id
string

Specifies a character string with a maximum length of 128 characters.

Min length1
Max length128
chanlTp
string Required

Specifies a character string with a maximum length of 4 characters.

Min length1
Max length4
id
object (Party38Choice)

Nature or use of the account.

OneOf
object
object
orgId
object (OrganisationIdentification29) 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: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "BANK", "CBID", "CHID", "CINC", "COID", "CUST", "DUNS", "EMPL", "GS1G", "SREN", "SRET", "TXID", "BDID", "BOID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
object
object
prvtId
object (PersonIdentification13) Required

Unique and unambiguous way to identify a person.

dtAndPlcOfBirth
object (DateAndPlaceOfBirth1)

Date and place of birth of a person.

cityOfBirth
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prvcOfBirth
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
birthDt
string (xs:date) 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))?
Example2002-09-24Z
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "ARNU", "CCPT", "CUST", "DRLC", "EMPL", "NIDN", "SOSE", "TELE", "TXID", "POID", "BANK" ]
object
object
prtry
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
chrgsAcctAgt
object (BranchAndFinancialInstitutionIdentification6)

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

finInstnId
object (FinancialInstitutionIdentification18) Required

Specifies the details to identify a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
bicfi
string

Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([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.

mmbId
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
clrSysId
object (ClearingSystemIdentification2Choice)

Choice of a clearing system identifier.

OneOf
object
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.

Valid values[ "MA", "ATBLZ", "AUBSB", "CACPA", "CHBCC", "CHSIC", "CNAPS", "DEBLZ", "ESNCC", "GBDSC", "GRBIC", "HKNCC", "IENCC", "INFSC", "ITNCC", "JPZGN", "NZNCC", "PLKNR", "PTNCC", "RUCBC", "SESBA", "SGIBG", "THCBC", "TWNCC", "USABA", "USPID", "ZANCC", "NZRSA", "MZBMO", "CNCIP", "KRBOK", "BRISP", "NACSC", "ZWTSS", "AD", "EGNCC", "AE", "AF", "AI", "AL", "AM", "AO", "AR", "AS", "AW", "AZ", "BA", "BD", "BG", "BH", "BI", "BL", "BM", "BN", "BO", "BS", "BT", "BW", "BY", "BZ", "CD", "CL", "CO", "CR", "CV", "CW", "CY", "CZ", "DO", "DZ", "EC", "EE", "GE", "GH", "GN", "GT", "GY", "HN", "HR", "HT", "HU", "ID", "IL", "IQ", "IS", "JM", "JO", "KE", "KG", "KH", "KM", "KW", "KZ", "LB", "LK", "LR", "LS", "LT", "LV", "LY", "MD", "ME", "MG", "MK", "MN", "MO", "MR", "MT", "MU", "MW", "MX", "MY", "NG", "NI", "NP", "OM", "PA", "PE", "PG", "PH", "PK", "PS", "PY", "QA", "RO", "RS", "RW", "SA", "SC", "SD", "SI", "SK", "SL", "ST", "SV", "SZ", "TJ", "TL", "TM", "TN", "TR", "TT", "TZ", "UA", "UG", "UY", "UZ", "VA", "VE", "VN", "XK", "ZM", "MARPA", "MARAC" ]
object
object
prtry
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
othr
object (GenericFinancialIdentification1)

Information related to an identification of a financial institution.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
brnchId
object (BranchData3)

Information that locates and identifies a specific branch of a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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
chrgBr
string

Specifies which party(ies) will pay charges due for processing of the instruction.

Valid values[ "DEBT", "CRED", "SHAR", "SLEV" ]
nbOfTxs
string

Specifies a numeric string with a maximum length of 15 digits.

Pattern[0-9]{1,15}
reqdExctnDt
object (DateAndDateTime2Choice) Required

Choice between a date or a date and time format.

OneOf
object
object
dt
string (xs:date) 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))?
Example2002-09-24Z
object
object
dtTm
string (date-time) 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:

  1. beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
  2. 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.
cdtTrfTxInf
Array of object (CreditTransferTransaction34) Required

Provides information on the individual transaction(s) included in the message.

Min items1
object

Provide further details specific to the individual transaction(s) included in the message.

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.

intrmyAgt2Acct
object (CashAccount38)

Provides the details to identify an account.

tp
object (CashAccountType2Choice)

Nature or use of the account.

OneOf
object
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.

Valid values[ "CACC", "CARD", "CASH", "CHAR", "CISH", "COMM", "CPAC", "LLSV", "LOAN", "MGLD", "MOMA", "NREX", "ODFT", "ONDP", "OTHR", "SACC", "SLRY", "SVGS", "TAXE", "TRAN", "TRAS", "VACC", "NFCA" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prxy
object (ProxyAccountIdentification1)

Information related to a proxy identification of the account.

tp
object (ProxyAccountType1Choice)

Specifies the scheme used for the identification of an account alias.

OneOf
object
object
cd
string Required

Specifies the external proxy account type code, as published in the proxy account type external code set. External code sets can be downloaded from www.iso20022.org.

Valid values[ "TELE", "EMAL", "DNAM", "CINC", "COTX", "COID", "CUST", "DRLC", "EIDN", "EWAL", "PVTX", "LEIC", "MBNO", "NIDN", "CCPT", "SHID", "SOSE", "TOKN", "UBIL", "VIPN", "BIID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
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}
id
object (AccountIdentification4Choice) Required

Specifies the unique identification of an account as assigned by the account servicer.

OneOf
object
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
object
othr
object (GenericAccountIdentification1) Required

Information related to a generic account identification.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "AIIN", "BBAN", "CUID", "UPIC" ]
object
object
prtry
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 70characters.

Min length1
Max length70
instrForCdtrAgt
Array of object (InstructionForCreditorAgent1)

Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.

object

Further information related to the processing of the payment instruction that may need to be acted upon by the creditor's agent. The instruction may relate to a level of service, or may be an instruction that has to be executed by the creditor's agent, or may be information required by the creditor's agent.

instrInf
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
cd
string

Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s).

Valid values[ "CHQB", "HOLD", "PHOB", "TELB" ]
intrmyAgt1Acct
object (CashAccount38)

Provides the details to identify an account.

tp
object (CashAccountType2Choice)

Nature or use of the account.

OneOf
object
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.

Valid values[ "CACC", "CARD", "CASH", "CHAR", "CISH", "COMM", "CPAC", "LLSV", "LOAN", "MGLD", "MOMA", "NREX", "ODFT", "ONDP", "OTHR", "SACC", "SLRY", "SVGS", "TAXE", "TRAN", "TRAS", "VACC", "NFCA" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prxy
object (ProxyAccountIdentification1)

Information related to a proxy identification of the account.

tp
object (ProxyAccountType1Choice)

Specifies the scheme used for the identification of an account alias.

OneOf
object
object
cd
string Required

Specifies the external proxy account type code, as published in the proxy account type external code set. External code sets can be downloaded from www.iso20022.org.

Valid values[ "TELE", "EMAL", "DNAM", "CINC", "COTX", "COID", "CUST", "DRLC", "EIDN", "EWAL", "PVTX", "LEIC", "MBNO", "NIDN", "CCPT", "SHID", "SOSE", "TOKN", "UBIL", "VIPN", "BIID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
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}
id
object (AccountIdentification4Choice) Required

Specifies the unique identification of an account as assigned by the account servicer.

OneOf
object
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
object
othr
object (GenericAccountIdentification1) Required

Information related to a generic account identification.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "AIIN", "BBAN", "CUID", "UPIC" ]
object
object
prtry
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 70characters.

Min length1
Max length70
rgltryRptg
Array of object (RegulatoryReporting3)

Information needed due to regulatory and statutory requirements.

Max items10
object

Information needed due to regulatory and/or statutory requirements.

dtls
Array of object (StructuredRegulatoryReporting3)

Set of elements used to provide details on the regulatory reporting information.

object

Information needed due to regulatory and statutory requirements.

tp
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
amt
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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}
inf
Array of string (Max35Text)

Additional details that cater for specific domestic regulatory requirements.

string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
cd
string

Specifies a character string with a maximum length of 10 characters.

Min length1
Max length10
dt
string (xs:date)

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))?
Example2002-09-24Z
authrty
object (RegulatoryAuthority2)

Entity requiring the regulatory reporting information.

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}
nm
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
dbtCdtRptgInd
string

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.

Valid values[ "CRED", "DEBT", "BOTH" ]
intrmyAgt3Acct
object (CashAccount38)

Provides the details to identify an account.

tp
object (CashAccountType2Choice)

Nature or use of the account.

OneOf
object
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.

Valid values[ "CACC", "CARD", "CASH", "CHAR", "CISH", "COMM", "CPAC", "LLSV", "LOAN", "MGLD", "MOMA", "NREX", "ODFT", "ONDP", "OTHR", "SACC", "SLRY", "SVGS", "TAXE", "TRAN", "TRAS", "VACC", "NFCA" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prxy
object (ProxyAccountIdentification1)

Information related to a proxy identification of the account.

tp
object (ProxyAccountType1Choice)

Specifies the scheme used for the identification of an account alias.

OneOf
object
object
cd
string Required

Specifies the external proxy account type code, as published in the proxy account type external code set. External code sets can be downloaded from www.iso20022.org.

Valid values[ "TELE", "EMAL", "DNAM", "CINC", "COTX", "COID", "CUST", "DRLC", "EIDN", "EWAL", "PVTX", "LEIC", "MBNO", "NIDN", "CCPT", "SHID", "SOSE", "TOKN", "UBIL", "VIPN", "BIID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
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}
id
object (AccountIdentification4Choice) Required

Specifies the unique identification of an account as assigned by the account servicer.

OneOf
object
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
object
othr
object (GenericAccountIdentification1) Required

Information related to a generic account identification.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "AIIN", "BBAN", "CUID", "UPIC" ]
object
object
prtry
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 70characters.

Min length1
Max length70
chqInstr
object (Cheque11)

Characteristics of a cheque instruction, such as cheque type or cheque number.

dlvrTo
object (NameAndAddress16)

Information that locates and identifies a party.

adr
object (PostalAddress24) Required

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
nm
string Required

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
chqTp
string

Specifies the type of cheque.

Valid values[ "CCHQ", "CCCH", "BCHQ", "DRFT", "ELDR" ]
dlvryMtd
object (ChequeDeliveryMethod1Choice)

Set of characteristics related to a cheque instruction, such as cheque type or cheque number.

OneOf
object
object
cd
string Required

Specifies the method to be used in delivering a cheque to a party.

Valid values[ "MLDB", "MLCD", "MLFA", "CRDB", "CRCD", "CRFA", "PUDB", "PUCD", "PUFA", "RGDB", "RGCD", "RGFA" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
rgnlClrZone
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prtLctn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
sgntr
Array of string (Max70Text)

Signature to be used by the cheque servicer on a specific cheque to be printed.

Max items5
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
chqNb
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
memoFld
Array of string (Max35Text)

Information that needs to be printed on a cheque, used by the payer to add miscellaneous information.

Max items2
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
chqMtrtyDt
string (xs:date)

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))?
Example2002-09-24Z
instrPrty
string

Specifies the priority level of an event.

Valid values[ "HIGH", "NORM" ]
chqFr
object (NameAndAddress16)

Information that locates and identifies a party.

adr
object (PostalAddress24) Required

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
nm
string Required

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
cdtrAcct
object (CashAccount38)

Provides the details to identify an account.

tp
object (CashAccountType2Choice)

Nature or use of the account.

OneOf
object
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.

Valid values[ "CACC", "CARD", "CASH", "CHAR", "CISH", "COMM", "CPAC", "LLSV", "LOAN", "MGLD", "MOMA", "NREX", "ODFT", "ONDP", "OTHR", "SACC", "SLRY", "SVGS", "TAXE", "TRAN", "TRAS", "VACC", "NFCA" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prxy
object (ProxyAccountIdentification1)

Information related to a proxy identification of the account.

tp
object (ProxyAccountType1Choice)

Specifies the scheme used for the identification of an account alias.

OneOf
object
object
cd
string Required

Specifies the external proxy account type code, as published in the proxy account type external code set. External code sets can be downloaded from www.iso20022.org.

Valid values[ "TELE", "EMAL", "DNAM", "CINC", "COTX", "COID", "CUST", "DRLC", "EIDN", "EWAL", "PVTX", "LEIC", "MBNO", "NIDN", "CCPT", "SHID", "SOSE", "TOKN", "UBIL", "VIPN", "BIID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
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}
id
object (AccountIdentification4Choice) Required

Specifies the unique identification of an account as assigned by the account servicer.

OneOf
object
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
object
othr
object (GenericAccountIdentification1) Required

Information related to a generic account identification.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "AIIN", "BBAN", "CUID", "UPIC" ]
object
object
prtry
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 70characters.

Min length1
Max length70
instrForDbtrAgt
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
rltdRmtInf
Array of object (RemittanceLocation7)

Provides information related to the handling of the remittance information by any of the agents in the transaction processing chain.

Max items10
object

Provides information on the remittance advice.

rmtId
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
rmtLctnDtls
Array of object (RemittanceLocationData1)

Set of elements used to provide information on the location and/or delivery of the remittance information.

object

Provides additional details on the remittance advice.

pstlAdr
object (NameAndAddress16)

Information that locates and identifies a party.

adr
object (PostalAddress24) Required

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
nm
string Required

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
elctrncAdr
string

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
mtd
string Required

Specifies the method used to deliver the remittance advice information.

Valid values[ "FAXI", "EDIC", "URID", "EMAL", "POST", "SMSM" ]
ultmtDbtr
object (PartyIdentification135)

Specifies the identification of a person or an organisation.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
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 (Contact4)

Specifies the details of the contact person.

nmPrfx
string

Specifies the terms used to formally address a person.

Valid values[ "DOCT", "MADM", "MISS", "MIST", "MIKS" ]
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}
dept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
prefrdMtd
string

Preferred method used to reach the individual contact within an organisation.

Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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}
emailPurp
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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}
rspnsblty
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
jobTitl
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
emailAdr
string

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
nm
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
othr
Array of object (OtherContact1)

Contact details in another form.

object

Communication device number or electronic address used for communication.

id
string

Specifies a character string with a maximum length of 128 characters.

Min length1
Max length128
chanlTp
string Required

Specifies a character string with a maximum length of 4 characters.

Min length1
Max length4
id
object (Party38Choice)

Nature or use of the account.

OneOf
object
object
orgId
object (OrganisationIdentification29) 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: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "BANK", "CBID", "CHID", "CINC", "COID", "CUST", "DUNS", "EMPL", "GS1G", "SREN", "SRET", "TXID", "BDID", "BOID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
object
object
prvtId
object (PersonIdentification13) Required

Unique and unambiguous way to identify a person.

dtAndPlcOfBirth
object (DateAndPlaceOfBirth1)

Date and place of birth of a person.

cityOfBirth
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prvcOfBirth
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
birthDt
string (xs:date) 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))?
Example2002-09-24Z
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "ARNU", "CCPT", "CUST", "DRLC", "EMPL", "NIDN", "SOSE", "TELE", "TXID", "POID", "BANK" ]
object
object
prtry
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
tax
object (TaxInformation8)

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.

dbtr
object (TaxParty2)

Details about the entity involved in the tax paid or to be paid.

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
taxId
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
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.

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}
value
number Required
Minimum0
Maximum10000000000000
refNb
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
seqNb
number

Number of objects represented as an integer.

Maximum1000000000000000000
admstnZone
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
rcrd
Array of object (TaxRecord2)

Record of tax details.

object

Set of elements used to define the tax record.

addtlInf
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
tp
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
taxAmt
object (TaxAmount2)

Set of elements used to provide information on the tax amount(s) of tax record.

dtls
Array of object (TaxRecordDetails2)

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.

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.

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}
value
number Required
Minimum0
Maximum10000000000000
prd
object (TaxPeriod2)

Period of time details related to the tax payment.

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" ]
yr
string (xs:date)

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))?
Example2002-09-24Z
frToDt
object (DatePeriod2)

Range of time defined by a start date and an end date.

frDt
string (xs:date) 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))?
Example2002-09-24Z
toDt
string (xs:date) 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))?
Example2002-09-24Z
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
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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
frmsCd
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prd
object (TaxPeriod2)

Period of time details related to the tax payment.

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" ]
yr
string (xs:date)

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))?
Example2002-09-24Z
frToDt
object (DatePeriod2)

Range of time defined by a start date and an end date.

frDt
string (xs:date) 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))?
Example2002-09-24Z
toDt
string (xs:date) 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))?
Example2002-09-24Z
certId
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
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.

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}
value
number Required
Minimum0
Maximum10000000000000
cdtr
object (TaxParty1)

Details about the entity involved in the tax paid or to be paid.

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
taxId
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dt
string (xs:date)

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))?
Example2002-09-24Z
pmtId
object (PaymentIdentification6) Required

Provides further means of referencing a payment transaction.

endToEndId
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
instrId
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
uetr
string

Universally Unique IDentifier (UUID) version 4, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace".

Pattern[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}
cdtrAgt
object (BranchAndFinancialInstitutionIdentification6)

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

finInstnId
object (FinancialInstitutionIdentification18) Required

Specifies the details to identify a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
bicfi
string

Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([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.

mmbId
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
clrSysId
object (ClearingSystemIdentification2Choice)

Choice of a clearing system identifier.

OneOf
object
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.

Valid values[ "MA", "ATBLZ", "AUBSB", "CACPA", "CHBCC", "CHSIC", "CNAPS", "DEBLZ", "ESNCC", "GBDSC", "GRBIC", "HKNCC", "IENCC", "INFSC", "ITNCC", "JPZGN", "NZNCC", "PLKNR", "PTNCC", "RUCBC", "SESBA", "SGIBG", "THCBC", "TWNCC", "USABA", "USPID", "ZANCC", "NZRSA", "MZBMO", "CNCIP", "KRBOK", "BRISP", "NACSC", "ZWTSS", "AD", "EGNCC", "AE", "AF", "AI", "AL", "AM", "AO", "AR", "AS", "AW", "AZ", "BA", "BD", "BG", "BH", "BI", "BL", "BM", "BN", "BO", "BS", "BT", "BW", "BY", "BZ", "CD", "CL", "CO", "CR", "CV", "CW", "CY", "CZ", "DO", "DZ", "EC", "EE", "GE", "GH", "GN", "GT", "GY", "HN", "HR", "HT", "HU", "ID", "IL", "IQ", "IS", "JM", "JO", "KE", "KG", "KH", "KM", "KW", "KZ", "LB", "LK", "LR", "LS", "LT", "LV", "LY", "MD", "ME", "MG", "MK", "MN", "MO", "MR", "MT", "MU", "MW", "MX", "MY", "NG", "NI", "NP", "OM", "PA", "PE", "PG", "PH", "PK", "PS", "PY", "QA", "RO", "RS", "RW", "SA", "SC", "SD", "SI", "SK", "SL", "ST", "SV", "SZ", "TJ", "TL", "TM", "TN", "TR", "TT", "TZ", "UA", "UG", "UY", "UZ", "VA", "VE", "VN", "XK", "ZM", "MARPA", "MARAC" ]
object
object
prtry
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
othr
object (GenericFinancialIdentification1)

Information related to an identification of a financial institution.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
brnchId
object (BranchData3)

Information that locates and identifies a specific branch of a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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
ultmtCdtr
object (PartyIdentification135)

Specifies the identification of a person or an organisation.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
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 (Contact4)

Specifies the details of the contact person.

nmPrfx
string

Specifies the terms used to formally address a person.

Valid values[ "DOCT", "MADM", "MISS", "MIST", "MIKS" ]
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}
dept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
prefrdMtd
string

Preferred method used to reach the individual contact within an organisation.

Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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}
emailPurp
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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}
rspnsblty
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
jobTitl
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
emailAdr
string

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
nm
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
othr
Array of object (OtherContact1)

Contact details in another form.

object

Communication device number or electronic address used for communication.

id
string

Specifies a character string with a maximum length of 128 characters.

Min length1
Max length128
chanlTp
string Required

Specifies a character string with a maximum length of 4 characters.

Min length1
Max length4
id
object (Party38Choice)

Nature or use of the account.

OneOf
object
object
orgId
object (OrganisationIdentification29) 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: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "BANK", "CBID", "CHID", "CINC", "COID", "CUST", "DUNS", "EMPL", "GS1G", "SREN", "SRET", "TXID", "BDID", "BOID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
object
object
prvtId
object (PersonIdentification13) Required

Unique and unambiguous way to identify a person.

dtAndPlcOfBirth
object (DateAndPlaceOfBirth1)

Date and place of birth of a person.

cityOfBirth
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prvcOfBirth
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
birthDt
string (xs:date) 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))?
Example2002-09-24Z
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "ARNU", "CCPT", "CUST", "DRLC", "EMPL", "NIDN", "SOSE", "TELE", "TXID", "POID", "BANK" ]
object
object
prtry
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
pmtTpInf
object (PaymentTypeInformation26)

Provides further details of the type of payment.

svcLvl
Array of object (ServiceLevel8Choice)

Agreement under which or rules under which the transaction should be processed.

object

Specifies the service level of the transaction.

OneOf
object
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.

Valid values[ "BKTR", "G001", "G002", "G003", "G004", "NPCA", "NUGP", "NURG", "PRPT", "SDVA", "SEPA", "SVDE", "URGP", "URNS", "INST", "SRTP", "SVAT", "G006", "G007", "G005", "G009", "WFSM", "EOLO", "SPLI" ]
object
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
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.

Valid values[ "0090", "0091", "0092", "0002", "0221", "0224", "0226", "0225", "0222", "0227", "0220", "0223", "0001", "0000", "BTR", "CKS", "CTR", "CTP", "DEP", "FFR", "FFS", "SVC", "DRW", "DRB", "DRC", "DDMC", "DDMP", "DDMU", "BPA", "IPA", "TRF", "82", "83", "CPP", "RTR", "GST", "DDT", "RDD", "CHN", "STR", "SDD", "SRT", "SRD", "SCN", "SGT", "CARD", "05", "04", "ISE", "BSE", "58", "19", "ASTI", "BACP", "MANP", "SBTI", "85", "08", "89", "60", "RIBA", "RIDO", "RIDV", "IDEAL", "INSTNT01", "INSTTC01", "INSTIDEAL", "INSTNT01IDEAL", "INSTTC01IDEAL", "NLDO", "NLUP", "SDN", "ACCEPT", "ICMC", "NLGOV", "IN", "ONCL", "PERI", "SDCL", "DDNR", "DDFA", "CORE", "B2BAMIPM", "B2B", "CR1AMIPM", "CORAMIPM", "COR1", "FADAMIPM", "CLSCCPERX", "CLSCCPLCH", "INST", "ADD", "UDD", "CCI", "IAT", "CCD", "CTX", "PPD", "CIE", "RCK", "ARC", "WEB", "POP", "POS", "TEL", "ITP", "CTP", "MDP", "IMD", "SOP", "FDP" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "BONU", "CASH", "CBLK", "CCRD", "CORT", "DCRD", "DIVI", "DVPM", "EPAY", "FCIN", "FCOL", "GP2P", "GOVT", "HEDG", "ICCP", "IDCP", "INTC", "INTE", "LBOX", "LOAN", "MP2B", "MP2P", "OTHR", "PENS", "RPRE", "RRCT", "RVPM", "SALA", "SECU", "SSBE", "SUPP", "TAXS", "TRAD", "TREA", "VATX", "WHLD", "SWEP", "TOPG", "ZABA", "VOST", "FCDT", "CIPC", "CONC", "CGWV", "SAVG", "CTDF" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
instrPrty
string

Specifies the priority level of an event.

Valid values[ "HIGH", "NORM" ]
amt
object (AmountType4Choice) Required

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
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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}
object
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.

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}
value
number Required
Minimum0
Maximum10000000000000
chrgBr
string

Specifies which party(ies) will pay charges due for processing of the instruction.

Valid values[ "DEBT", "CRED", "SHAR", "SLEV" ]
purp
object (Purpose2Choice)

Specifies the underlying reason for the payment transaction. Usage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.

OneOf
object
object
cd
string Required

Specifies the external purpose 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.

Valid values[ "BKDF", "BKFE", "BKFM", "BKIP", "BKPP", "CBLK", "CDCB", "CDCD", "CDCS", "CDDP", "CDOC", "CDQC", "ETUP", "FCOL", "MTUP", "ACCT", "CASH", "COLL", "CSDB", "DEPT", "INTC", "INTP", "LIMA", "NETT", "BFWD", "CCIR", "CCPC", "CCPM", "CCSM", "CRDS", "CRPR", "CRSP", "CRTL", "EQPT", "EQUS", "EXPT", "EXTD", "FIXI", "FWBC", "FWCC", "FWSB", "FWSC", "MARG", "MBSB", "MBSC", "MGCC", "MGSC", "OCCC", "OPBC", "OPCC", "OPSB", "OPSC", "OPTN", "OTCD", "REPO", "RPBC", "RPCC", "RPSB", "RPSC", "RVPO", "SBSC", "SCIE", "SCIR", "SCRP", "SHBC", "SHCC", "SHSL", "SLEB", "SLOA", "SWBC", "SWCC", "SWPT", "SWSB", "SWSC", "TBAS", "TBBC", "TBCC", "TRCP", "AGRT", "AREN", "BEXP", "BOCE", "COMC", "CPYR", "GDDS", "GDSV", "GSCB", "LICF", "MP2B", "POPE", "ROYA", "SCVE", "SERV", "SUBS", "SUPP", "TRAD", "CHAR", "COMT", "MP2P", "ECPG", "ECPR", "ECPU", "EPAY", "CLPR", "COMP", "DBTC", "GOVI", "HLRP", "HLST", "INPC", "INPR", "INSC", "INSU", "INTE", "LBRI", "LIFI", "LOAN", "LOAR", "PENO", "PPTI", "RELG", "RINP", "TRFD", "FORW", "FXNT", "ADMG", "ADVA", "BCDM", "BCFG", "BLDM", "BNET", "CBFF", "CBFR", "CCRD", "CDBL", "CFEE", "CGDD", "CORT", "COST", "CPKC", "DCRD", "DSMT", "DVPM", "EDUC", "FACT", "FAND", "FCPM", "FEES", "GIFT", "GOVT", "ICCP", "IDCP", "IHRP", "INSM", "IVPT", "MCDM", "MCFG", "MSVC", "NOWS", "OCDM", "OCFG", "OFEE", "OTHR", "PADD", "PTSP", "RCKE", "RCPT", "REBT", "REFU", "RENT", "REOD", "RIMB", "RPNT", "RRBN", "RRCT", "RRTP", "RVPM", "SLPI", "SPLT", "STDY", "TBAN", "TBIL", "TCSC", "TELI", "TMPG", "TPRI", "TPRP", "TRNC", "TRVC", "WEBI", "IPAY", "IPCA", "IPDO", "IPEA", "IPEC", "IPEW", "IPPS", "IPRT", "IPU2", "IPUW", "ANNI", "CAFI", "CFDI", "CMDT", "DERI", "DIVD", "FREX", "HEDG", "INVS", "PRME", "SAVG", "SECU", "SEPI", "TREA", "UNIT", "FNET", "FUTR", "ANTS", "CVCF", "DMEQ", "DNTS", "HLTC", "HLTI", "HSPC", "ICRF", "LTCF", "MAFC", "MARF", "MDCS", "VIEW", "CDEP", "SWFP", "SWPP", "SWRS", "SWUF", "ADCS", "AEMP", "ALLW", "ALMY", "BBSC", "BECH", "BENE", "BONU", "CCHD", "COMM", "CSLP", "GFRP", "GVEA", "GVEB", "GVEC", "GVED", "GWLT", "HREC", "PAYR", "PEFC", "PENS", "PRCP", "RHBS", "SALA", "SPSP", "SSBE", "LBIN", "LCOL", "LFEE", "LMEQ", "LMFI", "LMRK", "LREB", "LREV", "LSFL", "ESTX", "FWLV", "GSTX", "HSTX", "INTX", "NITX", "PTXP", "RDTX", "TAXS", "VATX", "WHLD", "TAXR", "B112", "BR12", "TLRF", "TLRR", "AIRB", "BUSB", "FERB", "RLWY", "TRPT", "CBTV", "ELEC", "ENRG", "GASB", "NWCH", "NWCM", "OTLC", "PHON", "UBIL", "WTER", "BOND", "CABD", "CAEQ", "CBCR", "DBCR", "DICL", "EQTS", "FLCR", "EFTC", "EFTD", "MOMA", "RAPI", "GAMB", "LOTT", "AMEX", "SASW", "AUCO", "PCOM", "PDEP", "PLDS", "PLRF", "GAFA", "GAHO", "CPEN", "DEPD", "RETL", "DEBT", "RMCO" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
rmtInf
object (RemittanceInformation16)

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 (StructuredRemittanceInformation16)

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.

taxRmt
object (TaxInformation7)

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.

dbtr
object (TaxParty2)

Details about the entity involved in the tax paid or to be paid.

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
taxId
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
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.

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}
value
number Required
Minimum0
Maximum10000000000000
refNb
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
seqNb
number

Number of objects represented as an integer.

Maximum1000000000000000000
ultmtDbtr
object (TaxParty2)

Details about the entity involved in the tax paid or to be paid.

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
taxId
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
rcrd
Array of object (TaxRecord2)

Record of tax details.

object

Set of elements used to define the tax record.

addtlInf
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
tp
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
taxAmt
object (TaxAmount2)

Set of elements used to provide information on the tax amount(s) of tax record.

dtls
Array of object (TaxRecordDetails2)

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.

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.

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}
value
number Required
Minimum0
Maximum10000000000000
prd
object (TaxPeriod2)

Period of time details related to the tax payment.

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" ]
yr
string (xs:date)

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))?
Example2002-09-24Z
frToDt
object (DatePeriod2)

Range of time defined by a start date and an end date.

frDt
string (xs:date) 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))?
Example2002-09-24Z
toDt
string (xs:date) 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))?
Example2002-09-24Z
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
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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
frmsCd
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prd
object (TaxPeriod2)

Period of time details related to the tax payment.

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" ]
yr
string (xs:date)

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))?
Example2002-09-24Z
frToDt
object (DatePeriod2)

Range of time defined by a start date and an end date.

frDt
string (xs:date) 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))?
Example2002-09-24Z
toDt
string (xs:date) 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))?
Example2002-09-24Z
certId
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
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.

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}
value
number Required
Minimum0
Maximum10000000000000
cdtr
object (TaxParty1)

Details about the entity involved in the tax paid or to be paid.

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
taxId
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dt
string (xs:date)

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))?
Example2002-09-24Z
invcee
object (PartyIdentification135)

Specifies the identification of a person or an organisation.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
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 (Contact4)

Specifies the details of the contact person.

nmPrfx
string

Specifies the terms used to formally address a person.

Valid values[ "DOCT", "MADM", "MISS", "MIST", "MIKS" ]
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}
dept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
prefrdMtd
string

Preferred method used to reach the individual contact within an organisation.

Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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}
emailPurp
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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}
rspnsblty
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
jobTitl
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
emailAdr
string

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
nm
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
othr
Array of object (OtherContact1)

Contact details in another form.

object

Communication device number or electronic address used for communication.

id
string

Specifies a character string with a maximum length of 128 characters.

Min length1
Max length128
chanlTp
string Required

Specifies a character string with a maximum length of 4 characters.

Min length1
Max length4
id
object (Party38Choice)

Nature or use of the account.

OneOf
object
object
orgId
object (OrganisationIdentification29) 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: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "BANK", "CBID", "CHID", "CINC", "COID", "CUST", "DUNS", "EMPL", "GS1G", "SREN", "SRET", "TXID", "BDID", "BOID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
object
object
prvtId
object (PersonIdentification13) Required

Unique and unambiguous way to identify a person.

dtAndPlcOfBirth
object (DateAndPlaceOfBirth1)

Date and place of birth of a person.

cityOfBirth
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prvcOfBirth
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
birthDt
string (xs:date) 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))?
Example2002-09-24Z
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "ARNU", "CCPT", "CUST", "DRLC", "EMPL", "NIDN", "SOSE", "TELE", "TXID", "POID", "BANK" ]
object
object
prtry
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
grnshmtRmt
object (Garnishment3)

Provides remittance information about a payment for garnishment-related purposes.

tp
object (GarnishmentType1) Required

Specifies the type of garnishment.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
cdOrPrtry
object (GarnishmentType1Choice) Required

Specifies the type of garnishment.

OneOf
object
object
cd
string Required

Specifies the garnishment type as published in an external document type code list.

Valid values[ "GNCS", "GNDP", "GTPP" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
grnshmtAdmstr
object (PartyIdentification135)

Specifies the identification of a person or an organisation.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
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 (Contact4)

Specifies the details of the contact person.

nmPrfx
string

Specifies the terms used to formally address a person.

Valid values[ "DOCT", "MADM", "MISS", "MIST", "MIKS" ]
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}
dept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
prefrdMtd
string

Preferred method used to reach the individual contact within an organisation.

Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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}
emailPurp
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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}
rspnsblty
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
jobTitl
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
emailAdr
string

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
nm
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
othr
Array of object (OtherContact1)

Contact details in another form.

object

Communication device number or electronic address used for communication.

id
string

Specifies a character string with a maximum length of 128 characters.

Min length1
Max length128
chanlTp
string Required

Specifies a character string with a maximum length of 4 characters.

Min length1
Max length4
id
object (Party38Choice)

Nature or use of the account.

OneOf
object
object
orgId
object (OrganisationIdentification29) 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: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "BANK", "CBID", "CHID", "CINC", "COID", "CUST", "DUNS", "EMPL", "GS1G", "SREN", "SRET", "TXID", "BDID", "BOID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
object
object
prvtId
object (PersonIdentification13) Required

Unique and unambiguous way to identify a person.

dtAndPlcOfBirth
object (DateAndPlaceOfBirth1)

Date and place of birth of a person.

cityOfBirth
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prvcOfBirth
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
birthDt
string (xs:date) 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))?
Example2002-09-24Z
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "ARNU", "CCPT", "CUST", "DRLC", "EMPL", "NIDN", "SOSE", "TELE", "TXID", "POID", "BANK" ]
object
object
prtry
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
fmlyMdclInsrncInd

A flag indicating a True or False value.

OneOf
boolean
boolean
integer
integer
Minimum0
Maximum1
refNb
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
mplyeeTermntnInd

A flag indicating a True or False value.

OneOf
boolean
boolean
integer
integer
Minimum0
Maximum1
grnshee
object (PartyIdentification135)

Specifies the identification of a person or an organisation.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
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 (Contact4)

Specifies the details of the contact person.

nmPrfx
string

Specifies the terms used to formally address a person.

Valid values[ "DOCT", "MADM", "MISS", "MIST", "MIKS" ]
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}
dept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
prefrdMtd
string

Preferred method used to reach the individual contact within an organisation.

Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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}
emailPurp
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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}
rspnsblty
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
jobTitl
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
emailAdr
string

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
nm
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
othr
Array of object (OtherContact1)

Contact details in another form.

object

Communication device number or electronic address used for communication.

id
string

Specifies a character string with a maximum length of 128 characters.

Min length1
Max length128
chanlTp
string Required

Specifies a character string with a maximum length of 4 characters.

Min length1
Max length4
id
object (Party38Choice)

Nature or use of the account.

OneOf
object
object
orgId
object (OrganisationIdentification29) 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: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "BANK", "CBID", "CHID", "CINC", "COID", "CUST", "DUNS", "EMPL", "GS1G", "SREN", "SRET", "TXID", "BDID", "BOID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
object
object
prvtId
object (PersonIdentification13) Required

Unique and unambiguous way to identify a person.

dtAndPlcOfBirth
object (DateAndPlaceOfBirth1)

Date and place of birth of a person.

cityOfBirth
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prvcOfBirth
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
birthDt
string (xs:date) 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))?
Example2002-09-24Z
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "ARNU", "CCPT", "CUST", "DRLC", "EMPL", "NIDN", "SOSE", "TELE", "TXID", "POID", "BANK" ]
object
object
prtry
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
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.

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}
value
number Required
Minimum0
Maximum10000000000000
dt
string (xs:date)

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))?
Example2002-09-24Z
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
cdOrPrtry
object (CreditorReferenceType1Choice) Required

Specifies the type of document referred by the creditor.

OneOf
object
object
cd
string Required

Specifies a type of financial or commercial document.

Valid values[ "RADM", "RPIN", "FXDR", "DISP", "PUOR", "SCOR" ]
object
object
prtry
string Required

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 (PartyIdentification135)

Specifies the identification of a person or an organisation.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
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 (Contact4)

Specifies the details of the contact person.

nmPrfx
string

Specifies the terms used to formally address a person.

Valid values[ "DOCT", "MADM", "MISS", "MIST", "MIKS" ]
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}
dept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
prefrdMtd
string

Preferred method used to reach the individual contact within an organisation.

Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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}
emailPurp
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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}
rspnsblty
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
jobTitl
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
emailAdr
string

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
nm
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
othr
Array of object (OtherContact1)

Contact details in another form.

object

Communication device number or electronic address used for communication.

id
string

Specifies a character string with a maximum length of 128 characters.

Min length1
Max length128
chanlTp
string Required

Specifies a character string with a maximum length of 4 characters.

Min length1
Max length4
id
object (Party38Choice)

Nature or use of the account.

OneOf
object
object
orgId
object (OrganisationIdentification29) 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: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "BANK", "CBID", "CHID", "CINC", "COID", "CUST", "DUNS", "EMPL", "GS1G", "SREN", "SRET", "TXID", "BDID", "BOID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
object
object
prvtId
object (PersonIdentification13) Required

Unique and unambiguous way to identify a person.

dtAndPlcOfBirth
object (DateAndPlaceOfBirth1)

Date and place of birth of a person.

cityOfBirth
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prvcOfBirth
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
birthDt
string (xs:date) 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))?
Example2002-09-24Z
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "ARNU", "CCPT", "CUST", "DRLC", "EMPL", "NIDN", "SOSE", "TELE", "TXID", "POID", "BANK" ]
object
object
prtry
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
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
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.

rltdDt
string (xs:date)

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))?
Example2002-09-24Z
tp
object (ReferredDocumentType4)

Specifies the type of the document referred in the remittance information.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
cdOrPrtry
object (ReferredDocumentType3Choice) Required

Specifies the type of the document referred in the remittance information.

OneOf
object
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
object
prtry
string Required

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
lineDtls
Array of object (DocumentLineInformation1)

Set of elements used to provide the content of the referred document line.

object

Provides document line information.

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.

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
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.

Valid values[ "CITY", "CNTY", "LOCL", "PROV", "STAT" ]
object
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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
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.

Valid values[ "APDS", "STDS", "TMDS" ]
object
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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.

addtlInf
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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.

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}
value
number Required
Minimum0
Maximum10000000000000
id
Array of object (DocumentLineIdentification1) Required

Provides identification of the document line.

Min items1
object

Identifies the documents referred to in the remittance information.

rltdDt
string (xs:date)

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))?
Example2002-09-24Z
tp
object (DocumentLineType1)

Specifies the type of the document line identification.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
cdOrPrtry
object (DocumentLineType1Choice) Required

Specifies the type of the document line identification.

OneOf
object
object
cd
string Required

Specifies the document line type as published in an external document type code list.

Valid values[ "ADPI", "AISB", "ASNB", "CTNB", "DBSP", "EANN", "EINB", "GSNB", "HIBC", "ISBN", "LTNB", "MDNB", "PRNB", "PTCD", "SKNB", "STNB", "TONB", "UPCC", "UPNB" ]
object
object
prtry
string Required

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
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.

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
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.

Valid values[ "CITY", "CNTY", "LOCL", "PROV", "STAT" ]
object
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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
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.

Valid values[ "APDS", "STDS", "TMDS" ]
object
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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.

addtlInf
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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.

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}
value
number Required
Minimum0
Maximum10000000000000
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.

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}
value
number Required
Minimum0
Maximum10000000000000
xchgRateInf
object (ExchangeRate1)

Further detailed information on the exchange rate that has been used in the payment transaction.

xchgRate
number

Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.

Maximum9.9999999999
rateTp
string

Specifies a type of financial or commercial document.

Valid values[ "SPOT", "SALE", "AGRD" ]
unitCcy
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}
ctrctId
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
intrmyAgt3
object (BranchAndFinancialInstitutionIdentification6)

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

finInstnId
object (FinancialInstitutionIdentification18) Required

Specifies the details to identify a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
bicfi
string

Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([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.

mmbId
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
clrSysId
object (ClearingSystemIdentification2Choice)

Choice of a clearing system identifier.

OneOf
object
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.

Valid values[ "MA", "ATBLZ", "AUBSB", "CACPA", "CHBCC", "CHSIC", "CNAPS", "DEBLZ", "ESNCC", "GBDSC", "GRBIC", "HKNCC", "IENCC", "INFSC", "ITNCC", "JPZGN", "NZNCC", "PLKNR", "PTNCC", "RUCBC", "SESBA", "SGIBG", "THCBC", "TWNCC", "USABA", "USPID", "ZANCC", "NZRSA", "MZBMO", "CNCIP", "KRBOK", "BRISP", "NACSC", "ZWTSS", "AD", "EGNCC", "AE", "AF", "AI", "AL", "AM", "AO", "AR", "AS", "AW", "AZ", "BA", "BD", "BG", "BH", "BI", "BL", "BM", "BN", "BO", "BS", "BT", "BW", "BY", "BZ", "CD", "CL", "CO", "CR", "CV", "CW", "CY", "CZ", "DO", "DZ", "EC", "EE", "GE", "GH", "GN", "GT", "GY", "HN", "HR", "HT", "HU", "ID", "IL", "IQ", "IS", "JM", "JO", "KE", "KG", "KH", "KM", "KW", "KZ", "LB", "LK", "LR", "LS", "LT", "LV", "LY", "MD", "ME", "MG", "MK", "MN", "MO", "MR", "MT", "MU", "MW", "MX", "MY", "NG", "NI", "NP", "OM", "PA", "PE", "PG", "PH", "PK", "PS", "PY", "QA", "RO", "RS", "RW", "SA", "SC", "SD", "SI", "SK", "SL", "ST", "SV", "SZ", "TJ", "TL", "TM", "TN", "TR", "TT", "TZ", "UA", "UG", "UY", "UZ", "VA", "VE", "VN", "XK", "ZM", "MARPA", "MARAC" ]
object
object
prtry
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
othr
object (GenericFinancialIdentification1)

Information related to an identification of a financial institution.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
brnchId
object (BranchData3)

Information that locates and identifies a specific branch of a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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
intrmyAgt2
object (BranchAndFinancialInstitutionIdentification6)

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

finInstnId
object (FinancialInstitutionIdentification18) Required

Specifies the details to identify a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
bicfi
string

Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([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.

mmbId
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
clrSysId
object (ClearingSystemIdentification2Choice)

Choice of a clearing system identifier.

OneOf
object
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.

Valid values[ "MA", "ATBLZ", "AUBSB", "CACPA", "CHBCC", "CHSIC", "CNAPS", "DEBLZ", "ESNCC", "GBDSC", "GRBIC", "HKNCC", "IENCC", "INFSC", "ITNCC", "JPZGN", "NZNCC", "PLKNR", "PTNCC", "RUCBC", "SESBA", "SGIBG", "THCBC", "TWNCC", "USABA", "USPID", "ZANCC", "NZRSA", "MZBMO", "CNCIP", "KRBOK", "BRISP", "NACSC", "ZWTSS", "AD", "EGNCC", "AE", "AF", "AI", "AL", "AM", "AO", "AR", "AS", "AW", "AZ", "BA", "BD", "BG", "BH", "BI", "BL", "BM", "BN", "BO", "BS", "BT", "BW", "BY", "BZ", "CD", "CL", "CO", "CR", "CV", "CW", "CY", "CZ", "DO", "DZ", "EC", "EE", "GE", "GH", "GN", "GT", "GY", "HN", "HR", "HT", "HU", "ID", "IL", "IQ", "IS", "JM", "JO", "KE", "KG", "KH", "KM", "KW", "KZ", "LB", "LK", "LR", "LS", "LT", "LV", "LY", "MD", "ME", "MG", "MK", "MN", "MO", "MR", "MT", "MU", "MW", "MX", "MY", "NG", "NI", "NP", "OM", "PA", "PE", "PG", "PH", "PK", "PS", "PY", "QA", "RO", "RS", "RW", "SA", "SC", "SD", "SI", "SK", "SL", "ST", "SV", "SZ", "TJ", "TL", "TM", "TN", "TR", "TT", "TZ", "UA", "UG", "UY", "UZ", "VA", "VE", "VN", "XK", "ZM", "MARPA", "MARAC" ]
object
object
prtry
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
othr
object (GenericFinancialIdentification1)

Information related to an identification of a financial institution.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
brnchId
object (BranchData3)

Information that locates and identifies a specific branch of a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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
cdtr
object (PartyIdentification135)

Specifies the identification of a person or an organisation.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
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 (Contact4)

Specifies the details of the contact person.

nmPrfx
string

Specifies the terms used to formally address a person.

Valid values[ "DOCT", "MADM", "MISS", "MIST", "MIKS" ]
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}
dept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
prefrdMtd
string

Preferred method used to reach the individual contact within an organisation.

Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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}
emailPurp
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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}
rspnsblty
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
jobTitl
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
emailAdr
string

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
nm
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
othr
Array of object (OtherContact1)

Contact details in another form.

object

Communication device number or electronic address used for communication.

id
string

Specifies a character string with a maximum length of 128 characters.

Min length1
Max length128
chanlTp
string Required

Specifies a character string with a maximum length of 4 characters.

Min length1
Max length4
id
object (Party38Choice)

Nature or use of the account.

OneOf
object
object
orgId
object (OrganisationIdentification29) 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: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "BANK", "CBID", "CHID", "CINC", "COID", "CUST", "DUNS", "EMPL", "GS1G", "SREN", "SRET", "TXID", "BDID", "BOID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
object
object
prvtId
object (PersonIdentification13) Required

Unique and unambiguous way to identify a person.

dtAndPlcOfBirth
object (DateAndPlaceOfBirth1)

Date and place of birth of a person.

cityOfBirth
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prvcOfBirth
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
birthDt
string (xs:date) 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))?
Example2002-09-24Z
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "ARNU", "CCPT", "CUST", "DRLC", "EMPL", "NIDN", "SOSE", "TELE", "TXID", "POID", "BANK" ]
object
object
prtry
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
intrmyAgt1
object (BranchAndFinancialInstitutionIdentification6)

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

finInstnId
object (FinancialInstitutionIdentification18) Required

Specifies the details to identify a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
bicfi
string

Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([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.

mmbId
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
clrSysId
object (ClearingSystemIdentification2Choice)

Choice of a clearing system identifier.

OneOf
object
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.

Valid values[ "MA", "ATBLZ", "AUBSB", "CACPA", "CHBCC", "CHSIC", "CNAPS", "DEBLZ", "ESNCC", "GBDSC", "GRBIC", "HKNCC", "IENCC", "INFSC", "ITNCC", "JPZGN", "NZNCC", "PLKNR", "PTNCC", "RUCBC", "SESBA", "SGIBG", "THCBC", "TWNCC", "USABA", "USPID", "ZANCC", "NZRSA", "MZBMO", "CNCIP", "KRBOK", "BRISP", "NACSC", "ZWTSS", "AD", "EGNCC", "AE", "AF", "AI", "AL", "AM", "AO", "AR", "AS", "AW", "AZ", "BA", "BD", "BG", "BH", "BI", "BL", "BM", "BN", "BO", "BS", "BT", "BW", "BY", "BZ", "CD", "CL", "CO", "CR", "CV", "CW", "CY", "CZ", "DO", "DZ", "EC", "EE", "GE", "GH", "GN", "GT", "GY", "HN", "HR", "HT", "HU", "ID", "IL", "IQ", "IS", "JM", "JO", "KE", "KG", "KH", "KM", "KW", "KZ", "LB", "LK", "LR", "LS", "LT", "LV", "LY", "MD", "ME", "MG", "MK", "MN", "MO", "MR", "MT", "MU", "MW", "MX", "MY", "NG", "NI", "NP", "OM", "PA", "PE", "PG", "PH", "PK", "PS", "PY", "QA", "RO", "RS", "RW", "SA", "SC", "SD", "SI", "SK", "SL", "ST", "SV", "SZ", "TJ", "TL", "TM", "TN", "TR", "TT", "TZ", "UA", "UG", "UY", "UZ", "VA", "VE", "VN", "XK", "ZM", "MARPA", "MARAC" ]
object
object
prtry
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
othr
object (GenericFinancialIdentification1)

Information related to an identification of a financial institution.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
brnchId
object (BranchData3)

Information that locates and identifies a specific branch of a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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
cdtrAgtAcct
object (CashAccount38)

Provides the details to identify an account.

tp
object (CashAccountType2Choice)

Nature or use of the account.

OneOf
object
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.

Valid values[ "CACC", "CARD", "CASH", "CHAR", "CISH", "COMM", "CPAC", "LLSV", "LOAN", "MGLD", "MOMA", "NREX", "ODFT", "ONDP", "OTHR", "SACC", "SLRY", "SVGS", "TAXE", "TRAN", "TRAS", "VACC", "NFCA" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prxy
object (ProxyAccountIdentification1)

Information related to a proxy identification of the account.

tp
object (ProxyAccountType1Choice)

Specifies the scheme used for the identification of an account alias.

OneOf
object
object
cd
string Required

Specifies the external proxy account type code, as published in the proxy account type external code set. External code sets can be downloaded from www.iso20022.org.

Valid values[ "TELE", "EMAL", "DNAM", "CINC", "COTX", "COID", "CUST", "DRLC", "EIDN", "EWAL", "PVTX", "LEIC", "MBNO", "NIDN", "CCPT", "SHID", "SOSE", "TOKN", "UBIL", "VIPN", "BIID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
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}
id
object (AccountIdentification4Choice) Required

Specifies the unique identification of an account as assigned by the account servicer.

OneOf
object
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
object
othr
object (GenericAccountIdentification1) Required

Information related to a generic account identification.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "AIIN", "BBAN", "CUID", "UPIC" ]
object
object
prtry
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 70characters.

Min length1
Max length70
dbtr
object (PartyIdentification135) Required

Specifies the identification of a person or an organisation.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
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 (Contact4)

Specifies the details of the contact person.

nmPrfx
string

Specifies the terms used to formally address a person.

Valid values[ "DOCT", "MADM", "MISS", "MIST", "MIKS" ]
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}
dept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
prefrdMtd
string

Preferred method used to reach the individual contact within an organisation.

Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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}
emailPurp
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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}
rspnsblty
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
jobTitl
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
emailAdr
string

Specifies a character string with a maximum length of 2048 characters.

Min length1
Max length2048
nm
string

Specifies a character string with a maximum length of 140 characters.

Min length1
Max length140
othr
Array of object (OtherContact1)

Contact details in another form.

object

Communication device number or electronic address used for communication.

id
string

Specifies a character string with a maximum length of 128 characters.

Min length1
Max length128
chanlTp
string Required

Specifies a character string with a maximum length of 4 characters.

Min length1
Max length4
id
object (Party38Choice)

Nature or use of the account.

OneOf
object
object
orgId
object (OrganisationIdentification29) 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: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "BANK", "CBID", "CHID", "CINC", "COID", "CUST", "DUNS", "EMPL", "GS1G", "SREN", "SRET", "TXID", "BDID", "BOID" ]
object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
object
object
prvtId
object (PersonIdentification13) Required

Unique and unambiguous way to identify a person.

dtAndPlcOfBirth
object (DateAndPlaceOfBirth1)

Date and place of birth of a person.

cityOfBirth
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
prvcOfBirth
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
birthDt
string (xs:date) 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))?
Example2002-09-24Z
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.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

Valid values[ "ARNU", "CCPT", "CUST", "DRLC", "EMPL", "NIDN", "SOSE", "TELE", "TXID", "POID", "BANK" ]
object
object
prtry
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
pmtInfId
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pmtMtd
string Required

Specifies the transfer method that will be used to transfer an amount of money.

Valid values[ "CHK", "TRF", "TRA" ]
dbtrAgt
object (BranchAndFinancialInstitutionIdentification6) Required

Unique and unambiguous identification of a financial institution or a branch of a financial institution.

finInstnId
object (FinancialInstitutionIdentification18) Required

Specifies the details to identify a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
bicfi
string

Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - "Banking - Banking telecommunication messages - Business identifier code (BIC)".

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([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.

mmbId
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
clrSysId
object (ClearingSystemIdentification2Choice)

Choice of a clearing system identifier.

OneOf
object
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.

Valid values[ "MA", "ATBLZ", "AUBSB", "CACPA", "CHBCC", "CHSIC", "CNAPS", "DEBLZ", "ESNCC", "GBDSC", "GRBIC", "HKNCC", "IENCC", "INFSC", "ITNCC", "JPZGN", "NZNCC", "PLKNR", "PTNCC", "RUCBC", "SESBA", "SGIBG", "THCBC", "TWNCC", "USABA", "USPID", "ZANCC", "NZRSA", "MZBMO", "CNCIP", "KRBOK", "BRISP", "NACSC", "ZWTSS", "AD", "EGNCC", "AE", "AF", "AI", "AL", "AM", "AO", "AR", "AS", "AW", "AZ", "BA", "BD", "BG", "BH", "BI", "BL", "BM", "BN", "BO", "BS", "BT", "BW", "BY", "BZ", "CD", "CL", "CO", "CR", "CV", "CW", "CY", "CZ", "DO", "DZ", "EC", "EE", "GE", "GH", "GN", "GT", "GY", "HN", "HR", "HT", "HU", "ID", "IL", "IQ", "IS", "JM", "JO", "KE", "KG", "KH", "KM", "KW", "KZ", "LB", "LK", "LR", "LS", "LT", "LV", "LY", "MD", "ME", "MG", "MK", "MN", "MO", "MR", "MT", "MU", "MW", "MX", "MY", "NG", "NI", "NP", "OM", "PA", "PE", "PG", "PH", "PK", "PS", "PY", "QA", "RO", "RS", "RW", "SA", "SC", "SD", "SI", "SK", "SL", "ST", "SV", "SZ", "TJ", "TL", "TM", "TN", "TR", "TT", "TZ", "UA", "UG", "UY", "UZ", "VA", "VE", "VN", "XK", "ZM", "MARPA", "MARAC" ]
object
object
prtry
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
othr
object (GenericFinancialIdentification1)

Information related to an identification of a financial institution.

issr
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
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.

object
object
prtry
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
brnchId
object (BranchData3)

Information that locates and identifies a specific branch of a financial institution.

pstlAdr
object (PostalAddress24)

Information that locates and identifies a specific address, as defined by postal services.

strtNm
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
ctrySubDvsn
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
flr
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
bldgNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
twnLctnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
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
twnNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
subDept
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
pstBx
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
dstrctNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
dept
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
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}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string Required

Specifies the type of address.

Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
object
prtry
object (GenericIdentification30) Required

Information related to an identification, for example, party identification or account identification.

issr
string Required

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
id
string Required

Specifies an alphanumeric string with a length of 4 characters.

Pattern[a-zA-Z0-9]{4}
schmeNm
string

Specifies a character string with a maximum length of 35 characters.

Min length1
Max length35
pstCd
string

Specifies a character string with a maximum length of 16 characters.

Min length1
Max length16
room
string

Specifies a character string with a maximum length of 70characters.

Min length1
Max length70
lei
string

Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".

Pattern[A-Z0-9]{18,18}[0-9]{2,2}
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
btchBookg

Identifies whether the sending party requests a single debit or credit entry per individual transaction or a batch entry for the sum of the amounts of all transactions.

OneOf
boolean
boolean
integer
integer
Minimum0
Maximum1
Responses
200

OK - The operation is idempotent, and the same payment has been submitted successfully previously.

Expand All
object
data
object (Data)
paymentsHubId
string
Example56bc0609-6a4d-3cca-a614-b9b40d92ec59
paymentId
string
ExamplepaymentId
status
string
ExamplePENDING
creationDateTime
string (date-time)
Example2021-12-18T13:15:22Z
201

Created - Payment has been submitted successfully.

Expand All
object
data
object (Data)
paymentsHubId
string
Example56bc0609-6a4d-3cca-a614-b9b40d92ec59
paymentId
string
ExamplepaymentId
status
string
ExamplePENDING
creationDateTime
string (date-time)
Example2021-12-18T13:15:22Z
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." } ] }