> For the complete documentation index, see [llms.txt](https://docs.txn.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.txn.io/transactions/crypto-deposit-webhooks.md).

# Crypto deposit webhooks

Txn sends a crypto deposit webhook when a transfer to one of your account addresses is detected, when it is put on hold, and when it reaches a final status. Payments to invoice and channel addresses are reported as [invoice webhooks](https://docs.txn.io/invoices/invoice-webhooks.md) and [channel webhooks](https://docs.txn.io/channels/channel-webhooks.md) instead.

Unlike the other webhooks, this payload does not mirror its Read endpoint. [Reading crypto deposit](https://docs.txn.io/transactions/reading-crypto-deposit.md) returns the account transaction in `data` and the deposit in `included[]`. The webhook carries the `coinDeposits` entity itself in `data`, with the `network` and `addresses` entities in `included[]`. `data.id` is the same ID in both, so you can pass it to Reading crypto deposit to fetch the account transaction and its balance.

For the lifecycle of a deposit, see [Crypto deposit status flow](https://docs.txn.io/transactions/crypto-deposit-status-flow.md). For configuring webhook URLs, retry behaviour, source IPs, and signature verification, see the general [Webhooks](https://docs.txn.io/api-basics/webhooks.md) section.

**Payload**

| Name                                              | Type   | Description                                                                                                                                                                                                                                |
| ------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| data.id                                           | string | Deposit ID. The same ID identifies the account transaction in [Reading crypto deposit](https://docs.txn.io/transactions/reading-crypto-deposit.md).                                                                                        |
| data.type                                         | string | Always `coinDeposits`.                                                                                                                                                                                                                     |
| data.attributes.accountId                         | string | ID of the account the deposit is credited to.                                                                                                                                                                                              |
| data.attributes.amount                            | string | Amount received, in `currencyCode`.                                                                                                                                                                                                        |
| data.attributes.currencyCode                      | string | Currency of the deposit.                                                                                                                                                                                                                   |
| data.attributes.txHash                            | string | On-chain transaction hash.                                                                                                                                                                                                                 |
| data.attributes.sourceAddresses                   | array  | Address or addresses the funds were sent from. Several entries are possible on UTXO networks (BTC, LTC, BCH, DOGE) when the sender's wallet combined inputs.                                                                               |
| data.attributes.simplifiedState                   | string | Deposit status: `pending`, `on_hold`, `travel_rule_waiting`, `completed`, `rejected` or `cancelled`. Use this field in your integration. See [Crypto deposit status flow](https://docs.txn.io/transactions/crypto-deposit-status-flow.md). |
| data.attributes.state                             | string | Internal Txn state. Ignore it and use `simplifiedState`.                                                                                                                                                                                   |
| data.attributes.reference                         | string | Deposit reference. `null` for deposits to account addresses.                                                                                                                                                                               |
| data.attributes.riskScore                         | string | Risk score of the source address from on-chain analytics screening, when one was returned. Otherwise `null`.                                                                                                                               |
| data.attributes.clusterCategory                   | string | Category of the entity the source address is attributed to, for example `Exchange`. `null` until screening completes.                                                                                                                      |
| data.attributes.clusterName                       | string | Name of the entity the source address is attributed to. `null` until screening completes.                                                                                                                                                  |
| data.attributes.createdAt                         | string | When Txn detected the deposit. See [Date and time format](https://docs.txn.io/api-basics/date-and-time-format.md).                                                                                                                         |
| data.relationships.address                        | object | The receiving address. `data.type` is `addresses`; the entity is in `included[]`.                                                                                                                                                          |
| data.relationships.network                        | object | The network the deposit arrived on. `data.type` is `network`; the entity is in `included[]`.                                                                                                                                               |
| data.relationships.author                         | object | Always `null` for deposits, so `included[]` carries no `apiKeys` entity.                                                                                                                                                                   |
| included\[].type(network).attributes.code         | string | Network code, for example `ttrx:usdt`. See [Supported currencies](https://docs.txn.io/api-basics/supported-currencies.md).                                                                                                                 |
| included\[].type(network).attributes.name         | string | Network name, for example `Tron (TRC20)`.                                                                                                                                                                                                  |
| included\[].type(network).attributes.currencyCode | string | Currency of the network.                                                                                                                                                                                                                   |
| included\[].type(addresses).attributes.value      | string | The address the deposit was received at.                                                                                                                                                                                                   |
| included\[].type(addresses).attributes.label      | string | Address label.                                                                                                                                                                                                                             |
| included\[].type(addresses).attributes.createdAt  | string | When the address was created.                                                                                                                                                                                                              |

**Examples**

The examples below were captured from Sandbox: a USDT transfer on the Tron test network to an account address, detected and then completed.

{% tabs %}
{% tab title="Status Pending" %}

```json
{
  "data": {
    "attributes": {
      "accountId": "e289de2b-37bd-4eff-b832-f754c31a2d95",
      "amount": "5.000000",
      "clusterCategory": null,
      "clusterName": null,
      "createdAt": "2026-11-04T12:30:30.453Z",
      "currencyCode": "USDT",
      "reference": null,
      "riskScore": null,
      "simplifiedState": "pending",
      "sourceAddresses": [
        "TPE3bwwmwMBHyddFpruHeFWMVUibxs3rq8"
      ],
      "state": "unconfirmed",
      "txHash": "4b60f4640aa55a1d88a36c902457de2af835ec98285a9668d4e616d3f2f08e83"
    },
    "id": "17c7b674-1c65-44b4-8d04-61777d4be3df",
    "relationships": {
      "address": {
        "data": {
          "id": "38ca46fa-8bd8-4fc4-8d7b-d1fa4cacaa82",
          "type": "addresses"
        }
      },
      "author": {
        "data": null
      },
      "network": {
        "data": {
          "id": "8ededca3-a1cd-4b46-8c3a-14915f706ab2",
          "type": "network"
        }
      }
    },
    "type": "coinDeposits"
  },
  "included": [
    {
      "attributes": {
        "code": "ttrx:usdt",
        "currencyCode": "USDT",
        "name": "Tron (TRC20)"
      },
      "id": "8ededca3-a1cd-4b46-8c3a-14915f706ab2",
      "type": "network"
    },
    {
      "attributes": {
        "createdAt": "2026-11-01T13:26:34.427Z",
        "label": "Tron (TRC20)",
        "value": "TRdhEZGqveMwtnpGZDfNhbMDKUJpQSWE7X"
      },
      "id": "38ca46fa-8bd8-4fc4-8d7b-d1fa4cacaa82",
      "relationships": {
        "account": {
          "meta": {
            "included": false
          }
        },
        "network": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "addresses"
    }
  ],
  "meta": {}
}
```

{% endtab %}

{% tab title="Status Completed" %}

```json
{
  "data": {
    "attributes": {
      "accountId": "e289de2b-37bd-4eff-b832-f754c31a2d95",
      "amount": "5.000000",
      "clusterCategory": "Exchange",
      "clusterName": "Test ENV",
      "createdAt": "2026-11-04T12:30:30.453Z",
      "currencyCode": "USDT",
      "reference": null,
      "riskScore": null,
      "simplifiedState": "completed",
      "sourceAddresses": [
        "TPE3bwwmwMBHyddFpruHeFWMVUibxs3rq8"
      ],
      "state": "completed",
      "txHash": "4b60f4640aa55a1d88a36c902457de2af835ec98285a9668d4e616d3f2f08e83"
    },
    "id": "17c7b674-1c65-44b4-8d04-61777d4be3df",
    "relationships": {
      "address": {
        "data": {
          "id": "38ca46fa-8bd8-4fc4-8d7b-d1fa4cacaa82",
          "type": "addresses"
        }
      },
      "author": {
        "data": null
      },
      "network": {
        "data": {
          "id": "8ededca3-a1cd-4b46-8c3a-14915f706ab2",
          "type": "network"
        }
      }
    },
    "type": "coinDeposits"
  },
  "included": [
    {
      "attributes": {
        "code": "ttrx:usdt",
        "currencyCode": "USDT",
        "name": "Tron (TRC20)"
      },
      "id": "8ededca3-a1cd-4b46-8c3a-14915f706ab2",
      "type": "network"
    },
    {
      "attributes": {
        "createdAt": "2026-11-01T13:26:34.427Z",
        "label": "Tron (TRC20)",
        "value": "TRdhEZGqveMwtnpGZDfNhbMDKUJpQSWE7X"
      },
      "id": "38ca46fa-8bd8-4fc4-8d7b-d1fa4cacaa82",
      "relationships": {
        "account": {
          "meta": {
            "included": false
          }
        },
        "network": {
          "meta": {
            "included": false
          }
        }
      },
      "type": "addresses"
    }
  ],
  "meta": {}
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.txn.io/transactions/crypto-deposit-webhooks.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
