Creating channel

POST /api/public/v1/channels

This endpoint creates channels.

XRP Channel Addresses Format:

For XRP channels, addresses are returned in the following format:

rwCQVZLSMNY6DgMH61317qvH3nHYqm68PF?dt=xyz

where xyz is a unique destination tag generated for each channel.

A destination tag acts like a reference number in bank transfers, identifying the intended beneficiary of the transaction.

Displaying Channel Deposit Addresses:

  • When showing the deposit address to your customers, separate the address and the destination tag, and ensure both are clearly viewable and copyable

Headers

Name
Value

Content-Type

application/vnd.api+json

Authorization

Bearer <api_key>

Body

Name
Type
Description

targetCurrency

string

payNetwork

string

reference

string

The custom reference ID to tie the channel and its deposits to end-user who pays. This can be anything you choose. Must be a unique value for each channel you create.

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.

Response

{
  "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"
  }
}

Response Body

Name
Type
Description

data.id

string

Channel ID.

data.type

string

Always channels.

data.attributes.targetCurrency

string

data.attributes.payCurrency

string

data.attributes.address

string

Channel address.

data.attributes.networkCode

string

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.

Last updated