listChannels

Circle Mint

Core Functionality

Balances

Payouts

Wires

CBIT

PIX

Transfers

Addresses

Deposits

Accounts API

Wallets

Transfers

API Overview

Health

Management

Encryption

Subscriptions

Stablecoins

Channels

Payments API

Payments

Pull Crypto Payments

Crypto Payment Intents

Cards

Payment Tokens

Settlements

Chargebacks

Balances

Checkout Sessions

Payouts API

Payouts

Crypto Address Book

Crypto Exchange Rates

List all channels

GEThttps://api.circle.com/v1/channels

Retrieve a list of channels with details (e.g. cardDescriptor, achDescriptor, etc.).

Response

200ListChannelsResponse

Response Body

object

data

array of objects

Show 4 properties

string

Unique system generated identifier for the entity.

default

boolean

Flag to indicate whether the channel is configured as default. At most one of the channels will have this flag set to true and the default channel is used when a payment request does not have the channel property set.

cardDescriptor

string

Descriptor that appears on cardholders' bank statements for card payments submitted through this channel.

achDescriptor

string

Descriptor that appears on end-users' bank statements for ACH payments submitted through this channel.

401NotAuthorized

RequestChoose a language

ResponseChoose an example

1{
2  "data": [
3    {
4      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
5      "default": true,
6      "cardDescriptor": "CIRCLE LLC.",
7      "achDescriptor": "CIRCLE LLC."
8    }
9  ]
10}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy