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
      }
    }
}

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": "b86c034b-efe3-11eb-b56f-0691764446a7",
    "asset_symbol": "HCC",
    "time": "2024-04-25T12:46:23Z",
    "asset_amount": "-2.00000000",
    "fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
    "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": "ea96ccef-edee-11eb-9bf0-06502b1fe55d"
    }
  }
}

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": "b86c034b-efe3-11eb-b56f-0691764446a7",
    "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": "2e910f38-d05f-11ec-a6ac-0a686dc2c129",
    "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": "368b7c66-d05f-11ec-a6ac-0a686dc2c129",
    "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": "ea96ccef-edee-11eb-9bf0-06502b1fe55d"
    }
  }
}

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": "257ce2d5-4e18-11ed-9fd4-0a20f3bbd759",
    "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": "775324e0-c551-11ec-a6ac-0a686dc2c129",
    "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": "378bdc66-d05f-11ec-a6ac-0a686dc2c129",
    "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": "355db876-d05f-11ec-a6ac-0a686dc2c129",
    "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": "39ef188b-5382-11ec-b276-0a69e15c2b31",
            "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": "39ef188b-5382-11ec-b276-0a69e15c2b31",
      "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": "3a04ce9b-5382-11ec-b276-0a69e15c2b31",
      "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": "39ef188b-5382-11ec-b276-0a69e15c2b31",
            "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": "39ef188b-5382-11ec-b276-0a69e15c2b31",
      "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": "3a04ce9b-5382-11ec-b276-0a69e15c2b31",
      "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
      }
    }
}

This webhook is designed to communicate various user-related actions — such as verification, blacklisting, or inactivation — which are conducted by a third-party service. When the third-party service completes an action, the webhook instantly relays the outcome:

• Verification: It notifies whether the user's verification process has succeeded or failed after analysing the provided documents.
• Blacklisting: It alerts when a user has been added to or updated on the blacklist, usually due to breaching terms of service or other predefined criteria.
• Inactivation: It sends a notification if a user's account has been deactivated, which may occur for various reasons.

By subscribing to this webhook, partners can ensure they are immediately informed of critical updates to user status, enabling prompt and appropriate responses within their systems.

This webhook provides real-time updates on cryptocurrency deposit and withdrawal transactions.

Given the asynchronous nature of crypto transfers, this webhook promptly notifies partners about transaction status changes, allowing for efficient handling of user assets and account management. This notification includes comprehensive details such as transaction identifiers, amounts, fees, and status, ensuring partners have the necessary information for accurate and timely processing.

This webhook is used to notify the Partner about specific settlement processes listed below that take place between Bitpanda and the Partner:

• Top-Up (Lower Threshold)

  Event triggered when the partner's balance on our side drops below a predetermined lower threshold as a result of a buy trade. It serves to notify partners that they need to top up their account to maintain their trading activities without interruption. Once the partner replenishes their balance, and it no longer falls under the lower limit, the notifications cease until such a condition is met again.

• Top-Up (Daily Settlement)

  This webhook provides a daily notification about the partner's current wallet balance compared to a set baseline. It helps manage financial resources by informing the partner of the need to deposit funds if the current balance falls short of the baseline. If the amount_to_deposit is zero, indicating no need for additional funds, the notification is not sent.

This webhook is used to notify the Partner about specific settlement processes listed below that take place between Bitpanda and the Partner:

• Top-Up (Lower Threshold)

  Event triggered when the partner's balance on our side drops below a predetermined lower threshold as a result of a buy trade. It serves to notify partners that they need to top up their account to maintain their trading activities without interruption. Once the partner replenishes their balance, and it no longer falls under the lower limit, the notifications cease until such a condition is met again.

• Top-Up (Daily Settlement)

  This webhook provides a daily notification about the partner's current wallet balance compared to a set baseline. It helps manage financial resources by informing the partner of the need to deposit funds if the current balance falls short of the baseline. If the amount_to_deposit is zero, indicating no need for additional funds, the notification is not sent.

