Reading channel

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

This endpoint returns details of a particular channel by its ID.

Headers

Name	Value
Content-Type	application/vnd.api+json

Path Parameters

Name	Type	Description
id	string	Channel ID.

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-25T08:35:07.034Z",
      "payCurrency": "USDT",
      "targetCurrency": "USD",
      "address": "TJTuEYJ8P9to4Zhdw7zg55VPH3gzLaQDV6",
      "networkName": "Tron (TRC20)",
      "networkCode": "ttrx:usdt"
    }
  },
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}

HTTP 404

{
  "errors": [
    {
      "status": 404,
      "title": "Record not found",
      "code": "channel_not_found"
    }
  ]
}

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.