Skip to main content

Non-user Initiated Transactions

Webhook
deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

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:

  • Metal Storage Fee: Weekly fees charged for the storage of physical metals.
  • Staking Reward: Rewards distributed for participating in cryptocurrency staking.
  • Giveaway: Credits added to user wallets from promotional giveaways.
  • Tax Refund: Refunds received from overpaid taxes on previous transactions.
  • Deduction: Deductions made for penalties, fees, or adjustments.
  • OTC Trade: OTC (Over-the-Counter) Trades are manually processed trades, typically initiated for reasons such as trade failures or tax refunds.

Examples​

Metal Storage Fee​

{
  "params": {
    "id": "9a2b5bc2-effc-48ee-99b3-412c04943b90",
    "user_id": "3c3c11a9-79b2-4d45-b668-4119d843c72a",
    "asset_id": 28,
    "asset_amount": "0.02442815",
    "type": "metal_storage_fee",
    "direction": "outgoing",
    "created_at": "2022-01-18T05:19:22Z",
    "related_offer_id": null
  }
}

Staking Reward​

{
  "params": {
    "id": "1ef17946-33ef-6bca-be62-6b4cda1f924b",
    "user_id": "1eda3a0b-7a31-60a2-90ec-465a39bfb319",
    "asset_id": 2262,
    "asset_amount": "0.10160299",
    "type": "staking_reward",
    "direction": "incoming",
    "created_at": "2024-05-21T17:05:55Z",
    "related_offer_id": null
  }
}

Giveaway​

{
  "params": {
    "id": "a790b35b-1a11-46e5-98be-49dc3dfb9b3f",
    "user_id": "1ef01723-f676-6210-a69d-ebda6451bef7",
    "asset_id": 3815,
    "asset_amount": "0.9622527",
    "type": "giveaway",
    "direction": "incoming",
    "created_at": "2024-05-22T14:31:15Z",
    "related_offer_id": null
  }
}

Tax Refund​

{
  "params": {
    "id": "d27e6f16-40ba-4791-97b6-de91fd08b0aa",
    "user_id": "1ef18678-9648-6d34-a268-a9751dd9d0db",
    "asset_id": 1,
    "asset_amount": "22.88",
    "type": "tax_refund",
    "direction": "incoming",
    "created_at": "2024-05-22T18:19:28Z",
    "related_offer_id": "7d3e76a4-0c72-47c9-bf94-7b0bcfb6c121"
  }
}

Deduction​

{
  "params": {
    "id": "4be2b00d-f69c-45d0-9d13-70f60082c68b",
    "user_id": "1ef01723-f676-6210-a69d-ebda6451bef7",
    "asset_id": 3815,
    "asset_amount": "1",
    "type": "deduction",
    "direction": "outgoing",
    "created_at": "2024-05-23T12:12:05Z",
    "related_offer_id": null
  }
}

OTC Trade​

{
  "params": {
    "id": "b9299c2e-eb39-59a2-a4af-88417cc4e803",
    "user_id": "1ef18dea-b7e7-6abe-bde8-23eb6307d6b5",
    "asset_id": 2372,
    "asset_amount": "0.11803707",
    "type": "otc_trade",
    "direction": "outgoing",
    "created_at": "2024-05-23T09:54:38Z",
    "related_offer_id": null
  }
}

Request​

Responses​

Return a 200, 201, 202 or 204 status to indicate that the data was received successfully