Message Definition Report Part 2 - swift.com€¦ · Message Definition Report Part 2 This document provides details of the messages for Cash Management November 2018. February 2018

Cash Management November 2018

Standards MX

Message Definition Report Part 2

This document provides details of the messages for Cash Management November 2018.

February 2018

Standards

Table of Contents

1 Message Set Overview ...................................................................................................................................... 71.1 List of MessageDefinitions ........................................................................................................................... 7

2 MX camt.003.001.06 GetAccountV06 ........................................................................................................ 122.1 MessageDefinition Functionality ................................................................................................................ 122.2 Structure ........................................................................................................................................................ 142.3 Constraints .................................................................................................................................................... 162.4 Message Building Blocks ............................................................................................................................ 18

3 MX camt.004.001.07 ReturnAccountV07 ................................................................................................. 483.1 MessageDefinition Functionality ................................................................................................................ 483.2 Structure ........................................................................................................................................................ 503.3 Constraints .................................................................................................................................................... 533.4 Message Building Blocks ............................................................................................................................ 55

4 MX camt.005.001.07 GetTransactionV07 ............................................................................................... 1094.1 MessageDefinition Functionality .............................................................................................................. 1094.2 Structure ...................................................................................................................................................... 1114.3 Constraints .................................................................................................................................................. 1194.4 Message Building Blocks .......................................................................................................................... 123

5 MX camt.006.001.07 ReturnTransactionV07 ........................................................................................ 2375.1 MessageDefinition Functionality .............................................................................................................. 2375.2 Structure ...................................................................................................................................................... 2405.3 Constraints .................................................................................................................................................. 2455.4 Message Building Blocks .......................................................................................................................... 248

6 MX camt.007.001.07 ModifyTransactionV07 ........................................................................................ 3296.1 MessageDefinition Functionality .............................................................................................................. 3296.2 Structure ...................................................................................................................................................... 3316.3 Constraints .................................................................................................................................................. 3326.4 Message Building Blocks .......................................................................................................................... 333

7 MX camt.008.001.07 CancelTransactionV07 ........................................................................................ 3487.1 MessageDefinition Functionality .............................................................................................................. 3487.2 Structure ...................................................................................................................................................... 3507.3 Constraints .................................................................................................................................................. 3517.4 Message Building Blocks .......................................................................................................................... 352

8 MX camt.009.001.06 GetLimitV06 ............................................................................................................. 3648.1 MessageDefinition Functionality .............................................................................................................. 3648.2 Structure ...................................................................................................................................................... 3658.3 Constraints .................................................................................................................................................. 3688.4 Message Building Blocks .......................................................................................................................... 370

Cash Management November 2018 for Standards MX

2 Message Definition Report Part 2

9 MX camt.010.001.07 ReturnLimitV07 ...................................................................................................... 4159.1 MessageDefinition Functionality .............................................................................................................. 4159.2 Structure ...................................................................................................................................................... 4179.3 Constraints .................................................................................................................................................. 4199.4 Message Building Blocks .......................................................................................................................... 421

10 MX camt.011.001.06 ModifyLimitV06 ...................................................................................................... 44910.1 MessageDefinition Functionality .............................................................................................................. 44910.2 Structure ...................................................................................................................................................... 45010.3 Constraints .................................................................................................................................................. 45110.4 Message Building Blocks .......................................................................................................................... 453

11 MX camt.012.001.06 DeleteLimitV06 ....................................................................................................... 47511.1 MessageDefinition Functionality .............................................................................................................. 47511.2 Structure ...................................................................................................................................................... 47611.3 Constraints .................................................................................................................................................. 47611.4 Message Building Blocks .......................................................................................................................... 478

12 MX camt.013.001.03 GetMemberV03 ....................................................................................................... 48912.1 MessageDefinition Functionality .............................................................................................................. 48912.2 Structure ...................................................................................................................................................... 49012.3 Constraints .................................................................................................................................................. 49112.4 Message Building Blocks .......................................................................................................................... 491

13 MX camt.014.001.03 ReturnMemberV03 ................................................................................................ 50013.1 MessageDefinition Functionality .............................................................................................................. 50013.2 Structure ...................................................................................................................................................... 50213.3 Constraints .................................................................................................................................................. 50313.4 Message Building Blocks .......................................................................................................................... 504

14 MX camt.015.001.03 ModifyMemberV03 ................................................................................................ 51814.1 MessageDefinition Functionality .............................................................................................................. 51814.2 Structure ...................................................................................................................................................... 51914.3 Constraints .................................................................................................................................................. 51914.4 Message Building Blocks .......................................................................................................................... 520

15 MX camt.016.001.03 GetCurrencyExchangeRateV03 ...................................................................... 52715.1 MessageDefinition Functionality .............................................................................................................. 52715.2 Structure ...................................................................................................................................................... 52815.3 Constraints .................................................................................................................................................. 52815.4 Message Building Blocks .......................................................................................................................... 529

16 MX camt.017.001.03 ReturnCurrencyExchangeRateV03 ............................................................... 53316.1 MessageDefinition Functionality .............................................................................................................. 53316.2 Structure ...................................................................................................................................................... 53516.3 Constraints .................................................................................................................................................. 53516.4 Message Building Blocks .......................................................................................................................... 536

Table of Contents

February 2018 3

17 MX camt.018.001.04 GetBusinessDayInformationV04 .................................................................... 54417.1 MessageDefinition Functionality .............................................................................................................. 54417.2 Structure ...................................................................................................................................................... 54517.3 Constraints .................................................................................................................................................. 54617.4 Message Building Blocks .......................................................................................................................... 547

18 MX camt.019.001.06 ReturnBusinessDayInformationV06 ............................................................. 56018.1 MessageDefinition Functionality .............................................................................................................. 56018.2 Structure ...................................................................................................................................................... 56218.3 Constraints .................................................................................................................................................. 56418.4 Message Building Blocks .......................................................................................................................... 564

19 MX camt.020.001.03 GetGeneralBusinessInformationV03 ............................................................ 58719.1 MessageDefinition Functionality .............................................................................................................. 58719.2 Structure ...................................................................................................................................................... 58819.3 Constraints .................................................................................................................................................. 58919.4 Message Building Blocks .......................................................................................................................... 589

