RTGS.global Participant Gateway API (1.0.0)

Download OpenAPI specification:

Overview

The RTGS.global Participant Gateway API allows JSON messages to be sent and received.

HTTP requests are sent to the API endpoints and responses will either be synchronously returned as a HTTP response or asynchronously via Azure Event Grid.

Synchronous responses

The messages will be in the Body of the HTTP response with the appropriate HTTP status code.

Asynchronous responses

The messages will be delivered using the CloudEvent v1.0 schema. The payload is provided in the data_base64 property of the CloudEvent. This value must be base64-decoded before the payload can be used or verified.

Azure Event Grid supports multiple subscription types however all asynchronous responses are marked as a webhook in this documentation. The same message types will be used, regardless of the subscription choice.

Link and Settle

Link and Settle allows two participants to instantly PvP ( Payment vs Payment) settle two currencies once a trade has been agreed between them.

Transaction status update Webhook

ISO-20022 pacs.002 message. Information about a transaction status update.

Event type: global.rtgs.TransactionStatusNotificationV1

Request Body schema: application/json

object or null

The FIToFIPaymentStatusReport message is exchanged between agents to provide status information about instructions previously sent. Its usage will always be governed by a bilateral agreement between the agents.

Responses

Request samples

Payload

Content type

application/json

Example

payaway failure

{"FIToFIPmtStsRpt": {"GrpHdr": {"MsgId": "b9fdbd5351eb4bc9b2accd83b860a016",
"CreDtTm": "2019-08-24T15:15:00Z",
"InstdAgt": {"FinInstnId": {"BICFI": "EEXGBP11",
"LEI": "376323TESTVDK1GB1L12",
"Othr": {"Id": "RTGS:B:GB43400282"
}
}
}
},
"TxInfAndSts": [{"OrgnlEndToEndId": "c13afc06de22444e8e6869573c0168e9",
"OrgnlUETR": "90fdc79b-4090-413d-9a79-9a87cb838285",
"TxSts": "RJCT",
"StsRsnInf": [{"Rsn": {"Cd": "AM04"
},
"AddtlInf": ["Insufficient Funds"
]
}
],
"OrgnlTxRef": {"IntrBkSttlmAmt": {"Ccy": "JPY",
"Value": "999"
},
"PmtTpInf": {"LclInstrm": {"Prtry": "FIToFICustomerCreditTransfer"
}
},
"Cdtr": {"Pty": {"Nm": "Tom Tompson",
"PstlAdr": {"TwnNm": "Tokyo",
"Ctry": "JP"
}
}
}
}
}
]
}
}

New transaction Webhook

ISO-20022 camt.054 message. Information about a debit or credit transaction against an account.

Event type: global.rtgs.TransactionNotificationV1

Request Body schema: application/json

	object or null BankToCustomerDebitCreditNotification : to inform the account owner of single or multiple debit and/or credit entries reported to the account
	object or null Extra proprietary metadata associated with the notification.

Responses

Request samples

Payload

Content type

application/json

Example

valid payaway request

{"BkToCstmrDbtCdtNtfctn": {"GrpHdr": {"MsgId": "df9857cdee60482a8d2646931958a367",
"CreDtTm": "2023-03-08T15:58:22.0090079Z"
},
"Ntfctn": [{"Id": "9b74b93586d9488f841c43e7ad8d0887",
"Acct": {"Id": {"IBAN": "GB33BUKB30301666666666"
}
},
"Ntry": [{"NtryRef": "0",
"Amt": {"Ccy": "GBP",
"Value": "99.99"
},
"CdtDbtInd": "DBIT",
"Sts": {"Cd": "BOOK"
},
"BkTxCd": {"Domn": {"Cd": "PMNT",
"Fmly": {"Cd": "ICDT",
"SubFmlyCd": "FICT"
}
}
},
"NtryDtls": [{"TxDtls": {"Refs": {"EndToEndId": "unique-end-to-end-id",
"UETR": "90fdc79b-4090-413d-9a79-9a87cb838285"
},
"LclInstrm": {"Prtry": "FIToFICustomerCreditTransfer"
}
}
}
]
}
]
}
]
}
}

Create a new settlement request

ISO-20022 compatible proprietary message. Initiate a Link and Settle by creating a new settlement request, which will be linked to a counterparty request and settled.

Webhooks will be called for both the initiating and counterparty participants to inform them of the status of the settlement and transactions that are created.

Request Body schema: application/json

required	object or null Set of characteristics shared by all individual transactions included in the message.
required	object or null Set of elements providing information specific to the individual credit transfer.
required	(object or null) or (object or null) Unique and unambiguous identification of a financial institution or a branch of a financial institution.
LinkIdentifiers required	Array of strings or null One or more unique entries used to match a settlement, which should be common between counterparties. Where the FX quotes service has been used, please specify the ClOrdID and OrderID from the execution report.

Responses

Request samples

Payload

Content type

application/json

{"GrpHdr": {"MsgId": "a9bcdf070ab5472fb9529c84e2224a54"
},
"CdtTrfTxInf": {"PmtId": {"UETR": "d1fca09c-e91e-40ef-9bd6-74c10c21e725",
"EndToEndId": "end2endid"
},
"DbitAmt": {"Ccy": "GBP",
"Value": "3.14"
},
"CrdtAmt": {"Ccy": "JPY",
"Value": "100"
},
"DbtrAcct": {"Id": {"IBAN": "GB33BUKB20201555555555"
}
},
"CdtrAcct": {"Id": {"Othr": {"Id": "JPBKJP44XXX"
}
}
}
},
"Counterparty": {"LEI": "RTGSTECH1234ABCD0000"
},
"LinkIdentifiers": ["5C3D8999FE8344BD8777009C8BC9CA3B",
"7F5D84B02A0249AB965E07EB998595ED"
]
}

Response samples

Content type

application/problem+json

{"Type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
"Title": "One or more validation errors occurred.",
"Status": 400,
"Errors": {"GrpHdr": ["'GrpHdr' must not be empty."
],
"CdtTrfTxInf": ["'CdtTrfTxInf' must not be empty."
],
"Counterparty": ["'Counterparty' must not be empty."
],
"LinkIdentifiers": ["'LinkIdentifiers' must not be empty."
]
}
}

Create a new cancel settlement request

Proprietary model. Cancel a pending Link and Settle request by creating a cancel settlement request.

Webhooks will be called for both the initiating and counterparty participants to inform them of the status of the cancellation.

Request Body schema: application/json

required	object or null Identifies the assignment of an investigation case from an assigner to an assignee.
required	object or null Identifies the payment instruction to be cancelled.

Responses

Request samples

Payload

Content type

application/json

{"Assignment": {"Identification": "a9bcdf070ab5476a12329c84e2224a54"
},
"Underlying": {"TransactionInformation": {"LinkIdentifiers": ["5C3D8999FE8344BD8777009C8BC9CA3B",
"7F5D84B02A0249AB965E07EB998595ED"
],
"OriginalUETR": "d1fca09c-e91e-40ef-9bd6-74c10c21e123"
}
}
}

Response samples

Content type

application/problem+json

{"Type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
"Title": "One or more validation errors occurred.",
"Status": 400,
"Errors": {"Assignment": ["'Assignment' must not be empty."
],
"Underlying": ["'Underlying' must not be empty."
]
}
}

FI to FI Customer Credit Transfer

Instruct participants to make payments to beneficiaries in other jurisdictions.

Transaction status update Webhook

ISO-20022 pacs.002 message. Information about a transaction status update.

Event type: global.rtgs.TransactionStatusNotificationV1

Request Body schema: application/json

object or null

Responses

Request samples

Payload

Content type

application/json

Example

payaway failure

{"FIToFIPmtStsRpt": {"GrpHdr": {"MsgId": "b9fdbd5351eb4bc9b2accd83b860a016",
"CreDtTm": "2019-08-24T15:15:00Z",
"InstdAgt": {"FinInstnId": {"BICFI": "EEXGBP11",
"LEI": "376323TESTVDK1GB1L12",
"Othr": {"Id": "RTGS:B:GB43400282"
}
}
}
},
"TxInfAndSts": [{"OrgnlEndToEndId": "c13afc06de22444e8e6869573c0168e9",
"OrgnlUETR": "90fdc79b-4090-413d-9a79-9a87cb838285",
"TxSts": "RJCT",
"StsRsnInf": [{"Rsn": {"Cd": "AM04"
},
"AddtlInf": ["Insufficient Funds"
]
}
],
"OrgnlTxRef": {"IntrBkSttlmAmt": {"Ccy": "JPY",
"Value": "999"
},
"PmtTpInf": {"LclInstrm": {"Prtry": "FIToFICustomerCreditTransfer"
}
},
"Cdtr": {"Pty": {"Nm": "Tom Tompson",
"PstlAdr": {"TwnNm": "Tokyo",
"Ctry": "JP"
}
}
}
}
}
]
}
}

New transaction Webhook

ISO-20022 camt.054 message. Information about a debit or credit transaction against an account.

Event type: global.rtgs.TransactionNotificationV1

Request Body schema: application/json

	object or null BankToCustomerDebitCreditNotification : to inform the account owner of single or multiple debit and/or credit entries reported to the account
	object or null Extra proprietary metadata associated with the notification.

Responses

Request samples

Payload

Content type

application/json

Example

valid payaway request

{"BkToCstmrDbtCdtNtfctn": {"GrpHdr": {"MsgId": "df9857cdee60482a8d2646931958a367",
"CreDtTm": "2023-03-08T15:58:22.0090079Z"
},
"Ntfctn": [{"Id": "9b74b93586d9488f841c43e7ad8d0887",
"Acct": {"Id": {"IBAN": "GB33BUKB30301666666666"
}
},
"Ntry": [{"NtryRef": "0",
"Amt": {"Ccy": "GBP",
"Value": "99.99"
},
"CdtDbtInd": "DBIT",
"Sts": {"Cd": "BOOK"
},
"BkTxCd": {"Domn": {"Cd": "PMNT",
"Fmly": {"Cd": "ICDT",
"SubFmlyCd": "FICT"
}
}
},
"NtryDtls": [{"TxDtls": {"Refs": {"EndToEndId": "unique-end-to-end-id",
"UETR": "90fdc79b-4090-413d-9a79-9a87cb838285"
},
"LclInstrm": {"Prtry": "FIToFICustomerCreditTransfer"
}
}
}
]
}
]
}
]
}
}

New payaway funds request Webhook

ISO-20022 pacs.008 message. Forwarded Financial Institution To Financial Institution Customer Credit Transfer message from the initiating participant to the counterparty participant.

Event type: global.rtgs.PayawayFundsV1

Request Body schema: application/json

FromRtgsGlobalId	string or null
	object or null

Responses

Request samples

Payload

Content type

application/json

{"FIToFICstmrCdtTrf": {"GrpHdr": {"CreDtTm": "2024-03-01T10:49:55.713Z",
"MsgId": "bcf7d211fa32470c8035ae07f83c5624",
"SttlmInf": {"SttlmMtd": "INDA"
},
"InstgAgt": {"FinInstnId": {"BICFI": "EEXGBP11",
"LEI": "376323TESTVDK1GB1L12",
"Othr": {"Id": "RTGS:GB:43400282"
}
}
},
"InstdAgt": {"FinInstnId": {"BICFI": "EEZJPY31",
"LEI": "235323TESTDHZ1JP4P49",
"Othr": {"Id": "RTGS:JP:15887136"
}
}
},
"NbOfTxs": "1"
},
"CdtTrfTxInf": [{"PmtId": {"EndToEndId": "c13afc06de22444e8e6869573c0168e9",
"UETR": "a8968c6f-896f-40f7-9add-5391333435d9"
},
"IntrBkSttlmAmt": {"Ccy": "JPY",
"Value": "999"
},
"ChrgBr": "DEBT",
"Dbtr": {"Nm": "John Johnson",
"PstlAdr": {"Ctry": "GB",
"TwnNm": "London",
"BldgNb": "99",
"StrtNm": "Bond Street",
"PstCd": "EC1A 1AA"
}
},
"DbtrAcct": {"Id": {"Othr": {"Id": "AA11223344"
}
}
},
"DbtrAgt": {"FinInstnId": {"BICFI": "HIXLEPPKHFR"
},
"BrnchId": {"Id": "990011",
"Nm": "debtor-branch-name"
}
},
"Cdtr": {"Nm": "Tom Tompson",
"PstlAdr": {"Ctry": "JP",
"TwnNm": "Tokyo",
"BldgNb": "11A",
"StrtNm": "Otome Road",
"PstCd": "329-0214"
}
},
"CdtrAcct": {"Id": {"Othr": {"Id": "1234567890"
}
}
},
"CdtrAgt": {"FinInstnId": {"BICFI": "TFKPFZLCGUF"
},
"BrnchId": {"Id": "054546",
"Nm": "creditor-branch-name"
}
}
}
]
}
}