This webhook confirms that a deposit made by the partner into Bitpanda bank account has been successfully received. It ensures that partners are immediately informed about the status of their deposited funds.

Note: The reference number in the request body is the same as used in the request for the Create new domain deposit endpoint.

This webhook confirms that a deposit made by the partner into Bitpanda bank account has been successfully received. It ensures that partners are immediately informed about the status of their deposited funds.

Note: The reference number in the request body is the same as used in the request for the Create new domain deposit endpoint.

This webhook is triggered when Bitpanda initiates send money to partner account

This webhook is triggered when Bitpanda initiates send money to partner account

This webhook notifies partners when a money transfer from our platform to their account has been initiated successfully. It gives partners timely updates about fund transfers that affect their accounts.

The reference number in the request body is the same as used in the request for the Create new domain deposit endpoint.

This webhook notifies partners when a money transfer from our platform to their account has been initiated successfully. It gives partners timely updates about fund transfers that affect their accounts.

The reference number in the request body is the same as used in the request for the Create new domain deposit endpoint.

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
  }
}

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:

• 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

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",
    "type_defined_for": "asset",
    "direction": "incoming",
    "created_at": "2024-05-21T17:05:55Z",
    "fiat_id": null,
    "fiat_amount": null,
    "related_offer_id": null,
    "asset_fee": "0.05297462"
  }
}

Giveaway

{
  "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,
    "asset_fee": null
  }
}

Tax Refund

{
  "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",
    "asset_fee": null
  }
}

Deduction

{
  "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,
    "asset_fee": 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",
    "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",
    "asset_fee": null
  }
}

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:

• 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

Staking Reward

{
  "params": {
    "id": "1ef17946-33ef-6bca-be62-6b4cda1f924b",
    "user_id": "1eda3a0b-7a31-60a2-90ec-465a39bfb319",
    "asset_id": "b86c034b-efe3-11eb-b56f-0691764446a7",
    "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,
    "asset_fee": "0.05297462"
  }
}

Giveaway

{
  "params": {
    "id": "a790b35b-1a11-46e5-98be-49dc3dfb9b3f",
    "user_id": "1ef01723-f676-6210-a69d-ebda6451bef7",
    "asset_id": "b86c034b-efe3-11eb-b56f-0691764446a7",
    "asset_amount": "0.9622527",
    "type": "giveaway",
    "type_defined_for": "asset",
    "direction": "incoming",
    "created_at": "2024-05-22T14:31:15Z",
    "fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
    "fiat_amount": "100.70327009",
    "related_offer_id": null,
    "asset_fee": null
  }
}

Tax Refund

{
  "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": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
    "fiat_amount": "4.95",
    "related_offer_id": "4a296047-01b1-4e60-a41a-592b9a33573b",
    "asset_fee": null
  }
}

Deduction

{
  "params": {
    "id": "4be2b00d-f69c-45d0-9d13-70f60082c68b",
    "user_id": "1ef01723-f676-6210-a69d-ebda6451bef7",
    "asset_id": "b86c034b-efe3-11eb-b56f-0691764446a7",
    "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,
    "asset_fee": null
  }
}

OTC Trade

{
  "params": {
    "id": "b9299c2e-eb39-59a2-a4af-88417cc4e803",
    "user_id": "1ef18dea-b7e7-6abe-bde8-23eb6307d6b5",
    "asset_id": "b86c034b-efe3-11eb-b56f-0691764446a7",
    "asset_amount": "0.11803707",
    "type": "otc_trade",
    "type_defined_for": "asset",
    "direction": "outgoing",
    "created_at": "2024-05-23T09:54:38Z",
    "fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
    "fiat_amount": "59.36",
    "related_offer_id": "2018c32b-49c4-4fe5-bf15-2ba6cdb7138a",
    "asset_fee": null
  }
}

