improved

Updated Run_ID Type Change

Release date

  • July 6th, 2023

Release type

  • Informational – Optional action from platforms.

Summary

We will be implementing a change to improve performance related to settlement processing that requires the run_id field to migrate to a UUID "string" type. On the REST API, the run_id field is currently being passed as type “string”, but appears as an integer (i.e., “123456”). We will be changing this to a UUID "string" type (i.e., “7f30ac2e-aa6d-4390-931a-2f947253722a”). Additionally, on the Websocket Balances feed, the run_id is currently being passed as type “integer”. We will be changing this to a UUID "string" type.

Action required

Platforms need to adjust to make sure they support ingesting the run_id as a "string" instead of as an "integer". A specific use case that would be impacted would be if a platform is relying on the run_id integer to keep track of sequencing.

Impacted endpoints and WebSocket feed

  • REST Endpoints
    • GET /accounts/:account_id/run_history
    • GET /accounts/:account_id/movements
    • GET /deposits
  • WebSocket Feed
    • Balances

Relevant documentation