Skip to main content

API Reference

The RTGS.global platform is documented across several OpenAPI specifications. All participants need the Signing API and Core specification; an FC-specific specification is added once a Funds Controller has been agreed.

Which specification to use​

SpecificationWhen to use
Signing APIAlways — required for signing outbound requests and verifying inbound event signatures
Participant API (Core)Always — covers the platform endpoints every participant needs, regardless of Funds Controller
FC-specific (Verto, Realis Finance, TransferMate)Once a Funds Controller has been agreed

Signing API​

The Signing API covers the Signing Module that participants deploy as part of their integration. Every outbound API request must be signed, and every inbound event notification must have its signature verified, before the payload is processed. The Signing API is independent of any Funds Controller and applies in every environment.

Participant API (Core)​

The Core specification covers the RTGS.global Participant API endpoints that are not specific to any Funds Controller — event notifications, platform-level operations, and other FC-agnostic flows. These endpoints apply in every environment and at every phase, including participants who move directly to Phase 2 without first building against the emulator.

If you do use the emulator during Phase 1, it also exposes FC-adjacent flows — Payaway, Link and Settle, FX Quotes, Defund, and Party Management — so you can build and validate the full payment lifecycle before connecting to a real Funds Controller. Note that the emulator uses simulated schemas: the specific fields required, valid values, and supported endpoints will differ when you connect to a real Funds Controller. Use the emulator to validate your integration architecture and flow handling, not to finalise FC-specific field mappings.

FC-specific specifications​

Once a Funds Controller has been agreed, switch to their specification. FC-specific specs are tailored to that partner: valid FundsControllerCode values are locked to their codes, request examples use realistic values, and any endpoints not supported by that FC are omitted.

SpecificationFunds Controller
Participant API (Realis Finance)Realis Finance
Participant API (TransferMate)TransferMate
Participant API (Verto)Verto

If you are starting Phase 2 and your Funds Controller is not yet listed above, contact your RTGS.global representative to confirm the applicable specification.