Retrieves a resolution of investigation message (camt025/v05).

Prev Next
Get
/camt025/v05/{paymentsHubId}

The resolution of investigation message is sent by a case assignee to a case creator/case assigner.

This message is used to inform of the resolution of a case.

Header parameters
X-Client-Id
string

Client ID header

Example0123
Path parameters
paymentsHubId
stringRequired

Unique identification as assigned by the Payments Hub to uniquely identify the payment submission resource.

Example11111111-1111-1111-1111-111111111111
Responses
200

OK - The resolution of investigation message has been retrieved successfully.

Expand All
object
rct
object (ReceiptV05)

Scope The Receipt message is sent by the transaction administrator to a member of the system. It is sent to acknowledge the receipt of one or multiple messages sent previously. The Receipt message is an application receipt acknowledgement and conveys information about the processing of the original message(s). Usage The Receipt message is used when the exchange of messages takes place in an asynchronous manner. This may happen, for instance, when an action is requested from the transaction administrator (a deletion, modification or cancellation). The transaction administrator will first acknowledge the request (with a Receipt message) and then execute it. The message can contain information based on the following elements: reference of the message(s) it acknowledges, the status code (optional) and further explanation:

  • reference of the message it acknowledges
  • potentially, a status code and an explanation.
splmtryData
Array of object (SupplementaryData1)

Additional information that cannot be captured in the structured elements and/or any other specific block.

object

Additional information that can not be captured in the structured fields and/or any other specific block.

plcAndNm
string

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

Min length1
Max length350
envlp
object (SupplementaryDataEnvelope1)

Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.

rctDtls
Array of object (Receipt3)

Details of the receipt.

Min items1
object

Provides details on the request.

orgnlPmtId
object (PaymentIdentification6Choice)

Choice between ways of identifying a payment instruction by its references and business identification.

OneOf
object
object
lngBizId
object (LongPaymentIdentification2)

Identifies a payment instruction by a set of characteristics (as per EBA system requirements) which provides an unambiguous identification of the instruction.

instdAgt
object (BranchAndFinancialInstitutionIdentification6)

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

finInstnId
object (FinancialInstitutionIdentification18)

Specifies the details to identify a financial institution.

pstlAdr
object (PostalAddress24)

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

strtNm
string

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

Min length1
Max length70
ctrySubDvsn
string

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

Min length1
Max length35
flr
string

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

Min length1
Max length70
bldgNm
string

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

Min length1
Max length35
twnLctnNm
string

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

Min length1
Max length35
adrLine
Array of string (Max70Text)

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max items7
string

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

Min length1
Max length70
twnNm
string

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

Min length1
Max length35
subDept
string

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

Min length1
Max length70
pstBx
string

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

Min length1
Max length16
dstrctNm
string

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

Min length1
Max length35
dept
string

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

Min length1
Max length70
bldgNb
string

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

Min length1
Max length16
ctry
string

Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

Pattern[A-Z]{2,2}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string

Specifies the type of address.

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

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

issr
string

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

Min length1
Max length35
id
string

Specifies an alphanumeric string with a length of 4 characters.

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

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

Min length1
Max length35
pstCd
string

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

Min length1
Max length16
room
string

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

Min length1
Max length70
lei
string

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

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

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

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)

Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.

mmbId
string

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

Min length1
Max length35
clrSysId
object (ClearingSystemIdentification2Choice)

Choice of a clearing system identifier.

OneOf
object
object
cd
string

Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.

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

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

Min length1
Max length35
nm
string

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

Min length1
Max length140
othr
object (GenericFinancialIdentification1)

Information related to an identification of a financial institution.

issr
string

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

Min length1
Max length35
id
string

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

Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)

Sets of elements to identify a name of the organisation identification scheme.

OneOf
object
object
cd
string

Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.

object
object
prtry
string

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

Min length1
Max length35
brnchId
object (BranchData3)

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

pstlAdr
object (PostalAddress24)

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

strtNm
string

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

Min length1
Max length70
ctrySubDvsn
string

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

Min length1
Max length35
flr
string

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

Min length1
Max length70
bldgNm
string

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

