Listing channels

GET /api/public/v1/channels

This endpoint returns a list of channels with pagination.

Headers

Name	Value
Content-Type	application/vnd.api+json
Authorization	Bearer <api_key>

URL Parameters

Name	Type	Description
order	string	Order in which the list of channels 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 channels.
per_page	number	Number of channels per page to return.
reference	number	Channel reference.

Response

HTTP 200

{
  "data": [
    {
      "id": "60e05bc0-4690-4985-a08a-8acf00e48294",
      "type": "channels",
      "attributes": {
        "reference": "ecd05fb9-76e6-42e7-b86e-5a7e18f4da6d",
        "status": "enabled",
        "createdAt": "2024-09-25T08:35:07.034Z",
        "updatedAt": "2024-09-25T09:32:50.626Z",
        "payCurrency": "USDT",
        "targetCurrency": "USD",
        "address": "TJTuEYJ8P9to4Zhdw7zg55VPH3gzLaQDV6",
        "networkName": "Tron (TRC20)",
        "networkCode": "ttrx:usdt"
      }
    },
    {
      "id": "aa09547b-3264-4295-a863-1cc538faa630",
      "type": "channels",
      "attributes": {
        "reference": "b644dd1c-9179-466c-82f5-b9bef1e995ab",
        "status": "enabled",
        "createdAt": "2024-09-25T08:26:24.030Z",
        "updatedAt": "2024-09-25T08:26:24.030Z",
        "payCurrency": "USDT",
        "targetCurrency": "USDT",
        "address": "TMtgUMciydZbyAJi5if45oNdTkYzgV8E8Z",
        "networkName": "Tron (TRC20)",
        "networkCode": "ttrx:usdt"
      }
    }
  ],
  "meta": {
    "page": "1",
    "per_page": "2",
    "total": 12
  },
  "jsonapi": {
    "version": "1.0"
  }
} 

Response Body

Name	Type	Description
data.id	string	Channel ID.
data.type	string	Always channels.
data.attributes.targetCurrency	string	Channel currency to display to end users. Determines the currency due after processing and conversion. Refer to supported currencies.
data.attributes.payCurrency	string	Crypto currency that customer must pay in. Refer to supported currencies.
data.attributes.address	string	Channel address.
data.attributes.networkCode	string	Payment network code. Refer to supported networks.
data.attributes.networkName	string	Network name.
data.attributes.reference	string	The custom reference ID to tie the channel and its deposits to end-user who pays.
data.attributes.status	string	Channel status. Can be either enabled or disabled. If enabled, deposits get processed and credited to the merchant's account as normal. If disabled, deposits do not get credited to the merchant's account.
data.attributes.createdAt	string	Timestamp when a channel was created.
data.attributes.updatedAt	string	Timestamp when a channel was last updated.