Corporate Actions NotificationsWebhook

This webhook is specifically designed to inform partners whenever a corporate action impacts their users. Subscribing to this webhook ensures that partners receive immediate updates about corporate actions affecting their users, allowing for necessary adjustments in users portfolios & accounts and maintaining alignment with actual asset statuses and balances.

Actions Triggering Notifications:

  • Delisting: Notification of an asset being removed from listing.
  • Dividend: Alert when dividends are paid to shareholders.
  • Merger (Cash): Information on cash settlements from mergers.
  • Merger (Stock): Information on stock considerations from mergers.
  • Stock Split: Alert when a company increases the outstanding amount of shares and the share price drops proportionally.
  • Reverse Stock Split: Notification of consolidation of company's shares, thus the number of outstanding shares is reduced and consequently the share price rises in proportion.
  • Spin-Off: Information when a company spins off one of its divisions into a new independent entity.

How to Handle the Notification:

  • Fiat Amount: If the notification includes a fiat_amount, this indicates that the specified amount has already been transferred to the partner’s corporate wallet. Partners should promptly transfer this amount to the respective user’s account in their system.
  • Asset Amount: If the notification includes an asset_amount, it represents a change in the user’s asset portfolio on our platform—either an addition or a deduction. Partners need to update the user’s asset portfolio accordingly to reflect these changes

Delisting

A scenario in which a company's shares are no longer traded on a stock market.

Notifications

{
  "params": {
    "id": "1ef0300f-aaca-6988-b92f-e37173d1efdf",
    "ca_id": "1ef02fed-b3e9-693c-a0c5-5b8044f2b6cc",
    "user_pid": "1ef02fe8-ddf6-6df6-9f07-053d75a38807",
    "type": "delisting",
    "asset_id": 3788,
    "asset_symbol": "HCC",
    "time": "2024-04-25T12:46:23Z",
    "asset_amount": "-2.00000000",
    "fiat_id": 1,
    "fiat_symbol": "EUR",
    "fiat_amount": "4",
    "additional_details": {
      "id_defined_for": "trade",
      "type_defined_for": "asset",
      "action": "delisting",
      "type": "subtract",
      "direction": "outgoing",
      "credited_at": "2024-04-25T12:40:21Z",
      "asset_group": "stock",
      "asset_price": "2.00000000",
      "asset_price_including_fee": "2.00000000",
      "asset_price_fiat_id": 1
    }
  }
}

Dividend

A dividend is a payment from a company to its investors. You can earn a dividend if you own stock in a company that pays them.

Dividend (Asset)

Some companies pay dividends in assets, meaning shareholders will receive a certain amount of those assets.

Notifications

{
  "params": {
    "id": "1eeeb766-143e-6f46-9f83-3571850a647b",
    "ca_id": "1eeeb75f-a80a-6808-a4b3-af7b04773f44",
    "user_pid": "645280f2-15c3-421e-a288-bb11d627f4fc",
    "type": "dividend",
    "asset_id": 3722,
    "asset_symbol": "SAE",
    "time": "2024-03-26T13:45:37Z",
    "asset_amount": "0.2776331",
    "fiat_id": null,
    "fiat_symbol": null,
    "fiat_amount": null,
    "additional_details": {
      "id_defined_for": "wallet_transaction",
      "type_defined_for": "asset",
      "action": "dividend",
      "type": "payout",
      "direction": "incoming",
      "credited_at": "2024-03-26T13:45:29Z",
      "asset_group": "stock",
      "asset_price": null,
      "asset_price_including_fee": null,
      "asset_price_fiat_id": null
    }
  }
}

Dividend (Fiat)

Some companies pay dividends in fiat currency, meaning shareholders will receive a certain amount of fiat based on the number of shares they hold.

Notifications

{
  "params": {
    "id": "1eda157f-3192-6efa-a52c-26cfa786d4ce",
    "ca_id": "1eda1576-6e55-6cb0-8385-da5863bc9734",
    "user_pid": "1eda0aa0-4444-6a10-9298-6e3cbc822981",
    "type": "dividend",
    "asset_id": 3667,
    "asset_symbol": "NUF",
    "time": "2023-01-31T12:15:47+01:00",
    "asset_amount": null,
    "fiat_id": 1,
    "fiat_symbol": "EUR",
    "fiat_amount": "100.00000000",
    "additional_details": null
  }
}

