> 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/channels/channel-webhooks.md).

# Channel webhooks

Txn sends a channel webhook each time a channel deposit changes state. The payload mirrors the [Read channel deposit](https://docs.txn.io/channels/reading-channel-deposit.md) endpoint response.

You can receive more than one webhook with the same `status`. When a channel converts the deposit into another currency, Txn sends a second `pending` webhook once the conversion has executed, with `amount`, `exchangeRate`, `fee` and `localAmount` recalculated at the executed rate. Treat the values in the `completed` webhook as final.

The tabs below show example payloads for each status. For the lifecycle of a channel deposit, see [Channels deposit flow](https://docs.txn.io/channels/channels-deposit-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.

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

```json
{
  "data": {
    "attributes": {
      "address": "TUbXumfKqgrkGpdtZ1uLeboPPLds9EGbVN",
      "amount": "26.07",
      "amountCurrency": "EUR",
      "amountToLocalCurrencyRate": "1.5924759378",
      "channelId": "0bbac1e2-849c-4a0e-b864-a4a266e4248b",
      "clusterCategory": "Exchange",
      "clusterName": "Test ENV",
      "consolidationFee": "0.00",
      "createdAt": "2026-11-04T18:38:54.645Z",
      "exchangeRate": "0.877734",
      "fee": "0.26",
      "feeCurrency": "EUR",
      "hash": "98b860cee790708ec24ddecf2551cb71899a3f7d4c2540ce9de9060ab5d5c847",
      "localAmount": "41.93",
      "localCurrency": "AUD",
      "networkCode": "ttrx:usdt",
      "networkFee": "0.000000",
      "networkFeeCurrency": "TRX",
      "networkFeeLocalAmount": "0.00",
      "networkFeePayAmount": "0.000000",
      "networkName": "Tron (TRC20)",
      "payAmount": "30.000000",
      "payCurrency": "USDT",
      "payToLocalCurrencyRate": "1.3977702747889452",
      "reference": "2a63adee-4d02-4d26-9fad-b20ed2244594",
      "riskScore": null,
      "simplifiedState": "pending",
      "sourceAddresses": [
        "TTbGTMwUwA3mncLP7xqCZei1ekaNSgeAJe"
      ],
      "status": "pending",
      "updatedAt": "2026-11-04T18:38:54.645Z"
    },
    "id": "15056622-0ed9-448f-92aa-dede8b03804d",
    "relationships": {
      "account": {
        "meta": {
          "included": false
        }
      },
      "author": {
        "meta": {
          "included": false
        }
      }
    },
    "type": "channelTransactions"
  },
  "meta": {}
}
```

{% endtab %}

{% tab title="Status Completed" %}

```json
{
  "data": {
    "attributes": {
      "address": "TUbXumfKqgrkGpdtZ1uLeboPPLds9EGbVN",
      "amount": "26.07",
      "amountCurrency": "EUR",
      "amountToLocalCurrencyRate": "1.5923333195",
      "channelId": "0bbac1e2-849c-4a0e-b864-a4a266e4248b",
      "clusterCategory": "Exchange",
      "clusterName": "Test ENV",
      "consolidationFee": "0.00",
      "createdAt": "2026-11-04T18:38:54.645Z",
      "exchangeRate": "0.877734",
      "fee": "0.26",
      "feeCurrency": "EUR",
      "hash": "98b860cee790708ec24ddecf2551cb71899a3f7d4c2540ce9de9060ab5d5c847",
      "localAmount": "41.93",
      "localCurrency": "AUD",
      "networkCode": "ttrx:usdt",
      "networkFee": "0.000000",
      "networkFeeCurrency": "TRX",
      "networkFeeLocalAmount": "0.00",
      "networkFeePayAmount": "0.000000",
      "networkName": "Tron (TRC20)",
      "payAmount": "30.000000",
      "payCurrency": "USDT",
      "payToLocalCurrencyRate": "1.397645093858013",
      "reference": "2a63adee-4d02-4d26-9fad-b20ed2244594",
      "riskScore": null,
      "simplifiedState": "completed",
      "sourceAddresses": [
        "TTbGTMwUwA3mncLP7xqCZei1ekaNSgeAJe"
      ],
      "status": "completed",
      "updatedAt": "2026-11-04T18:39:00.783Z"
    },
    "id": "15056622-0ed9-448f-92aa-dede8b03804d",
    "relationships": {
      "account": {
        "meta": {
          "included": false
        }
      },
      "author": {
        "meta": {
          "included": false
        }
      }
    },
    "type": "channelTransactions"
  },
  "meta": {}
}
```

{% endtab %}

{% tab title="Status Rejected" %}

```json
{
  "data": {
    "attributes": {
      "address": "TE9dTePQppQ1HG7HLMbvgQbnvaJNwi9LEY",
      "amount": "8.38",
      "amountCurrency": "EUR",
      "amountToLocalCurrencyRate": "1.612010217",
      "channelId": "c83aeb04-11ee-4892-8913-80fb6f875d39",
      "clusterCategory": "Exchange",
      "clusterName": "Test ENV",
      "consolidationFee": "0.00",
      "createdAt": "2026-08-27T12:11:43.241Z",
      "exchangeRate": "0.8456679",
      "fee": "0.08",
      "feeCurrency": "EUR",
      "hash": "de97884989fb247211d4de127a334d75a69e09078f76c87c78fa582755d286c5",
      "localAmount": "13.64",
      "localCurrency": "AUD",
      "networkCode": "ttrx:usdt",
      "networkFee": "3.149500",
      "networkFeeCurrency": "TRX",
      "networkFeeLocalAmount": "1.45",
      "networkFeePayAmount": "1.061854",
      "networkName": "Tron (TRC20)",
      "payAmount": "10.000000",
      "payCurrency": "USDT",
      "payToLocalCurrencyRate": "1.3632252949889343",
      "reference": "smoke-ch-ebee220e-4ee5-4730-bd43-c4a35ea8386e",
      "riskScore": "10.0",
      "simplifiedState": "rejected",
      "sourceAddresses": [
        "TVkgb653SJdqxA8jyWcD49PAJonZzCBcMk"
      ],
      "status": "rejected",
      "updatedAt": "2026-08-27T12:11:43.241Z"
    },
    "id": "b6e2b8e2-1252-40d0-b224-4a4c00aba7bb",
    "relationships": {
      "account": {
        "meta": {
          "included": false
        }
      },
      "author": {
        "meta": {
          "included": false
        }
      }
    },
    "type": "channelTransactions"
  },
  "meta": {}
}
```

{% endtab %}
{% endtabs %}

**Payload Description**

| Name                                      | Type   | Description                                                                                                                                                                                                                          |
| ----------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| data.id                                   | string | Channel deposit ID.                                                                                                                                                                                                                  |
| data.type                                 | string | Always `channelTransactions`.                                                                                                                                                                                                        |
| data.attributes.hash                      | string | Transaction hash.                                                                                                                                                                                                                    |
| data.attributes.amountCurrency            | string | Determines the currency due after processing and conversion. Refer to [supported](https://docs.txn.io/api-basics/supported-currencies) currencies.                                                                                   |
| data.attributes.amount                    | string | Determines the amount due **after** processing and conversion. This is the amount the end-user's deposit resulted in on your account.                                                                                                |
| data.attributes.payCurrency               | string | Crypto currency that customer paid in. Refer to [supported](https://docs.txn.io/api-basics/supported-currencies.md) currencies.                                                                                                      |
| data.attributes.payAmount                 | string | Crypto amount that customer paid in.                                                                                                                                                                                                 |
| data.attributes.localAmount               | string | Determines the deposit amount value **before** fees in a display currency like CNY, KRW, BRL, etc. **This is normally the amount you will want to credit to the user's account on your platform.**                                   |
| data.attributes.localCurrency             | string | Display currency code, e.g. CNY, KRW, BRW. This is normally your end-user's currency. Refer to [Supported currencies](https://docs.txn.io/api-basics/supported-currencies.md)                                                        |
| data.attributes.amountToLocalCurrencyRate | string | `amountCurrency` vs `localCurency` exchange rate.                                                                                                                                                                                    |
| data.attributes.exchangeRate              | string | `payCurrency` vs `amountCurrency` exchange rate applied to the deposit.                                                                                                                                                              |
| data.attributes.payToLocalCurrencyRate    | string | `payCurrency` vs `localCurrency` exchange rate.                                                                                                                                                                                      |
| data.attributes.fee                       | string | Fee amount taken by Txn for processing this deposit.                                                                                                                                                                                 |
| data.attributes.feeCurrency               | string | Fee currency.                                                                                                                                                                                                                        |
| data.attributes.consolidationFee          | string | Fee for consolidating the deposited funds to your account. Quoted in `feeCurrency`.                                                                                                                                                  |
| data.attributes.networkFee                | string | On-chain network fee for the deposit transaction, in `networkFeeCurrency`.                                                                                                                                                           |
| data.attributes.networkFeeCurrency        | string | Currency of the network fee — the network's native asset, e.g. `TRX`.                                                                                                                                                                |
| data.attributes.networkFeePayAmount       | string | Network fee expressed in `payCurrency`.                                                                                                                                                                                              |
| data.attributes.networkFeeLocalAmount     | string | Network fee expressed in `localCurrency`.                                                                                                                                                                                            |
| data.attributes.address                   | string | Channel address.                                                                                                                                                                                                                     |
| data.attributes.networkCode               | string | Network code.                                                                                                                                                                                                                        |
| data.attributes.networkName               | string | Network name.                                                                                                                                                                                                                        |
| data.attributes.reference                 | string | The custom reference ID inherited from the parent channel.                                                                                                                                                                           |
| data.attributes.channelId                 | string | The ID of the parent channel that this particular deposit is linked to.                                                                                                                                                              |
| data.attributes.status                    | string | Channel deposit status. Refer to the [Channel deposit flow](https://docs.txn.io/channels/channels-deposit-flow.md) for more info.                                                                                                    |
| data.attributes.simplifiedState           | string | Simplified channel deposit status.                                                                                                                                                                                                   |
| data.attributes.riskScore                 | string | Risk score for the deposit's source address from on-chain analytics screening, when available. `null` if no score was returned.                                                                                                      |
| data.attributes.clusterCategory           | string | Category of the entity the source address is attributed to by on-chain analytics, e.g. `Exchange`. `null` until screening completes.                                                                                                 |
| data.attributes.clusterName               | string | Name of the entity the source address is attributed to, e.g. `Binance`. `null` until screening completes.                                                                                                                            |
| data.attributes.sourceAddresses           | array  | Wallet address(es) the funds were sent from. Typically a single address; may contain multiple entries when the deposit arrived via a UTXO-based network (BTC, LTC, BCH, DOGE, etc.) and the sender’s wallet combined several inputs. |
| data.attributes.createdAt                 | string | Timestamp when a channel deposit was created.                                                                                                                                                                                        |
| data.attributes.updatedAt                 | string | Timestamp when a channel deposit was last updated.                                                                                                                                                                                   |
| data.relationships.account                | object | Not expanded (`meta.included` is `false`). The deposit is credited to the channel's target account: read the channel given by `data.attributes.channelId` to get it.                                                                 |
| data.relationships.author                 | object | Not expanded (`meta.included` is `false`).                                                                                                                                                                                           |


---

# 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/channels/channel-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.