Initiate FI to FI Customer Credit Transfer

ISO-20022 pacs.008 message. Instruct funds controller to initiate onward payment to beneficiaries in other countries.

On success, the pacs.008 message will be sent to the funds controller to inform them of the onward payment requests.

On failure, the initiating party's webhook will receive a notification with the reason.

The InstgAgt.FinInstnId.Othr.Id and InstdAgt.FinInstnId.Othr.Id properties must be populated with the RTGS.global Ids of the debtor participant and debtor's funds controller respectively.

If the debtor's funds controller requires debtor party management, the ultimate debtor's account alias id must be provided. If the ultimate debtor is an individual, use FIToFICstmrCdtTrf.CdtTrfTxInf[0].Dbtr.Id.PrvtId.Othr[0].Id, otherwise FIToFICstmrCdtTrf.CdtTrfTxInf[0].Dbtr.Id.OrgId.Othr[0].Id.

If the debtor's funds controller requires creditor party management, the ultimate creditors's account alias id must be provided. If the ultimate creditor is an individual, use FIToFICstmrCdtTrf.CdtTrfTxInf[0].Cdtr.Id.PrvtId.Othr[0].Id, otherwise FIToFICstmrCdtTrf.CdtTrfTxInf[0].Cdtr.Id.OrgId.Othr[0].Id.

Request Body schema: application/json

object or null

pacs.008.001.10 - the Financial Institution To Financial Institution Customer Credit Transfer message

Responses

Request samples

Payload

Content type

application/json

{"FIToFICstmrCdtTrf": {"GrpHdr": {"CreDtTm": "2024-03-01T10:49:55.713Z",
"MsgId": "bcf7d211fa32470c8035ae07f83c5624",
"SttlmInf": {"SttlmMtd": "INDA"
},
"InstgAgt": {"FinInstnId": {"BICFI": "EEXGBP11",
"LEI": "376323TESTVDK1GB1L12",
"Othr": {"Id": "RTGS:GB:43400282"
}
}
},
"InstdAgt": {"FinInstnId": {"BICFI": "EEZJPY31",
"LEI": "235323TESTDHZ1JP4P49",
"Othr": {"Id": "RTGS:JP:15887136"
}
}
},
"NbOfTxs": "1"
},
"CdtTrfTxInf": [{"InstgAgt": {"FinInstnId": {"Othr": {"Id": "LU280019400644750000",
"SchmeNm": {"Prtry": "IBAN"
}
}
}
},
"PmtId": {"EndToEndId": "c13afc06de22444e8e6869573c0168e9",
"UETR": "a8968c6f-896f-40f7-9add-5391333435d9"
},
"IntrBkSttlmAmt": {"Ccy": "JPY",
"Value": "999"
},
"ChrgBr": "DEBT",
"Dbtr": {"Id": {"PvtId": {"Othr": [{"Id": "debtors-account-alias-id"
}
]
}
},
"Nm": "John Johnson",
"PstlAdr": {"Ctry": "GB",
"TwnNm": "London",
"BldgNb": "99",
"StrtNm": "Bond Street",
"PstCd": "EC1A 1AA"
}
},
"DbtrAcct": {"Id": {"Othr": {"Id": "AA11223344"
}
}
},
"DbtrAgt": {"FinInstnId": {"BICFI": "HIXLEPPKHFR"
},
"BrnchId": {"Id": "990011",
"Nm": "debtor-branch-name"
}
},
"Cdtr": {"Id": {"PvtId": {"Othr": [{"Id": "creditors-account-alias-id"
}
]
}
},
"Nm": "Tom Tompson",
"PstlAdr": {"Ctry": "JP",
"TwnNm": "Tokyo",
"BldgNb": "11A",
"StrtNm": "Otome Road",
"PstCd": "329-0214"
}
},
"CdtrAcct": {"Id": {"Othr": {"Id": "1234567890"
}
}
},
"CdtrAgt": {"FinInstnId": {"BICFI": "TFKPFZLCGUF"
},
"BrnchId": {"Id": "054546",
"Nm": "creditor-branch-nam"
}
}
}
]
}
}

Response samples

Content type

application/json

{"FIToFICstmrCdtTrf.CdtTrfTxInf[0].Dbtr.PstlAdr.Ctry": ["Invalid 'Ctry' value. The value should come from the list of country names obtained from the United Nations(ISO 3166, Alpha - 2 code)"
],
"FIToFICstmrCdtTrf.GrpHdr": ["'GrpHdr' is missing child properties."
],
"FIToFICstmrCdtTrf.GrpHdr.MsgId": ["'MsgId' must not be empty."
]
}

Validate a FI to FI Customer Credit Transfer request

ISO-20022 pacs.008 message. Synchronously validate FI to FI Customer Credit Transfer request. The validation logic applied by this endpoint is identical to the logic applied by the /v1/Payaway endpoint.

On success, a 204 response will be returned immediately.

On failure, a 400 response will be returned immediately with details of the validation failures.

The InstgAgt.FinInstnId.Othr.Id and InstdAgt.FinInstnId.Othr.Id properties must be populated with the RTGS.global Ids of the debtor participant and debtor's funds controller respectively.

If the debtor's funds controller requires debtor party management, the ultimate debtor's account alias id must be provided. If the ultimate debtor is an individual, use FIToFICstmrCdtTrf.CdtTrfTxInf[0].Dbtr.Id.PrvtId.Othr[0].Id, otherwise FIToFICstmrCdtTrf.CdtTrfTxInf[0].Dbtr.Id.OrgId.Othr[0].Id.

If the debtor's funds controller requires creditor party management, the ultimate creditors's account alias id must be provided. If the ultimate creditor is an individual, use FIToFICstmrCdtTrf.CdtTrfTxInf[0].Cdtr.Id.PrvtId.Othr[0].Id, otherwise FIToFICstmrCdtTrf.CdtTrfTxInf[0].Cdtr.Id.OrgId.Othr[0].Id.

Request Body schema: application/json

object or null

pacs.008.001.10 - the Financial Institution To Financial Institution Customer Credit Transfer message

Responses

Request samples

Payload

Content type

application/json

{"FIToFICstmrCdtTrf": {"GrpHdr": {"CreDtTm": "2024-03-01T10:49:55.713Z",
"MsgId": "bcf7d211fa32470c8035ae07f83c5624",
"SttlmInf": {"SttlmMtd": "INDA"
},
"InstgAgt": {"FinInstnId": {"BICFI": "EEXGBP11",
"LEI": "376323TESTVDK1GB1L12",
"Othr": {"Id": "RTGS:GB:43400282"
}
}
},
"InstdAgt": {"FinInstnId": {"BICFI": "EEZJPY31",
"LEI": "235323TESTDHZ1JP4P49",
"Othr": {"Id": "RTGS:JP:15887136"
}
}
},
"NbOfTxs": "1"
},
"CdtTrfTxInf": [{"InstgAgt": {"FinInstnId": {"Othr": {"Id": "LU280019400644750000",
"SchmeNm": {"Prtry": "IBAN"
}
}
}
},
"PmtId": {"EndToEndId": "c13afc06de22444e8e6869573c0168e9",
"UETR": "a8968c6f-896f-40f7-9add-5391333435d9"
},
"IntrBkSttlmAmt": {"Ccy": "JPY",
"Value": "999"
},
"ChrgBr": "DEBT",
"Dbtr": {"Id": {"PvtId": {"Othr": [{"Id": "debtors-account-alias-id"
}
]
}
},
"Nm": "John Johnson",
"PstlAdr": {"Ctry": "GB",
"TwnNm": "London",
"BldgNb": "99",
"StrtNm": "Bond Street",
"PstCd": "EC1A 1AA"
}
},
"DbtrAcct": {"Id": {"Othr": {"Id": "AA11223344"
}
}
},
"DbtrAgt": {"FinInstnId": {"BICFI": "HIXLEPPKHFR"
},
"BrnchId": {"Id": "990011",
"Nm": "debtor-branch-name"
}
},
"Cdtr": {"Id": {"PvtId": {"Othr": [{"Id": "creditors-account-alias-id"
}
]
}
},
"Nm": "Tom Tompson",
"PstlAdr": {"Ctry": "JP",
"TwnNm": "Tokyo",
"BldgNb": "11A",
"StrtNm": "Otome Road",
"PstCd": "329-0214"
}
},
"CdtrAcct": {"Id": {"Othr": {"Id": "1234567890"
}
}
},
"CdtrAgt": {"FinInstnId": {"BICFI": "TFKPFZLCGUF"
},
"BrnchId": {"Id": "054546",
"Nm": "creditor-branch-nam"
}
}
}
]
}
}

Response samples

Content type

application/json

{"FIToFICstmrCdtTrf.CdtTrfTxInf[0].Dbtr.PstlAdr.Ctry": ["Invalid 'Ctry' value. The value should come from the list of country names obtained from the United Nations(ISO 3166, Alpha - 2 code)"
],
"FIToFICstmrCdtTrf.GrpHdr": ["'GrpHdr' is missing child properties."
],
"FIToFICstmrCdtTrf.GrpHdr.MsgId": ["'MsgId' must not be empty."
]
}

Payment Status Report

Payments statuses.

Transaction status update Webhook

ISO-20022 pacs.002 message. Information about a transaction status update.

Event type: global.rtgs.TransactionStatusNotificationV1

Request Body schema: application/json

object or null

Responses

Request samples

Payload

Content type

application/json

Example

payaway failure

{"FIToFIPmtStsRpt": {"GrpHdr": {"MsgId": "b9fdbd5351eb4bc9b2accd83b860a016",
"CreDtTm": "2019-08-24T15:15:00Z",
"InstdAgt": {"FinInstnId": {"BICFI": "EEXGBP11",
"LEI": "376323TESTVDK1GB1L12",
"Othr": {"Id": "RTGS:B:GB43400282"
}
}
}
},
"TxInfAndSts": [{"OrgnlEndToEndId": "c13afc06de22444e8e6869573c0168e9",
"OrgnlUETR": "90fdc79b-4090-413d-9a79-9a87cb838285",
"TxSts": "RJCT",
"StsRsnInf": [{"Rsn": {"Cd": "AM04"
},
"AddtlInf": ["Insufficient Funds"
]
}
],
"OrgnlTxRef": {"IntrBkSttlmAmt": {"Ccy": "JPY",
"Value": "999"
},
"PmtTpInf": {"LclInstrm": {"Prtry": "FIToFICustomerCreditTransfer"
}
},
"Cdtr": {"Pty": {"Nm": "Tom Tompson",
"PstlAdr": {"TwnNm": "Tokyo",
"Ctry": "JP"
}
}
}
}
}
]
}
}

Send a payment status report

ISO-20022 pacs.002 message. Send a payment status report to a counterparty via a webhook. Used to notify the counterparty of a status update on a transaction they initiated. The status code provided drives specific actions within the RTGS.global system. For example:

RJCT: Cancels the pending transaction associated with the given UETR.
ACWP: Indicates successful vetting and signature verification meaning the participant accepts the onward payment request. This triggers transaction settlement. Upon settlement, both participants receive a camt.054 and pacs.002 messages confirming the movement of funds.
ACCC: Signals that the onward payment has been successfully committed and credited to the recipient — marking the final step in the onward payment flow.

Note: due to this request being a notification for another participant, the gateway has to be instructed separately about who to sign this request for. This is done via HTTP header 'rtgs-global-signed-for', that should be set to the RTGS.global Id of the counterparty participant.

header Parameters

rtgs-global-signed-for

required

string

Example: RTGS:B:GB43400282

Request Body schema: application/json

object or null

Responses

Request samples

Payload

Content type

application/json

{"FIToFIPmtStsRpt": {"GrpHdr": {"MsgId": "b9fdbd5351eb4bc9b2accd83b860a016",
"CreDtTm": "2019-08-24T15:15:00Z",
"InstgAgt": {"FinInstnId": {"BICFI": "EEZJPY31",
"LEI": "235323TESTDHZ1JP4P49",
"Othr": {"Id": "RTGS:B:JP15887136"
}
}
},
"InstdAgt": {"FinInstnId": {"BICFI": "EEXGBP11",
"LEI": "376323TESTVDK1GB1L12",
"Othr": {"Id": "RTGS:B:GB43400282"
}
}
}
},
"TxInfAndSts": [{"OrgnlEndToEndId": "c13afc06de22444e8e6869573c0168e9",
"OrgnlUETR": "90fdc79b-4090-413d-9a79-9a87cb838285",
"TxSts": "ACCC",
"OrgnlTxRef": {"IntrBkSttlmAmt": {"Ccy": "JPY",
"Value": "999"
},
"PmtTpInf": {"LclInstrm": {"Prtry": "FIToFICustomerCreditTransfer"
}
},
"Cdtr": {"Pty": {"Nm": "Tom Tompson",
"PstlAdr": {"TwnNm": "Tokyo",
"Ctry": "JP"
}
}
}
}
}
]
}
}