Merger (Cash)

An event where two or more companies merge, and the acquiring company purchases the other company's shares with cash instead of exchanging them for its own shares.

Notifications

{
  "params": {
    "id": "1eef575b-b3de-6d4a-9d26-270c4aab99a4",
    "ca_id": "1eef574c-135a-60cc-838c-3fe7b32dd4bc",
    "user_pid": "1eeeb752-29ac-6afe-837e-51b5bab16bff",
    "type": "merger_cash",
    "asset_id": 3722,
    "asset_symbol": "SAE",
    "time": "2024-04-08T07:06:05Z",
    "asset_amount": "-6.00000000",
    "fiat_id": 1,
    "fiat_symbol": "EUR",
    "fiat_amount": "18",
    "additional_details": {
      "id_defined_for": "trade",
      "type_defined_for": "asset",
      "action": "merger_cash",
      "type": "payout",
      "direction": "outgoing",
      "credited_at": "2024-04-08T07:00:50Z",
      "asset_group": "stock",
      "asset_price": "3.00000000",
      "asset_price_including_fee": "3.00000000",
      "asset_price_fiat_id": 1
    }
  }
}

Merger (Stock)

An event where two or more companies merge, and the shareholders of one company receive shares in the other company or companies instead of monetary payment.

Notifications

{
  "params": {
    "id": "1eeeb558-9094-61be-bc3f-9f4ef7622a77",
    "ca_id": "1eeeb553-6996-67b0-840b-7db8946f69ac",
    "user_pid": "1eeeb46e-44c5-6908-a589-b1f74e216120",
    "type": "merger_stock",
    "asset_id": 238,
    "asset_symbol": "SSL",
    "time": "2024-03-26T09:51:23Z",
    "asset_amount": "-30.00000000",
    "fiat_id": null,
    "fiat_symbol": null,
    "fiat_amount": null,
    "additional_details": {
      "id_defined_for": "wallet_transaction",
      "type_defined_for": "asset",
      "action": "merger_stock",
      "type": "both",
      "direction": "outgoing",
      "credited_at": "2024-03-26T09:51:03Z",
      "asset_group": "stock",
      "asset_price": null,
      "asset_price_including_fee": null,
      "asset_price_fiat_id": null
    }
  }
}

{
  "params": {
    "id": "1eeeb558-90b2-679a-8aec-f7ae3b7f585c",
    "ca_id": "1eeeb553-6996-67b0-840b-7db8946f69ac",
    "user_pid": "1eeeb46e-44c5-6908-a589-b1f74e216120",
    "type": "merger_stock",
    "asset_id": 2601,
    "asset_symbol": "OBS",
    "time": "2024-03-26T09:51:23Z",
    "asset_amount": "15",
    "fiat_id": null,
    "fiat_symbol": null,
    "fiat_amount": null,
    "additional_details": {
      "id_defined_for": "wallet_transaction",
      "type_defined_for": "asset",
      "action": "merger_stock",
      "type": "both",
      "direction": "incoming",
      "credited_at": "2024-03-26T09:51:03Z",
      "asset_group": "stock",
      "asset_price": null,
      "asset_price_including_fee": null,
      "asset_price_fiat_id": null
    }
  }
}

Stock Split

An event where a company's shares are split into smaller units to facilitate sales at a lower price, while the total value of the company's shares remains unchanged.

Notifications

{
  "params": {
    "id": "1eeeb57c-2986-63ae-83ce-c7661070f794",
    "ca_id": "1eeeb574-d216-62ba-957f-25368d481edb",
    "user_pid": "1eeeb46e-44c5-6908-a589-b1f74e216120",
    "type": "stock_split",
    "asset_id": 2500,
    "asset_symbol": "SRPT",
    "time": "2024-03-26T10:06:16Z",
    "asset_amount": "5",
    "fiat_id": null,
    "fiat_symbol": null,
    "fiat_amount": null,
    "additional_details": {
      "id_defined_for": "wallet_transaction",
      "type_defined_for": "asset",
      "action": "stock_split",
      "type": "payout",
      "direction": "incoming",
      "credited_at": "2024-03-26T10:06:15Z",
      "asset_group": "stock",
      "asset_price": null,
      "asset_price_including_fee": null,
      "asset_price_fiat_id": null
    }
  }
}