20 MX camt.021.001.05 ReturnGeneralBusinessInformationV05 ..................................................... 59720.1 MessageDefinition Functionality .............................................................................................................. 59720.2 Structure ...................................................................................................................................................... 59920.3 Constraints .................................................................................................................................................. 60020.4 Message Building Blocks .......................................................................................................................... 600

21 MX camt.023.001.06 BackupPaymentV06 ............................................................................................. 61021.1 MessageDefinition Functionality .............................................................................................................. 61021.2 Structure ...................................................................................................................................................... 61221.3 Constraints .................................................................................................................................................. 61221.4 Message Building Blocks .......................................................................................................................... 613

22 MX camt.024.001.05 ModifyStandingOrderV05 .................................................................................. 62122.1 MessageDefinition Functionality .............................................................................................................. 62122.2 Structure ...................................................................................................................................................... 62222.3 Constraints .................................................................................................................................................. 62322.4 Message Building Blocks .......................................................................................................................... 624

23 MX camt.025.001.04 ReceiptV04 ............................................................................................................... 63223.1 MessageDefinition Functionality .............................................................................................................. 63223.2 Structure ...................................................................................................................................................... 63323.3 Constraints .................................................................................................................................................. 63423.4 Message Building Blocks .......................................................................................................................... 635

24 MX camt.046.001.04 GetReservationV04 ............................................................................................... 64724.1 MessageDefinition Functionality .............................................................................................................. 64724.2 Structure ...................................................................................................................................................... 64824.3 Constraints .................................................................................................................................................. 64824.4 Message Building Blocks .......................................................................................................................... 650



25 MX camt.047.001.05 ReturnReservationV05 ........................................................................................ 65925.1 MessageDefinition Functionality .............................................................................................................. 65925.2 Structure ...................................................................................................................................................... 66025.3 Constraints .................................................................................................................................................. 66225.4 Message Building Blocks .......................................................................................................................... 663

26 MX camt.048.001.04 ModifyReservationV04 ........................................................................................ 68726.1 MessageDefinition Functionality .............................................................................................................. 68726.2 Structure ...................................................................................................................................................... 68826.3 Constraints .................................................................................................................................................. 68826.4 Message Building Blocks .......................................................................................................................... 690

27 MX camt.049.001.04 DeleteReservationV04 ......................................................................................... 69827.1 MessageDefinition Functionality .............................................................................................................. 69827.2 Structure ...................................................................................................................................................... 69927.3 Constraints .................................................................................................................................................. 69927.4 Message Building Blocks .......................................................................................................................... 700

28 MX camt.050.001.04 LiquidityCreditTransferV04 .............................................................................. 70428.1 MessageDefinition Functionality .............................................................................................................. 70428.2 Structure ...................................................................................................................................................... 70528.3 Constraints .................................................................................................................................................. 70528.4 Message Building Blocks .......................................................................................................................... 707

29 MX camt.051.001.04 LiquidityDebitTransferV04 ................................................................................ 71129.1 MessageDefinition Functionality .............................................................................................................. 71129.2 Structure ...................................................................................................................................................... 71229.3 Constraints .................................................................................................................................................. 71229.4 Message Building Blocks .......................................................................................................................... 714

30 MX camt.069.001.02 GetStandingOrderV02 ......................................................................................... 71830.1 MessageDefinition Functionality .............................................................................................................. 71830.2 Structure ...................................................................................................................................................... 71930.3 Constraints .................................................................................................................................................. 72030.4 Message Building Blocks .......................................................................................................................... 722

31 MX camt.070.001.03 ReturnStandingOrderV03 .................................................................................. 73931.1 MessageDefinition Functionality .............................................................................................................. 73931.2 Structure ...................................................................................................................................................... 74031.3 Constraints .................................................................................................................................................. 74231.4 Message Building Blocks .......................................................................................................................... 743

32 MX camt.071.001.02 DeleteStandingOrderV02 ................................................................................... 76732.1 MessageDefinition Functionality .............................................................................................................. 76732.2 Structure ...................................................................................................................................................... 76732.3 Constraints .................................................................................................................................................. 76732.4 Message Building Blocks .......................................................................................................................... 769

Table of Contents

February 2018 5

33 MX camt.998.001.03 CashManagementProprietaryMessageV03 ............................................... 77333.1 MessageDefinition Functionality .............................................................................................................. 77333.2 Structure ...................................................................................................................................................... 77433.3 Constraints .................................................................................................................................................. 77433.4 Message Building Blocks .......................................................................................................................... 774

34 Message Items Types .................................................................................................................................... 77734.1 MessageComponents ............................................................................................................................... 77734.2 Message Datatypes ................................................................................................................................... 822

.Legal Notices ................................................................................................................................................................ 872



1 Message Set Overview

1.1 List of MessageDefinitionsThe following table lists all MessageDefinitions described in this book.

MessageDefinition Definition

camt.003.001.06GetAccountV06

The GetAccount message is sent by a member to thetransaction administrator.

It is used to request information on the details of one ormore accounts held at the transaction administrator,including information on the balances.

camt.004.001.07ReturnAccountV07

The ReturnAccount message is sent by the transactionadministrator to a member.

It is used to provide information on the details of one ormore accounts held at the transaction administrator,including information on the balances.

The Return Account message can be sent as aresponse to a related GetAccount message (pullmode) or initiated by the transaction administrator(push mode). The push of information can take placeeither at prearranged times or as a warning or alarmwhen a problem has occurred.

camt.005.001.07GetTransactionV07

The GetTransaction message is sent by a member tothe transaction administrator.

It is used to request information about paymentinstructions held at the transaction administrator.Payment instructions are either sent by the member,debiting or crediting its account at the transactionadministrator or received by the transactionadministrator, crediting or debiting the member'saccount.

camt.006.001.07ReturnTransactionV07

The ReturnTransaction message is sent by thetransaction administrator to a member of the system.

It is used to provide information on transactions andbooked entries held at the transaction administrator.

The Return Transaction message can be sent as aresponse to a related GetTransaction message (pullmode) or initiated by the transaction administrator(push mode). The push of information can take placeeither at prearranged times or as a warning or alarmwhen a problem has occurred.

camt.007.001.07ModifyTransactionV07

The ModifyTransaction message is sent by a memberto the transaction administrator.

It is used to request one modification in one paymentinstruction held at the transaction administrator andsent by the member, debiting or crediting its account atthe transaction administrator.

camt.008.001.07CancelTransactionV07

