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 ifuntil
specifiedsince_id
required ifuntil_id
specifiedsince_ulid
required ifuntil_ulid
specifiedsince
,since_id
orsince_ulid
can’t be used at the same time
Behavior:- if
since
,since_id
orsince_ulid
not specified this will not return any historic data - if
until
,until_id
oruntil_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.