Creates a credit transfer to make a payment (pain001/v09).
- 05 Feb 2024
- 111 Minutes to read
- Print
- DarkLight
Creates a credit transfer to make a payment (pain001/v09).
- Updated on 05 Feb 2024
- 111 Minutes to read
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
Post
/pain001/v09
Creates a credit transfer to make a payment using the pain.001.001.09 message format.
Security
OAuth
FlowImplicit
Authorization URL$(authorization-url)
Scopes:
makePaymentsDefault scope
Header parameters
x-santander-client-id
stringRequired
Client ID header
sca-token
stringRequired
JWT token for payload validation
x-santander-consumer
string
Consumer Id for checking ownership of payments
x-b3-traceid
string
Overall ID of the trace, shared by every span in the trace. The value is 64 or 128 bits long.
x-b3-parentspanid
string
Position of the parent operation in the trace tree. The value is 64 bits long. The value is omitted when the span is the root of the trace tree.
x-b3-spanid
string
Position of the current operation in the trace tree. The value is 64 bits long. Do not interpret the value; it may or may not be derived from the value of the TraceId.
x-b3-sampled
string
Sampling decision. Sampling is a mechanism to reduce the volume of data in the tracing system. In B3, sampling applies consistently per-trace: once the sampling decision is made, the same value must be consistently sent downstream. This means that either all or no spans share a trace ID.
Body parameters
object
Document following ISO20022 pain.001.001.09 rules
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.
grpHdr
object (GroupHeader85)Required
Set of characteristics shared by all individual transactions included in the message.
msgId
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
creDtTm
string Required
a particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. note on the time format:
- beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
- fractions of second in time format decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
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.
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
nbOfTxs
string Required
Specifies a numeric string with a maximum length of 15 digits.
Pattern[0-9]{1,15}
ctrlSum
number
Number of objects represented as a decimal number, for example 0.75 or 45.6.
Maximum9.99999999999999999
initgPty
object (PartyIdentification135)Required
Specifies the identification of a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
object
cd
string Required
Specifies the type of address.
Valid values[ "ADDR", "PBOX", "HOME", "BIZZ", "MLTO", "DLVY" ]
object
prtry
object (GenericIdentification30)Required
Information related to an identification, for example, party identification or account identification.
id
string Required
Specifies an alphanumeric string with a length of 4 characters.
Pattern[a-zA-Z0-9]{4}
issr
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
schmeNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
id
object (Party38Choice)
Nature or use of the account.
OneOf
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.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
schmeNm
object (OrganisationIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
issr
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
object
prvtId
object (PersonIdentification13)Required
Unique and unambiguous way to identify a person.
dtAndPlcOfBirth
object (DateAndPlaceOfBirth1)
Date and place of birth of a person.
birthDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
prvcOfBirth
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
cityOfBirth
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctryOfBirth
string Required
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
othr
Array of object (GenericPersonIdentification1)
Unique identification of a person, as assigned by an institution, using an identification scheme.
object
Information related to an identification of a person.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
schmeNm
object (PersonIdentificationSchemeName1Choice)
Sets of elements to identify a name of the identification scheme.
OneOf
issr
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
emailPurp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
jobTitl
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
rspnsblty
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
Array of object (OtherContact1)
Contact details in another form.
object
Communication device number or electronic address used for communication.
chanlTp
string Required
Specifies a character string with a maximum length of 4 characters.
Max length4
Min length1
id
string
Specifies a character string with a maximum length of 128 characters.
Max length128
Min length1
prefrdMtd
string
Preferred method used to reach the individual contact within an organisation.
Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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.
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.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
issr
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
brnchId
object (BranchData3)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
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.
object
Characteristics that apply to the debit side of the payment transactions included in the credit transfer initiation.
pmtInfId
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
pmtMtd
string Required
Specifies the transfer method that will be used to transfer an amount of money.
Valid values[ "CHK", "TRF", "TRA" ]
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
Maximum1
Minimum0
nbOfTxs
string
Specifies a numeric string with a maximum length of 15 digits.
Pattern[0-9]{1,15}
ctrlSum
number
Number of objects represented as a decimal number, for example 0.75 or 45.6.
Maximum9.99999999999999999
pmtTpInf
object (PaymentTypeInformation26)
Provides further details of the type of payment.
instrPrty
string
Specifies the priority level of an event.
Valid values[ "HIGH", "NORM" ]
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
lclInstrm
object (LocalInstrument2Choice)
Set of elements that further identifies the type of local instruments being requested by the initiating party.
OneOf
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
reqdExctnDt
object (DateAndDateTime2Choice)Required
Choice between a date or a date and time format.
OneOf
object
dt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
object
dtTm
string Required
a particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. note on the time format:
- beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
- fractions of second in time format decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
poolgAdjstmntDt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
dbtr
object (PartyIdentification135)Required
Specifies the identification of a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
id
object (Party38Choice)
Nature or use of the account.
OneOf
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" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
emailPurp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
jobTitl
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
rspnsblty
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
Array of object (OtherContact1)
Contact details in another form.
object
Communication device number or electronic address used for communication.
chanlTp
string Required
Specifies a character string with a maximum length of 4 characters.
Max length4
Min length1
id
string
Specifies a character string with a maximum length of 128 characters.
Max length128
Min length1
prefrdMtd
string
Preferred method used to reach the individual contact within an organisation.
Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
dbtrAcct
object (CashAccount38)Required
Provides the details to identify an account.
id
object (AccountIdentification4Choice)Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
object
cd
string Required
Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Max length4
Min length1
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
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
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.
Max length4
Min length1
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
id
string Required
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
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.
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.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
issr
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
brnchId
object (BranchData3)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
dbtrAgtAcct
object (CashAccount38)
Provides the details to identify an account.
id
object (AccountIdentification4Choice)Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
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
id
string Required
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
instrForDbtrAgt
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
ultmtDbtr
object (PartyIdentification135)
Specifies the identification of a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
id
object (Party38Choice)
Nature or use of the account.
OneOf
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" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
emailPurp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
jobTitl
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
rspnsblty
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
Array of object (OtherContact1)
Contact details in another form.
object
Communication device number or electronic address used for communication.
chanlTp
string Required
Specifies a character string with a maximum length of 4 characters.
Max length4
Min length1
id
string
Specifies a character string with a maximum length of 128 characters.
Max length128
Min length1
prefrdMtd
string
Preferred method used to reach the individual contact within an organisation.
Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
chrgBr
string
Specifies which party(ies) will pay charges due for processing of the instruction.
Valid values[ "DEBT", "CRED", "SHAR", "SLEV" ]
chrgsAcct
object (CashAccount38)
Provides the details to identify an account.
id
object (AccountIdentification4Choice)Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
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
id
string Required
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
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.
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.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
issr
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
brnchId
object (BranchData3)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
cdtTrfTxInf
Array of object (CreditTransferTransaction34) Required
Provides information on the individual transaction(s) included in the message.
object
Provide further details specific to the individual transaction(s) included in the message.
pmtId
object (PaymentIdentification6)Required
Provides further means of referencing a payment transaction.
instrId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
endToEndId
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
pmtTpInf
object (PaymentTypeInformation26)
Provides further details of the type of payment.
instrPrty
string
Specifies the priority level of an event.
Valid values[ "HIGH", "NORM" ]
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
lclInstrm
object (LocalInstrument2Choice)
Set of elements that further identifies the type of local instruments being requested by the initiating party.
OneOf
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
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
instdAmt
object (ActiveOrHistoricCurrencyAndAmount)Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
object
eqvtAmt
object (EquivalentAmount2)Required
Amount of money to be moved between the debtor and creditor, expressed in the currency of the debtor's account, and the currency in which the amount is to be moved.
amt
object (ActiveOrHistoricCurrencyAndAmount)Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
ccyOfTrf
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
xchgRateInf
object (ExchangeRate1)
Further detailed information on the exchange rate that has been used in the payment transaction.
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}
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" ]
ctrctId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
chrgBr
string
Specifies which party(ies) will pay charges due for processing of the instruction.
Valid values[ "DEBT", "CRED", "SHAR", "SLEV" ]
chqInstr
object (Cheque11)
Characteristics of a cheque instruction, such as cheque type or cheque number.
chqTp
string
Specifies the type of cheque.
Valid values[ "CCHQ", "CCCH", "BCHQ", "DRFT", "ELDR" ]
chqNb
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
chqFr
object (NameAndAddress16)
Information that locates and identifies a party.
nm
string Required
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
adr
object (PostalAddress24)Required
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
dlvryMtd
object (ChequeDeliveryMethod1Choice)
Set of characteristics related to a cheque instruction, such as cheque type or cheque number.
OneOf
dlvrTo
object (NameAndAddress16)
Information that locates and identifies a party.
nm
string Required
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
adr
object (PostalAddress24)Required
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
instrPrty
string
Specifies the priority level of an event.
Valid values[ "HIGH", "NORM" ]
chqMtrtyDt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
frmsCd
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
memoFld
Array of string (Max35Text)
Information that needs to be printed on a cheque, used by the payer to add miscellaneous information.
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
rgnlClrZone
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
prtLctn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
sgntr
Array of string (Max70Text)
Signature to be used by the cheque servicer on a specific cheque to be printed.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
ultmtDbtr
object (PartyIdentification135)
Specifies the identification of a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
id
object (Party38Choice)
Nature or use of the account.
OneOf
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" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
emailPurp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
jobTitl
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
rspnsblty
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
Array of object (OtherContact1)
Contact details in another form.
object
Communication device number or electronic address used for communication.
chanlTp
string Required
Specifies a character string with a maximum length of 4 characters.
Max length4
Min length1
id
string
Specifies a character string with a maximum length of 128 characters.
Max length128
Min length1
prefrdMtd
string
Preferred method used to reach the individual contact within an organisation.
Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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.
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.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
issr
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
brnchId
object (BranchData3)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
intrmyAgt1Acct
object (CashAccount38)
Provides the details to identify an account.
id
object (AccountIdentification4Choice)Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
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
id
string Required
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
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.
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.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
issr
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
brnchId
object (BranchData3)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
intrmyAgt2Acct
object (CashAccount38)
Provides the details to identify an account.
id
object (AccountIdentification4Choice)Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
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
id
string Required
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
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.
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.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
issr
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
brnchId
object (BranchData3)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
intrmyAgt3Acct
object (CashAccount38)
Provides the details to identify an account.
id
object (AccountIdentification4Choice)Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
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
id
string Required
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
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.
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.
clrSysId
object (ClearingSystemIdentification2Choice)
Choice of a clearing system identifier.
OneOf
mmbId
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
object (GenericFinancialIdentification1)
Information related to an identification of a financial institution.
id
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
schmeNm
object (FinancialIdentificationSchemeName1Choice)
Sets of elements to identify a name of the organisation identification scheme.
OneOf
issr
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
brnchId
object (BranchData3)
Information that locates and identifies a specific branch of a financial institution.
id
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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}
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
cdtrAgtAcct
object (CashAccount38)
Provides the details to identify an account.
id
object (AccountIdentification4Choice)Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
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
id
string Required
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
cdtr
object (PartyIdentification135)
Specifies the identification of a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
id
object (Party38Choice)
Nature or use of the account.
OneOf
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" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
emailPurp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
jobTitl
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
rspnsblty
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
Array of object (OtherContact1)
Contact details in another form.
object
Communication device number or electronic address used for communication.
chanlTp
string Required
Specifies a character string with a maximum length of 4 characters.
Max length4
Min length1
id
string
Specifies a character string with a maximum length of 128 characters.
Max length128
Min length1
prefrdMtd
string
Preferred method used to reach the individual contact within an organisation.
Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
cdtrAcct
object (CashAccount38)
Provides the details to identify an account.
id
object (AccountIdentification4Choice)Required
Specifies the unique identification of an account as assigned by the account servicer.
OneOf
tp
object (CashAccountType2Choice)
Nature or use of the account.
OneOf
ccy
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
nm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
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
id
string Required
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
ultmtCdtr
object (PartyIdentification135)
Specifies the identification of a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
id
object (Party38Choice)
Nature or use of the account.
OneOf
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" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
emailPurp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
jobTitl
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
rspnsblty
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
Array of object (OtherContact1)
Contact details in another form.
object
Communication device number or electronic address used for communication.
chanlTp
string Required
Specifies a character string with a maximum length of 4 characters.
Max length4
Min length1
id
string
Specifies a character string with a maximum length of 128 characters.
Max length128
Min length1
prefrdMtd
string
Preferred method used to reach the individual contact within an organisation.
Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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.
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" ]
instrInf
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
instrForDbtrAgt
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
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
rgltryRptg
Array of object (RegulatoryReporting3)
Information needed due to regulatory and statutory requirements.
object
Information needed due to regulatory and/or statutory requirements.
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" ]
authrty
object (RegulatoryAuthority2)
Entity requiring the regulatory reporting information.
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
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}
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.
Max length35
Min length1
dt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
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}
cd
string
Specifies a character string with a maximum length of 10 characters.
Max length10
Min length1
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.
value
number Required
Maximum9999999999999.99999
Minimum0
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}
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.
Max length35
Min length1
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.
cdtr
object (TaxParty1)
Details about the entity involved in the tax paid or to be paid.
taxId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
regnId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
taxTp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dbtr
object (TaxParty2)
Details about the entity involved in the tax paid or to be paid.
taxId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
regnId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
taxTp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
authstn
object (TaxAuthorisation1)
Details of the authorised tax paying party.
titl
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
admstnZone
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
refNb
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
mtd
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ttlTaxblBaseAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
ttlTaxAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
dt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
seqNb
integer
Number of objects represented as an integer.
Maximum999999999999999999
rcrd
Array of object (TaxRecord2)
Record of tax details.
object
Set of elements used to define the tax record.
tp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctgy
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctgyDtls
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dbtrSts
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
certId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
frmsCd
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
prd
object (TaxPeriod2)
Period of time details related to the tax payment.
yr
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
tp
string
Specifies the period related to the tax payment.
Valid values[ "MM01", "MM02", "MM03", "MM04", "MM05", "MM06", "MM07", "MM08", "MM09", "MM10", "MM11", "MM12", "QTR1", "QTR2", "QTR3", "QTR4", "HLF1", "HLF2" ]
frToDt
object (DatePeriod2)
Range of time defined by a start date and an end date.
frDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
toDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
taxAmt
object (TaxAmount2)
Set of elements used to provide information on the tax amount(s) of tax record.
rate
number
Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%.
Maximum9.9999999999
taxblBaseAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
ttlAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
dtls
Array of object (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.
prd
object (TaxPeriod2)
Period of time details related to the tax payment.
yr
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
tp
string
Specifies the period related to the tax payment.
Valid values[ "MM01", "MM02", "MM03", "MM04", "MM05", "MM06", "MM07", "MM08", "MM09", "MM10", "MM11", "MM12", "QTR1", "QTR2", "QTR3", "QTR4", "HLF1", "HLF2" ]
frToDt
object (DatePeriod2)
Range of time defined by a start date and an end date.
frDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
toDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
amt
object (ActiveOrHistoricCurrencyAndAmount)Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
addtlInf
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
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.
object
Provides information on the remittance advice.
rmtId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
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.
mtd
string Required
Specifies the method used to deliver the remittance advice information.
Valid values[ "FAXI", "EDIC", "URID", "EMAL", "POST", "SMSM" ]
elctrncAdr
string
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
pstlAdr
object (NameAndAddress16)
Information that locates and identifies a party.
nm
string Required
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
adr
object (PostalAddress24)Required
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
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.
Max length140
Min length1
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.
rfrdDocInf
Array of object (ReferredDocumentInformation7)
Provides the identification and the content of the referred document.
object
Set of elements used to identify the documents referred to in the remittance information.
tp
object (ReferredDocumentType4)
Specifies the type of the document referred in the remittance information.
cdOrPrtry
object (ReferredDocumentType3Choice)Required
Specifies the type of the document referred in the remittance information.
OneOf
object
cd
string Required
Specifies a type of financial or commercial document.
Valid values[ "MSIN", "CNFA", "DNFA", "CINV", "CREN", "DEBN", "HIRI", "SBIN", "CMCN", "SOAC", "DISP", "BOLD", "VCHR", "AROI", "TSUT", "PUOR" ]
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
issr
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
nb
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
rltdDt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
lineDtls
Array of object (DocumentLineInformation1)
Set of elements used to provide the content of the referred document line.
object
Provides document line information.
id
Array of object (DocumentLineIdentification1) Required
Provides identification of the document line.
object
Identifies the documents referred to in the remittance information.
tp
object (DocumentLineType1)
Specifies the type of the document line identification.
cdOrPrtry
object (DocumentLineType1Choice)Required
Specifies the type of the document line identification.
OneOf
object
cd
string Required
Specifies the document line type as published in an external document type code list.
Max length4
Min length1
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
issr
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
nb
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
rltdDt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
desc
string
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
amt
object (RemittanceAmount3)
Nature of the amount and currency on a document referred to in the remittance section, typically either the original amount due/payable or the amount actually remitted for the referenced document.
duePyblAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
dscntApldAmt
Array of object (DiscountAmountAndType1)
Amount of discount to be applied to the amount due and payable to the creditor.
object
Specifies the amount with a specific type.
tp
object (DiscountAmountType1Choice)
Specifies the amount type.
OneOf
object
cd
string Required
Specifies the nature, or use, of the amount in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Max length4
Min length1
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
amt
object (ActiveOrHistoricCurrencyAndAmount)Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
cdtNoteAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
taxAmt
Array of object (TaxAmountAndType1)
Amount of the tax.
object
Specifies the amount with a specific type.
tp
object (TaxAmountType1Choice)
Specifies the amount type.
OneOf
object
cd
string Required
Specifies the nature, or use, of the amount in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.
Max length4
Min length1
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
amt
object (ActiveOrHistoricCurrencyAndAmount)Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
adjstmntAmtAndRsn
Array of object (DocumentAdjustment1)
Specifies detailed information on the amount and reason of the adjustment.
object
Set of elements used to provide information on the amount and reason of the document adjustment.
amt
object (ActiveOrHistoricCurrencyAndAmount)Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
cdtDbtInd
string
Specifies if an operation is an increase or a decrease.
Valid values[ "CRDT", "DBIT" ]
rsn
string
Specifies a character string with a maximum length of 4 characters.
Max length4
Min length1
addtlInf
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
rmtdAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
rfrdDocAmt
object (RemittanceAmount2)
Nature of the amount and currency on a document referred to in the remittance section, typically either the original amount due/payable or the amount actually remitted for the referenced document.
duePyblAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
dscntApldAmt
Array of object (DiscountAmountAndType1)
Amount specified for the referred document is the amount of discount to be applied to the amount due and payable to the creditor.
object
Specifies the amount with a specific type.
tp
object (DiscountAmountType1Choice)
Specifies the amount type.
OneOf
amt
object (ActiveOrHistoricCurrencyAndAmount)Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
cdtNoteAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
taxAmt
Array of object (TaxAmountAndType1)
Quantity of cash resulting from the calculation of the tax.
object
Specifies the amount with a specific type.
tp
object (TaxAmountType1Choice)
Specifies the amount type.
OneOf
amt
object (ActiveOrHistoricCurrencyAndAmount)Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
adjstmntAmtAndRsn
Array of object (DocumentAdjustment1)
Specifies detailed information on the amount and reason of the document adjustment.
object
Set of elements used to provide information on the amount and reason of the document adjustment.
amt
object (ActiveOrHistoricCurrencyAndAmount)Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
cdtDbtInd
string
Specifies if an operation is an increase or a decrease.
Valid values[ "CRDT", "DBIT" ]
rsn
string
Specifies a character string with a maximum length of 4 characters.
Max length4
Min length1
addtlInf
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
rmtdAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
cdtrRefInf
object (CreditorReferenceInformation2)
Reference information provided by the creditor to allow the identification of the underlying documents.
tp
object (CreditorReferenceType2)
Specifies the type of creditor reference.
cdOrPrtry
object (CreditorReferenceType1Choice)Required
Specifies the type of document referred by the creditor.
OneOf
issr
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ref
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
invcr
object (PartyIdentification135)
Specifies the identification of a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
id
object (Party38Choice)
Nature or use of the account.
OneOf
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" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
emailPurp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
jobTitl
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
rspnsblty
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
Array of object (OtherContact1)
Contact details in another form.
object
Communication device number or electronic address used for communication.
chanlTp
string Required
Specifies a character string with a maximum length of 4 characters.
Max length4
Min length1
id
string
Specifies a character string with a maximum length of 128 characters.
Max length128
Min length1
prefrdMtd
string
Preferred method used to reach the individual contact within an organisation.
Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
invcee
object (PartyIdentification135)
Specifies the identification of a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
id
object (Party38Choice)
Nature or use of the account.
OneOf
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" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
emailPurp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
jobTitl
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
rspnsblty
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
Array of object (OtherContact1)
Contact details in another form.
object
Communication device number or electronic address used for communication.
chanlTp
string Required
Specifies a character string with a maximum length of 4 characters.
Max length4
Min length1
id
string
Specifies a character string with a maximum length of 128 characters.
Max length128
Min length1
prefrdMtd
string
Preferred method used to reach the individual contact within an organisation.
Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
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.
cdtr
object (TaxParty1)
Details about the entity involved in the tax paid or to be paid.
taxId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
regnId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
taxTp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dbtr
object (TaxParty2)
Details about the entity involved in the tax paid or to be paid.
taxId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
regnId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
taxTp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
authstn
object (TaxAuthorisation1)
Details of the authorised tax paying party.
titl
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
ultmtDbtr
object (TaxParty2)
Details about the entity involved in the tax paid or to be paid.
taxId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
regnId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
taxTp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
authstn
object (TaxAuthorisation1)
Details of the authorised tax paying party.
titl
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
admstnZone
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
refNb
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
mtd
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ttlTaxblBaseAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
ttlTaxAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
dt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
seqNb
integer
Number of objects represented as an integer.
Maximum999999999999999999
rcrd
Array of object (TaxRecord2)
Record of tax details.
object
Set of elements used to define the tax record.
tp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctgy
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctgyDtls
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dbtrSts
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
certId
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
frmsCd
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
prd
object (TaxPeriod2)
Period of time details related to the tax payment.
yr
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
tp
string
Specifies the period related to the tax payment.
Valid values[ "MM01", "MM02", "MM03", "MM04", "MM05", "MM06", "MM07", "MM08", "MM09", "MM10", "MM11", "MM12", "QTR1", "QTR2", "QTR3", "QTR4", "HLF1", "HLF2" ]
frToDt
object (DatePeriod2)
Range of time defined by a start date and an end date.
frDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
toDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
taxAmt
object (TaxAmount2)
Set of elements used to provide information on the tax amount(s) of tax record.
rate
number
Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%.
Maximum9.9999999999
taxblBaseAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
ttlAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
dtls
Array of object (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.
prd
object (TaxPeriod2)
Period of time details related to the tax payment.
yr
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
tp
string
Specifies the period related to the tax payment.
Valid values[ "MM01", "MM02", "MM03", "MM04", "MM05", "MM06", "MM07", "MM08", "MM09", "MM10", "MM11", "MM12", "QTR1", "QTR2", "QTR3", "QTR4", "HLF1", "HLF2" ]
frToDt
object (DatePeriod2)
Range of time defined by a start date and an end date.
frDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
toDt
string Required
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
amt
object (ActiveOrHistoricCurrencyAndAmount)Required
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
addtlInf
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
grnshmtRmt
object (Garnishment3)
Provides remittance information about a payment for garnishment-related purposes.
tp
object (GarnishmentType1)Required
Specifies the type of garnishment.
cdOrPrtry
object (GarnishmentType1Choice)Required
Specifies the type of garnishment.
OneOf
object
cd
string Required
Specifies the garnishment type as published in an external document type code list.
Max length4
Min length1
object
prtry
string Required
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
issr
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
grnshee
object (PartyIdentification135)
Specifies the identification of a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
id
object (Party38Choice)
Nature or use of the account.
OneOf
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" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
emailPurp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
jobTitl
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
rspnsblty
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
Array of object (OtherContact1)
Contact details in another form.
object
Communication device number or electronic address used for communication.
chanlTp
string Required
Specifies a character string with a maximum length of 4 characters.
Max length4
Min length1
id
string
Specifies a character string with a maximum length of 128 characters.
Max length128
Min length1
prefrdMtd
string
Preferred method used to reach the individual contact within an organisation.
Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
grnshmtAdmstr
object (PartyIdentification135)
Specifies the identification of a person or an organisation.
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
pstlAdr
object (PostalAddress24)
Information that locates and identifies a specific address, as defined by postal services.
adrTp
object (AddressType3Choice)
Choice of formats for the type of address.
OneOf
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
subDept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
strtNm
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
bldgNb
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
bldgNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
flr
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstBx
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
room
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
pstCd
string
Specifies a character string with a maximum length of 16 characters.
Max length16
Min length1
twnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
twnLctnNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dstrctNm
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctrySubDvsn
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
ctry
string
Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
Pattern[A-Z]{2,2}
adrLine
Array of string (Max70Text)
Information that locates and identifies a specific address, as defined by postal services, presented in free format text.
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
id
object (Party38Choice)
Nature or use of the account.
OneOf
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" ]
nm
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
phneNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
mobNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
faxNb
string
the collection of information which identifies a specific phone or FAX number as defined by telecom services. it consists of a "+" followed by the country code (from 1 to 3 characters) then a "-" and finally, any combination of numbers, "(", ")", "+" and "-" (up to 30 characters).
Pattern\+[0-9]{1,3}-[0-9()+\-]{1,30}
emailAdr
string
Specifies a character string with a maximum length of 2048 characters.
Max length2048
Min length1
emailPurp
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
jobTitl
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
rspnsblty
string
Specifies a character string with a maximum length of 35 characters.
Max length35
Min length1
dept
string
Specifies a character string with a maximum length of 70characters.
Max length70
Min length1
othr
Array of object (OtherContact1)
Contact details in another form.
object
Communication device number or electronic address used for communication.
chanlTp
string Required
Specifies a character string with a maximum length of 4 characters.
Max length4
Min length1
id
string
Specifies a character string with a maximum length of 128 characters.
Max length128
Min length1
prefrdMtd
string
Preferred method used to reach the individual contact within an organisation.
Valid values[ "LETT", "MAIL", "PHON", "FAXX", "CELL" ]
refNb
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
dt
string
A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
rmtdAmt
object (ActiveOrHistoricCurrencyAndAmount)
A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.
value
number Required
Maximum9999999999999.99999
Minimum0
ccy
string Required
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
Pattern[A-Z]{3,3}
fmlyMdclInsrncInd
A flag indicating a True or False value.
OneOf
boolean
boolean
integer
integer
Maximum1
Minimum0
mplyeeTermntnInd
A flag indicating a True or False value.
OneOf
boolean
boolean
integer
integer
Maximum1
Minimum0
addtlRmtInf
Array of string (Max140Text)
Additional information, in free text form, to complement the structured remittance information.
string
Specifies a character string with a maximum length of 140 characters.
Max length140
Min length1
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.
Max length350
Min length1
envlp
object (SupplementaryDataEnvelope1)Required
Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.
splmtryData
Array of object (SupplementaryData1)
Additional information that cannot be captured in the structured elements and/or any other specific block.
object
Additional information that can not be captured in the structured fields and/or any other specific block.
plcAndNm
string
Specifies a character string with a maximum length of 350 characters.
Max length350
Min length1
envlp
object (SupplementaryDataEnvelope1)Required
Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.
Responses
200
OK - The operation is idempotent, and the same payment has been submitted successfully previously.
object
data
object (Data)
paymentsHubId
string
paymentId
string
status
string
creationDateTime
string
201
Created - Payment has been submitted successfully.
object
data
object (Data)
paymentsHubId
string
paymentId
string
status
string
creationDateTime
string
400
Bad request
object
401
Unauthorized
object
403
Forbidden
object
404
Not found
object
406
Not Acceptable
object
415
Unsupported media type
object
429
Too Many Requests
object
500
Internal server error
object
503
Service unavailable
object
504
Gateway timeout
object
Was this article helpful?