The CancelTransaction message is sent by a memberto the transaction administrator.

Message Set Overview

February 2018 7

MessageDefinition DefinitionIt is used to request the cancellation of one paymentinstruction held at the transaction administrator andsent by the member.

camt.009.001.06GetLimitV06

The GetLimit message is used to request informationon the details of one or more limits set by the member(or on behalf of the member) and managed by thetransaction administrator.

camt.010.001.07ReturnLimitV07

The ReturnLimit message is sent by the transactionadministrator to a member of the system.

It is used to provide information on the details of one ormore limits set by the member (or on behalf of themember) and managed by the transactionadministrator.

The ReturnLimit message can be sent as a responseto a related GetLimit message (pull mode) or initiatedby the transaction administrator (push mode). Thepush of information can take place either atprearranged times or as a warning or alarm when aproblem has occurred.

camt.011.001.06ModifyLimitV06

The ModifyLimit message is sent by a member to thetransaction administrator.

It is used to request modifications in the details of oneparticular, several or all limits set by the member andmanaged by the transaction administrator.

Each ModifyLimit message can alter only one type oflimit (current or default).

camt.012.001.06DeleteLimitV06

The DeleteLimit message is sent by a member to thetransaction administrator.

It is used to request the deletion of one particular,several or all limits set by the member and managedby the transaction administrator.

The DeleteLimit message may delete several types ofcurrent limits (risk or liquidity management limit), basedon a multiple requests.

camt.013.001.03GetMemberV03

The GetMember message is sent by a member to thetransaction administrator.

It is used to request information on static datamaintained by the transaction administrator and relatedto the participants in the system and their membershipstatus vis-a-vis this system.

camt.014.001.03ReturnMemberV03

The ReturnMember message is sent by the transactionadministrator to a member of the system.

It is used to provide information on static datamaintained by the transaction administrator and relatedto the participants in the system and their membershipstatus vis-a-vis this system.

The ReturnMember message can be sent as aresponse to a related GetMember message (pullmode) or initiated by the transaction administrator(push mode). The push of information can take place



MessageDefinition Definitioneither at prearranged times or as a warning or alarmwhen a problem has occurred.

camt.015.001.03ModifyMemberV03

The ModifyMember message is sent by a member tothe transaction administrator.

It is used to request modifications to the static datarelated to the profile of a member that the transactionadministrator maintains.

camt.016.001.03GetCurrencyExchangeRateV03

The GetCurrencyExchangeRate message is sent by amember to the transaction administrator.

It is used to request information on static datamaintained by the transaction administrator and relatedto currency exchange details as maintained for thesystem operations by the transaction administrator.

camt.017.001.03ReturnCurrencyExchangeRateV03

The ReturnCurrencyExchangeRate message is sent bythe transaction administrator to a member of thesystem.

It is used to provide information on static data andrelated to currency exchange details as maintained forsystem operations by the transaction administrator.

The ReturnCurrencyExchangeRate message can besent as a response to a relatedGetCurrencyExchangeRate message (pull mode) orinitiated by the account servicer (push mode). Thepush of information can take place either atprearranged times or as a warning or alarm when aproblem has occurred.

camt.018.001.04GetBusinessDayInformationV04

The GetBusinessDayInformation message is sent by amember to the transaction administrator.

It is used to request information on different types ofadministrative data linked to the system.

camt.019.001.06ReturnBusinessDayInformationV06

The ReturnBusinessDayInformation message is sentby the transaction administrator to a member of thesystem.

It is used to provide information on different types ofadministrative data linked to the system.

The ReturnBusinessDayInformation message can besent as a response to a related GetBusinesDayInformation message (pull mode), or initiated bythe transaction administrator (push mode). The push ofinformation can take place either at prearranged timesor as a warning or alarm when a problem hasoccurred.

camt.020.001.03GetGeneralBusinessInformationV03

The GetGeneralBusinessInformation message is sentby a member to the transaction administrator.

It is used to request information on a broadcast-typemessage previously sent by the transactionadministrator to all or some of the members, givinginformation related to the processing business.

camt.021.001.05ReturnGeneralBusinessInformationV05

The ReturnGeneralBusinessInformation message issent by the transaction administrator to a member ofthe system. It is used to provide some or all of the


February 2018 9

MessageDefinition Definitionmembers with information related to the processing ofthe system.

The Return General Business Information messagecan be sent as a response to a relatedGetGeneralBusinessInformation message (pull mode)or initiated by the transaction administrator (pushmode). The push of information can take place eitherat prearranged times or as a warning or alarm when aproblem has occurred.

camt.023.001.06BackupPaymentV06

The BackupPayment message is sent by a member tothe transaction administrator.

It is used to request a liquidity transfer from themember to another participant in the system when theuser is in recovery mode.

camt.024.001.05ModifyStandingOrderV05

The ModifyStandingOrder message is sent by amember to the transaction administrator.

It is used to request a change in the features of apermanent order for the transfer of funds between twoaccounts belonging to the same member and beingheld at the transaction administrator.

camt.025.001.04ReceiptV04

The Receipt message is sent by the transactionadministrator to a member of the system. It is sent toacknowledge the receipt of one or multiple messagessent previously.

The Receipt message is an application receiptacknowledgement and conveys information about theprocessing of the original message(s).

camt.046.001.04GetReservationV04

The GetReservation message is sent by a member tothe transaction administrator.

It is used to request information on the details of one ormore reservation facilities set by the member andmanaged by the transaction administrator.

camt.047.001.05ReturnReservationV05

The ReturnReservation message is sent by thetransaction administrator to a member.

It is used to provide information on the details of one ormore reservation facilities set by the member andmanaged by the transaction administrator.

The ReturnReservation message can be sent as aresponse to a related Get Reservation message (pullmode) or initiated by the transaction administrator(push mode). The push of information can take placeeither at prearranged times or as a warning or alarmwhen a problem has occurred.

camt.048.001.04ModifyReservationV04

The ModifyReservation message is used to requestmodifications in the details of one particular reservationset by the member and managed by the transactionadministrator.

camt.049.001.04DeleteReservationV04

The DeleteReservation message is used to request thedeletion of one particular reservation by the memberand managed by the transaction administrator.



MessageDefinition Definition

camt.050.001.04LiquidityCreditTransferV04

The LiquidityCreditTransfer message is sent by amember to the transaction administrator.

