Skip to main content

Integration Journey

Integrating with RTGS.global follows a structured three-phase process. Each phase builds on the last, and technical sign-off is required before progressing to the next phase.


Phase 1 — Core Integration​

In this phase you connect your systems to the RTGS.global API using the emulator — a full-fidelity local environment that mirrors the production API without requiring a live network connection.

What you'll do:

  • Deploy and run the RTGS.global emulator — see The Emulator for Docker setup instructions (hosted version available on request)
  • Implement API request signing using the RTGS.global Signing API
  • Verify synchronous responses and handle asynchronous event notifications via webhook
  • Integrate your systems against the emulator and validate your implementation end-to-end

Sign-off criteria:

  • All target API operations implemented and tested against the emulator
  • Request signing and webhook signature verification working correctly
  • Integration reviewed and approved by the RTGS.global technical team
Technical sign-off required

Your implementation will be reviewed before you progress to Phase 2. Reach out to your RTGS.global contact to request sign-off when Phase 1 is complete.


Phase 2 — Sandbox Integration​

In this phase you connect to the RTGS.global sandbox environment. The RTGS.global team will create your participant entity and accounts, and you will test end-to-end against a Funds Controller operating in the sandbox. Switch from the Core specification to the FC-specific specification for your chosen Funds Controller.

What you'll do:

  • Establish a live network connection — see Getting Connected
  • Work with the RTGS.global team to onboard your participant and open accounts with your chosen Funds Controller in the sandbox environment
  • Integrate against the FC-specific API specification for your Funds Controller
  • Run end-to-end tests across the payment services you intend to use (Payaway, Link and Settle, FX Quotes, Defund)

Sign-off criteria:

  • Network connectivity to the sandbox environment confirmed
  • Participant entity and accounts created in sandbox
  • End-to-end tests passed for all target payment services
  • Integration reviewed and approved by the RTGS.global technical team
Technical sign-off required

Your integration will be reviewed before you progress to Phase 3. Reach out to your RTGS.global contact to request sign-off when Phase 2 is complete.


Phase 3 — Production​

In this phase your integration goes live. The RTGS.global team will onboard your participant to the production environment and connect you with your chosen Funds Controllers.

What you'll do:

  • Confirm your target Funds Controllers and jurisdictions with the RTGS.global team
  • Coordinate production onboarding (participant entity, accounts, and Funds Controller relationships)
  • Complete final validation and go live

What to prepare:

  • Production infrastructure deployed and hardened
  • Incident response and support contacts confirmed
  • Any compliance or legal prerequisites satisfied with your Funds Controllers

Summary​

PhaseEnvironmentGate
1 — Core IntegrationEmulator (local or hosted)Technical sign-off
2 — Sandbox IntegrationRTGS.global sandboxTechnical sign-off
3 — ProductionRTGS.global productionOnboarding complete

Not sure where to start? The Getting Connected guide walks through the network and infrastructure setup needed for Phase 2 onwards. The Emulator guide covers Phase 1.

For guidance on which API specification to integrate against at each phase, see API Specifications.