Examples
Dividends
For example, when there's a fiat dividend payout, Partner's user portfolio will increase with the amount of the dividend which was paid out.
The dividends can be of two types:
-
paid in fiat
(in this example EUR )
{ "params": { "id": "abcd1234-12ab-ab12-abc123123456", "ca_id": "abcdefgh-abcd-ab12-abc123123457", "user_pid": "1234567a-8822-489b-8e25-123456789890", "type": "dividend", "asset_id": 2465, "asset_symbol": "GRAB", "time": "2022-09-24T12:11:59+00:00", "fiat_id": 1, "fiat_symbol": "EUR", "fiat_amount": "74.39000000" } } -
paid in asset
( in this example AMZ )
{ "params": { "id": "abcd1234-12ab-ab12-abc123123456", "ca_id": "abcdefgh-abcd-ab12-abc123123457", "user_pid": "1234567a-8822-489b-8e25-123456789890", "type": "dividend", "asset_id": 2465, "asset_symbol": "AMZ", "time": "2022-09-24T13:06:30+00:00", "asset_amount": "12.12617834" } }
Some complex corporate actions consist of a couple of operations. For those, you will receive two or three webhook notifications, which correspond to the same corporate action.
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
You will receive three notifications:
-
one with a negative value of the
asset_amount, which informs about removal of the owned asset ABC 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 } } } -
second one having a positive value of
asset_amount, showing the quantity of asset ABC, which the user shall still own (and is added 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 } } } -
third one having a positive value of
asset_amount, showing how much of asset XYZ 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 } } }