It is used to request a transfer of funds between twoaccounts belonging to the same member or the samegroup of accounts, and being held at the transactionadministrator.

camt.051.001.04LiquidityDebitTransferV04

The LiquidityDebitTransfer message is sent by amember to the transaction administrator.

It is used to request a transfer of funds between twoaccounts belonging to the same member or the samegroup of accounts, and being held at the transactionadministrator.

camt.069.001.02GetStandingOrderV02

The GetStandingOrder message is sent by a memberto the transaction administrator.

It is used to request information on the details of one ormore standing orders, based on specific requestcriteria, especially to query the amount of the overallliquidity available. It will allow to query both reservedliquidity and liquidity available for normal operations.

camt.070.001.03ReturnStandingOrderV03

The ReturnStandingOrder message is sent by atransaction administrator to a member.

It is used to provide information on the details of one ormore standing orders, based on specific request andreturn criteria.

in response to a request a on information on standingand predefined orders.

camt.071.001.02DeleteStandingOrderV02

The DeleteStandingOrder message is sent by thesystem member to delete one or more standing orderswithin the static data held by the system transactionadministrator.

camt.998.001.03CashManagementProprietaryMessageV03

The ProprietaryMessage is used by financialinstitutions, with their own offices, or with otherfinancial institutions with which they have establishedbilateral agreements. It is used as an envelope for aspecified message included in it.


February 2018 11

2 MX camt.003.001.06GetAccountV06

2.1 MessageDefinition FunctionalityScope

The GetAccount message is sent by a member to the transaction administrator.

It is used to request information on the details of one or more accounts held at the transactionadministrator, including information on the balances.

Usage

At any time during the operating hours of the system, the member can query the transactionadministrator to get information about the account(s) that the transaction administrator maintains for themember.

For example, this may be necessary in order to perform the appropriate liquidity management and thefunds transfers between accounts.

The member can request information about accounts through a series of criteria, corresponding to theknown information stored at the transaction administrator.

The query can concern one or more specific accounts, accounts of a particular identification, or aparticular type. The purpose of the query may be to obtain one or more types of balance.

The member can request information based on the following elements:

- account identification

- account type (this element can be used to refine the query when the account identification represents,for example, a group of accounts)

- balance type (if not present, all balances are requested)

- type of counterparty: bilateral or multilateral (note that, by default, a balance is multilateral unless aparticular counterparty is specified)

- identification of the counterparty when a bilateral balance is requested

- balance value date (if not present in the GetAccount message, the ReturnAccount message willcontain the latest available balance)

This message will be answered by a ReturnAccount message.

Additional information on the generic design of the Get/Return messages can be found in the sectionHow to Use the Cash Management Messages.

Outline

The GetAccountV06 MessageDefinition is composed of 3 MessageBuildingBlocks:

A. MessageHeader



Common business identification for the message.

B. AccountQueryDefinition

Defines the account query criteria.

C. SupplementaryData

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

MX camt.003.001.06 GetAccountV06

February 2018 13

2.2 StructureOr MessageElement/BuildingBlock Mult. Type Constr.

No.Page

Message root [1..1]

MessageHeader [1..1] 18

MessageIdentification [1..1] Text 18

CreationDateTime [0..1] DateTime 19

RequestType [0..1] 19

{Or PaymentControl [1..1] CodeSet 19

Or Enquiry [1..1] CodeSet 19

Or} Proprietary [1..1] 19

AccountQueryDefinition [0..1] 20

QueryType [0..1] CodeSet 22

AccountCriteria [0..1] 23

{Or QueryName [1..1] Text 25

Or} NewCriteria [1..1] C9 25

NewQueryName [0..1] Text 27

SearchCriteria [0..*] C4 28

AccountIdentification [0..*] 30

{Or Equal [1..1] 30

Or ContainText [1..1] Text 30

Or} NotContainText [1..1] Text 30

Type [0..*] 31

Currency [0..*] CodeSet C1 31

Balance [0..*] C5, C6

31

Type [0..*] 33

{Or Code [1..1] CodeSet 33

Or} Proprietary [1..1] Text 39

CounterpartyType [1..1] CodeSet 39

CounterpartyIdentification [0..*] 39

ValueDate [0..*] 40

{Or DateTimeSearch [1..1] 40



Or MessageElement/BuildingBlock Mult. Type Constr.No.

Page

{Or FromDateTime [1..1] DateTime 40

Or ToDateTime [1..1] DateTime 40

Or} DateTimeRange [1..1] 41

Or} DateSearch [1..1] 41

{Or FromDate [1..1] Date 41

Or ToDate [1..1] Date 41

Or FromToDate [1..1] 41

FromDate [1..1] Date 42

ToDate [1..1] Date 42

Or EqualDate [1..1] Date 42

Or} NotEqualDate [1..1] Date 42

AccountOwner [0..1] 42

AccountServicer [0..1] 43

ReturnCriteria [0..1] 43

NameIndicator [0..1] Indicator 43

CurrencyIndicator [0..1] Indicator 44

TypeIndicator [0..1] Indicator 44

MultilateralLimitIndicator [0..1] Indicator 44

MultilateralBalanceReturnCriteria [0..1] 44


StatusIndicator [1..1] Indicator 45

ValueDateIndicator [1..1] Indicator 45

NumberOfPaymentsIndicator [1..1] Indicator 45

BilateralLimitIndicator [0..1] Indicator 45

BilateralBalanceReturnCriteria [0..1] 45





StandingOrderIndicator [0..1] Indicator 46

AccountOwnerIndicator [0..1] Indicator 47


February 2018 15

Or MessageElement/BuildingBlock Mult. Type Constr.No.

Page

AccountServicerIndicator [0..1] Indicator 47

SupplementaryData [0..*] C10 47

2.3 ConstraintsThe tick symbol () means that the rule is validated on the SWIFT Network, if the message is part of asolution for which validation is enabled.

C1 ActiveOrHistoricCurrency

(Rule)

The Currency Code must be registered, or have already been registered. Valid active or historiccurrency codes are registered with the ISO 4217 Maintenance Agency, consist of three (3)contiguous letters, and may be or not be withdrawn on the day the message containing theCurrency is exchanged. (Algorithm)

Error handling:

Error severity: Fatal

Error Code: D00006

Error Text: Invalid currency code.

C2 AnyBIC

(Rule)

