> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whitebit.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhook HTTP API

> Configure webhook callbacks to receive real-time notifications for deposits and withdrawals on WhiteBIT.

<CardGroup>
  <Card title="How to use" href="#how-to-use" icon="question" horizontal />

  <Card title="Requirements" href="#requirements" icon="clipboard" horizontal />

  <Card title="Webhook methods" href="#webhook-methods" icon="rss" horizontal />

  <Card title="WhiteBIT withdraw from main balance" href="#whitebit-withdraw-from-main-balance" icon="arrow-down" horizontal />
</CardGroup>

## Why Webhooks?

Webhooks deliver real-time HTTP notifications when events occur on a WhiteBIT account — deposits arriving, withdrawals completing, codes being applied, and refunds processing. Without webhooks, the only alternative is polling the deposit/withdrawal history endpoints repeatedly.

**Webhooks vs polling:**

|                 | Webhooks                                                          | Polling                                            |
| --------------- | ----------------------------------------------------------------- | -------------------------------------------------- |
| Latency         | Real-time (seconds)                                               | Depends on polling interval                        |
| Server load     | Event-driven — no wasted requests                                 | Constant requests, mostly empty                    |
| Reliability     | \~3 delivery attempts spaced roughly hourly over a \~1-day window | As reliable as the polling loop                    |
| Recommended for | Production payment flows                                          | Fallback for outages exceeding the delivery window |

<Note>
  There is no webhook replay mechanism. If every delivery attempt fails, the event is dropped. Implement polling of the [deposit / withdrawal history](/api-reference/account-wallet/get-deposit-withdraw-history) endpoint as a fallback so events can be reconciled after extended consumer downtime.
</Note>

**Common use cases:**

* **Payment processing** — Detect incoming deposits and credit end users automatically
* **Withdrawal monitoring** — Track withdrawal lifecycle from creation to completion or cancellation
* **Code redemption** — Receive notification when a WhiteBIT Code is applied
* **Refund handling** — Detect successful or failed refunds for reconciliation

## How to use

1. Log in to whitebit.com.
2. Open the API keys tab.
3. Select the web-hook configuration tab for the API keys.
4. Paste the correct URI for the web server to process web-hook calls.
5. Press Generate a new key button and toggle the activation switcher to "Activated".

<Warning>
  The secret key is shown only once. Save it in a secure key store.
</Warning>

## Requirements

### For web hook keys generation

Before using webhooks, verify ownership of the domain set as the webhook destination. Use one of three methods:

1. Add a TXT DNS record to the domain with the webhook public key.
2. Add the plain text file `whiteBIT-verification.txt` to the root domain folder and provide public web access. Place the public webhook key in the file.
3. Implement the `/whiteBIT-verification` endpoint to respond with 200 OK and return a JSON array containing the public webhook key. Example: `["<public-webhook-key>"]`

Passing one of these checks enables the webhook.

### For processing web-hook requests

All web hook requests are performing using POST method and with application/json content type. Consumer server should respond with 200 HTTP status code. If the consumer cannot handle the webhook, the platform retries delivery a small number of times spaced roughly an hour apart, over a window of about one day. Treat the exact cadence as best-effort, not a contract, and pair webhook consumption with periodic history polling for reconciliation.

#### Body data

All web-hook requests are performing with

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "method": "string",
  "params": {
    "nonce": 0
  },
  "id": "uniqueID"
}
```

**method** - string. The name of method which was evaluated. Web hooks API supports such web-hook methods:

* **code.apply**. Performs when code owned by a customer was applied.

**id** - string. Uuid to identify every request.

**params** - the request payload. Contains data about the actions triggering the webhook call. The field also contains a [nonce](/glossary#nonce). **'nonce'** - a number always **greater** than the previous request’s nonce number

#### Request headers

Also, all request contains additional data in headers:

1. `'Content-type': 'application/json'`
2. `'X-TXC-APIKEY': api_key` - the WhiteBIT webhook API key
3. `'X-TXC-PAYLOAD': payload'` - where payload is base64-encoded body data
4. `'X-TXC-SIGNATURE': signature` - where signature is `hex(HMAC_SHA512(payload), key=api_secret))`

On the consumer side, process the security headers to verify the request originated from WhiteBIT.

## WebHook Methods

### WhiteBIT code apply

