Crypto Actions NotificationsWebhook

Crypto Actions refer to events or changes that affect crypto assets, similar to traditional corporate actions in the stock market. These actions can include various events such as crypto/token merger, burns, modifications/rebranding and more. Notifications for crypto actions are needed by partners to stay informed about changes that may impact the asset value, structure, and portfolio of their users.

Merger Crypto: A specific type of crypto action where two or more crypto assets are combined into a single, unified asset. This process is comparable to traditional corporate mergers, aiming to streamline operations within the blockchain ecosystem.

Examples

Merger Crypto

There can be 2 cases:

  1. The payload contains 2 transactions (1 outgoing & 1 incoming) for each asset pair that is merged

    {
      "params": {
        "id": "c125f2e8-e4b7-4776-a634-0a351ecd1dee",
        "user_id": "1ef39d79-9339-678a-837c-3d4fce1bebbd",
        "type": "merger_crypto",
        "credited_at": "2024-07-04T07:40:11Z",
        "transactions": [
          {
            "id": "c125f2e8-e4b7-4776-a634-0a351ecd1dee",
            "asset_id": "1edcf0f1-0267-687e-8fc8-8aa7f8be420e",
            "asset_int": 4108,
            "fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
            "fiat_int": 1,
            "asset_amount": "3501.04394764",
            "fiat_amount": "10.69",
            "fee_amount": "0",
            "type_defined_for": "asset",
            "direction": "outgoing"
          },
          {
            "id": "587b8cca-b3f9-4549-815a-82be8a197dca",
            "asset_id": "fb9e023f-ae71-11ec-87a8-024dd640430f",
            "asset_int": 2473,
            "fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
            "fiat_int": 1,
            "asset_amount": "1516.74326526",
            "fiat_amount": "1677.97",
            "fee_amount": "0",
            "type_defined_for": "asset",
            "direction": "incoming"
          }
        ]
      }
    }
    
  2. The payload contains 1 transaction (1 outgoing) which occurs only when there is a very small position that cannot be converted due to the ratio being less than 1 (also known as dust removal).

    {
      "params": {
        "id": "c125f2e8-e4b7-4776-a634-0a351ecd1dee",
        "user_id": "1ef39d79-9339-678a-837c-3d4fce1bebbd",
        "type": "merger_crypto",
        "credited_at": "2024-07-04T07:40:11Z",
        "transactions": [
          {
            "id": "c125f2e8-e4b7-4776-a634-0a351ecd1dee",
            "asset_id": "1edcf0f1-0267-687e-8fc8-8aa7f8be420e",
            "asset_int": 4108,
            "fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
            "fiat_int": 1,
            "asset_amount": "0.0000000012",
            "fiat_amount": "0.00000001",
            "fee_amount": "0",
            "type_defined_for": "asset",
            "direction": "outgoing"
          },
        ]
      }
    }
    
Request
Request Body schema: application/json
object
Responses
200

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

Request samples
application/json
{
  • "params": {
    }
}