Only a valid Business identifier code is allowed. Business identifier codes for financial or non-financial institutions are registered by the ISO 9362 Registration Authority in the BIC directory,and consists of eight (8) or eleven (11) contiguous characters. (Algorithm)

Error handling:


Error Code: D00008

Error Text: Invalid BIC.

C3 BICFI

(Rule)

Valid BICs for financial institutions are registered by the ISO 9362 Registration Authority in theBIC directory, and consist of eight (8) or eleven (11) contiguous characters. (Algorithm)

Error handling:


Error Code: D00001

Error Text: Invalid FI BIC.

C4 CashAccountIdentificationGuideline

(Rule)



If the account identification identifies a group of accounts with different types or in differentcurrencies, the currency and/or the account type can be used as additional search criteria.

C5 CounterpartyIdentification1Rule

(Rule)

If at least one occurrence of CounterpartyType is present and is equal to Multilateral (MULT),then no occurrence of CounterpartyIdentification is allowed.

If CounterpartyType is not present, then any occurrence of CounterpartyIdentification isoptional. (CrossElementComplexRule)

Error handling:


Error Code: X00216

Error Text: Invalid message content for limit counterparty with a multilateral balance.

C6 CounterpartyIdentification2Rule

(Rule)

If at least one occurrence of CounterpartyType is present and is equal to Bilateral (BILA), thenat least one occurrence of CounterpartyIdentification must be present.

If CounterpartyType is not present, then any occurrence of CounterpartyIdentification isoptional. (CrossElementComplexRule)

Error handling:


Error Code: X00217

Error Text: Invalid message content for limit counterparty with a bilateral balance.

C7 Country

(Rule)

The code is checked against the list of country names obtained from the United Nations (ISO3166, Alpha-2 code). (Algorithm)

Error handling:


Error Code: D00004

Error Text: Invalid Country Code.

C8 IBAN

(Rule)

A valid IBAN consists of all three of the following components: Country Code, check digits andBBAN. (Algorithm)


February 2018 17

Error handling:


Error Code: D00003

Error Text: Invalid IBAN format or invalid check digits.

C9 ReturnCriteriaAndOrSearchCriteriaRule

(Rule)

If ReturnCriteria is not present, then at least one occurrence of SearchCriteria must be present.If ReturnCriteria is present, then any occurrence of SearchCriteria isoptional. (CrossElementComplexRule)

Error handling:


Error Code: X00327

Error Text: Invalid message content for search and return criteria.

C10 SupplementaryDataRule

(Rule)

This component may not be used without the explicit approval of a SEG and submission to theRA of ISO 20022 compliant structure(s) to be used in the Envelope element.

2.4 Message Building BlocksThis chapter describes the MessageBuildingBlocks of this MessageDefinition.

2.4.1 MessageHeader Presence: [1..1]

Definition: Common business identification for the message.

MessageHeader contains the following MessageHeader9 elements

Or MessageElement Mult. Type Constr.No.

Page

MessageIdentification [1..1] Text 18

CreationDateTime [0..1] DateTime 19

RequestType [0..1] 19




2.4.1.1 MessageIdentification Presence: [1..1]

Definition: Point to point reference, as assigned by the sender, to unambiguously identify the message.



Usage: The sender has to make sure that MessageIdentification is unique for a pre-agreed period.

Datatype: Max35Text on page 870

2.4.1.2 CreationDateTime Presence: [0..1]

Definition: Date and time at which the message was created.

Datatype: ISODateTime on page 864

2.4.1.3 RequestType Presence: [0..1]

Definition: Specific actions to be executed through the request.

RequestType contains one of the following RequestType4Choice elements


Page




2.4.1.3.1 PaymentControl Presence: [1..1]

Definition: Request type is a control command on a set of transactions.

Datatype: ExternalPaymentControlRequestType1Code on page 831

2.4.1.3.2 Enquiry Presence: [1..1]

Definition: Request type is an enquiry on a position or a transaction.

Datatype: ExternalEnquiryRequestType1Code on page 830

2.4.1.3.3 Proprietary Presence: [1..1]

Definition: Request type is in proprietary format.

Proprietary contains the following elements (see GenericIdentification1 on page 793 fordetails)


Page

Identification [1..1] Text 793

SchemeName [0..1] Text 793

Issuer [0..1] Text 793


February 2018 19

2.4.2 AccountQueryDefinition Presence: [0..1]

Definition: Defines the account query criteria.



AccountQueryDefinition contains the following AccountQuery2 elements


Page

QueryType [0..1] CodeSet 22

AccountCriteria [0..1] 23