Reverse Stock Split

The act of reducing the number of shares a company has on the market without decreasing the overall value of the shares

Notifications

{
  "params": {
    "id": "1eeeb621-c22c-6b1c-85cb-c725cb1b9785",
    "ca_id": "1eeeb620-76a8-60fc-8165-31d1e0794010",
    "user_pid": "1eeeb46e-44c5-6908-a589-b1f74e216120",
    "type": "reverse_stock_split",
    "asset_id": 2503,
    "asset_symbol": "7735",
    "time": "2024-03-26T11:20:25Z",
    "asset_amount": "-4.00000000",
    "fiat_id": null,
    "fiat_symbol": null,
    "fiat_amount": null,
    "additional_details": {
      "id_defined_for": "wallet_transaction",
      "type_defined_for": "asset",
      "action": "reverse_stock_split",
      "type": "subtract",
      "direction": "outgoing",
      "credited_at": "2024-03-26T11:20:16Z",
      "asset_group": "stock",
      "asset_price": null,
      "asset_price_including_fee": null,
      "asset_price_fiat_id": null
    }
  }
}

Spin-Off

A spin-off occurs when a company separates part of its business into another company or creates a new class of shares and allocates them proportionally to existing investors.

What happens?

The amount of owned assets (ABC) is decreased. Users receive e new asset (XYZ) in their portfolio.

Notifications

Example 1: 3 Transactions

Normally, we send three notifications/events:

  • One with a negative value of the initial owned asset from the user wallet.
     {
      "params": {
          "id": "1ef18df7-d933-6de6-92ce-f517e52ad784",
          "ca_id": "1ef18dde-4f34-646a-8b72-a92783b080d4",
          "user_pid": "1ee3dcff-2c3f-62f4-8ac6-2eb81d7f4699",
          "type": "spin_off",
          "asset_id": 1477,
          "asset_symbol": "BKR",
          "time": "2024-05-23T10:08:49Z",
          "asset_amount": "-3.05300681",
          "fiat_id": null,
          "fiat_symbol": null,
          "fiat_amount": null,
          "additional_details": {
              "id_defined_for": "wallet_transaction",
              "type_defined_for": "asset",
              "action": "spin_off",
              "type": "payout",
              "direction": "outgoing",
              "credited_at": "2024-05-23T08:45:36Z",
              "asset_group": "stock",
              "asset_price": null,
              "asset_price_including_fee": null,
              "asset_price_fiat_id": null
          }
      }
  }
  • A second one with a positive value of the initial asset the user owns (and is added back to the user wallet).
    {
  "params": {
    "id": "1ef18df7-d944-601a-8a43-ddba0318db5e",
    "ca_id": "1ef18dde-4f34-646a-8b72-a92783b080d4",
    "user_pid": "1ee3dcff-2c3f-62f4-8ac6-2eb81d7f4699",
    "type": "spin_off",
    "asset_id": 1477,
    "asset_symbol": "BKR",
    "time": "2024-05-23T10:08:49Z",
    "asset_amount": "3.05300681",
    "fiat_id": null,
    "fiat_symbol": null,
    "fiat_amount": null,
    "additional_details": {
      "id_defined_for": "wallet_transaction",
      "type_defined_for": "asset",
      "action": "spin_off",
      "type": "payout",
      "direction": "incoming",
      "credited_at": "2024-05-23T08:45:36Z",
      "asset_group": "stock",
      "asset_price": null,
      "asset_price_including_fee": null,
      "asset_price_fiat_id": null
    }
  }
}
  • A third one with a positive amount of the new asset that was added to the user's portfolio as a result of the spin-off.
    {
  "params": {
    "id": "1ef18df7-d991-6054-a4ec-e7076b7cae58",
    "ca_id": "1ef18dde-4f34-646a-8b72-a92783b080d4",
    "user_pid": "1ee3dcff-2c3f-62f4-8ac6-2eb81d7f4699",
    "type": "spin_off",
    "asset_id": 1479,
    "asset_symbol": "SAB",
    "time": "2024-05-23T10:08:50Z",
    "asset_amount": "1.5265034",
    "fiat_id": null,
    "fiat_symbol": null,
    "fiat_amount": null,
    "additional_details": {
      "id_defined_for": "wallet_transaction",
      "type_defined_for": "asset",
      "action": "spin_off",
      "type": "payout",
      "direction": "incoming",
      "credited_at": "2024-05-23T08:45:36Z",
      "asset_group": "stock",
      "asset_price": null,
      "asset_price_including_fee": null,
      "asset_price_fiat_id": null
    }
  }
}

