The webhook serves to notify partners promptly when any non-user initiated transaction occurs, detailing the nature of the transaction and its effect on the user’s portfolio. This ensures that all changes are reflected in the user’s account records in real time, helping partners provide up-to-date information.
The events are triggered in case of any non-user initiated transactions such as:
{
"params": {
"id": "1ef17946-33ef-6bca-be62-6b4cda1f924b",
"user_id": "1eda3a0b-7a31-60a2-90ec-465a39bfb319",
"asset_id": 2262,
"asset_amount": "0.10160299",
"type": "staking_reward",
"type_defined_for": "asset",
"direction": "incoming",
"created_at": "2024-05-21T17:05:55Z",
"fiat_id": null,
"fiat_amount": null,
"related_offer_id": null
}
}
{
"params": {
"id": "a790b35b-1a11-46e5-98be-49dc3dfb9b3f",
"user_id": "1ef01723-f676-6210-a69d-ebda6451bef7",
"asset_id": 3815,
"asset_amount": "0.9622527",
"type": "giveaway",
"type_defined_for": "asset",
"direction": "incoming",
"created_at": "2024-05-22T14:31:15Z",
"fiat_id": 1,
"fiat_amount": "100.70327009",
"related_offer_id": null
}
}
{
"params": {
"id": "bb8dbece-f727-4f2c-a4b5-04335d83103e",
"user_id": "1ef1746b-e606-6a5a-bcda-5ddff8945b8c",
"type": "tax_refund",
"type_defined_for": "fiat",
"direction": "incoming",
"created_at": "2024-05-21T09:41:47Z",
"asset_id": null,
"asset_amount": null,
"fiat_id": 1,
"fiat_amount": "4.95",
"related_offer_id": "4a296047-01b1-4e60-a41a-592b9a33573b"
}
}
{
"params": {
"id": "4be2b00d-f69c-45d0-9d13-70f60082c68b",
"user_id": "1ef01723-f676-6210-a69d-ebda6451bef7",
"asset_id": 3815,
"asset_amount": "1",
"type": "deduction",
"type_defined_for": "asset",
"direction": "outgoing",
"created_at": "2024-05-23T12:12:05Z",
"fiat_id": null,
"fiat_amount": null,
"related_offer_id": null
}
}
{
"params": {
"id": "b9299c2e-eb39-59a2-a4af-88417cc4e803",
"user_id": "1ef18dea-b7e7-6abe-bde8-23eb6307d6b5",
"asset_id": 2372,
"asset_amount": "0.11803707",
"type": "otc_trade",
"type_defined_for": "asset",
"direction": "outgoing",
"created_at": "2024-05-23T09:54:38Z",
"fiat_id": 1,
"fiat_amount": "59.36",
"related_offer_id": "2018c32b-49c4-4fe5-bf15-2ba6cdb7138a"
}
}
object |
Return a 200
, 201
, 202
or 204
status to indicate that the data was received successfully
{- "params": {
- "id": "abcd1234-12ab-ab12-abcdef123456",
- "user_id": "abcd1234-12ab-ab12-abcdef123456",
- "asset_id": 1,
- "asset_amount": "0.46987983466586",
- "fiat_id": 1,
- "fiat_amount": "323000.78000000",
- "related_offer_id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
- "type": "staking_reward",
- "type_defined_for": "asset",
- "direction": "incoming",
- "created_at": "2023-01-09T13:08:00Z"
}
}