Subscribe to Transfer Events (SSE)
GET {{baseUrl}}/v1/events/transfers/status
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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
since | string | Format: YYYY-MM-DD | |
until | string | Format: YYYY-MM-DD | |
since_id | number | ||
until_id | number | ||
since_ulid | string | ||
until_ulid | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"account_id":"afa2429a-0df1-07af-7417-e6bab9e9d6be","at":"1977-05-21T03:29:11.361Z","event_id":27584614,"event_ulid":"sed ","status_from":"QUEUED","status_to":"QUEUED","transfer_id":"fe6c3f77-a0b2-06c3-e100-599172485300"},{"account_id":"d657e49b-165a-0b68-78b3-5d5580ca10bd","at":"1963-08-27T18:56:36.011Z","event_id":-6963937,"event_ulid":"aute dolor voluptate","status_from":"QUEUED","status_to":"QUEUED","transfer_id":"e10b0427-f2c5-d362-e4eb-5f8e2f3fea19"}]