---
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.

# Get channel

Gets a specific channel using channel code.<br>

Returns the latest version of the channel, even if it has been soft‑deleted. The `deleted_at` field shows the channel’s lifecycle state: `null` indicates an active channel, while the timestamp indicates when it was deleted.


# 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": {
      "ChannelPath": {
        "name": "channel",
        "in": "path",
        "description": "Channel code",
        "schema": {
          "type": "string",
          "minLength": 1,
          "maxLength": 20,
          "pattern": "^[a-zA-Z0-9]+$"
        },
        "required": true,
        "example": "GDP"
      }
    },
    "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"
          }
        }
      },
      "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/{channel}": {
      "get": {
        "summary": "Get channel",
        "description": "Gets a specific channel using channel code.<br>\n\nReturns the latest version of the channel, even if it has been soft‑deleted. The `deleted_at` field shows the channel’s lifecycle state: `null` indicates an active channel, while the timestamp indicates when it was deleted.\n",
        "operationId": "get-corporate-v1-channels-channel",
        "tags": [
          "Channels"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/ChannelPath"
          }
        ],
        "responses": {
          "200": {
            "description": "OK. Returns the channel.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetChannelResponse"
                },
                "examples": {
                  "Active channel": {
                    "value": {
                      "channel": "GDP",
                      "description": "Global Direct Payments",
                      "created_at": "2026-02-26T10:30:00.123Z",
                      "deleted_at": null
                    }
                  },
                  "Deleted channel": {
                    "value": {
                      "channel": "GDP",
                      "description": "Global Direct Payments",
                      "created_at": "2026-02-26T10:30:00.123Z",
                      "deleted_at": "2026-05-10T09:00:00.000Z"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/403Forbidden"
          },
          "404": {
            "description": "Not Found. Channel does not exist.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "Channel not found": {
                    "summary": "Channel not found",
                    "value": {
                      "code": "WCCL0004",
                      "message": "Channel not found"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "$ref": "#/components/responses/500InternalServer"
          }
        }
      }
    }
  }
}
```