Min length1
Max length35
twnLctnNm
string

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

Min length1
Max length35
adrLine
Array of string (Max70Text)

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max items7
string

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

Min length1
Max length70
twnNm
string

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

Min length1
Max length35
subDept
string

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

Min length1
Max length70
pstBx
string

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

Min length1
Max length16
dstrctNm
string

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

Min length1
Max length35
dept
string

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

Min length1
Max length70
bldgNb
string

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

Min length1
Max length16
ctry
string

Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

Pattern[A-Z]{2,2}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string

Specifies the type of address.

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

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

issr
string

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

Min length1
Max length35
id
string

Specifies an alphanumeric string with a length of 4 characters.

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

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

Min length1
Max length35
pstCd
string

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

Min length1
Max length16
room
string

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

Min length1
Max length70
lei
string

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

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

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

Min length1
Max length35
nm
string

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

Min length1
Max length140
ntryTp
string

Identifier providing additional system specific information about the entry.

Pattern[BEOVW]{1,1}[0-9]{2,2}|DUM
txId
string

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

Min length1
Max length35
instgAgt
object (BranchAndFinancialInstitutionIdentification6)

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

finInstnId
object (FinancialInstitutionIdentification18)

Specifies the details to identify a financial institution.

pstlAdr
object (PostalAddress24)

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

strtNm
string

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

Min length1
Max length70
ctrySubDvsn
string

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

Min length1
Max length35
flr
string

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

Min length1
Max length70
bldgNm
string

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

Min length1
Max length35
twnLctnNm
string

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

Min length1
Max length35
adrLine
Array of string (Max70Text)

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max items7
string

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

Min length1
Max length70
twnNm
string

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

Min length1
Max length35
subDept
string

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

Min length1
Max length70
pstBx
string

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

Min length1
Max length16
dstrctNm
string

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

Min length1
Max length35
dept
string

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

Min length1
Max length70
bldgNb
string

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

Min length1
Max length16
ctry
string

Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

Pattern[A-Z]{2,2}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string

Specifies the type of address.

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

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

issr
string

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

Min length1
Max length35
id
string

Specifies an alphanumeric string with a length of 4 characters.

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

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

Min length1
Max length35
pstCd
string

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

Min length1
Max length16
room
string

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

Min length1
Max length70
lei
string

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

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

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

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)

Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.

mmbId
string

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

Min length1
Max length35
clrSysId
object (ClearingSystemIdentification2Choice)

Choice of a clearing system identifier.

OneOf
object
object
cd
string

Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.

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

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

Min length1
Max length35
nm
string

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

Min length1
Max length140
othr
object (GenericFinancialIdentification1)

Information related to an identification of a financial institution.

issr
string

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

Min length1
Max length35
id
string

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

Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)

Sets of elements to identify a name of the organisation identification scheme.

OneOf
object
object
cd
string

Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.

object
object
prtry
string

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

Min length1
Max length35
brnchId
object (BranchData3)

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

pstlAdr
object (PostalAddress24)

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

strtNm
string

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

Min length1
Max length70
ctrySubDvsn
string

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

Min length1
Max length35
flr
string

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

Min length1
Max length70
bldgNm
string

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

Min length1
Max length35
twnLctnNm
string

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

Min length1
Max length35
adrLine
Array of string (Max70Text)

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max items7
string

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

Min length1
Max length70
twnNm
string

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

Min length1
Max length35
subDept
string

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

Min length1
Max length70
pstBx
string

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

Min length1
Max length16
dstrctNm
string

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

Min length1
Max length35
dept
string

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

Min length1
Max length70
bldgNb
string

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

Min length1
Max length16
ctry
string

Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

Pattern[A-Z]{2,2}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string

Specifies the type of address.

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

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

issr
string

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

Min length1
Max length35
id
string

Specifies an alphanumeric string with a length of 4 characters.

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

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

Min length1
Max length35
pstCd
string

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

Min length1
Max length16
room
string

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

Min length1
Max length70
lei
string

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

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

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

Min length1
Max length35
nm
string

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

Min length1
Max length140
endToEndId
string

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

Min length1
Max length35
uetr
string

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

