Skip to main content

Standardising the Reference Field Across Simulate Funding API and Payment Run Initialization

ยท One min read

To ensure consistency across our APIs, the group_reference field in the Simulate Funding API endpoint has been renamed to reference.

Effective Dates:

  • Sandbox: 11 March 2025
  • Production: 11 March 2025

This aligns with the Payment Fund Initialization process, where the reference is retrieved from this endpoint.

info

No changes are required for the PIS Initialization process.

What's changingโ€‹

The group_reference field in the Simulate Funding API request payload has been renamed to reference.

Action Requiredโ€‹

Please update your integrations to use reference instead of group_reference.

If no action is takenโ€‹

Ensure that you update your integrations to avoid any disruptions in Simulate API functionality.

Reminder

The Simulate Funding endpoint should only be used in the Sandbox environment.

Affected Simulator endpoints: