Channels

A channel is an on-chain stablecoin asset and network fluxa collects through — USDT or USDC across TRON and major EVM chains (Ethereum, Base, Polygon, Arbitrum, BNB Chain). List the channels enabled for your account to get the code values you pass to Charges and Subscriptions, and to learn each channel's capabilities.

The capabilities model

  • Name
    code
    Type
    string
    Description

    The channel code to pass as channel when creating a charge.

  • Name
    name
    Type
    string
    Description

    Human-readable channel name. An operator-assigned name when set, else a generated English default.

  • Name
    name_is_default
    Type
    boolean
    Description

    true when name is the generated default (no operator-assigned name). UIs may then localize the label themselves from kind + currencies. Omitted when false.

  • Name
    kind
    Type
    string
    Description

    Payment-method family: crypto, local (local fiat methods such as bank transfer / QR collection), or other. External merchant accounts get crypto; local is operator-internal.

  • Name
    settlement
    Type
    string
    Description

    Funds-flow mode: direct (non-custodial — settles straight to your own address) or custodial (credits a fluxa balance). External merchant channels are always direct; custodial is operator-internal. See Settlement modes.

  • Name
    network
    Type
    string
    Description

    For self-hosted on-chain channels, the normalized network label (tron, base, bsc, …) matched by routed charges (the network parameter on Charges). Absent when not network-routable.

  • Name
    currencies
    Type
    array
    Description

    Accepted pricing currencies. Empty means any.

  • Name
    pay_currencies
    Type
    array
    Description

    When a channel lets the payer pick which crypto asset to settle in, the selectable assets. The first entry is the default. Absent when not selectable.

  • Name
    supports_refund
    Type
    boolean
    Description

    Whether the channel can be refunded through the platform.

  • Name
    requires_watcher
    Type
    boolean
    Description

    true for self-hosted on-chain channels (settlement is non-custodial).


GET/api/v1/channels

List channels

Signed locally — your secret stays in this browser and is never sent or stored.

No keys yet? Create an API key pair in the merchant portal — the secret is shown only once. Open the merchant portal

Return the channels available for charges as a plain data array of capability objects.

Request

GET
/api/v1/channels
curl "$BASE/api/v1/channels" \
  -H "X-Api-Key: $KEY_ID" \
  -H "X-Timestamp: $TS" \
  -H "X-Signature: $SIG"

Response

{
  "data": [
    {
      "code": "usdc_base",
      "name": "USDC (Base)",
      "kind": "crypto",
      "settlement": "direct",
      "network": "base",
      "currencies": ["USDC"],
      "supports_refund": false,
      "requires_watcher": true
    },
    {
      "code": "usdt_erc20",
      "name": "USDT (ERC-20)",
      "kind": "crypto",
      "settlement": "direct",
      "network": "ethereum",
      "currencies": ["USDT"],
      "supports_refund": false,
      "requires_watcher": true
    }
  ]
}