Ban User Webhook
When a user is banned from the platform, a notification will be sent with the following structure:| Key | Type | Description |
|---|---|---|
payload | object | Contains the webhook payload data. |
reason | string | The reason why the user was banned. |
is_banned | boolean | Indicates the user’s banned status. Will be true for ban events. |
updated_at | string | ISO datetime indicating when the user status was updated. |
end_user_id | string | End user’s external ref identifier. |
status | string | Current status of the user. Will be BANNED for ban events. |
event_type | string | Type of event. Will be USER.BANNED for ban events. |
issue_datetime | string | ISO datetime indicating when the webhook was issued. |
Unban User Webhook
When a user is unbanned from the platform, a notification will be sent with the following structure:| Key | Type | Description |
|---|---|---|
payload | object | Contains the webhook payload data. |
reason | string | The reason why the user was unbanned. |
is_banned | boolean | Indicates the user’s banned status. Will be false for unban events. |
updated_at | string | ISO datetime indicating when the user status was updated. |
status | string | Current status of the user. Will be ACTIVE for unban events. |
end_user_id | string | End user’s external ref identifier. |
event_type | string | Type of event. Will be USER.ACTIVE for active events. |
issue_datetime | string | ISO datetime indicating when the webhook was issued. |
Withdrawal Webhook
When a withdrawal is completed, a notification will be sent with the following structure:| Key | Type | Description |
|---|---|---|
payload | object | Contains the webhook payload data. |
id | string | Unique identifier for the withdrawal. |
hash | string | Transaction hash on the blockchain. |
amount | string | Amount withdrawn in the specified currency. |
status | string | Status of the withdrawal. Will be COMPLETED for completed withdrawals. |
txn_id | string | Internal transaction identifier. |
network | string | Blockchain network used for the withdrawal. |
op_type | string | Operation type. Will be WITHDRAWAL for withdrawal events. |
created_at | string | ISO datetime indicating when the withdrawal was created. |
create_date | string | ISO datetime indicating when the withdrawal was created. |
end_user_id | string | End user’s external ref identifier. |
currency_code | string | Currency code of the withdrawn asset. |
confirmation_date | string | ISO datetime indicating when the withdrawal was confirmed. |
address_destination | string | Destination address for the withdrawal. |
event_type | string | Type of event. Will be WITHDRAWAL.COMPLETED for completed withdrawals. |
issue_datetime | string | ISO datetime indicating when the webhook was issued. |
Deposit Webhook
When a deposit is completed, a notification will be sent with the following structure:| Key | Type | Description |
|---|---|---|
payload | object | Contains the webhook payload data. |
id | string | Unique identifier for the deposit. |
hash | string | Transaction hash on the blockchain. |
index | number | Transaction output index. |
amount | string | Amount deposited in the specified currency. |
reason | string | Additional reason of the blocked deposit. |
status | string | Status of the deposit. Will be COMPLETED for completed deposits. |
txn_id | string | Internal transaction identifier. |
network | string | Blockchain network used for the deposit. |
op_type | string | Operation type. Will be DEPOSIT for deposit events. |
created_at | string | ISO datetime indicating when the deposit was created. |
is_blocked | boolean | Indicates if the deposit is blocked. |
risk_score | number | Risk assessment score for the deposit (can be null). |
create_date | string | ISO datetime indicating when the deposit was created. |
end_user_id | string | End user’s external ref identifier. |
currency_code | string | Currency code of the deposited asset. |
confirmation_date | string | ISO datetime indicating when the deposit was confirmed. |
address_destination | string | Destination address for the deposit. |
event_type | string | Type of event. Will be DEPOSIT.COMPLETED for completed deposits. |
issue_datetime | string | ISO datetime indicating when the webhook was issued. |
Trade Webhook
When a trade is completed, a notification will be sent with the following structure:| Key | Type | Description |
|---|---|---|
payload | object | Contains the webhook payload data. |
id | string | Unique identifier for the trade. |
rate | string | Exchange rate used for the trade. |
status | string | Status of the trade. Will be COMPLETED for completed trades. |
txn_id | string | Internal transaction identifier. |
op_type | string | Operation type (e.g., BUY, SELL). |
quote_id | string | Identifier of the quote used for the trade. |
base_asset | string | Base asset currency code. |
base_amount | string | Amount of the base asset. |
charged_fee | string | Fee charged for the trade. |
create_date | string | ISO datetime indicating when the trade was created. |
end_user_id | string | End user’s external ref identifier. |
market_rate | string | Market rate at the time of the trade. |
quote_asset | string | Quote asset currency code. |
external_ref | string | External reference identifier. |
quote_amount | string | Amount of the quote asset. |
event_type | string | Type of event. Will be TRADE.COMPLETED for completed trades. |
issue_datetime | string | ISO datetime indicating when the webhook was issued. |
AutoSwap Webhook
When an AutoSwap is completed, a notification will be sent with the following structure:| Key | Type | Description |
|---|---|---|
payload | object | Contains the webhook payload data. |
id | string | Unique identifier for the AutoSwap. |
trade | object | Trade object containing all trade-related information. |
deposit | object | Deposit object containing all deposit-related information. |
withdrawal | object | Withdrawal object containing all withdrawal-related information. |
create_date | string | ISO datetime indicating when the AutoSwap was created. |
update_date | string | ISO datetime indicating when the AutoSwap was last updated. |
auto_swap_id | string | Unique identifier for the AutoSwap operation. |
error_reason | string | Error reason if the AutoSwap failed (can be null). |
event_type | string | Type of event. Will be AUTOSWAP.UPDATE for completed AutoSwaps. |
issue_datetime | string | ISO datetime indicating when the webhook was issued. |
trade, deposit, and withdrawal objects contain the same fields as their respective individual webhook payloads described above.