API and Event Messaging

RTGS.global standards and conventions for platform messaging

The RTGS.global platform is an ISO 20022 compatible API and Event based model. This means that ISO 20022 format and messaging is used as much as possible across the platform, but in instances where ISO 20022 messaging does not cater for RTGS.global product services, the below standards are followed:

1. Accepted conventions relating to RESTful API's and HTTP webhooks are adhered to

2. Payloads are in JSON format and follow the appropriate IS O20022 message, where possible

3. If there isn't a suitable ISO 20022 message, the ISO data dictionary is used for all values in the payload or query string, where possible

Instances where platform messaging diverges from ISO 20022 messaging are outlined below. Where the format is aligned, the structure, hierarchy and field parameters of the platform message follows the ISO message exactly.

FEATURE	FUNCTION	MESSAGE	TYPE	COMPATIBILITY
Link & Settle	Initiate	API Request Body	Proprietary	Uses parts of the pacs.009 message format Some required fields are outside of ISO data dictionary Only one transaction is accepted per request (CreditTransferTransactionInformation object is [1..1])
Link & Settle	Cancel	API Request Body	Proprietary	All fields are taken from ISO data dictionary, except ‘LinkIdentifiers’
Link & Settle	Status Update	Event	Pacs.002	Message format aligned to ISO
Link & Settle	Notification of Cr/Dr	Event	Camt.054	Message format aligned to ISO
FI to FI Customer Credit Transfer	Initiate	API Request Body	Pacs.008	Only one transaction is accepted per request (CreditTransferTransactionInformation object is [1..1])
FI to FI Customer Credit Transfer	Status Update	Event	Pacs.002	Message format aligned to ISO
FI to FI Customer Credit Transfer	FI to FI Customer Transfer Request	Event	Pacs.008	Only one transaction is accepted per request (CreditTransferTransactionInformation object is [1..1])
FI to FI Customer Credit Transfer	Notification of Cr/Dr	Event	Camt.054	Message format aligned to ISO
Get Balances	Request	RESTful HTTP API		Query string parameters are taken from ISO data dictionary
Get Balances	Response	RESTful HTTP API	camt.052	Message format aligned to ISO
Get Transactions	Request	RESTful HTTP API		Query string parameters are taken from ISO data dictionary
Get Transactions	Response	RESTful HTTP API	camt.006	Message format aligned to ISO
Get Accounts	Request	RESTful HTTP API		Query string parameters are taken from ISO data dictionary
Get Accounts	Response	RESTful HTTP API	Proprietary	Synchronous response string parameters are taken from ISO data dictionary
Get Participants	Request	RESTful HTTP API		Query string parameters are taken from ISO data dictionary
Get Participants	Response	RESTful HTTP API	Proprietary	Synchronous response string parameters are taken from ISO data dictionary
Get Relationships	Request	RESTful HTTP API		Query string parameters are taken from ISO data dictionary
Get Relationships	Response	RESTful HTTP API	Proprietary	Synchronous response string parameters are taken from ISO data dictionary

At least once delivery

The RTGS.global Gateway provides durable delivery and guarantees at least once message delivery. Consequently this should be considered when integrating with the Gateway. Participants should consider using patterns like idempotent consumers, inbox pattern or include simple deduplication within the consumer.

To support these patterns, all messages that are delivered from the RTGS.global Gateway will include a ISO 20022 GroupHeader with an accompanying message identifier, or another ID to identify the message. This message identifier should be used for deduplication.