---
title: "Get channel"
method: GET
path: "/api/v2/channel/{uuid}"
tags: ["Crypto Channels"]
---

# Get channel

`GET /api/v2/channel/{uuid}`

## Request

- Base URL: `https://api.sandbox.bvnk.com`
- URL: `https://api.sandbox.bvnk.com/api/v2/channel/{uuid}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/api/v2/channel/:uuid/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a specific channel by its UUID.

## Path parameters

- `uuid` string, required

## Response `200`

OK

- MerchantChannelDto
  - `id` integer: The UUID of the channel.
  - `dateCreated` integer: The date and time, encoded into UNIX epoch timestamps.
  - `lastUpdated` integer: The date and time, encoded into UNIX epoch timestamps.
  - `merchantId` string: The merchant ID linked to the channel.
  - `walletCurrency` string: The wallet currency of the channel.
  - `displayCurrency` string: The display currency of the channel.
  - `payCurrency` string: The payed currency of the channel.
  - `address` string: The address of the channel
  - `tag` string: The tag for payments
  - `network` string: The network of the channel. We recommend using the `network` parameter instead of `protocol`.
  - `protocol` string: The protocol of the channel. **Deprecated**. Use `network` instead.
  - `reference` string: The custom reference for the channel payment.
  - `status` 'OPEN': The status of the channel.
  - `uuid` string: The UUID of the channel.
  - `redirectUrl` string: The redirect URL to the channel payment page.
  - `uri` string: The URI of the address for QR code
  - `alternatives` AlternativeAddressDto[]
    - `network` string: The network of the alternative address. We recommend using the `network` parameter instead of `protocol`.
    - `protocol` string: The protocol behind a currency. Matches currency for native tokens. **Deprecated**. Use `network` instead.
    - `address` string: The crypto address to send funds to.
    - `tag` string: This is a payment destination tag. This fields isn't null when the paidCurrency currency value is XRP.
    - `uri` string: The destination address URI for QR code
  - `walletId` string: Unique identifier of the wallet used in the operation.
  - `walletDescription` string: Human-readable description of the wallet used for the channel.
  - `pegged` boolean: Indicates whether the pay currency is a pegged stablecoin (e.g., USDC, USDT) that maintains a fixed value relative to a fiat currency. Set to `true` for stablecoins, `false` for volatile cryptocurrencies like BTC or ETH.
  - `accountReference` string: Unique identifier linking the channel to a specific account or entity within your system. Enables tracking and reconciliation of transactions across multiple channels belonging to the same account or customer relationship.
  - `contact` object: Contact information associated with the channel.
    - `id` string
    - `name` string
    - `description` string
    - `relationshipType` string
    - `entity` object
      - `externalId` string
      - `firstName` string
      - `middleName` string
      - `lastName` string
      - `dateOfBirth` string
      - `address` object
        - `addressLine1` string
        - `addressLine2` string
        - `region` string
        - `city` string
        - `country` string
        - `postCode` string
      - `category` string
      - `type` string
    - `updatedAt` string, date-time
    - `createdAt` string, date-time

## Other responses

- `404`: Not Found

## Changes

- **2026-06-16** `97d6c0d2fe2e`: 1 info
  - removed the `CLOSED` enum value from the `status` response property for the response status `200`

[Operation history](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/changes/api/v2/channel/:uuid/get.md)

---

[API](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints.md) - [All operations](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/revisions/c386d436bf2c?raw)
