Subscribe to Transfer Events (SSE) (Legacy)

Deprecation notice

As part of the deprecation process, the legacy transfer events API is now only available for existing broker-partners at GET /v1/events/transfers/status and for compatibility reasons.

All new broker partners will not have the option to use the legacy transfer events endpoint.

They should integrate with the new /v2/events/funding/status endpoint instead.

Also, all existing broker partners are now recommended to upgrade to the /v2/events/funding/status endpoint, which provides faster event delivery times.

The Events API provides event push as well as historical queries via SSE (server sent events).

You can listen to transfer status updates as they get processed by our backoffice, for both end-user and firm accounts.

Historical events are streamed immediately if queried, and updates are pushed as events occur.

Query Params Rules:

• since required if until specified
• since_id required if until_id specified
• since_ulid required if until_ulid specified
• since, since_id or since_ulid can’t be used at the same time Behavior:
• if since, since_id or since_ulid not specified this will not return any historic data
• if until, until_id or until_ulid reached stream will end (status 200)

Note for people using the clients generated from this OAS spec. Currently OAS-3 doesn't have full support for representing SSE style responses from an API, so if you are using a generated client and don't specify a since and until there is a good chance the generated clients will hang waiting for the response to end.

If you require the streaming capabilities we recommend not using the generated clients for this specific usecase until the OAS-3 standards come to a consensus on how to represent this correcting in OAS-3.