Balances

Real time information of network accounts.

Get balances v2

Returns ISO-20022 camt.052 models. Get the available balances of network accounts in all jurisdictions.

The response will be in PascalCase and any enum types returned as strings.

Responses

Response samples

Content type

application/json

{"GrpHdr": {"MsgId": "2b4cf98fc94c4520a845433aa2600bfb",
"CreDtTm": "2024-01-22T16:37:25.2055281Z"
},
"Rpt": [{"Id": "cd893b00154e467ca100d843542a1f8b",
"CreDtTm": "2024-01-22T16:37:25.2055281Z",
"Acct": {"Id": {"IBAN": "GB33BUKB20201555555555"
}
},
"Bal": [{"Tp": {"CdOrPrtry": {"Cd": "ITAV"
}
},
"Amt": {"Ccy": "GBP",
"Value": "9.99"
},
"CdtDbtInd": "CRDT",
"Dt": {"DtTm": "2023-01-02T13:14:15Z"
}
}
]
},
{"Id": "fae84131176848d1a46e7b96dff6fcef",
"CreDtTm": "2024-01-22T16:37:25.2055281Z",
"Acct": {"Id": {"Othr": {"Id": "USBKUS44XXX"
}
}
},
"Bal": [{"Tp": {"CdOrPrtry": {"Cd": "ITAV"
}
},
"Amt": {"Ccy": "USD",
"Value": "3.33"
},
"CdtDbtInd": "CRDT",
"Dt": {"DtTm": "2023-01-02T16:17:18Z"
}
}
]
}
]
}

Accounts

Information about participant's accounts

Network account created event V1 Webhook

ISO-20022 compatible proprietary message. Event emitted upon creating a network account

Event type: participants.networkaccount.created.v1

Request Body schema: application/json

CorrelationId	string or null <uuid>
	object (RtgsGlobal.ParticipantGateway.Messages.Admin.Events.NetworkAccount1)

Request samples

Payload

Content type

application/json

{"CorrelationId": "6c70ab43-9882-4a7e-a322-8d2d7f7a5a17",
"Data": {"Acct": {"Id": {"IBAN": "GB29NWBK60161331926819"
},
"Ccy": "GBP",
"Ownr": {"Nm": "Bank of Sam",
"Id": {"OrgId": {"AnyBIC": "12ASUS12",
"LEI": "USR4ABCDE123ABCD1233",
"Othr": [{"Id": "RTGS:B:US12521USD",
"Issr": "RTGS.global"
}
]
}
}
},
"Svcr": {"FinInstnId": {"BICFI": "CTBKTH37",
"LEI": "213800PLUYXGZ3TH6C38",
"Nm": "Bank of Ian",
"Othr": {"Id": "RTGS:B:GB46204285",
"Issr": "RTGS.global"
}
}
}
},
"ServicerParticipantJurisdiction": {"Ccy": "GBP",
"Nm": "Bank of England (GBP)",
"JurisdictionCode": "gbpboe1",
"Owner": "Bank of England"
},
"OwnerParticipantJurisdiction": {"Ccy": "USD",
"Nm": "US Federal Reserve (USD)",
"JurisdictionCode": "usdfed1",
"Owner": "US Federal Reserve"
},
"Sts": "Active",
"CreDtTm": "2019-08-24T14:15:22Z",
"UpdatedDate": "2022-12-11T04:51:21Z"
}
}

Account Approval Failed Event V1 Webhook

ISO-20022 compatible proprietary message. Event emitted when an account approval fails.

Event type: global.rtgs.participants.account.approval.requestfailed.v1

Request Body schema: application/json
required

	object (RtgsGlobal.Participants.Contracts.Commands.v1.ApproveAccountRequestV1Command) Request which triggered the failure
ErrorMessage	string Reason for the failure

Request samples

Payload

Content type

application/json

{"Request": {"OwnerRtgsGlobalId": "RTGS:B:US13221932",
"FundsControllerCode": "BOE1",
"AccountIdentifier": {"Ccy": "GBP",
"Id": {"IBAN": "GB29NWBK60161331926819"
}
}
},
"ErrorMessage": "Account validation failed due to missing KYC information."
}

Account Approved Event V1 Webhook

ISO-20022 compatible proprietary message. Event emitted when an account gets approved.

Event type: global.rtgs.participants.account.approved.v1

Request Body schema: application/json

required	object (RtgsGlobal.Participants.Contracts.Queries.Responses.v1.MinimalFundsControllerV1) Funds controller of the account.
required	object (RtgsGlobal.ISO20022.Messages.CashAccount40) Identifier of the account.
required	object (RtgsGlobal.ISO20022.Messages.OrganisationIdentification29) Servicer (host) of the account.
CorrelationId	string <uuid> Request correlation id

Request samples

Payload

Content type

application/json

{"FundsController": {"Nm": "Alpha Funds Controller",
"Cd": "ALPHA1",
"JurisdictionCode": "usdfed1",
"Sts": "Active",
"Ctry": "US"
},
"AccountIdentifier": {"Id": {"Othr": {"Id": 2922774458,
"Issr": "Federal Reserve"
}
},
"Ccy": "USD",
"Nm": "Savings Account"
},
"CurrencyCode": "USD",
"ServicerParticipant": {"AnyBIC": "SFFBUS33",
"LEI": "5493001KJTIORY4R8375",
"Othr": [{"Id": "RTGS:B:US13221932",
"Issr": "RTGS.global"
}
]
},
"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}

Account Requested Event V1 Webhook

ISO-20022 compatible proprietary message. Event emitted when hosted account is requested by a participant.

Event type: global.rtgs.participants.account.requested.v1

Request Body schema: application/json

required	object (RtgsGlobal.Participants.Contracts.Events.FundsControllerV1)
CurrencyCode required	string Three-letter uppercase currency code of the account. See ISO-4217.
OwnerRtgsGlobalId required	string RtgsGlobalId of participant who requested the account.
CorrelationId	string <uuid> Request correlation id

Request samples

Payload

Content type

application/json

Example

Example AccountRequestedEventV1

{"FundsController": {"Nm": "Federal Reserve (USD)",
"Cd": "FED1",
"JurisdictionCode": "usdfed1",
"Sts": "Active",
"Ctry": "US"
},
"CurrencyCode": "USD",
"OwnerRtgsGlobalId": "RTGS:B:US13221932",
"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}

Account Request Failed Event V1 Webhook

ISO-20022 compatible proprietary message. Event emitted when requesting an account fails.

Event type: global.rtgs.participants.account.requestfailed.v1

Request Body schema: application/json

	object (RtgsGlobal.Participants.Contracts.Commands.v1.CreateAccountRequestV1Command) Request which triggered the failure
ErrorMessage	string Reason for the failure

Request samples

Payload

Content type

application/json

{"Request": {"AccountId": "f9a3e4a9-6f4a-4b3a-8b2a-9e9e9e9e9e9e",
"AccountName": "My Account",
"AccountCurrency": "USD",
"OwnerId": "user123"
},
"ErrorMessage": "Insufficient permissions to create account"
}

Get accounts

Returns ISO-20022 compatible proprietary models. Get the collection of accounts owned by the participant in all active jurisdictions

Responses

Response samples

Content type

application/json

[{"Id": {"IBAN": "GB33BUKB30301666666666"
},
"Ccy": "GBP",
"Jurisdiction": {"Ccy": "GBP",
"Nm": "Bank of England (GBP)",
"Sts": "Active",
"Cd": "gbpboe1",
"Ownr": "Bank of England"
},
"Ownr": {"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:DK05298237",
"Issr": "RTGS.global"
}
}
}
},
"Svcr": {"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:GB80881964",
"Issr": "RTGS.global"
}
}
}
},
"Sts": "Active",
"CreDtTm": "2019-08-24T14:15:22Z",
"UpdateDateTime": "2022-08-24T14:15:22Z"
}
]

Get accounts v2

Returns ISO-20022 compatible proprietary models. Get accounts owned by the participant in all active jurisdictions. Returns 200 with an array of AccountV2 objects if found; returns 204 if none found.

Responses

Response samples

Content type

application/json

[{"Id": {"IBAN": "GB33BUKB30301676767676"
},
"Owner": {"Nm": "Bank of Bob",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:DE5298237",
"Issr": "RTGS.global"
}
}
}
},
"Svcr": {"Nm": "Bank of Sam",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:US80881964",
"Issr": "RTGS.global"
}
}
}
},
"AccountJurisdiction": {"Cd": "gbpboe1",
"Nm": "Bank of England (GBP)",
"Ccy": "GBP",
"Sts": "Active",
"Ownr": "Bank of England"
},
"AccountHostJurisdiction": {"Cd": "usdfed1",
"Nm": "US Federal Reserve (USD)",
"Ccy": "USD",
"Sts": "Active",
"Ownr": "US Federal Reserve"
},
"Ccy": "GBP",
"Sts": "Active",
"CreDtTm": "2024-10-21T11:44:32+00:00",
"UpdateDateTime": "2025-01-01T09:40:00+00:00"
}
]

Approve Account V1

Approves a hosted account request.

Request Body schema: application/json

OwnerRtgsGlobalId required	string RtgsGlobalId of participant who requested the account.
FundsControllerCode required	string Funds controller code indicating where account should reside.
required	object (RtgsGlobal.ISO20022.Messages.CashAccount40) Identifier for the account.

Responses

Request samples

Payload

Content type

application/json

{"OwnerRtgsGlobalId": "RTGS:B:US13221932",
"FundsControllerCode": "BOE1",
"AccountIdentifier": {"Ccy": "GBP",
"Id": {"IBAN": "GB29NWBK60161331926819"
}
}
}

Get accounts requests V1

Returns ISO-20022 compatible proprietary models. Get list of account requests related to a given participant. Returns 200 with an array of AccountRequestV1 objects if found; returns 204 if none found.

Responses

Response samples

Content type

application/json

{"Owner": {"Nm": "Bank of Bob",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:DE5298237",
"Issr": "RTGS.global"
}
}
}
},
"Svcr": {"Nm": "Bank of Sam",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:US80881964",
"Issr": "RTGS.global"
}
}
}
},
"Ccy": "USD",
"AccountFundsController": {"Nm": "Federal Reserve (USD)",
"Cd": "FED1",
"JurisdictionCode": "usdfed1",
"Sts": "Active",
"Ctry": "US"
},
"Sts": "Active",
"CreDtTm": "2024-10-21T11:44:32+00:00",
"UpdateDateTime": "2025-01-01T09:40:00+00:00"
}

Create Account Request V1

Endpoint to request the creation of a new account.

Request Body schema: application/json

CorrelationId	string <uuid> Request correlation id
ServicerRtgsGlobalId required	string RtgsGlobalId of the desired account servicer.
FundsControllerCode required	string Funds controller code indicating where account should reside.
CurrencyCode required	string Currency of the account. Must be a three-letter uppercase currency code defined by ISO-4217.

Responses

Request samples

Payload

Content type

application/json

{"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"ServicerRtgsGlobalId": "RTGS:B:US98765432",
"FundsControllerCode": "FED1",
"CurrencyCode": "USD"
}

Response samples

Content type

application/json

{ }

Get Accounts V3

Returns ISO-20022 compatible proprietary models. Get accounts owned by a given participant with all funds controllers.

Responses

Response samples

Content type

application/json

[{"Id": {"IBAN": "GB29NWBK60161331926819"
},
"Owner": {"Nm": "Acme Corp",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:GB78901234",
"Issr": "RTGS.global"
}
}
}
},
"Svcr": {"Nm": "Globex Bank",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:US56789012",
"Issr": "RTGS.global"
}
}
}
},
"AccountFundsController": {"Nm": "Federal Reserve (USD)",
"Cd": "FED1",
"JurisdictionCode": "usdfed1",
"Sts": "Active",
"Ctry": "US",
"Ccys": ["USD"
]
},
"ServicerFundsController": {"Nm": "Bank of England (GBP)",
"Cd": "BOE",
"JurisdictionCode": "gbpboe1",
"Sts": "Active",
"Ctry": "GB",
"Ccys": ["GBP"
]
},
"Ccy": "GBP",
"Sts": "Active",
"CreDtTm": "2024-01-01T00:00:00Z",
"UpdateDateTime": "2024-01-02T00:00:00Z"
},
{"Id": {"Othr": {"Id": 1234567890
}
},
"Owner": {"Nm": "Beta Industries",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:JP90123456",
"Issr": "RTGS.global"
}
}
}
},
"Svcr": {"Nm": "Universal Financial",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:DE34567890",
"Issr": "RTGS.global"
}
}
}
},
"AccountFundsController": {"Nm": "European Central Bank (EUR)",
"Cd": "ECB1",
"JurisdictionCode": "eurecb1",
"Sts": "Active",
"Ctry": "EU",
"Ccys": ["EUR"
]
},
"ServicerFundsController": {"Nm": "Bank of Japan (JPY)",
"Cd": "BOJ1",
"JurisdictionCode": "jpyboj1",
"Sts": "Active",
"Ctry": "JP",
"Ccys": ["JPY"
]
},
"Ccy": "JPY",
"Sts": "Active",
"CreDtTm": "2024-02-15T10:30:00Z",
"UpdateDateTime": "2024-02-16T12:00:00Z"
}
]

