For the complete documentation index, see llms.txt. This page is also available as Markdown.

Listing channel deposits

GET /api/public/v1/channels/:id/transactions

This endpoint returns a paginated list of deposits for a specific channel.

Headers

Name
Value

Content-Type

application/vnd.api+json

Authorization

Bearer <api_key>

Body

Name
Type
Description

id

string

Channel ID

URL Parameters

Name
Type
Description

order

string

Order in which the list of transactions should be returned. Can be created_at.

order_type

string

Order type. Can be either asc or desc.

page

number

Page for which you want to return transactions.

per_page

number

Number of transactions per page to return.

created_at_from

string

Date and time filter. Supports timestamps in ISO 8601 format, e.g. 2024-06-18T15:49:02.031Z.

created_at_to

string

Date and time filter. Supports timestamps in ISO 8601 format, e.g. 2024-06-18T15:49:02.031Z.

Response

{
  "data": [
    {
      "id": "aefeea52-d59a-41a4-944a-0bbef4e38095",
      "type": "channelTransactions",
      "attributes": {
        "address": "TUbpY2zUNFDcpacgNzoJczT4x8ctV2mmLn",
        "amount": "74.94",
        "amountCurrency": "EUR",
        "amountToLocalCurrencyRate": "53.3840874",
        "channelId": "ace25dae-dc26-4fdc-9a7a-6561237f340b",
        "clusterCategory": "Exchange",
        "clusterName": "Binance",
        "consolidationFee": "0.00",
        "createdAt": "2026-05-26T09:45:58.636Z",
        "exchangeRate": "0.7971774",
        "fee": "4.78",
        "feeCurrency": "EUR",
        "hash": "9a6fe053bd758967e43ee10e82963110f9ac809c318371b2f4464908d112f19e",
        "localAmount": "4255.78",
        "localCurrency": "TRY",
        "networkCode": "ttrx:usdt",
        "networkFee": "3.149500",
        "networkFeeCurrency": "TRX",
        "networkFeeLocalAmount": "44.43",
        "networkFeePayAmount": "1.043981",
        "networkName": "Tron (TRC20)",
        "payAmount": "100.000000",
        "payCurrency": "USDT",
        "payToLocalCurrencyRate": "42.5578",
        "reference": "docs-try-eur-example-001",
        "riskScore": "10.0",
        "simplifiedState": "completed",
        "sourceAddresses": [
          "TZDYuARwgbzsnEKQ6Z2srh8fZYsmqU4my2"
        ],
        "status": "completed",
        "updatedAt": "2026-05-26T09:46:01.307Z"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 10,
    "total": 1
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Response Body

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 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 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

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.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.consolidationFee

string

Network fee for consolidating the deposited funds (e.g. combining UTXO inputs). Quoted in feeCurrency. 0.00 when not applicable.

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 for more info.

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.simplifiedState

string

Simplified channel deposit status.

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.

meta.page

number

Current page number.

meta.per_page

number

Page size used for the response.

meta.total

number

Total number of deposits matching the query.

Last updated