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.

Response

{
  "data": [
    {
      "id": "01426edd-b07b-4a00-8583-3232c0bb9fd8",
      "type": "channelTransactions",
      "attributes": {
        "createdAt": "2024-09-25T09:37:18.154Z",
        "updatedAt": "2024-09-25T09:37:18.154Z",
        "hash": "572f204f9d6b80e94b973a0f3b9c7fc4ddcc27f33ee21f62dc70ff54f0cc3a40",
        "address": "TJTuEYJ8P9to4Zhdw7zg55VPH3gzLaQDV6",
        "networkCode": "ttrx:usdt",
        "networkName": "Tron (TRC20)",
        "amount": "48.97",
        "amountCurrency": "USD",
        "payAmount": "50.000000",
        "payCurrency": "USDT",
        "exchangeRate": "0.9891981",
        "fee": "0.49",
        "feeCurrency": "USD",
        "status": "completed",
        "channelId": "60e05bc0-4690-4985-a08a-8acf00e48294",
        "reference": "ecd05fb9-76e6-42e7-b86e-5a7e18f4da6d"
      }
    }
  ],
  "meta": {
    "page": "1",
    "per_page": "1",
    "total": 10
  },
  "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

Channel currency to display to end users. 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, and this is the amount you will want to credit to the user's account on your platform.

data.attributes.payCurrency

string

Crypto currency that customer paod in. Refer to supported currencies.

data.attributes.payAmount

string

Crypto amount that customer paid in.

data.attributes.exchangeRate

string

Exchange rate applied to the deposit.

data.attributes.fee

string

Fee amount taken by Txn for processing this deposit.

data.attributes.feeCurrency

string

Fee currency.

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

string

Timestamp when a channel deposit was created.

data.attributes.updatedAt

string

Timestamp when a channel deposit was last updated.

Last updated