List Channels

List Channels

GET https://api.sandbox.coindirect.com/api/v2/channel?merchantId=:id

This endpoint allows you to list all channels.

Query Parameters

Name	Type	Description
offset	string	This tells where to start fetching the records
max	string	This limits the number of records returned per page. The default is 10 records
merchantId	string	Your Merchant ID. You can find it on the "Merchant Details" page in your business account

Headers

Name	Type	Description
Authorization	string	HAWK Token. See Authentication page

200 Channels successfully retrieved.

[
  {
    "id": 65,
    "dateCreated": 1631619193321,
    "lastUpdated": 1631619193321,
    "merchantId": "0a12a214-1619-43fa-9be1-0029f6a440a0",
    "walletCurrency": "EUR",
    "displayCurrency": "JPY",
    "payCurrency": "ETH",
    "address": "0xb4e8bb9918248007dc9d0dc12ae1142f0d62ef0e",
    "tag": null,
    "reference": "c1b933d5-3354-4f83-a05f-0b53f1be85f2",
    "status": "OPEN",
    "uuid": "9d1f67f2-a647-404b-9b02-247c77be81d0",
    "redirectUrl": "https://business.sandbox.coindirect.com/channel?uuid=9d1f67f2-a647-404b-9b02-247c77be81d0",
    "uri": "ethereum:0xb4e8bb9918248007dc9d0dc12ae1142f0d62ef0e",
    "alternatives": null
  }
]

Response parameters

Parameter	Type	Description
id	number	Channel sequence number
dateCreated	number	Channel creation date
lastUpdated	number	Channel last update
merchantId	string	Your merchant ID. You can find it on the "Merchant Details" page in your business account
walletCurrency	string	The merchant's target wallet currency code that the cryptocurrency payment will be converted and credited to e.g. EUR
displayCurrency	string	Channel price currency e.g. JPY
payCurrency	string	Cryptocurrency code e.g. ETH
address	string	Channel cryptocurrency address
tag	number	In the case of XRP, we will provide the payment destination tag in this field e.g. 3948573904. It is important that your customers specify destination tags when they send XRP payment to you as destination tags indicate the beneficiary or destination for a payment. See https://xrpl.org/source-and-destination-tags.html
reference	string	Channel external ID
status	string	Channel status
uuid	string	Channel UUID
redirectUrl	string	URL to the payment page that you can redirect your customers to
uri	string	Channel URI
alternatives	array	In this object, our API will return alternative protocols if there are any supported by Coindirect. For example, for USDT the API will return alternative TRC20 protocol details such as protocol, address, tag and uri
alternatives.protocol	string	Alternative protocol code e.g. TRC20
alternatives.address	string	Alternative protocol address
alternatives.tag	string	Alternative protocol destination tag. Can be applied to XRP only but there are no alternative XRP protocols supported by Coindirect for now so it is null
alternatives.uri	string	Alternative protocol URI