Participants

Participant related information and actions

Details of the current participant

Returns ISO-20022 compatible proprietary model. Get the information about the participant registered with the current gateway installation

Responses

Response samples

Content type

application/json

{"Nm": "Bank of Sam",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:US12521USD",
"Issr": "RTGS.global"
},
"LEI": "USR4ABCDE123ABCD1233",
"AnyBIC": "12ASUS12"
}
},
"SIC": "12345",
"CtryOfRes": "US",
"Ccy": "USD",
"Sts": "Online",
"Jurisdiction": {"Ccy": "USD",
"Nm": "US Federal Reserve (USD)",
"Sts": "Active",
"Cd": "usdfed1",
"Ownr": "US Federal Reserve"
}
}

Status of the current participant

Returns ISO-20022 compatible proprietary model. Get the information about the participant's status for the participant registered with the current gateway installation.

Responses

Response samples

Content type

application/json

{"Sts": "Online"
}

List existing participants

Returns ISO-20022 compatible proprietary models. Get a list of participants residing in the given jurisdiction

query Parameters

required

string

Example: cd=gbpboe1

Jurisdiction Code

Responses

Response samples

Content type

application/json

[{"Nm": "Bank of Jane",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:GB12521115",
"Issr": "RTGS.global"
},
"LEI": "4UYJ00EJD47E2IZ0LB86",
"AnyBIC": "BJUKGB4B"
}
},
"Sic": "12345",
"CtryOfRes": "GB",
"Ccy": "GBP",
"Sts": "Online",
"Jurisdiction": {"Ccy": "GBP",
"Nm": "Bank of England (GBP)",
"Sts": "Active",
"Cd": "gbpboe1",
"Ownr": "Bank of England"
}
},
{"Nm": "Bank of Ian",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:GB46204285",
"Issr": "RTGS.global"
},
"LEI": "213800PLUYXGZ3TH6C38",
"AnyBIC": "BIUKGB37"
}
},
"Sic": "1234",
"CtryOfRes": "GB",
"Ccy": "GBP",
"Sts": "Validated",
"Jurisdiction": {"Ccy": "GBP",
"Nm": "Bank of England (GBP)",
"Sts": "Active",
"Cd": "gbpboe1",
"Ownr": "Bank of England"
}
},
{"Nm": "Bank of Simon",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:GB47218789",
"Issr": "RTGS.global"
},
"LEI": "TCN300DJVKZTREAUQB78",
"AnyBIC": "BSUKGB44"
}
},
"Sic": "1234",
"CtryOfRes": "GB",
"Ccy": "GBP",
"Sts": "Validated",
"Jurisdiction": {"Ccy": "GBP",
"Nm": "Bank of England (GBP)",
"Sts": "Active",
"Cd": "gbpboe1",
"Ownr": "Bank of England"
}
},
{"Nm": "Bank of Carl",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:GB43361757",
"Issr": "RTGS.global"
},
"LEI": "CBVA00CMD3CSTI1OQW52",
"AnyBIC": "BOCUKGB84"
}
},
"Sic": "6419",
"CtryOfRes": "GB",
"Ccy": "GBP",
"Sts": "Validated",
"Jurisdiction": {"Ccy": "GBP",
"Nm": "Bank of England (GBP)",
"Sts": "Active",
"Cd": "gbpboe1",
"Ownr": "Bank of England"
}
},
{"Nm": "Bank of Bob",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:GB12521JPY",
"Issr": "RTGS.global"
},
"LEI": "JWTM00DJOI56YUEASE22",
"AnyBIC": "BOBUKGB90"
}
},
"Sic": "12345",
"CtryOfRes": "GB",
"Ccy": "GBP",
"Sts": "Online",
"Jurisdiction": {"Ccy": "GBP",
"Nm": "Bank of England (GBP)",
"Sts": "Active",
"Cd": "gbpboe1",
"Ownr": "Bank of England"
}
}
]

Activate participant gateway

Proprietary model. Activate fresh participant gateway installation

Responses

Get Participant Me V2

Get details of current participant.

Responses

Response samples

Content type

application/json

{"Nm": "Acme Corp",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:US12345678",
"Issr": "RTGS.global"
}
}
},
"CtryOfRes": "US",
"SIC": "7372",
"Sts": "Active",
"FundsController": {"Nm": "Federal Reserve (USD)",
"Cd": "FED1",
"JurisdictionCode": "usdfed1",
"Sts": "Active",
"Ctry": "US"
}
}

Get Participants V2

Get a list of participants residing in any active jurisdiction

Request Body schema: application/json

Cd	string The code of the funds controller to query.

Responses

Request samples

Payload

Content type

application/json

Example

Example FundsControllerQueryV1

{"Cd": "FED1"
}

Response samples

Content type

application/json

[{"Nm": "Acme Corp",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:US12345678",
"Issr": "RTGS.global"
}
}
},
"CtryOfRes": "US",
"SIC": "1234",
"Sts": "Active",
"FundsController": {"Nm": "Federal Reserve (USD)",
"Cd": "FED",
"JurisdictionCode": "usdfed1",
"Sts": "Active",
"Ctry": "US"
}
},
{"Nm": "Beta Inc",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:GB87654321",
"Issr": "RTGS.global"
}
}
},
"CtryOfRes": "GB",
"SIC": "5678",
"Sts": "Active",
"FundsController": {"Nm": "Bank of England (GBP)",
"Cd": "BOE",
"JurisdictionCode": "gbpboe1",
"Sts": "Active",
"Ctry": "GB"
}
}
]

Relationships

Participant relationships, related information and actions

Relationship update failed event Webhook

Proprietary message. Event emitted upon failing to update a relationship

Event type: global.rtgs.participants.relationship.updatefailed.v1

Request Body schema: application/json

CorrelationId	string or null <uuid>
	object (RtgsGlobal.ParticipantGateway.Messages.Admin.Events.RelationshipEvent1)

Request samples

Payload

Content type

application/json

{"CorrelationId": "6c70ab43-9882-4a7e-a322-8d2d7f7a5a17",
"Data": {"RelationshipId": "928dd5b8-3ead-4528-bdef-9c0b867a5d7d",
"RequestingParticipantId": "38175118-083d-468e-8045-9c498b327fb5",
"ApprovingParticipantId": "5798deed-5213-41ea-a69f-770a2f6e87e5",
"IsHost": true,
"Sts": "Pending",
"ApprovingJurisdiction": {"Ccy": "GBP",
"Nm": "Bank of England (GBP)",
"JurisdictionCode": "gbpboe1",
"Owner": "Bank of England"
},
"CreDtTm": "2019-08-24T14:15:22Z",
"UpdatedDate": "2022-12-11T04:51:21Z"
}
}

Relationship Creation Failed Event V3 Webhook

ISO-20022 compatible proprietary message. Event emitted for participant when a new relationship creation fails.

Event type: global.rtgs.participants.relationship.creationfailed.v3

Request Body schema: application/json

CorrelationId	string Request correlation id
	object (RtgsGlobal.Participants.Contracts.Events.v3.RelationshipV3) Relationship event info

Request samples

Payload

Content type

application/json

{"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"Data": {"RelationshipId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"RequestingParticipant": {"AnyBIC": "RZTIUK22XXX",
"LEI": "5493001KJTIIGC8Y1R05",
"Othr": [{"Id": "RTGS:B:US13221932",
"Issr": "RTGS.global"
}
]
},
"ApprovingParticipant": {"AnyBIC": "BARCGB22XXX",
"LEI": "213800WAVVYYP1F7LZ92",
"Othr": [{"Id": "RTGS:B:GB43400282",
"Issr": "RTGS.global"
}
]
},
"Sts": "Rejected",
"ApproverFundsController": {"Nm": "Federal Reserve Bank of New York",
"Cd": "FEDNY1",
"JurisdictionCode": "usdfed1",
"Sts": "Active",
"Ctry": "US"
},
"CreDtTm": "2024-01-26T10:00:00Z",
"UpdatedDate": "2024-01-26T10:30:00Z"
}
}

Relationship Request Created Event V3 Webhook

ISO-20022 compatible proprietary message. Event emitted for participant when new relationship request arrives.

Event type: global.rtgs.participants.relationship.requestcreated.v3

Request Body schema: application/json

CorrelationId	string Request correlation id
	object (RtgsGlobal.Participants.Contracts.Events.v3.RelationshipV3)

Request samples

Payload

Content type

application/json

{"CorrelationId": "64e9c2f3-1b4a-4e7c-b8d5-9a3f2e1d4c6b",
"Data": {"RelationshipId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"RequestingParticipant": {"AnyBIC": "FOOBARXX",
"LEI": "5493001KJTIIGC1YVC23",
"Othr": [{"Id": "RTGS:B:US13221932",
"Issr": "RTGS.global"
}
]
},
"ApprovingParticipant": {"AnyBIC": "BAZQUXBB",
"LEI": "5493001KJTIIGC1YVC24",
"Othr": [{"Id": "RTGS:B:GB43400282",
"Issr": "RTGS.global"
}
]
},
"Sts": "Pending",
"ApproverFundsController": {"Nm": "Acme Funds Controller",
"Cd": "ACMEFC01",
"JurisdictionCode": "usdfed1",
"Sts": "Active",
"Ctry": "US"
},
"CreDtTm": "2024-01-26T10:00:00Z",
"UpdatedDate": "2024-01-26T10:30:00Z"
}
}

Relationship Updated Event V3 Webhook

ISO-20022 compatible proprietary message. Event emitted for participant when an existing relationship gets updated.

Event type: global.rtgs.participants.relationship.updated.v3

Request Body schema: application/json

CorrelationId	string Request correlation id
	object (RtgsGlobal.Participants.Contracts.Events.v3.RelationshipV3)

Request samples

Payload

Content type

application/json

{"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"Data": {"RelationshipId": "123e4567-e89b-12d3-a456-426614174000",
"RequestingParticipant": {"AnyBIC": "UCJAES2MXXX",
"LEI": "D1TL00GWEJPLHI9PET25",
"Othr": [{"Id": "RTGS:B:US13221932",
"Issr": "RTGS.global"
}
]
},
"ApprovingParticipant": {"AnyBIC": "COBADEFF910",
"LEI": "OMSC00UFOY5ER3K6WV02",
"Othr": [{"Id": "RTGS:B:GB43400282",
"Issr": "RTGS.global"
}
]
},
"Sts": "Online",
"ApproverFundsController": {"Nm": "Acme Funds Controller",
"Cd": "ACME123",
"JurisdictionCode": "usdfed1",
"Sts": "Active",
"Ctry": "US"
},
"CreDtTm": "2024-01-26T10:00:00Z",
"UpdatedDate": "2024-01-27T12:00:00Z"
}
}

Relationship Update Failed Event V3 Webhook

ISO-20022 compatible proprietary message. Event emitted for participant when an existing relationship update fails.

Event type: global.rtgs.participants.relationship.updatefailed.v3

Request Body schema: application/json
required

CorrelationId	string <uuid> Request correlation id
	object (RtgsGlobal.Participants.Contracts.Events.v3.RelationshipV3)
ErrorMessage	string Reason for the failure

Request samples

Payload

Content type

application/json

{"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"ErrorMessage": "Duplicate AccountIdentifier",
"Data": {"RelationshipId": "123e4567-e89b-12d3-a456-426614174000",
"RequestingParticipant": {"AnyBIC": "FOOBARXX",
"LEI": "5493001KJTIIGC8Y1R05",
"Othr": [{"Id": "RTGS:B:US13221932",
"Issr": "RTGS.global"
}
]
},
"ApprovingParticipant": {"AnyBIC": "BAZQUXBB",
"LEI": "5493001KJTIIGC8Y1R06",
"Othr": [{"Id": "RTGS:B:GB43400282",
"Issr": "RTGS.global"
}
]
},
"Sts": "Rejected",
"ApproverFundsController": {"Nm": "Acme Funds Controller",
"Cd": "ACME123",
"JurisdictionCode": "usdfed1",
"Sts": "Active",
"Ctry": "US"
},
"CreDtTm": "2024-01-23T12:34:56Z",
"UpdatedDate": "2024-01-24T12:34:56Z"
}
}

Approve Relationship V3

Approves an existing relationship between two participants.

Request Body schema: application/json

RequestingParticipantRtgsGlobalId	string RTGS.global ID of the requesting participant.
CorrelationId	string Request correlation id

