---
title: "List channel payments"
method: GET
path: "/api/v2/channel/payment"
tags: ["Crypto Channels"]
---

# List channel payments

`GET /api/v2/channel/payment`

## Request

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

Retrieves a list of payments to a channel on a specific Wallet ID.

## Query parameters

- `walletId` string, required
- `status` 'DETECTED' | 'COMPLETE' | 'HELD' | 'CANCELLED': The status of the channel payment.
- `fromDate` string
- `toDate` string
- `offset` string
- `max` string
- `q` string

## Response `200`

OK

- MerchantChannelPaymentDto[]
  - `channelId` string: The ID of the channel.
  - `merchantId` string: The merchant ID linked to channel.
  - `merchantDisplayName` string: The display name fo the merchant.
  - `reference` string: The unique reference 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.
  - `status` 'DETECTED' | 'COMPLETE' | 'HELD' | 'CANCELLED': The status of the channel payment.
  - `uuid` string: The uuid fo the channel payment.
  - `hash` string: The transaction hash of the channel payment.
  - `address` string: The address of the channel.
  - `tag` string: The tag of the channel.
  - `paidCurrency` string: The currency of the payment.
  - `displayCurrency` string: The display currency of the channel.
  - `walletCurrency` string: The currency of the wallet linked to the channel.
  - `feeCurrency` string: The currency of the fee taken.
  - `paidAmount` number: The amount paid to the channel.
  - `displayAmount` number: The amount displayed of the channel payment.
  - `walletAmount` number: The amount converted to the wallet linked to the channel.
  - `feeAmount` number: The amount of the fee taken.
  - `exchangeRate` ExchangeRateDto: Contains exchange rate information to convert from base currency to counter currency.
    - `base` string: The base currency acronym.
    - `counter` string: The counter currency acronym.
    - `rate` number: The exchange rate
  - `displayRate` ExchangeRateDto: Contains exchange rate information to convert from base currency to counter currency.
    - `base` string: The base currency acronym.
    - `counter` string: The counter currency acronym.
    - `rate` number: The exchange rate
  - `risk` object
    - `level` string
    - `resourceName` string
    - `resourceCategory` string
    - `alerts` unknown[]
      - unknown
  - `sources` string[]: The address source of the payment.
  - `networkFee` NetworkFeeDto
    - `paidCurrency` string
    - `paidAmount` number
    - `displayCurrency` string
    - `displayAmount` number

## Changes

- **2026-06-16** `97d6c0d2fe2e`: 3 warning, 5 info
  - removed the optional property `items/risk/base` from the response with the `200` status
  - removed the optional property `items/risk/counter` from the response with the `200` status
  - removed the optional property `items/risk/rate` from the response with the `200` status
  - added the optional property `items/risk/alerts` to the response with the `200` status
  - …4 more

[Operation history](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/changes/api/v2/channel/payment/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)