Performed when [code](/glossary#whitebit-codes) was applied. Request example:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "method": "code.apply",
  "params": {
    "code": "<SOME_WHITE_BIT_CODE>",
    "nonce": 1
  },
  "id": "45a1d85d-2fdf-483e-8dfa-6d253148c730"
}
```

### WhiteBIT deposit to main balance

Performed when deposit was accepted. Request example:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "method": "deposit.accepted",
  "params": {
    "address": "wallet address", // deposit address
    "amount": "0.000600000000000000", // amount of deposit
    "createdAt": 1593437922, // timestamp of deposit
    "currency": "Tether US", // deposit currency
    "description": "", // deposit description
    "fee": "0.000000000000000000", // deposit fee
    "memo": "", // deposit memo
    "method": 1, // called method 1 - deposit, 2 - withdraw
    "network": "ERC20", // if currency is multi network
    "status": 15, // transactions status
    "ticker": "USDT_ETH", // deposit currency ticker
    "transactionHash": "transaction hash", // deposit transaction hash
    "uniqueId": null, // unique Id of deposit
    "confirmations": {
      // if transaction has confirmations info it will display here
      "actual": 1, // current block confirmations
      "required": 2 // required block confirmation for successful deposit
    }
  },
  "id": "uuid"
}
```

Performed when deposit was update. Request example:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "method": "deposit.updated",
  "params": {
    "address": "wallet address", // deposit address
    "amount": "0.000600000000000000", // amount of deposit
    "createdAt": 1593437922, // timestamp of deposit
    "currency": "Tether US", // deposit currency
    "description": "update", // deposit description
    "fee": "0.000000000000000000", // deposit fee
    "memo": "", // deposit memo
    "network": "ERC20", // if currency is multi network
    "status": 15, // transactions status
    "ticker": "USDT_ETH", // deposit currency ticker
    "transactionHash": "transaction hash", // deposit transaction hash
    "uniqueId": null, // unique Id of deposit
    "confirmations": {
      // if transaction has confirmations info it will display here
      "actual": 1, // current block confirmations
      "required": 2 // required block confirmation for successful deposit
    }
  },
  "id": "uuid"
}
```

Performed when the deposit was processed and is available on the balance. Request example:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "method": "deposit.processed",
  "params": {
    "address": "wallet address", // deposit address
    "amount": "0.000600000000000000", // amount of deposit
    "createdAt": 1593437922, // timestamp of deposit
    "currency": "Tether US", // deposit currency
    "description": "", // deposit description
    "fee": "0.000000000000000000", // deposit fee
    "memo": "", // deposit memo
    "method": 1, // called method 1 - deposit, 2 - withdraw
    "network": "ERC20", // if currency is multi network
    "status": 15, // transactions status
    "ticker": "USDT_ETH", // deposit currency ticker
    "transactionHash": "transaction hash", // deposit transaction hash
    "uniqueId": null, // unique Id of deposit
    "confirmations": {
      // if transaction has confirmations info it will display here
      "actual": 1, // current block confirmations
      "required": 2 // required block confirmation for successful deposit
    }
  },
  "id": "uuid"
}
```

Performed when deposit was canceled. Request example:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "method": "deposit.canceled",
  "params": {
    "address": "wallet address", // deposit address
    "amount": "100.00", // amount of deposit
    "createdAt": 1593437922, // timestamp of deposit
    "currency": "Tether US", // deposit currency
    "description": "", // deposit description
    "fee": "0.000000000000000000", // deposit fee
    "memo": "", // deposit memo
    "method": 1, // called method 1 - deposit, 2 - withdraw
    "network": "ERC20", // if currency is multi network, "null" if no multi network
    "status": 15, // transactions status
    "ticker": "USDT_ETH", // deposit currency ticker
    "transactionHash": "transaction hash", // deposit transaction hash
    "uniqueId": null, // unique Id of deposit
    "confirmations": {
      // if transaction has confirmations info it will display here
      "actual": 1, // current block confirmations
      "required": 32 // required block confirmation for successful deposit
    }
  },
  "id": "uuid"
}
```

#### Travel Rule deposit events (EEA)

For EEA users, deposits may be frozen pending Travel Rule verification. When a deposit is frozen, the webhook delivers deposit.updated events with Travel Rule-specific status codes. The end user must complete Travel Rule verification through the WhiteBIT platform UI — the partner cannot submit Travel Rule data via API.

For details on Travel Rule requirements and the travelRule object for withdrawals, see [Regulatory Compliance](/institutional/compliance).

Deposit status codes:

| Code | Status                        | Description                                              |
| ---- | ----------------------------- | -------------------------------------------------------- |
| 15   | Pending                       | Deposit detected, awaiting confirmations                 |
| 27   | Travel Rule Frozen            | Deposit frozen — Travel Rule verification required (EEA) |
| 28   | Travel Rule Frozen Processing | Travel Rule verification in progress (EEA)               |

### WhiteBIT withdraw from main balance

Performed when withdraw was created. Request example:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "method": "withdraw.unconfirmed",
  "params": {
    "address": "wallet address", // withdraw address
    "amount": "100.00", // amount of withdraw
    "createdAt": 1593437922, // timestamp of withdraw
    "currency": "Tether US", // withdraw currency
    "ticker": "USDT", // withdraw currency ticker
    "description": null, // withdraw description
    "fee": "0.000000000000000000", // withdraw fee
    "memo": "", // withdraw memo
    "method": 2, // called method 1 - deposit, 2 - withdraw
    "network": "TRC20", // if currency is multi network, "null" if no multi network
    "status": 15, // transactions status
    "transactionHash": "transaction hash", // withdraw transaction hash
    "uniqueId": null // unique Id of withdraw
  },
  "id": "uuid"
}
```