The webhook is used to alert partners about the upcoming execution of a trade related to a Savings Plan, allowing them to prepare and reserve the funds.

The webhook is used to alert partners about the upcoming execution of a trade related to a Savings Plan, allowing them to prepare and reserve the funds.

This webhook is for informing partners about the successful execution of a savings plan trade. It confirms that a trade has been completed as planned, providing partners with the outcome of the transaction. The notification differentiates between success and failure, ensuring that only final statuses are communicated.

This webhook alerts partners when a savings plan trade encounters errors during execution. It communicates issues that may affect the completion of a trade, such as technical failures or business issues detailed in the error message.

This webhook is for informing partners about the auto cancel of a savings plan. Due to events like corporate or crypto actions, such as delisting, stock merger, cash merger or crypto merger, certain assets are closed so savings plans can no longer be active.

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"
         },
       ]
     }
   }
   

These notifications allow you to receive real-time updates regarding the status of automated orders. It ensures seamless communication and timely updates enabling you to take necessary actions promptly, like notifying further your users. The events include the following statuses:

• Finished - Indicates that an automated order has been successfully executed.
• Failed - Indicates that an automated order has failed due to any processing error.
• Cancelled - Indicates that an automated order has been cancelled by the user (no fail_reason) or by the system due to specific reasons such as delisting an asset.

Examples

1. Finished

{
  "params": {
    "user_id": "1ef2efc7-1d0c-658b-8bdb-7398fd6afe94",
    "domain_slug": "b2b2c_qa",
    "trade_id": "01ef5401-cf20-6165-b0cb-3e1e8185fb3c",
    "asset_id": "a49406ee-ee33-11ec-aafe-062d595118ef",
    "fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
    "asset_amount": "2.43667276",
    "fiat_amount": "1",
    "type": "buy",
    "status": "finished",
    "created_at": "2024-08-06T14:40:21.848515Z"
  }
}

2. Failed (with reason)

{
  "params": {
    "user_id": "1ef2efc7-1d0c-658b-8bdb-7398fd6afe94",
    "domain_slug": "b2b2c_qa",
    "trade_id": "01ef52f5-9f60-60e1-8165-8a61e573af23",
    "asset_id": "a49406ee-ee33-11ec-aafe-062d595118ef",
    "fiat_id": "ea96d0fc-edee-11eb-9bf0-06502b1fe55d",
    "type": "buy",
    "status": "failed",
    "fail_reason": "slippage.evaluation",
    "created_at": "2024-08-05T06:40:36.612535Z"
  }
}

3. Cancelled (no reason, user action)

{
  "params": {
    "user_id": "1ef50a17-5397-610c-bc4b-5de229acd5eb",
    "domain_slug": "b2b2c_qa",
    "trade_id": "01ef50be-98ba-678f-aeb0-164c3edf7ee5",
    "asset_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
    "fiat_id": "1eebacd8-7001-6ebe-97ca-dd9f96ed2091",
    "type": "buy",
    "status": "cancelled",
    "created_at": "2024-08-02T11:01:40.81443Z"
  }

4. Cancelled (with reason, auto-canceling)

{
  "params": {
    "user_id": "1ef50a17-5397-610c-bc4b-5de229acd5eb",
    "domain_slug": "b2b2c_qa",
    "trade_id": "01ef50da-52c7-6848-9b66-8a418b68cf6f",
    "asset_id": "1eebacd8-7001-6ebe-97ca-dd9f96ed2091",
    "fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
    "type": "buy",
    "status": "cancelled",
    "fail_reason": "cancelled.due.to.asset.disabling",
    "created_at": "2024-08-02T14:20:09.370021Z"
  }
}

This webhook is designed to notify partners about the generation of reports for users.

The notification includes details about the report, such as its type, creation timestamp, and the trigger method. This webhook ensures that partners are promptly informed about new report availability, whether they are scheduled or generated on demand, allowing for timely access and user assistance.