Example 2: 2 Transactions

Sometimes, there are only the first two transactions sent if the spin-off stock is too small to be represented.

  • One with a negative value of the initial owned asset from the user wallet.
     {
      "params": {
          "id": "1ef18df7-d933-6de6-92ce-f517e52ad784",
          "ca_id": "1ef18dde-4f34-646a-8b72-a92783b080d4",
          "user_pid": "1ee3dcff-2c3f-62f4-8ac6-2eb81d7f4699",
          "type": "spin_off",
          "asset_id": 1477,
          "asset_symbol": "BKR",
          "time": "2024-05-23T10:08:49Z",
          "asset_amount": "-3.05300681",
          "fiat_id": null,
          "fiat_symbol": null,
          "fiat_amount": null,
          "additional_details": {
              "id_defined_for": "wallet_transaction",
              "type_defined_for": "asset",
              "action": "spin_off",
              "type": "payout",
              "direction": "outgoing",
              "credited_at": "2024-05-23T08:45:36Z",
              "asset_group": "stock",
              "asset_price": null,
              "asset_price_including_fee": null,
              "asset_price_fiat_id": null
          }
      }
  }
  • A second one with a positive value of the initial asset the user owns (and is added back to the user wallet).
    {
  "params": {
    "id": "1ef18df7-d944-601a-8a43-ddba0318db5e",
    "ca_id": "1ef18dde-4f34-646a-8b72-a92783b080d4",
    "user_pid": "1ee3dcff-2c3f-62f4-8ac6-2eb81d7f4699",
    "type": "spin_off",
    "asset_id": 1477,
    "asset_symbol": "BKR",
    "time": "2024-05-23T10:08:49Z",
    "asset_amount": "3.05300681",
    "fiat_id": null,
    "fiat_symbol": null,
    "fiat_amount": null,
    "additional_details": {
      "id_defined_for": "wallet_transaction",
      "type_defined_for": "asset",
      "action": "spin_off",
      "type": "payout",
      "direction": "incoming",
      "credited_at": "2024-05-23T08:45:36Z",
      "asset_group": "stock",
      "asset_price": null,
      "asset_price_including_fee": null,
      "asset_price_fiat_id": null
    }
  }
}

Example 3: 1 Transaction

There might be other rare cases with just one transaction (only the 3rd one), in case the initial stock was sold before the spin-off was executed.

{
    "params": {
      "id": "1ef18df7-d991-6054-a4ec-e7076b7cae58",
      "ca_id": "1ef18dde-4f34-646a-8b72-a92783b080d4",
      "user_pid": "1ee3dcff-2c3f-62f4-8ac6-2eb81d7f4699",
      "type": "spin_off",
      "asset_id": 1479,
      "asset_symbol": "SAB",
      "time": "2024-05-23T10:08:50Z",
      "asset_amount": "1.5265034",
      "fiat_id": null,
      "fiat_symbol": null,
      "fiat_amount": null,
      "additional_details": {
        "id_defined_for": "wallet_transaction",
        "type_defined_for": "asset",
        "action": "spin_off",
        "type": "payout",
        "direction": "incoming",
        "credited_at": "2024-05-23T08:45:36Z",
        "asset_group": "stock",
        "asset_price": null,
        "asset_price_including_fee": null,
        "asset_price_fiat_id": null
      }
    }
}
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": {
    }
}