Responses

Request samples

Payload

Content type

application/json

{"RequestingParticipantRtgsGlobalId": "RTGS:B:US12345678",
"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}

Response samples

Content type

application/json

[{"ErrorCode": "InvalidRtgsGlobalId",
"PropertyName": "RequestingParticipantRtgsGlobalId",
"ErrorMessage": "The provided RtgsGlobal ID is not valid."
}
]

Create Relationship V3

Create (request) a new relationship. This will create a Pending relationship request

Request Body schema: application/json

ApprovingParticipantRtgsGlobalId	string RTGS.global ID of the approving participant.
CorrelationId	string <uuid> Request correlation id

Responses

Request samples

Payload

Content type

application/json

{"ApprovingParticipantRtgsGlobalId": "RTGS:B:US13221932",
"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}

Response samples

Content type

application/json

[{"ErrorCode": "GloballyUniqueAccountIdentifierValidator",
"PropertyName": "AccountIdentifier.Id",
"ErrorMessage": "Account identifier must be globally unique"
}
]

Get Relationships V3

Returns ISO-20022 compatible proprietary models. Retrieves a list of relationships between participants.

Responses

Response samples

Content type

application/json

[{"RelationshipId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"RequestingParticipant": {"Nm": "GlobalCorp Inc.",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:US12345678",
"Issr": "RTGS.global"
}
}
},
"CtryOfRes": "US"
},
"ApprovingParticipant": {"Nm": "National Bank of Commerce",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:GB87654321",
"Issr": "RTGS.global"
}
}
},
"CtryOfRes": "GB"
},
"Sts": "Online",
"ApproverFundsController": {"Nm": "United Kingdom (GBP)",
"Cd": "BOE1",
"JurisdictionCode": "gbpboe1",
"Sts": "Active",
"Ctry": "GB"
},
"CreDtTm": "2024-01-01T12:00:00Z",
"UpdatedDate": "2024-01-02T14:30:00Z"
},
{"RelationshipId": "4eb6bd70-09a0-4a23-890a-b53090123abc",
"RequestingParticipant": {"Nm": "International Holdings Ltd.",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:JP98765432",
"Issr": "RTGS.global"
}
}
},
"CtryOfRes": "JP"
},
"ApprovingParticipant": {"Nm": "Federal Reserve Bank",
"Id": {"OrgId": {"Othr": {"Id": "RTGS:B:US54321678",
"Issr": "RTGS.global"
}
}
},
"CtryOfRes": "US"
},
"Sts": "Pending",
"ApproverFundsController": {"Nm": "United States (USD)",
"Cd": "FED1",
"JurisdictionCode": "usdfed1",
"Sts": "Active",
"Ctry": "US"
},
"CreDtTm": "2024-02-15T08:00:00Z",
"UpdatedDate": null
}
]

Reject Relationship V3

Rejects an existing relationship between two participants.

Request Body schema: application/json

RequestingParticipantRtgsGlobalId	string RTGS.global ID of the requesting participant.
CorrelationId	string Request correlation id

Responses

Request samples

Payload

Content type

application/json