Performed when withdraw is pending. Request example:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "method": "withdraw.pending",
  "params": {
    "address": "wallet address", // withdraw address
    "amount": "100.00", // amount of withdraw
    "createdAt": 1593437922, // timestamp of withdraw
    "currency": "Tether US", // withdraw currency
    "ticker": "USDT", // withdraw currency ticker
    "description": null, // withdraw description
    "fee": "0.000000000000000000", // withdraw fee
    "memo": "", // withdraw memo
    "method": 2, // called method 1 - deposit, 2 - withdraw
    "network": "TRC20", // if currency is multi network, "null" if no multi network
    "status": 15, // transactions status
    "transactionHash": "transaction hash", // withdraw transaction hash
    "uniqueId": null // unique Id of withdraw
  },
  "id": "uuid"
}
```

Performed when withdraw was canceled. Request example:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "method": "withdraw.canceled",
  "params": {
    "address": "wallet address", // withdraw address
    "amount": "100.00", // amount of withdraw
    "createdAt": 1593437922, // timestamp of withdraw
    "currency": "Tether US", // withdraw currency
    "ticker": "USDT", // withdraw currency ticker
    "description": null, // withdraw description
    "fee": "0.000000000000000000", // withdraw fee
    "memo": "", // withdraw memo
    "method": 2, // called method 1 - deposit, 2 - withdraw
    "network": "TRC20", // if currency is multi network, "null" if no multi network
    "status": 15, // transactions status
    "transactionHash": "transaction hash", // withdraw transaction hash
    "uniqueId": null // unique Id of withdraw
  },
  "id": "uuid"
}
```

Performed when withdraw was completed. Request example:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "method": "withdraw.successful",
  "params": {
    "address": "wallet address", // withdraw address
    "amount": "100.00", // amount of withdraw
    "createdAt": 1593437922, // timestamp of withdraw
    "currency": "Tether US", // withdraw currency
    "ticker": "USDT", // withdraw currency ticker
    "description": null, // withdraw description
    "fee": "0.000000000000000000", // withdraw fee
    "memo": "", // withdraw memo
    "method": 2, // called method 1 - deposit, 2 - withdraw
    "network": "TRC20", // if currency is multi network, "null" if no multi network
    "status": 15, // transactions status
    "transactionHash": "transaction hash", // withdraw transaction hash
    "uniqueId": null // unique Id of withdraw
  },
  "id": "uuid"
}
```

### WhiteBIT refund successful

Triggered after the system successfully completes a refund. Request example:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "method": "refund.successful",
  "params": {
    "transactionId": "5e112b38-...",
    "status": "completed",
    "refundAddress": "GDTSOI56...",
    "depositAmount": "100",
    "currency": "Tether USDT",
    "ticker": "USDT",
    "network": "ERC-20",
    "createdAt": 1733924412,
    "processedAt": 1733925012,
    "refundNetworkFee": "1",
    "refundAmount": "99",
    "refundHash": "0x767ebd2...",
    "nonce": 0
  },
  "id": "uuid"
}
```

### WhiteBIT refund failed

Triggered after the system fails to complete a refund. The system rejects the refund if the destination address does not support the required network or asset, or if validation fails. Use a different address or contact support. Request example:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "method": "refund.failed",
  "params": {
    "transactionId": "5e112b38-...",
    "status": "failed",
    "refundAddress": "GDTSOI56...",
    "depositAmount": "100",
    "currency": "Tether USDT",
    "ticker": "USDT",
    "network": "ERC-20",
    "createdAt": 1733924412,
    "processedAt": 1733925012,
    "nonce": 0
  },
  "id": "uuid"
}
```

## What's Next

<CardGroup cols={2}>
  <Card title="Payment Integration" icon="credit-card" href="/guides/payment-integration">
    End-to-end guide for deposit and withdrawal processing with webhook reconciliation.
  </Card>

  <Card title="Security Best Practices" icon="shield" href="/best-practices/security">
    HMAC-SHA512 signature verification, API key management, and production hardening.
  </Card>
</CardGroup>