{Or Equal [1..1] 30



Type [0..*] 31



31

Type [0..*] 33





ValueDate [0..*] 40













February 2018 21


Page























2.4.2.1 QueryType Presence: [0..1]

Definition: Specifies the type of matching items to be returned in the response to the query.

Datatype: QueryType2Code on page 846

CodeName Name Definition

ALLL All Specifies that the query requests that allmatching items be returned.

CHNG Changed Specifies that the query requests thatonly new matching items since the lastsimilar query be returned.




MODF Modified Specifies that the query requests thatonly items that have changed since thelast query be returned.

DELD Deleted Specifies that the query requests thatitems that have been deleted since thelast query be returned.

2.4.2.2 AccountCriteria Presence: [0..1]

Definition: Defines the account query criteria.


February 2018 23

AccountCriteria contains one of the following AccountCriteria2Choice elements


Page






{Or Equal [1..1] 30



Type [0..*] 31



31

Type [0..*] 33





ValueDate [0..*] 40

















Page





















2.4.2.2.1 QueryName Presence: [1..1]

Definition: Recalls the criteria (search and return criteria) defined in a preceding query.


2.4.2.2.2 NewCriteria Presence: [1..1]

Definition: Explicitly defines the query criteria.

Impacted by: C9 ReturnCriteriaAndOrSearchCriteriaRule


February 2018 25

NewCriteria contains the following AccountCriteria6 elements


Page




{Or Equal [1..1] 30



Type [0..*] 31



31

Type [0..*] 33





ValueDate [0..*] 40



















Page



















Constraints

ReturnCriteriaAndOrSearchCriteriaRule

(Rule)

If ReturnCriteria is not present, then at least one occurrence of SearchCriteria must be present. IfReturnCriteria is present, then any occurrence of SearchCriteria is optional.On Condition /ReturnCriteria is absentFollowing Must be True /SearchCriteria[1] Must be presentError handling:


Error Code: X00327

Error Text: Invalid message content for search and return criteria.

2.4.2.2.2.1 NewQueryName

Presence: [0..1]


February 2018 27

Definition: Name of the query defined by the search criteria and return criteria.


2.4.2.2.2.2 SearchCriteria

Presence: [0..*]

Definition: Defines the criteria to be used to extract the account information.

Impacted by: C4 CashAccountIdentificationGuideline



SearchCriteria contains the following CashAccountSearchCriteria6 elements


Page


{Or Equal [1..1] 30



Type [0..*] 31



31

Type [0..*] 33





ValueDate [0..*] 40















Constraints

CashAccountIdentificationGuideline

(Rule)


February 2018 29

If the account identification identifies a group of accounts with different types or in differentcurrencies, the currency and/or the account type can be used as additional search criteria.

2.4.2.2.2.2.1 AccountIdentification

Presence: [0..*]

Definition: Unique and unambiguous identification for the account between the account owner and theaccount servicer.

AccountIdentification contains one of the followingAccountIdentificationSearchCriteria2Choice elements


Page

{Or Equal [1..1] 30



2.4.2.2.2.2.1.1 Equal

Presence: [1..1]

Definition: Search for one or more accounts based on exact identification of the account(s).

Equal contains one of the following elements (see AccountIdentification4Choice on page 781 fordetails)


Page

{Or IBAN [1..1] IdentifierSet C5 782

Or} Other [1..1] 782

Identification [1..1] Text 783

SchemeName [0..1] 783



Issuer [0..1] Text 783

2.4.2.2.2.2.1.2 ContainText

Presence: [1..1]

Definition: Search for one or more accounts based on partial identification of the account(s).


2.4.2.2.2.2.1.3 NotContainText

Presence: [1..1]

Definition: Search for one or more accounts based on a pattern that cannot be contained in the accountidentification.




2.4.2.2.2.2.2 Type

Presence: [0..*]

Definition: Specifies the nature, or use, of the cash account.

Type contains one of the following elements (see CashAccountType2Choice on page 781 fordetails)


Page



2.4.2.2.2.2.3 Currency

Presence: [0..*]

Definition: Specifies the currency of the cash account.

Impacted by: C1 ActiveOrHistoricCurrency

Datatype: ActiveOrHistoricCurrencyCode on page 825

Constraints

ActiveOrHistoricCurrency

(Rule)

The Currency Code must be registered, or have already been registered. Valid active or historiccurrency codes are registered with the ISO 4217 Maintenance Agency, consist of three (3)contiguous letters, and may be or not be withdrawn on the day the message containing the Currencyis exchanged.

Error handling:


Error Code: D00006

Error Text: Invalid currency code.

2.4.2.2.2.2.4 Balance

Presence: [0..*]

Definition: Balance of the account which is being queried.

Impacted by: C5 CounterpartyIdentification1Rule , C6 CounterpartyIdentification2Rule


February 2018 31

Balance contains the following CashBalance9 elements


Page

Type [0..*] 33





ValueDate [0..*] 40













Constraints

CounterpartyIdentification1Rule

(Rule)

If at least one occurrence of CounterpartyType is present and is equal to Multilateral (MULT), then nooccurrence of CounterpartyIdentification is allowed.

If CounterpartyType is not present, then any occurrence of CounterpartyIdentification is optional.On Condition /CounterpartyType is present And /CounterpartyType is equal to value 'Multilateral'Following Must be True /CounterpartyIdentification[1] Must be absentError handling:


Error Code: X00216



Error Text: Invalid message content for limit counterparty with a multilateral balance.

CounterpartyIdentification2Rule

(Rule)

If at least one occurrence of CounterpartyType is present and is equal to Bilateral (BILA), then atleast one occurrence of CounterpartyIdentification must be present.

If CounterpartyType is not present, then any occurrence of CounterpartyIdentification is optional.On Condition /CounterpartyType is present And /CounterpartyType is equal to value 'Bilateral'Following Must be True /CounterpartyIdentification[1] Must be presentError handling:


Error Code: X00217

Error Text: Invalid message content for limit counterparty with a bilateral balance.

2.4.2.2.2.2.4.1 Type

Presence: [0..*]

Definition: Specifies the nature of a balance.

Type contains one of the following BalanceType8Choice elements


Page



2.4.2.2.2.2.4.1.1 Code

Presence: [1..1]

Definition: Specifies the nature of a balance, in a coded form.

Datatype: SystemBalanceType1Code on page 849


OPNG Opening Book balance of the account at thebeginning of the account servicer'sbusiness day. It always equals theclosing book balance from the previousbusiness day.

Note: the available balance at thebeginning of the account servicer'sbusiness day may be different from theclosing book balance from the previousbusiness day.

INTM Interim Balance calculated in the course of theaccount servicer's business day, at thetime specified, and subject to furtherchanges during the business day. Theinterim balance is calculated on the


February 2018 33

CodeName Name Definitionbasis of booked credit and debit itemsduring the calculation time/periodspecified.

CLSG Closing Balance of the account at the end of theaccount servicer's business day. It is thesum of the opening balance at thebeginning of the day and all entriesbooked to the account during theaccount servicer's business day.

BOOK Book Balance that is registered in the books ofthe account servicer.

CRRT Current Balance of the account at a precisemoment in time.

PDNG Pending Balance of securities pending delivery,such as the orders to sell securities havebeen executed but settlement of theopen transactions has not beenconfirmed.

LRLD LimitRelated Balance of a specific limit value, such asa bilateral balance is calculated inrelation to a given bilateral limit.

AVLB Available Balance of money or securities that is atthe disposal of the account owner on thedate specified.

LTSF LiquidityTransfer Balance composed of the sum of allliquidity transfers made to or from anaccount.

CRDT Credit Balance representing the sum of allcredit entries booked to an account.

EAST EligibleAssets Balance representing the potential loan aCentral Bank would make in cash if thecollateral is pledged, such as securitiesavailable and eligible as collateral withthe central bank.

PYMT Payment Balance representing the sum of entriesas a result of payments processing.Entries relating to fees, interest, or othermovements not a result of paymentssent or received by the account ownerare not included.

BLCK Blocked Balance representing the regulatoryreserve that a financial institution musthave with the account servicinginstitution, such as the minimum creditbalance a financial institution is to keepwith its Central Bank for mandatoryreserve purposes. In some countries, ablocked balance is known as a 'reserve'balance.

XPCD Expected Balance, composed of booked entriesand pending items known at the time ofcalculation, which projects the end ofday balance if everything is booked onthe account and no other entry is posted.




DLOD DaylightOverdraft Balance representing the intra dayoverdraft granted by the central bank tofinancial institutions participating in aRTGS system. This balance may varyover time and shall be offset at the endof the day.

XCRD ExpectedCredit Balance, composed of booked entriesand pending items known at the time ofcalculation, which projects the end ofday credit balance if everything books tothe account and no other credit entry isposted.

XDBT ExpectedDebit Balance, composed of booked entriesand pending items known at the time ofcalculation, which projects the end ofday debit balance if everything books tothe account and no other debit entry isposted.

ADJT Adjustment Average balance to be held in thesettlement account at the end of eachday in order to fulfil the reserve due.

The approximation will be always maderounding up.

PRAV ProgressiveAverage Average of the daily balances on theaccount used to fulfil the reserverequirements calculated from thebeginning of the maintenance period.

DBIT Debit Balance representing the sum of all debitentries booked to an account.

THRE Threshold Balance representing the amount thatwill be destined for investment.Difference between available balanceand threshold for investment limit.

NOTE Noted Balance representing the amount that afinancial institution has set aside for aspecific reason and which is thereforenot available.

SELF Self Balance of the account identified (asopposed to Master Balance).

MSTR Master Balance of the identified account plusthe balance of all of its subaccounts.

FSET ForecastSettlement Balance representing the forecast oftotal of all cash legs for trades that areready to settle via a a central securitiesdepository. Amounts shown are stillsubject to processing of the securitiessettlement.

BLOC BlockedTrades Balance representing the projected totalof all cash legs for trades settling via acentral securities depository that havebeen matched but blocked in order to notsettle. These blocked trades areincluded in the calculation for settlement(for example to avoid overdrafts).


February 2018 35

CodeName Name DefinitionUsage rule: Blocking can be done byaccount owner or its counterparties.Usually this is done to chain transactionsor to prioritise other trades. Blockedtrades have an indicator that preventsthe transactions from settling. Oncematched, they can settle whenever thefreeze is lifted. In this case they willmove to FSET. Lifting the freeze canhappen anytime during the day and thetransaction will be settling in the nextsettlement cycle which can be the sameday if the (international) centralsecurities depository's operates severalsettlements cycles per day.

OTHB OtherBlockedTrades Balance representing the projected totalof all cash legs for trades settling via acentral securities depository that havebeen matched but blocked in order to notsettle. These blocked transactions arenot included in the calculation forsettlement.

CUST Custody Balance representing the projected totalof all asset servicing transactions suchas dividends, income corporate actionsequivalents, tax returns, etc.

FORC CashForecast Balance representing the total of allbalance types representing transactionsto settle, blocked items and custodytransactions.

COLC DividendsCollection Balance representing the projected totalamount of all payment obligations to theparticipant (bank), based on their role asmain paying agent.

FUND NetFunding Balance representing the net amount tobe funded resulting from all transactionswhich have an impact on the fundingrequirement.

PIPO PayInPayOut Balance representing the fictive forecastof automated direct debits or paymentbased on standing arrangementsbetween a central securities depositoryand the user.

Usage: Pay-Ins and Pay-Outs can bedifferent based on individual paymentinstructions or available funds.

XCHG ExchangeForecast Balance representing the forecast of thetotal of all cash legs of transactionstraded in exchanges.

CCPS CentralCounterparty Balance representing the forecast of thetotal of all cash legs of transactionstraded in exchanges that operate acentral counterparty functionality.




TOHB TotalOnHold Balance representing the total of thepayments that were put on hold becausethe limits have been exceeded.

COHB CreditOnHold Balance representing the total incomingpayments that were put on hold becausethe credit limit has been exceeded.

DOHB DebitOnHold Balance representing the total outgoingpayments that were put on hold becausethe debit limit has been exceeded.

TPBL TotalProcessed Balance representing the total of thepayments that have been processed andare waiting for settlement during the day.

CPBL CreditProcessed Balance representing the total incomingpayments that have been processed andare waiting for settlement.

DPBL DebitProcessed Balance representing the total outgoingpayments that have been processed andare waiting for settlement.

FUTB TotalFuture Balance representing the total of thepayments with a processing date in thefuture.

REJB TotalRejected Balance representing the total of thepayments that have been rejected.

FCOL FirmCollateralisation Balance representing the forecast of thecash-equivalent resulting from evaluationof existing holdings at central securitiesdepositary that are qualified to serve ascollateral.

FCOU UsedAmountsFirmCollateralisation Balance representing the cashequivalent resulting from evaluation ofexisting holdings at CSD that arequalified to serve as collateral and havebeen used as collateral.

SCOL SelfCollateralisation Balance representing the forecast of thecash-equivalent resulting from evaluationof the net incoming balance of securitiesqualified to serve as collateral for whichsettlement instructions are held at.

SCOU UsedAmountsSelfCollateralisation Balance representing the cash-equivalent resulting from evaluation ofincoming securities, qualified to serve ascollateral and actually used as collateral,which have been settled during thesettlement process.

CUSA CustodyActual Balance representing the actual total ofall asset servicing transactions such asdividends, income corporate actionsequivalents, tax returns, redemptions,etc.

XCHC CCPGuaranteedForecasting Balance representing the forecast of thetotal of all cash legs of transactions inexchanges, going through CCPfunctions.


February 2018 37


XCHN NonCCPGuaranteedForecasting Balance representing the forecast of thetotal of all cash legs of transactionstraded in exchanges not going throughcentral counter party (CCP) functions.

DSET DefinitiveSettledSecurities Balance representing the cashequivalent of all settled securitiestransactions.

LACK LackOfHoldingsTransactions Balance representing the cashequivalent of transactions with a lack ofholdings.

NSET NonSettledSecurities Balance representing the cashequivalent of all non-settled securitiestransactions.

OTCC CCPGuaranteedOTCTransactions Balance representing the Forecast of thetotal of all cash-legs of transactions 'overthe counter' (OTC), going through centralcounter party (CCP) functions.

OTCG ForecastOTCTransactions Balance representing the forecast of thetotal of all cash legs of transactionstraded 'over the counter' (OTC).

OTCN NonCCPGuaranteedOTCTransactions Balance representing the forecast of thetotal of all cash legs of transactionstraded 'over the counter' (OTC) not goingthrough central counter party (CCP)functions.

SAPD SAPDirectDebitAmount Balance represents the settlementaccount processor direct debit amount.

SAPC SAPDirectCreditAmount Balance represents the settlementaccount processor direct credit amount.

REPD CMUPRepoDebit Balance represents the total of thecentral moneymarkets unit processorrepo debits.

REPC CMUPRepoCredit Balance represents the total of thecentral moneymarkets unit processorrepo credits.

BSCD BulkSettlementCMUPDebit Balance represents the total of the bulksettlement and central moneymarketsunit processor debit.

BSCC BulkSettlementCMUPCredit Balance represents the total of the bulksettlement and central moneymarketsunit processor credit.

SAPP SAPQueueAmount Balance represents the settlementaccount processor queue amount.

IRLT IntradayRepoLimit Balance represents the intraday repolimit.

IRDR IntradayRepoDrawings Balance represents the intraday repodrawings.

DWRD DiscountWindowRepoDrawings Balance represents the discount windowrepo drawings.




ADWR AvailableDMVForDiscountWindowRepo Balance represents the availablediscounted market value for discountwindow repo.

AIDR AvailableDMVForIntradayRepo Balance represents the availablediscounted market value for intradayrepo.

REST Restricted Balance of cash that may only be usedunder certain conditions.

Balance type is used to block securities/cash in the client account for example,when related to specific corporateactions, the holding is under the directcontrol of the system paying agent, whois the only one who can transfersecurities out of this balance type.

Also known as the "escrow balance" or"sequestered balance".

2.4.2.2.2.2.4.1.2 Proprietary

Presence: [1..1]

Definition: Specifies the nature of a balance, in a proprietary form.


2.4.2.2.2.2.4.2 CounterpartyType

Presence: [1..1]

Definition: Specifies the type of counterparty for which the balance is calculated.

Datatype: BalanceCounterparty1Code on page 826


BILA Bilateral Balance calculated regarding onemember in the system.

MULT Multilateral Balance calculated regarding allmembers in the system.

2.4.2.2.2.2.4.3 CounterpartyIdentification

Presence: [0..*]

Definition: Specifies the counterparty for which the balance is calculated.

CounterpartyIdentification contains the following elements (seeBranchAndFinancialInstitutionIdentification5 on page 787 for details)


Page

FinancialInstitutionIdentification [1..1] 787

BranchIdentification [0..1] 788


February 2018 39

2.4.2.2.2.2.4.4 ValueDate

Presence: [0..*]

Definition: Date and time at which the balance is or will be available.

ValueDate contains one of the following DateAndDateTimeSearch3Choice elements


Page













2.4.2.2.2.2.4.4.1 DateTimeSearch

Presence: [1..1]

Definition: Patterns to search a date time.

DateTimeSearch contains one of the following DateTimePeriod1Choice elements


Page




2.4.2.2.2.2.4.4.1.1 FromDateTime

Presence: [1..1]

Definition: Date and time at which the range starts.


2.4.2.2.2.2.4.4.1.2 ToDateTime

Presence: [1..1]

Definition: Date and time at which the range ends.




2.4.2.2.2.2.4.4.1.3 DateTimeRange

Presence: [1..1]

Definition: Range of time between a start date and time and an end date and time.

DateTimeRange contains the following elements (see DateTimePeriod1 on page 787 fordetails)


Page

FromDateTime [1..1] DateTime 787

ToDateTime [1..1] DateTime 787

2.4.2.2.2.2.4.4.2 DateSearch

Presence: [1..1]

Definition: Patterns to search a date.

DateSearch contains one of the following DatePeriodSearch1Choice elements


Page








2.4.2.2.2.2.4.4.2.1 FromDate

Presence: [1..1]

Definition: Start date of the range.

Datatype: ISODate on page 864

2.4.2.2.2.2.4.4.2.2 ToDate

Presence: [1..1]

Definition: End date of the range.


2.4.2.2.2.2.4.4.2.3 FromToDate

Presence: [1..1]

Definition: Particular time span specified between a start date and an end date.


February 2018 41

FromToDate contains the following DatePeriod2 elements


Page



2.4.2.2.2.2.4.4.2.3.1 FromDate

Presence: [1..1]

Definition: Start date of the range.


2.4.2.2.2.2.4.4.2.3.2 ToDate

Presence: [1..1]

Definition: End date of the range.


2.4.2.2.2.2.4.4.2.4 EqualDate

Presence: [1..1]

Definition: Specified date to match.


2.4.2.2.2.2.4.4.2.5 NotEqualDate

Presence: [1..1]

Definition: Specified date to be excluded from the search.


2.4.2.2.2.2.5 AccountOwner

Presence: [0..1]

Definition: Owner of the account which is being queried.

AccountOwner contains the following elements (see PartyIdentification125 on page 808for details)


Page

Name [0..1] Text 808

PostalAddress [0..1] 808

Identification [0..1] 809

{Or OrganisationIdentification [1..1] 809

Or} PrivateIdentification [1..1] 810

CountryOfResidence [0..1] CodeSet C4 810

ContactDetails [0..1] 811



2.4.2.2.2.2.6 AccountServicer

Presence: [0..1]

Definition: Servicer of the account which is being queried.

AccountServicer contains the following elements (seeBranchAndFinancialInstitutionIdentification5 on page 787 for details)


Page

FinancialInstitutionIdentification [1..1] 787

BranchIdentification [0..1] 788

2.4.2.2.2.3 ReturnCriteria

Presence: [0..1]

Definition: Defines the expected account report.

ReturnCriteria contains the following CashAccountReturnCriteria4 elements


Page



















2.4.2.2.2.3.1 NameIndicator

Presence: [0..1]


February 2018 43

Definition: Indicates whether the account name is requested.

Datatype: One of the following values must be used (see RequestedIndicator on page 866):

Meaning When True: Requested

Meaning When False: Not Requested

2.4.2.2.2.3.2 CurrencyIndicator

Presence: [0..1]

Definition: Indicates whether the account currency is requested.

Datatype: One of the following values must be

Documents

Message Definition Report Part 2 - swift.com€¦ · Message Definition Report Part 2 This document provides details of the messages for Cash Management November 2018. February 2018