---
updatedAt: 2026-08-07T15:22:40.000Z
---
Fetch the complete documentation index at: https://developers.pismo.io/pismo-docs/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.
# List channels
Lists all active channels.
Returns only active (non-deleted) channels. Supports optional date range filtering and cursor-based pagination.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Banking - Transaction banking",
"version": "0.9.0",
"description": "Transaction banking API",
"contact": {
"name": "API Support",
"url": "https://developers.pismo.io/support/"
},
"license": {
"name": "Copyright Pismo"
}
},
"servers": [
{
"url": "https://sandbox.pismolabs.io",
"description": "Sandbox API server for testing"
}
],
"security": [
{
"BearerAuth": []
}
],
"tags": [
{
"name": "Channels",
"description": "Channel management endpoints"
}
],
"components": {
"parameters": {
"CursorQuery": {
"name": "cursor",
"in": "query",
"description": "Cursor to the next page of results. If no value is specified, it fetches the first page.",
"schema": {
"type": "string"
},
"example": "1234"
}
},
"schemas": {
"ChannelCreatedAt": {
"description": "Timestamp indicating when the channel was created, expressed in RFC3339 format with millisecond precision.",
"type": "string",
"format": "date-time",
"example": "2026-02-26T10:30:00.123Z"
},
"ChannelDescription": {
"description": "Text describing the channel",
"type": "string",
"maxLength": 255,
"example": "GDP channel"
},
"ChannelCodeResponse": {
"description": "Alphanumeric channel code",
"type": "string",
"example": "GDP"
},
"ChannelDeletedAt": {
"description": "Timestamp that indicates when the channel was soft-deleted. Null if the channel is active.",
"type": "string",
"format": "date-time",
"nullable": true,
"example": null
},
"GetChannelResponse": {
"description": "Response body for a single channel",
"type": "object",
"required": [
"channel",
"created_at"
],
"properties": {
"channel": {
"$ref": "#/components/schemas/ChannelCodeResponse"
},
"created_at": {
"$ref": "#/components/schemas/ChannelCreatedAt"
},
"description": {
"$ref": "#/components/schemas/ChannelDescription"
},
"deleted_at": {
"$ref": "#/components/schemas/ChannelDeletedAt"
}
}
},
"ListChannelsResponse": {
"description": "Response body for a list of channels",
"type": "object",
"required": [
"channels",
"pagination"
],
"properties": {
"channels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetChannelResponse"
}
},
"pagination": {
"$ref": "#/components/schemas/ListChannelsPagination"
}
}
},
"ListChannelsPagination": {
"description": "Pagination metadata for channel listing",
"type": "object",
"required": [
"limit",
"cursor"
],
"properties": {
"limit": {
"type": "integer",
"description": "Number of items per page",
"example": 10
},
"cursor": {
"type": "string",
"description": "Cursor to the next page of results",
"example": "eyJpZCI6MTMyfQ=="
}
}
},
"ErrorCode": {
"description": "Error code\n`minLength: 1`\n`maxLength: 12`\n",
"type": "string",
"minLength": 1,
"maxLength": 12,
"example": "WPMT0017"
},
"ErrorMessage": {
"description": "Error message\n`minLength: 1`\n`maxLength: 1000`\n",
"type": "string",
"minLength": 1,
"maxLength": 1000,
"example": "Invalid JSON payload received: Error unmarshalling request"
},
"ErrorResponse": {
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/ErrorCode"
},
"message": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"responses": {
"401Unauthorized": {
"description": "Access token is missing or invalid"
},
"403Forbidden": {
"description": "The request has been lost"
},
"500InternalServer": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"Generic internal error": {
"value": {
"code": "ECMN9999",
"message": "Internal error"
}
}
}
}
}
}
},
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"paths": {
"/corporate/v1/channels": {
"get": {
"summary": "List channels",
"description": "Lists all active channels.
\n\nReturns only active (non-deleted) channels. Supports optional date range filtering and cursor-based pagination.\n",
"operationId": "get-corporate-v1-channels",
"tags": [
"Channels"
],
"parameters": [
{
"name": "createdAtStart",
"in": "query",
"description": "Filter channels created on or after this date. Format = `YYYY-MM-DD`.",
"schema": {
"type": "string",
"format": "date"
},
"example": "2026-01-01"
},
{
"name": "createdAtEnd",
"in": "query",
"description": "Filter channels created on or before this date. Format = `YYYY-MM-DD`.",
"schema": {
"type": "string",
"format": "date"
},
"example": "2026-06-30"
},
{
"$ref": "#/components/parameters/CursorQuery"
},
{
"name": "limit",
"in": "query",
"description": "Maximum number of items per page. Defaults to `10`. Maximum is `100`.",
"schema": {
"type": "integer",
"format": "int32",
"default": 10,
"maximum": 100
},
"example": 10
}
],
"responses": {
"200": {
"description": "OK. Returns list of active channels with pagination.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListChannelsResponse"
},
"examples": {
"Channels list": {
"value": {
"channels": [
{
"channel": "GDP",
"description": "Global Direct Payments",
"created_at": "2026-02-26T10:30:00.123Z",
"deleted_at": null
},
{
"channel": "GCE",
"description": "GCE sweep operations channel",
"created_at": "2026-02-15T08:30:00.000Z",
"deleted_at": null
}
],
"pagination": {
"limit": 10,
"cursor": "eyJpZCI6MTI4fQ=="
}
}
},
"Empty list": {
"value": {
"channels": [],
"pagination": {
"limit": 10,
"cursor": ""
}
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"Invalid date format": {
"summary": "Invalid date format",
"value": {
"code": "WCCL0002",
"message": "CreatedAtStart 10-12-2026 should be formatted as yyyy-mm-dd and be a valid date"
}
},
"Invalid cursor": {
"summary": "Invalid cursor",
"value": {
"code": "WCMN0004",
"message": "Invalid cursor"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401Unauthorized"
},
"403": {
"$ref": "#/components/responses/403Forbidden"
},
"500": {
"$ref": "#/components/responses/500InternalServer"
}
}
}
}
}
}
```