{"RequestingParticipantRtgsGlobalId": "RTGS:B:US12345678",
"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}

Response samples

Content type

application/json

[{"ErrorCode": "InvalidRtgsGlobalId",
"PropertyName": "RequestingParticipantRtgsGlobalId",
"ErrorMessage": "The provided RtgsGlobal ID is not valid."
}
]

Jurisdictions

Jurisdiction related information

Get jurisdictions

Returns ISO-20022 compatible proprietary models. Get the collection of supported jurisdictions

Responses

Response samples

Content type

application/json

[{"Ccy": "GBP",
"Nm": "Bank of England (GBP)",
"Sts": "Active",
"Cd": "gbpboe1",
"Ownr": "Bank of England"
},
{"Ccy": "USD",
"Nm": "US Federal Reserve (USD)",
"Sts": "Active",
"Cd": "usdfed1",
"Ownr": "US Federal Reserve"
}
]

Transactions

Transaction information of network accounts.

Get transactions v2

Returns ISO-20022 camt.006 models. Get the available transactions of the network account requested.

The response will be in PascalCase and any enum types returned as strings.

query Parameters

AccountIdentificationIban	string Examples: AccountIdentificationIban=GB33BUKB20201555555555 - a sample IBAN account identifier IBAN of the account to query. Only to be specified if not using AccountIdentificationOther.
AccountIdentificationOther	string Examples: AccountIdentificationOther=USBKUS44XXX - a sample other account identifier An alternative id of the account to query. Only to be specified if not using AccountIdentificationIban.
EntryDateToDateTime	string Examples: EntryDateToDateTime=2020-01-01T14:13:12.000Z - a sample entry date to datetime An ISO 8061 UTC date and time filter, applied to Entry Date. Transactions with an Entry Date later than this value will be excluded. If not supplied, this will default to the current date and time.
EntryDateFromDateTime	string Examples: EntryDateFromDateTime=2020-01-01T14:13:12.000Z - a sample entry date from datetime An ISO 8061 UTC date and time filter, applied to Entry Date. Transactions with an Entry Date earlier than this value will be excluded. If not supplied, this will default to 31 days prior to the current date and time.

Responses

Response samples

Content type

application/json

{"MsgHdr": {"MsgId": "e13d0d1829774034abba4bd71c57a37f",
"CreDtTm": "2024-01-23T11:08:17.5750517Z"
},
"RptOrErr": {"BizRpt": {"TxRpt": [{"PmtId": {"TxId": "a5d03ee8-2f27-4763-b1ae-44fea23444e4",
"UETR": "acd8867c-6145-4a3e-8036-a2c5e6e1b376"
},
"TxOrErr": {"Tx": {"PmtTo": {"MmbId": {"FinInstnId": {"BICFI": "RTGYBL54321",
"LEI": "984500DBU63BFB050000",
"Nm": "Yellowbank",
"Othr": {"Id": "RTGS:B:BE13046594"
}
}
}
},
"PmtFr": {"MmbId": {"FinInstnId": {"BICFI": "RTGBGB34642",
"LEI": "E7HSDF9WLP443ZUK1270",
"Nm": "Bluebank",
"Othr": {"Id": "RTGS:B:GB80881964"
}
}
}
},
"CdtDbtInd": "CRDT",
"Pmt": {"ReqdExctnDt": {"DtTm": "2023-05-10T12:05:00Z"
},
"Sts": [{"Cd": {"Fnl": "STLD"
},
"DtTm": {"DtTm": "2023-05-10T12:05:00Z"
},
"Rsn": [{"Prtry": "Settled"
}
]
}
],
"IntrBkSttlmAmt": {"AmtWthtCcy": "10000.00"
},
"Tp": {"Prtry": "LinkAndSettle"
},
"TxId": "a5d03ee8-2f27-4763-b1ae-44fea23444e4",
"IntrBkSttlmDt": "2023-05-10T12:05:00Z",
"EndToEndId": "11650492fe004ba483d0d17013bbf603"
},
"AcctNtry": {"Acct": {"Id": {"IBAN": "GB33BUKB20201555555555"
},
"Ccy": "GBP"
},
"Ntry": {"Amt": {"Ccy": "GBP",
"Value": "10000.00"
},
"Dt": {"DtTm": "2023-05-10T12:05:00Z"
}
}
}
}
}
},
{"PmtId": {"TxId": "af8a36e6-d0de-4f24-9adf-c0e643d92abd",
"UETR": "9c2e488b-9089-4512-a14b-d243e818eb5c"
},
"TxOrErr": {"Tx": {"PmtTo": {"MmbId": {"FinInstnId": {"BICFI": "RTGGFR63459",
"LEI": "R2TOPU3DAB378ANL5031",
"Nm": "Greenbank",
"Othr": {"Id": "RTGS:B:NL14963425"
}
}
}
},
"PmtFr": {"MmbId": {"FinInstnId": {"BICFI": "RTGBGB34642",
"LEI": "E7HSDF9WLP443ZUK1270",
"Nm": "Bluebank",
"Othr": {"Id": "RTGS:B:GB80881964"
}
}
}
},
"CdtDbtInd": "CRDT",
"Pmt": {"ReqdExctnDt": {"DtTm": "2023-05-10T12:06:10Z"
},
"Sts": [{"Cd": {"Fnl": "STLD"
},
"DtTm": {"DtTm": "2023-05-10T12:06:10Z"
},
"Rsn": [{"Prtry": "Settled"
}
]
}
],
"IntrBkSttlmAmt": {"AmtWthtCcy": "8000.00"
},
"Tp": {"Prtry": "LinkAndSettle"
},
"TxId": "af8a36e6-d0de-4f24-9adf-c0e643d92abd",
"IntrBkSttlmDt": "2023-05-10T12:06:10Z",
"EndToEndId": "0b335068780342f6833d7f93cc550a94"
},
"AcctNtry": {"Acct": {"Id": {"IBAN": "GB33BUKB20201555555555"
},
"Ccy": "EUR"
},
"Ntry": {"Amt": {"Ccy": "EUR",
"Value": "8000.00"
},
"Dt": {"DtTm": "2023-05-10T12:06:10Z"
}
}
}
}
}
}
]
}
}
}

Funds Controllers

Funds Controllers, related information and actions.

Get Funds Controllers V1

Returns ISO-20022 compatible proprietary models. Retrieves a list of funds controllers.

Responses

Response samples

Content type

application/json

[{"Nm": "Federal Reserve District 1",
"Cd": "FED1",
"JurisdictionCode": "usdfed1",
"Sts": "Active",
"Ctry": "US",
"Ccys": ["USD"
],
"ParticipantRtgsGlobalId": "RTGS:B:US12345678",
"DebtorPartyManagementRequired": false,
"CreditorPartyManagementRequired": true
},
{"Nm": "Bank of England",
"Cd": "BOE1",
"JurisdictionCode": "gbpboe1",
"Sts": "Active",
"Ctry": "GB",
"Ccys": ["GBP"
],
"ParticipantRtgsGlobalId": "RTGS:B:GB12345678",
"DebtorPartyManagementRequired": false,
"CreditorPartyManagementRequired": false
}
]

Party Management

Funds Controller Beneficiary Party management.

Creditor Created Event V1 Webhook

Event emitted for Participant when Creditor creation succeeds.

Event type: global.rtgs.creditorCreatedV1

Request Body schema: application/json
required

AccountAliasId	string The Account alias identifier. The identifier is the ClientId.
CorrelationId	string <uuid> Request correlation id.
CreditorName	string The Creditor name.
AccountNumber	string The Account number.
ClientId	string The Client identification.

Request samples

Payload

Content type

application/json

{"AccountAliasId": "CL0001",
"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"CreditorName": "IRE Creditor name",
"AccountNumber": "IE29AIBK93115212345678",
"ClientId": "CL0001"
}

Create Creditor Failed Event V1 Webhook

Event emitted for participant when Creditor creation fails.

Event type: global.rtgs.createCreditorFailedV1

Request Body schema: application/json
required

any (RtgsGlobal.PartyManagement.Contracts.Events.v1.CreateCreditorFailedEventV1)

Request samples

Payload

Content type

application/json

{"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"DebtorName": "IRE Creditor name",
"AccountNumber": "IE29AIBK93115212345678",
"ClientId": "CL0001",
"SchemaFailures": {"schema": {"$ref": "#/components/schemas/DictionaryOfErrors"
},
"examples": {"response": {"summary": "Schema validation failures",
"value": {"CreditorName": ["'CreditorName' must not be empty."
]
}
}
}
},
"GenericFailures": {"schema": {"$ref": "#/components/schemas/DictionaryOfErrors"
},
"examples": {"response": {"summary": "Generic validation failures",
"value": {"CreditorAlreadyExists": ["The creditor already exists."
]
}
}
}
}
}

Debtor Created Event V1 Webhook

Event emitted for Participant when Debtor creation succeeds.

Event type: global.rtgs.debtorCreatedV1

Request Body schema: application/json
required

AccountAliasId	string The Account alias identifier. The identifier is the ReconciliationId.
CorrelationId	string <uuid> Request correlation id.
DebtorName	string The Debtor name.
AccountNumber	string The Account number.
ReconciliationId	string <uuid> The Reconciliation identification.

Request samples

Payload

Content type

application/json

{"AccountAliasId": "123",
"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"DebtorName": "IRE Debtor name",
"AccountNumber": "IE31IRCE99990100014450",
"ReconciliationId": "57f21a8b14c84548bdb7f2bc3b0f9053"
}

Debtor Failed Event V1 Webhook

Event emitted for participant when Debtor creation fails.

Event type: global.rtgs.createDebtorFailedV1

Request Body schema: application/json
required

any (RtgsGlobal.PartyManagement.Contracts.Events.v1.DebtorFailedEventV1)

Request samples

Payload

Content type

application/json

{"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"DebtorName": "IRE Debtor name",
"AccountNumber": "IE31IRCE99990100014450",
"ReconciliationId": "57f21a8b14c84548bdb7f2bc3b0f9053",
"SchemaFailures": {"schema": {"$ref": "#/components/schemas/DictionaryOfErrors"
},
"examples": {"response": {"summary": "Schema validation failures",
"value": {"PayeeName": ["'PayeeName' must not be empty."
]
}
}
}
},
"GenericFailures": {"schema": {"$ref": "#/components/schemas/DictionaryOfErrors"
},
"examples": {"response": {"summary": "Generic validation failures",
"value": {"DebtorAlreadyExists": ["The debtor already exists."
]
}
}
}
}
}

Creditor Created Event V2 Webhook

Event emitted for Participant when Creditor creation succeeds. Event type: global.rtgs.creditorCreatedV2

Request Body schema: application/json
required

CorrelationId	string <uuid> Request correlation id.
CreditorId	string <uuid> The Creditor identification
AccountAliasId	string The Account alias.
FundsControllerCode	string The Funds Controller code.
	RtgsGlobal.PartyManagement.Contracts.Queries.v2.CreditorV2.Creditor.Verto (any)

Request samples

Payload

Content type

application/json

{"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"CreditorId": "61d675a0165a418e9fdcb7d1ebf2eb1f",
"AccountAliasId": "CL0001",
"FundsControllerCode": "E6C0B3B4",
"Creditor": {"oneOf": [{"$ref": "#/components/schemas/RtgsGlobal.PartyManagement.Contracts.Queries.v2.CreditorV2.Creditor.Verto"
}
]
}
}

Create Creditor Failed Event V2 Webhook

Event emitted for Participant when Creditor creation fails. Event type: global.rtgs.createCreditorFailedV2

Request Body schema: application/json
required

CorrelationId	string <uuid> Request correlation id.
CreditorId	string <uuid> The Creditor identification
FundsControllerCode	string The Funds Controller code.

Request samples

Payload

Content type

application/json

{"CorrelationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"CreditorId": "61d675a0165a418e9fdcb7d1ebf2eb1f",
"FundsControllerCode": "E6C0B3B4"
}

Get Creditors V1

Get all Creditors of a Funds Controller

query Parameters

FundsControllerCode

required

string

Examples:

FundsControllerCode=E6C0B3B4 - a sample Funds Controller identification code

The Funds Controller identification code.

Responses

Response samples

Content type

application/json

{"AccountAliasId": "CL0001",
"PayeeName": "Alice Johnson",
"ClientId": "CL0001",
"Country": "US",
"CurrencyCode": "USD",
"IsIndividual": true,
"ObfuscatedAccountDetails": "Chase Bank, 123456789, CHASUS33, US12CHAS12345678901234",
"Address": "101 First Ave, New York, NY 10009",
"Status": "Active",
"BankBranchAddress": "123 Bank St, New York, NY 10010",
"DefaultPaymentReference": "Payment for services",
"DefaultTransferReason": "Service Fees",
"Email": "alice.johnson@example.com",
"EmailAlertFlag": true
}

Create Creditor V1

Sends Creditor create request to specified Funds Controller

Request Body schema: application/json

FundsControllerCode	string A unique code used to identifer the Funds Controller.
CorrelationId	string The request correlation identifier.
PayeeName	string or null A unique payee name used to identify the Beneficiary account.
CountryCode	string Two-letter uppercase country code of the Payee. See ISO 3166.
StateCode	string Mandatory for Australia, New Zealand, the USA, and Canada. Otherwise, empty string.
CurrencyCode	string A three-letter uppercase currency code defined by ISO-4217.
IsIndividual	bool Indicate if the Beneficiary is an individual or not.
IsIban	string Indicate if the account number is supplied in IBAN format or not.
AccountNumber	string The IBAN code or otherwise the bank account number of the Beneficiary.
	"AbaRoutingNumber" (string) or "BankCode" (string) or "Bsb" (string) or "Ifsc" (string) or "OtherNumber" (string) or "SortCode" (string) or "TransitNumberAndInstitutionNumber" (string) The transit code type.
TransitCode	string A valid code of the TransitCodeType.
SwiftCode	string or null A SWIFT code.
PayeeCity	string The city name where the Payee resides.
PayeeBuildingName	string The building number or name where the Payee resides.
PayeeStreetName	string The street name where the Payee resides.
PayeeTownName	string The town name where the Payee resides.
PayeePostalCode	string or null The postal code where the Payee resides. Mandatory for Australia, Canada, Mexico, Malaysia, New Zealand, Serbia, Sweden, Philippines, UAE, USA.
PayeeCountryCode	string The Two-letter uppercase country code of the Payee. See ISO 3166.
PayeeStateCode	string The state where the Payee resides. Mandatory for Australia, New Zealand, the USA, and Canada. Otherwise, empty string.
PayeePhoneNumberInternationalDialingCode	string The international dialing code of the country where the Payee resides.
PayeePhoneNumberMobilePhone	string The contact phone number for the Payee.
PayeeDateOfBirth	string or null The date of birth of the Payee.
BankBranchAddress	string or null The full address of the Payee bank.
	"Standard" (string) or "Wps" (string) The Beneficiary bank account type.
	"Resident" (string) or "NonResident" (string) The account type.
ForFurtherCreditTo	string or null The name of the final Beneficiary.
DefaultPaymentReference	string or null The default payment reference.
	"BillPayment" (string) or "BusinessVenture" (string) or "CharitableDonation" (string) or "EstateSettlementOrInheritance" (string) or "ExpenseReimbursement" (string) or "GovernmentRelatedPayment" (string) or "IntercompanyPayment" (string) or "InvestmentRelatedPayment" (string) or "MedicalFeeRefund" (string) or "PayingConsultancyFees" (string) or "LoanOrDepositPayment" (string) or "PayrollOrPersonnelPayment" (string) or "ProfessionalFeesPayment" (string) or "PromotionalRebate" (string) or "PurchaseOfGoods" (string) or "PurchaseOfPropertyOrRealEstate" (string) or "PurchaseOfServices" (string) or "RepatriationOfFunds" (string) or "ResearchAndDevelopment" (string) or "StudentLoanReturns" (string) or "StudentRefunds" (string) or "TaxPayment" (string) or "TransferToOwnAccounts" (string) The default transfer reason.
DefaultTransferReason	string or null The default transfer reason description.
Email	string or null Email address of the Beneficiary. Mandatory when payment is from California or the Beneficiary is in California.
EmailAlertFlag	boolean Indicates whether email alerts are sent to the Beneficiary.
PayeeTaxId	string or null The Beneficiary tax registration number.
PassportNumber	string or null The Passport number of the Beneficiary.
AdditionalRoutingNumber	string or null The additional routing number.
BeneficiaryCompanyRegisterNum	string or null The Beneficiary company registration number.
BeneficiaryNationality	string or null The Beneficiary National country ISO code.
EmployeeId	int or null The employee identifier.
	"Checking" (string) or "Saving" (string) The Beneficiary category

Responses

Request samples

Payload

Content type

application/json

{"CreateCreditorCommandV1": {"FundsControllerCode": "E6C0B3B4",
"CorrelationId": "e8639fe751b4487c851f3dcb35f43a3e",
"PayeeName": "IRE payee name",
"ClientId": "CL0001",
"CountryCode": "IE",
"CurrencyCode": "EUR",
"IsIban": true,
"AccountNumber": "IE29AIBK93115212345678",
"SwiftCode": "AIBKIE2DXXX",
"PayeeCity": "Dublin",
"PayeePostalCode": "D01 F5P2",
"PayeeCountryCode": "IE",
"PayeePhoneNumberInternationalDialingCode": "353",
"PayeePhoneNumberMobilePhone": "871234567",
"DefaultPaymentReference": "Payement Reference",
"DefaultTransferReason": "Bill Payment",
"DefaultTransferReasonId": "BillPayment"
}
}

Get Debtors V1

Get all Debtors of a Funds Controller

query Parameters

FundsControllerCode

required

string

Examples:

FundsControllerCode=E6C0B3B4 - a sample Funds Controller identification code

The Funds Controller identification code.

Responses

Response samples

Content type

application/json

{"AccountAliasId": "3245",
"DebtorName": "Lena Marwood",
"DebtorType": "Individual",
"City": "Dublin",
"Country": "Ireland",
"ReconciliationId": "REC7X92A",
"Status": "Active"
}

Create Debtor V1

Sends Debtor create request to specified Funds Controller

Request Body schema: application/json

FundsControllerCode	string A unique code used to identifer the Funds Controller.
CorrelationId	string The request correlation identifier.
	"Corporate" (string) or "Individual" (string) The request correlation identifier.
DebtorName	string The name of the Debtor.
AccountNumber	string The Debtor account number.
ReconciliationId	string The reconciliation id.
CountryCode	string Two-letter uppercase country code of the Debtor. See ISO 3166.
Address	string The address that the Debtor resides.
City	string The city where the Debtor resides.
State	string or null The state where the Debtor resides.
PostalCode	string The post code where the Debtor resides.
Email	string The email address of the Debtor.

Responses

Request samples

Payload

Content type

application/json

{"CreateDebtorCommandV1": {"FundsControllerCode": "E6C0B3B4",
"CorrelationId": "e8639fe751b4487c851f3dcb35f43a3e",
"DebtorType": "Individual",
"DebtorNam": "IRE debtor name",
"AccountNumber": "IE31IRCE99990100014450",
"ReconciliationId": "57f21a8b14c84548bdb7f2bc3b0f9053",
"CountryCode": "IE",
"Address": "1 Main Street",
"City": "Dublin",
"PostalCode": "D01 F5P2"
}
}

Get Creditors V2

Get all Creditors of a Funds Controller

query Parameters

FundsControllerCode

string

Examples:

FundsControllerCode=E6C0B3B4 - a sample Funds Controller identification code

The Funds Controller identification code.

Responses

Response samples

Content type

application/json

{"CreditorId": "61d675a0165a418e9fdcb7d1ebf2eb1f",
"AccountAliasId": "CL0001",
"FundsControllerCode": "E6C0B3B4",
"Creditor": {"Id": "12345",
"Status": "Approved",
"Currency": "EUR",
"BeneficiaryCountryCode": "IE",
"AccountNumber": "IE29AIBK93115212345678",
"NationalId": "A1234567",
"Country": "IE",
"ClientReference": "Beneficiary For Individual",
"Reference": "REF-8722",
"BeneficiaryEmail": "alice.johnson@example.com",
"BankName": "Bank Name",
"BeneficiaryAddress": "1 Main Street",
"BeneficiaryCity": "Dublin",
"BeneficiaryPostcode": "D01 F5P2",
"BeneficiaryEntityType": "Individual",
"BeneficiaryFirstName": "Alice",
"BeneficiaryLastName": "Johnson",
"BeneficiaryCompanyName": null
}
}

Create Creditor V2

Sends Creditor create request to specified Funds Controller

Request Body schema: application/json

CorrelationId	string The request correlation identifier.
FundsControllerCode	string The funds controller code.
	RtgsGlobal.PartyManagement.Contracts.Commands.v2.CreateCreditorCommandV2.Creditor.Verto (any) The request correlation identifier.

Responses

Request samples

Payload

Content type

application/json

{"CreateCreditorCommandV2": {"CorrelationId": "e8639fe751b4487c851f3dcb35f43a3e",
"FundsControllerCode": "E6C0B3B4",
"Creditor": {"Currency": "EUR",
"BeneficiaryCountryCode": "IE",
"AccountNumber": "IE29AIBK93115212345678",
"NationalId": "A1234567",
"Country": "IE",
"ClientReference": "Beneficiary For Individual",
"BeneficiaryEmail": "alice.johnson@example.com",
"IsMobileMoney": false,
"BeneficiaryEntityType": "individual",
"BeneficiaryFirstName": "Alice",
"BeneficiaryLastName": "Johnson",
"BeneficiaryCompanyName": null
}
}
}

Response samples

Content type

application/json

{"CreditorId": "ea7f5f1f-6635-4c54-bde8-f17a81aedfab"
}

Get Creditor Create Schema V2

Get Creditor Create schema for a Funds Controller

query Parameters

FundsControllerCode

required

string

Examples:

FundsControllerCode=E6C0B3B4 - a sample Funds Controller identification code

The Funds Controller identification code.

Responses

Response samples

Content type

application/json

{"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "RtgsGlobal.FundsAdapter.Verto.Infrastructure.Clients.Verto.ExternalModels.CreateBeneficiaryRequestV1 Schema",
"properties": {"Currency": {"type": "string",
"$ref": "#/components/schemas/RtgsGlobal.PartyManagement.Contracts.v2.Creditor.Verto.Currency"
},
"AccountNumber": {"type": "string"
},
"NationalId": {"type": "string"
},
"Country": {"type": "string"
},
"BeneficiaryCountryCode": {"type": "string",
"$ref": "#/components/schemas/RtgsGlobal.PartyManagement.Contracts.v2.Creditor.Verto.BeneficiaryCountryCode"
},
"ClientReference": {"type": "string"
},
"BeneficiaryEmail": {"type": "string"
},
"IsMobileMoney": {"type": "boolean"
},
"BeneficiaryEntityType": {"type": "string",
"enum": ["individual",
"company"
]
}
},
"required": ["BeneficiaryEntityType",
"Currency",
"BeneficiaryCountryCode",
"AccountNumber",
"NationalId",
"Country",
"IsMobileMoney"
],
"allOf": [{"if": {"properties": {"BeneficiaryEntityType": {"const": "individual"
}
}
},
"then": {"properties": {"BeneficiaryCompanyName": {"type": "null"
},
"BeneficiaryFirstName": {"type": "string"
},
"BeneficiaryLastName": {"type": "string"
}
},
"required": ["BeneficiaryFirstName",
"BeneficiaryLastName"
]
},
"else": { }
},
{"if": {"properties": {"BeneficiaryEntityType": {"const": "company"
}
}
},
"then": {"properties": {"BeneficiaryCompanyName": {"type": "string"
},
"BeneficiaryFirstName": {"type": "null"
},
"BeneficiaryLastName": {"type": "null"
}
},
"required": ["BeneficiaryCompanyName"
]
},
"else": { }
}
]
}

Get Creditor Schema V2

Get Creditor schema for a Funds Controller

query Parameters

FundsControllerCode

required

string

Examples:

FundsControllerCode=E6C0B3B4 - a sample Funds Controller identification code

The Funds Controller identification code.

Responses

Response samples

Content type

application/json

{"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "RtgsGlobal.FundsAdapter.Verto.Infrastructure.Clients.Verto.InternalBeneficiaryDetailsSchema",
"properties": {"Id": {"type": "string"
},
"BeneficiaryEntityType": {"type": "string",
"enum": ["individual",
"company"
]
},
"Status": {"type": "string",
"enum": ["pending",
"rejected",
"approved"
]
},
"Currency": {"type": "string",
"$ref": "#/components/schemas/RtgsGlobal.PartyManagement.Contracts.v2.Creditor.Verto.Currency"
},
"AccountNumber": {"type": "string"
},
"NationalId": {"type": "string"
},
"Country": {"type": "string"
},
"ClientReference": {"type": "string"
},
"Reference": {"type": "string"
},
"BeneficiaryEmail": {"type": "string"
},
"BankName": {"type": "string"
},
"BeneficiaryAddress": {"type": "string"
},
"BeneficiaryCity": {"type": "string"
},
"BeneficiaryPostcode": {"type": "string"
},
"BeneficiaryCountryCode": {"type": "string",
"$ref": "#/components/schemas/RtgsGlobal.PartyManagement.Contracts.v2.Creditor.Verto.BeneficiaryCountryCode"
}
},
"required": ["Id",
"BeneficiaryEntityType",
"Status",
"Currency",
"BeneficiaryCountryCode",
"AccountNumber",
"NationalId",
"Country"
],
"allOf": [{"if": {"properties": {"BeneficiaryEntityType": {"const": "individual"
}
}
},
"then": {"properties": {"BeneficiaryCompanyName": {"type": "null"
},
"BeneficiaryFirstName": {"type": "string"
},
"BeneficiaryLastName": {"type": "string"
}
},
"required": ["BeneficiaryFirstName",
"BeneficiaryLastName"
]
},
"else": { }
},
{"if": {"properties": {"BeneficiaryEntityType": {"const": "company"
}
}
},
"then": {"properties": {"BeneficiaryCompanyName": {"type": "string"
},
"BeneficiaryFirstName": {"type": "null"
},
"BeneficiaryLastName": {"type": "null"
}
},
"required": ["BeneficiaryCompanyName"
]
},
"else": { }
}
]
}

FX Quotes

Requesting and receiving FX quotes.

Terminology used:

The initiating participant is the participant who initiates the FX Quote process by issuing a quote request.
The counterparty participant is the participant who is identified by the initiating participant in their quote request and is expected to respond with their quote.

Expected message flow and sequence:

The initiating participant issues a quote request identifying desired counterparty participants.

Note: The symbol specified in the quote request must match one of the currency pairs returned by the '/v1/quote/currency-pairs' endpoint, otherwise a validation error will be returned.
Some or all counterparty participants respond to the quote request with their quote.
The initiating participant examines the set of received quotes and calls the New Order (single) endpoint with the details of the quote that suits them best.
The counterparty participant who received the New Order (single) event responds with the Execution report to signify whether the order is confirmed and can be settled, or cancelled and will not go ahead.

For end to end processing, please use the same identifier across your quote, order and settlement messages. Where you are the quote requester, QuoteReqId > ClOrdId > LinkId, and where you are the responder, QuoteId > OrderId > LinkId

Quote request event V2 Webhook

FIX 4.2 compatible proprietary message. The counterparty receives this event when the initiating participant requests a quote.

Event type: global.rtgs.quoteRequestV2

Request Body schema: application/json

	object or object FIX 4.2 <R> Quote request message
FromRtgsGlobalId	string

Request samples

Payload

Content type

application/json

{"FromRtgsGlobalId": "RTGS:B:US20781688",
"QuoteRequest": {"QuoteReqId": "39054EA89BD9",
"Symbol": "GBP/USD",
"Side": "1",
"OrderQty": "10000",
"OrderQty2": "",
"ValidUntilTime": "20240718-12:25:49.128",
"ExpireTime": "20240718-12:25:49.128",
"SupplementaryData": "{\"RtgsGlobalRequestOrigin\": \"RtgsParticipantPortal\"}"
}
}

Quote event V2 Webhook

FIX 4.2 compatible proprietary message. The initiating participant receives this event when the counterparty responds to a quote request.

Event type: global.rtgs.quoteOfferV2

Request Body schema: application/json

	object FIX 4.2 <S> Quote request message
FromRtgsGlobalId	string

Request samples

Payload

Content type

application/json

{"FromRtgsGlobalId": "RTGS:B:US20781688",
"Quote": {"BidPx": "",
"ExpireTime": "20240718-12:42:41.419",
"OfferPx": "1.3",
"OrderQty": "10000",
"OrderQty2": "13000",
"QuoteId": "2E6BE282DE4E",
"QuoteReqId": "BA7BD340462A",
"Side": "1",
"Symbol": "GBP/USD"
}
}

New order (single) notification V2 Webhook

FIX 4.2 <D> message. The counterparty participant receives this event when the initiating participant accepts the provided quote.

Event type: global.rtgs.newOrderSingleV2

Request Body schema: application/json

QuoteId required	string Unique ID of the quote.
ClOrdId required	string Unique ID of the order. For end to end processing, this should match your QuoteReqId, and should be passed to the settlement service as a Link Identifier
FromRtgsGlobalId required	string RTGS.global ID of the participant sending the new order single.
HandlInst required	string Valid values: 1 = Automated execution order, private, no Broker intervention 3 = Manual order, best execution
OrdType required	string Should always be 1 = Market.
Price required	string Price of the instrument.
OrderQty required	string or null Base order quantity.
OrderQty2 required	string or null Quote order quantity.
Side required	string Action on the base currency. Possible values include: 1: Buy 2: Sell
Symbol required	string Exchange-provided product symbol for the tradable product.
ExpireTime required	string <fix-utc-timestamp yyyyMMdd-HH:mm:ss.fff> Time at which the order will expire.
TransactTime required	string <fix-utc-timestamp yyyyMMdd-HH:mm:ss.fff> Time of execution/order creation.

Request samples

Payload

Content type

application/json

{"ClOrdId": "098FGS",
"HandlInst": "1",
"Symbol": "GBP/USD",
"Side": "1",
"TransactTime": "20240718-12:30:00.000",
"OrderQty": "10000",
"OrderQty2": "13000",
"OrdType": "1",
"Price": "1.3",
"QuoteId": "2E6BE282DE4E",
"ExpireTime": "20240718-12:42:41.419",
"FromRtgsGlobalId": "RTGS:B:US20781688"
}

Execution report event V2 Webhook

FIX 4.2 <8> message. The initiating participant receives this event when the counterparty participant confirm the receipt of an order

Event type: global.rtgs.executionReportV2

Request Body schema: application/json

OrderId required	string Unique identifier for order. For end to end processing, this should match your QuoteId, and should be passed to the settlement service as a Link Identifier
ClOrdId required	string Unique ID of the order. For end to end processing, this should match your QuoteReqId, and should be passed to the settlement service as a Link Identifier
ExecId required	string Unique ID of the execution report.
ExecType required	string Valid values: 0 = New 1 = Partial fill 2 = Fill 3 = Done for day 4 = Canceled 5 = Replaced 6 = Pending Cancel (e.g. result of Order Cancel Request ) 7 = Stopped 8 = Rejected 9 = Suspended A = Pending New B = Calculated C = Expired
FromRtgsGlobalId required	string RTGS.global ID of the participant sending the execution report.
OrdStatus required	string Valid values: 0 = New 1 = Partial fill 2 = Fill 3 = Done for day 4 = Canceled 5 = Replaced 6 = Pending Cancel (e.g. result of Order Cancel Request ) 7 = Stopped 8 = Rejected 9 = Suspended A = Pending New B = Calculated C = Expired
Price required	string Price of the instrument.
OrderQty required	string or null Base order quantity.
OrderQty2 required	string or null Quote order quantity.
Side required	string Action on the base currency. Possible values include: 1: Buy 2: Sell
Symbol required	string Exchange-provided product symbol for the tradable product.
CumQty required	string Total quantity filled.
LeavesQty required	string Amount open for further execution (should be 0).
AvgPx required	string Calculated average price of all fills on this order.

Request samples

Payload

Content type

application/json

{"OrderId": "567GHL",
"ClOrdId": "098FGS",
"ExecId": "545GFDG",
"ExecType": "Filled",
"OrdStatus": "Filled",
"Symbol": "GBP/USD",
"Side": "1",
"OrderQty": "10000",
"OrderQty2": "13000",
"Price": "1.3",
"LeavesQty": "",
"CumQty": "",
"AvgPx": "1.3",
"FromRtgsGlobalId": "RTGS:B:US20781688"
}

Get a list of supported FX currency pairs.

Returns proprietary models. Get a list of currency pairs supported by the platform

Responses

Response samples

Content type

application/json

["AUD/USD",
"EUR/USD",
"GBP/USD",
"GBP/AUD",
"USD/CAD",
"USD/CHF",
"USD/JPY"
]

Issue a quote request V2.

FIX 4.2 compatible proprietary message. Initiate the process to gather quotes. Request indicates the participants from whom quotes are desired

Request Body schema: application/json

	object or object FIX 4.2 <R> Quote request message
Counterparties	Array of strings List of participants desired to provide their quotes

Responses

Request samples

Payload

Content type

application/json

Example

Quote request to buy 10,000.00 British pounds, and sell US dollars

{"Counterparties": ["RTGS:B:US13221932",
"RTGS:B:US20781688"
],
"QuoteRequest": {"QuoteReqId": "39054EA89BD9",
"Symbol": "GBP/USD",
"Side": "1",
"OrderQty": "10000",
"OrderQty2": "",
"ValidUntilTime": "20240718-12:25:49.128",
"ExpireTime": "20240718-12:25:49.128",
"SupplementaryData": "{\"RtgsGlobalRequestOrigin\": \"RtgsParticipantPortal\"}"
}
}

Response samples

Content type

application/json

{"QuoteRequest.QuoteReqId": ["'QuoteReqId' must not be empty."
],
"QuoteRequest.Side": ["'Side' must not be empty.",
"'Side' must be 1 character in length."
],
"QuoteRequest.Symbol": ["'Symbol' must not be empty."
],
"QuoteRequest.OrderQty": ["Either 'OrderQty' or 'OrderQty2' must be specified"
],
"QuoteRequest.OrderQty2": ["Either 'OrderQty' or 'OrderQty2' must be specified"
],
"QuoteRequest.ValidUntilTime": ["'ValidUntilTime' must not be empty."
],
"QuoteRequest.ExpireTime": ["'ExpireTime' must not be empty."
]
}

Send a quote V2.

FIX 4.2 compatible proprietary message. Respond with an quote to a quote request. This would be called by the counterparty in response to the incoming quote request.

As a quote is sent to a specific participant, the gateway has to be instructed separately about who to sign this request for. This is done via HTTP header 'rtgs-global-signed-for', that should be set to the RTGS.global Id of the counterparty participant.

header Parameters

rtgs-global-signed-for

required

string

Example: RTGS:B:JP15887136

Request Body schema: application/json

	object FIX 4.2 <S> Quote request message
FromRtgsGlobalId	string

Responses

Request samples

Payload

Content type

application/json

{"FromRtgsGlobalId": "RTGS:B:US20781688",
"Quote": {"BidPx": "",
"ExpireTime": "20240718-12:42:41.419",
"OfferPx": "1.3",
"OrderQty": "10000",
"OrderQty2": "13000",
"QuoteId": "2E6BE282DE4E",
"QuoteReqId": "BA7BD340462A",
"Side": "1",
"Symbol": "GBP/USD"
}
}

Response samples

Content type

application/json

{"FromRtgsGlobalId": ["'FromRtgsGlobalId' must not be empty."
],
"Quote.QuoteReqId": ["'QuoteReqId' must not be empty."
],
"Quote.QuoteId": ["'QuoteId' must not be empty."
],
"Quote.Side": ["The specified condition was not met for 'Side'."
],
"Quote.Symbol": ["'Symbol' must not be empty."
],
"Quote.OrderQty": ["'OrderQty' must not be empty."
],
"Quote.OrderQty2": ["'OrderQty2' must not be empty."
],
"Quote.ExpireTime": ["'ExpireTime' must not be empty."
]
}

Send new order - single V2.

FIX 4.2 <D> message. The new order message type is used by institutions wishing to electronically submit forex orders to a broker for execution.

As a new order message is sent to a specific participant, the gateway has to be instructed separately about who to sign this request for. This is done via HTTP header 'rtgs-global-signed-for', that should be set to the RTGS.global Id of the counterparty participant.

header Parameters

rtgs-global-signed-for

required

string

Example: RTGS:B:JP15887136

Request Body schema: application/json

QuoteId required	string Unique ID of the quote.
ClOrdId required	string Unique ID of the order. For end to end processing, this should match your QuoteReqId, and should be passed to the settlement service as a Link Identifier
FromRtgsGlobalId required	string RTGS.global ID of the participant sending the new order single.
HandlInst required	string Valid values: 1 = Automated execution order, private, no Broker intervention 3 = Manual order, best execution
OrdType required	string Should always be 1 = Market.
Price required	string Price of the instrument.
OrderQty required	string or null Base order quantity.
OrderQty2 required	string or null Quote order quantity.
Side required	string Action on the base currency. Possible values include: 1: Buy 2: Sell
Symbol required	string Exchange-provided product symbol for the tradable product.
ExpireTime required	string <fix-utc-timestamp yyyyMMdd-HH:mm:ss.fff> Time at which the order will expire.
TransactTime required	string <fix-utc-timestamp yyyyMMdd-HH:mm:ss.fff> Time of execution/order creation.

Responses

Request samples

Payload

Content type

application/json

{"ClOrdId": "098FGS",
"HandlInst": "1",
"Symbol": "GBP/USD",
"Side": "1",
"TransactTime": "20240718-12:30:00.000",
"OrderQty": "10000",
"OrderQty2": "13000",
"OrdType": "1",
"Price": "1.3",
"QuoteId": "2E6BE282DE4E",
"ExpireTime": "20240718-12:42:41.419",
"FromRtgsGlobalId": "RTGS:B:US20781688"
}

Response samples

Content type

application/json

{"QuoteId": ["'QuoteId' must not be empty."
],
"FromRtgsGlobalId": ["'FromRtgsGlobalId' must not be empty."
]
}

Send an execution report V2.

FIX 4.2 <8> message. Confirm the receipt of an order using an execution report.

As an execution report is sent to a specific participant, the gateway has to be instructed separately about who to sign this request for. This is done via HTTP header 'rtgs-global-signed-for', that should be set to the RTGS.global Id of the counterparty participant.

header Parameters

rtgs-global-signed-for

required

string

Example: RTGS:B:JP15887136

Request Body schema: application/json

OrderId required	string Unique identifier for order. For end to end processing, this should match your QuoteId, and should be passed to the settlement service as a Link Identifier
ClOrdId required	string Unique ID of the order. For end to end processing, this should match your QuoteReqId, and should be passed to the settlement service as a Link Identifier
ExecId required	string Unique ID of the execution report.
ExecType required	string Valid values: 0 = New 1 = Partial fill 2 = Fill 3 = Done for day 4 = Canceled 5 = Replaced 6 = Pending Cancel (e.g. result of Order Cancel Request ) 7 = Stopped 8 = Rejected 9 = Suspended A = Pending New B = Calculated C = Expired
FromRtgsGlobalId required	string RTGS.global ID of the participant sending the execution report.
OrdStatus required	string Valid values: 0 = New 1 = Partial fill 2 = Fill 3 = Done for day 4 = Canceled 5 = Replaced 6 = Pending Cancel (e.g. result of Order Cancel Request ) 7 = Stopped 8 = Rejected 9 = Suspended A = Pending New B = Calculated C = Expired
Price required	string Price of the instrument.
OrderQty required	string or null Base order quantity.
OrderQty2 required	string or null Quote order quantity.
Side required	string Action on the base currency. Possible values include: 1: Buy 2: Sell
Symbol required	string Exchange-provided product symbol for the tradable product.
CumQty required	string Total quantity filled.
LeavesQty required	string Amount open for further execution (should be 0).
AvgPx required	string Calculated average price of all fills on this order.

Responses

Request samples

Payload

Content type

application/json

{"OrderId": "567GHL",
"ClOrdId": "098FGS",
"ExecId": "545GFDG",
"ExecType": "Filled",
"OrdStatus": "Filled",
"Symbol": "GBP/USD",
"Side": "1",
"OrderQty": "10000",
"OrderQty2": "13000",
"Price": "1.3",
"LeavesQty": "",
"CumQty": "",
"AvgPx": "1.3",
"FromRtgsGlobalId": "RTGS:B:US20781688"
}

Response samples

Content type

application/json

{"ClOrdId": ["'ClOrdId' must not be empty."
],
"OrderId": ["'OrderId' must not be empty."
],
"FromRtgsGlobalId": ["'FromRtgsGlobalId' must not be empty."
]
}

Funds

Withdrawing funds from an Rtgs.global network account

Transaction status update Webhook

ISO-20022 pacs.002 message. Information about a transaction status update.

Event type: global.rtgs.TransactionStatusNotificationV1

Request Body schema: application/json

object or null

Responses

Request samples

Payload

Content type

application/json

Example

payaway failure

{"FIToFIPmtStsRpt": {"GrpHdr": {"MsgId": "b9fdbd5351eb4bc9b2accd83b860a016",
"CreDtTm": "2019-08-24T15:15:00Z",
"InstdAgt": {"FinInstnId": {"BICFI": "EEXGBP11",
"LEI": "376323TESTVDK1GB1L12",
"Othr": {"Id": "RTGS:B:GB43400282"
}
}
}
},
"TxInfAndSts": [{"OrgnlEndToEndId": "c13afc06de22444e8e6869573c0168e9",
"OrgnlUETR": "90fdc79b-4090-413d-9a79-9a87cb838285",
"TxSts": "RJCT",
"StsRsnInf": [{"Rsn": {"Cd": "AM04"
},
"AddtlInf": ["Insufficient Funds"
]
}
],
"OrgnlTxRef": {"IntrBkSttlmAmt": {"Ccy": "JPY",
"Value": "999"
},
"PmtTpInf": {"LclInstrm": {"Prtry": "FIToFICustomerCreditTransfer"
}
},
"Cdtr": {"Pty": {"Nm": "Tom Tompson",
"PstlAdr": {"TwnNm": "Tokyo",
"Ctry": "JP"
}
}
}
}
}
]
}
}

New transaction Webhook

ISO-20022 camt.054 message. Information about a debit or credit transaction against an account.

Event type: global.rtgs.TransactionNotificationV1

Request Body schema: application/json

	object or null BankToCustomerDebitCreditNotification : to inform the account owner of single or multiple debit and/or credit entries reported to the account
	object or null Extra proprietary metadata associated with the notification.

Responses

Request samples

Payload

Content type

application/json

Example

valid payaway request

{"BkToCstmrDbtCdtNtfctn": {"GrpHdr": {"MsgId": "df9857cdee60482a8d2646931958a367",
"CreDtTm": "2023-03-08T15:58:22.0090079Z"
},
"Ntfctn": [{"Id": "9b74b93586d9488f841c43e7ad8d0887",
"Acct": {"Id": {"IBAN": "GB33BUKB30301666666666"
}
},
"Ntry": [{"NtryRef": "0",
"Amt": {"Ccy": "GBP",
"Value": "99.99"
},
"CdtDbtInd": "DBIT",
"Sts": {"Cd": "BOOK"
},
"BkTxCd": {"Domn": {"Cd": "PMNT",
"Fmly": {"Cd": "ICDT",
"SubFmlyCd": "FICT"
}
}
},
"NtryDtls": [{"TxDtls": {"Refs": {"EndToEndId": "unique-end-to-end-id",
"UETR": "90fdc79b-4090-413d-9a79-9a87cb838285"
},
"LclInstrm": {"Prtry": "FIToFICustomerCreditTransfer"
}
}
}
]
}
]
}
]
}
}

Initiate a request to withdraw from your network accounts

ISO-20022 pacs.009 message. Withdraw from an account on the Rtgs.global network.

When withdrawing funds from your network account, the debtor fields of the request (FICdtTrf.CdtTrfTxInf[0].Dbtr and FICdtTrf.CdtTrfTxInf[0].DbtrAcct) pertain to your network account, and the creditor fields pertain to your off-network account.

If the instructed agent requires debtor party management, the FICdtTrf.CdtTrfTxInf[0].Dbtr.Othr.Id property must be populated with the AccountAliasId of the ultimate debtor.

Request Body schema: application/json

required

object

pacs.009.001.10 - the Financial Institution Credit Transfer message

Responses

Request samples

Payload

Content type

application/json

{"FICdtTrf": {"GrpHdr": {"MsgId": "6e75c1586a584d69b95154a6c257c078",
"CreDtTm": "2024-10-11T09:54:17.339Z",
"NbOfTxs": "1",
"SttlmInf": {"SttlmMtd": "CLRG"
}
},
"CdtTrfTxInf": [{"PmtId": {"EndToEndId": "unique-end-to-end-id",
"UETR": "e4dc8678-eb86-43cd-b4af-e796bcbe68b7"
},
"PmtTpInf": {"LclInstrm": {"Cd": null,
"Prtry": "defund"
}
},
"IntrBkSttlmAmt": {"Ccy": "usd",
"Value": "1234567.89"
},
"Dbtr": {"FinInstnId": {"BICFI": "654321ABCDEFGHIJKL78 // your details",
"Othr": {"Id": "debtor-account-alias-id"
},
"Nm": "your-institution-name"
}
},
"DbtrAcct": {"Id": {"IBAN": "GB33BUKB20201666666666 // your network account"
}
},
"Cdtr": {"FinInstnId": {"BICFI": "654321ABCDEFGHIJKL78 // your details",
"Nm": "your-institution-name"
}
},
"CdtrAcct": {"Id": {"IBAN": "GB33BUKB20201555555555 // your off-network account"
}
}
}
]
}
}

Response samples

Content type

application/problem+json

{"Type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
"Title": "One or more validation errors occurred.",
"Status": 400,
"Errors": {"FICdtTrf": ["'FICdtTrf' must not be empty."
]
}
}

RTGS.global Participant Gateway API (1.0.0)

Overview

Synchronous responses

Asynchronous responses

Link and Settle

Transaction status update Webhook

Request Body schema: application/json

Responses

Request samples

New transaction Webhook

Request Body schema: application/json

Responses

Request samples

Create a new settlement request

Request Body schema: application/json

Responses

Request samples

Response samples

Create a new cancel settlement request

Request Body schema: application/json

Responses

Request samples

Response samples

FI to FI Customer Credit Transfer

Transaction status update Webhook

Request Body schema: application/json

Responses

Request samples

New transaction Webhook

Request Body schema: application/json

Responses

Request samples

New payaway funds request Webhook

Request Body schema: application/json

Responses

Request samples

Initiate FI to FI Customer Credit Transfer

Request Body schema: application/json

Responses

Request samples

Response samples

Validate a FI to FI Customer Credit Transfer request

Request Body schema: application/json

Responses

Request samples

Response samples

Payment Status Report

Transaction status update Webhook

Request Body schema: application/json

Responses

Request samples

Send a payment status report

header Parameters

Request Body schema: application/json

Responses

Request samples

Balances

Get balances v2

Responses

Response samples

Accounts

Network account created event V1 Webhook

Request Body schema: application/json

Request samples

Account Approval Failed Event V1 Webhook

Request Body schema: application/jsonrequired

Request samples

Account Approved Event V1 Webhook

Request Body schema: application/json

Request samples

Account Requested Event V1 Webhook

Request Body schema: application/json

Request samples

Account Request Failed Event V1 Webhook

Request Body schema: application/json

Request samples

Get accounts

Responses

Response samples

Get accounts v2

Request Body schema: application/json
required

Request Body schema: application/json
required