Pattern[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}
intrBkSttlmAmt
number

Number of monetary units specified in a currency where the unit of currency is implied by the context and compliant with ISO 4217. The decimal separator is a dot. Note: a zero amount is considered a positive amount.

Minimum0
Maximum10000000000000
pmtMtd
object (PaymentOrigin1Choice)

Specifies the format under which the payment that generated the entry was transmitted.

OneOf
object
object
finmt
string

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

Pattern[0-9]{1,3}
object
object
instrm
string

Specifies the payment instrument used or the underlying financial transaction that resulted in a payment transaction.

Valid values[ "BDT", "BCT", "CDT", "CCT", "CHK", "BKT", "DCP", "CCP", "RTI", "CAN" ]
object
object
prtry
string

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

Min length1
Max length35
object
object
xmlmsgNm
string

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

Min length1
Max length35
intrBkSttlmDt
string (xs:date)

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.

Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Example2002-09-24Z
object
object
prtryId
string

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

Min length1
Max length70
object
object
qid
object (QueueTransactionIdentification1)

Identification of a payment instruction by its relative position in a queue of payment transactions managed by the clearing agent.

qid
string

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

Min length1
Max length16
posInQ
string

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

Min length1
Max length16
object
object
shrtBizId
object (ShortPaymentIdentification2)

Identifies a payment instruction by a simple set of characteristics which provides an unambiguous identification of the instruction.

txId
string

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

Min length1
Max length35
instgAgt
object (BranchAndFinancialInstitutionIdentification6)

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

finInstnId
object (FinancialInstitutionIdentification18)

Specifies the details to identify a financial institution.

pstlAdr
object (PostalAddress24)

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

strtNm
string

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

Min length1
Max length70
ctrySubDvsn
string

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

Min length1
Max length35
flr
string

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

Min length1
Max length70
bldgNm
string

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

Min length1
Max length35
twnLctnNm
string

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

Min length1
Max length35
adrLine
Array of string (Max70Text)

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max items7
string

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

Min length1
Max length70
twnNm
string

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

Min length1
Max length35
subDept
string

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

Min length1
Max length70
pstBx
string

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

Min length1
Max length16
dstrctNm
string

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

Min length1
Max length35
dept
string

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

Min length1
Max length70
bldgNb
string

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

Min length1
Max length16
ctry
string

Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

Pattern[A-Z]{2,2}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string

Specifies the type of address.

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

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

issr
string

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

Min length1
Max length35
id
string

Specifies an alphanumeric string with a length of 4 characters.

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

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

Min length1
Max length35
pstCd
string

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

Min length1
Max length16
room
string

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

Min length1
Max length70
lei
string

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

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

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

Pattern[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}
clrSysMmbId
object (ClearingSystemMemberIdentification2)

Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.

mmbId
string

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

Min length1
Max length35
clrSysId
object (ClearingSystemIdentification2Choice)

Choice of a clearing system identifier.

OneOf
object
object
cd
string

Specifies the clearing system identification code, as published in an external clearing system identification code list. External code sets can be downloaded from www.iso20022.org.

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

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

Min length1
Max length35
nm
string

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

Min length1
Max length140
othr
object (GenericFinancialIdentification1)

Information related to an identification of a financial institution.

issr
string

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

Min length1
Max length35
id
string

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

Min length1
Max length35
schmeNm
object (FinancialIdentificationSchemeName1Choice)

Sets of elements to identify a name of the organisation identification scheme.

OneOf
object
object
cd
string

Specifies the external financial institution identification scheme name code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.

object
object
prtry
string

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

Min length1
Max length35
brnchId
object (BranchData3)

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

pstlAdr
object (PostalAddress24)

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

strtNm
string

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

Min length1
Max length70
ctrySubDvsn
string

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

Min length1
Max length35
flr
string

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

Min length1
Max length70
bldgNm
string

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

Min length1
Max length35
twnLctnNm
string

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

Min length1
Max length35
adrLine
Array of string (Max70Text)

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

Max items7
string

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

Min length1
Max length70
twnNm
string

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

Min length1
Max length35
subDept
string

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

Min length1
Max length70
pstBx
string

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

Min length1
Max length16
dstrctNm
string

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

Min length1
Max length35
dept
string

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

Min length1
Max length70
bldgNb
string

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

Min length1
Max length16
ctry
string

Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

Pattern[A-Z]{2,2}
adrTp
object (AddressType3Choice)

Choice of formats for the type of address.

OneOf
object
object
cd
string

Specifies the type of address.

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

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

issr
string

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

Min length1
Max length35
id
string

Specifies an alphanumeric string with a length of 4 characters.

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

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

Min length1
Max length35
pstCd
string

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

Min length1
Max length16
room
string

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

Min length1
Max length70
lei
string

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

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

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

Min length1
Max length35
nm
string

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

Min length1
Max length140
intrBkSttlmDt
string (xs:date)

A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.

Pattern-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?
Example2002-09-24Z
object
object
txId
string

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

Min length1
Max length35
reqHdlg
Array of object (RequestHandling1)

Gives the status of the request.

object

Explains the status of the related request.

desc
string

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

Min length1
Max length140
stsCd
string

Specifies an alphanumeric string with a maximum length of 4 characters.

Min length1
Max length4
Pattern[a-zA-Z0-9]{1,4}
orgnlMsgId
object (OriginalMessageAndIssuer1)

Business reference(s) to one or more relevant messages previously sent by other parties, or by the same party issuing this message.

.

msgId
string

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

Min length1
Max length35
msgNmId
string

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

Min length1
Max length35
orgtrNm
string

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

Min length1
Max length70
msgHdr
object (MessageHeader9)

Set of characteristics, such as the identification or the creation date and time, specific to the message.

creDtTm
string (date-time)

A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. Note on the time format:

  1. beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
  2. fractions of second in time format Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
msgId
string

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

Min length1
Max length35
reqTp
object (RequestType4Choice)

Defines the type of action to be performed in the request.

OneOf
object
object
enqry
string

Specifies the external request type code for the enquiry on a position in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code set published separately. External code sets can be downloaded from www.iso20022.org.

Valid values[ "RT11", "RT12", "RT13", "RT14", "RT16", "RT15" ]
object
object
pmtCtrl
string

Specifies the external request type code for a payment control command in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code set published separately. External code sets can be downloaded from www.iso20022.org.

Valid values[ "RT01", "RT02", "RT03", "RT04", "RT05" ]
object
object
prtry
object (GenericIdentification1)

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

issr
string

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

Min length1
Max length35
id
string

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

Min length1
Max length35
schmeNm
string

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

Min length1
Max length35
400

Bad request

object
Example{ "errors": [ { "code": "400", "message": "Bad Request", "level": "Error", "description": "Validation error message." } ] }
401

Unauthorized

object
Example{ "errors": [ { "code": "401", "message": "Unauthorized", "level": "Error", "description": "Authorization error message." } ] }
403

Forbidden

object
Example{ "errors": [ { "code": "403", "message": "Forbidden", "level": "Error", "description": "Access error message." } ] }
404

Not found

object
Example{ "errors": [ { "code": "404", "message": "Not Found", "level": "Error", "description": "Not found error message." } ] }
406

Not acceptable

object
Example{ "errors": [ { "code": "406", "message": "Not Acceptable", "level": "Error", "description": "Not acceptable error message." } ] }
415

Unsupported media type

object
Example{ "errors": [ { "code": "415", "message": "Unsupported Media Type", "level": "Error", "description": "Unsupported type error message." } ] }
429

Too many requests

object
Example{ "errors": [ { "code": "429", "message": "Too Many Requests", "level": "Error", "description": "Too many requests error message." } ] }
500

Internal server error

object
Example{ "errors": [ { "code": "500", "message": "Internal Server Error", "level": "Error", "description": "Server error message." } ] }
503

Service unavailable

object
Example{ "errors": [ { "code": "503", "message": "Service Unavailable", "level": "Error", "description": "Unavailability error message." } ] }
504

Gateway timeout

object
Example{ "errors": [ { "code": "504", "message": "Gateway Timeout", "level": "Error", "description": "Timeout error message." } ] }