---
description: "This endpoint retrieves detailed information about a specific channel by its ID."
title: "Get Channel by ID"
---

# Get Channel by ID

> This endpoint retrieves detailed information about a specific channel by its ID.

```http
GET /channels/{ChannelID}
```

- `https://api.sandbox.noah.com/v1/channels/{ChannelID}` — V1 Sandbox Server
- `https://api.noah.com/v1/channels/{ChannelID}` — V1 Production Server

## Authentication

- `X-Api-Key`: Your Noah API key. Required on all requests. See [API Keys](/api-concepts/authentication/api).
- `Api-Signature`: Digitally signed JWT used to verify request authenticity. Optional in sandbox when your API key has no associated signing public key; required in production for all requests. If sent, the signature is always validated. See [Request Signing](/api-concepts/authentication/signing).

## Path parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ChannelID` | string | Yes | The ID of the channel to retrieve |

## Query parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `CryptoCurrency` | string | Yes | Cryptocurrency (prod/sandbox): * BTC/BTC_TEST * USDC/USDC_TEST Cryptocurrency: \| Environment \| BTC \| ETH \| USDC \| \|------------\|-----\|-------\|------\| \| Sandbox \| BTC_TEST \| ETH_TEST_SEPOLIA \| USDC_TEST \| \| Production \| BTC \| ETH \| USDC \| |
| `FiatAmount` | string | No | The fiat amount for which to calculate channel details and fees (length 1-38; pattern `^[+]?([.]\d+\|\d+[.]?\d*)$`) |
| `CustomerID` | string | No | Customer ID for personalized channel information and payment methods A unique ID which identifies the customer in the Business' internal system and in NOAH. (length 1-42) |

## Responses

### 200 — Channel details

#### `application/json`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ID` | string | Yes |  |
| `PaymentMethodCategory` | string | Yes | Categorizes one or more `PaymentMethodType`s into broader groups. Useful for listing channels, displaying payment methods: * Bank * Card * Identifier |
| `PaymentMethodType` | string | Yes | Specific type of payment method: * BankAch * BankFedNow * BankFedwire * BankLocal * BankSepa * BankSortCode * BankSwift * IdentifierAlias * IdentifierMerchantID * IdentifierMobileMoney * IdentifierPix * IdentifierQr * TokenizedCard |
| `FiatCurrency` | string | Yes | Supported fiat ISO_4217 3 letter currency codes. |
| `Country` | string | Yes | ISO 3166-1 alpha-2 country code. |
| `Calculated` | object | No | Calculated price information. Not returned if amount is not provided in the query. |
| `Calculated.TotalFee` | string | Yes | The total fee that will be charged for using the specific channel, always specified in the same currency as the requested fiat segment of the transaction. (length 1-38; pattern `^[+]?([.]\d+\|\d+[.]?\d*)$`) |
| `FeeConfig` | object | Yes | The effective channel fee rate parameters. |
| `FeeConfig.Fixed` | string | No | Fixed fee amount that is added to the percentage fee, denominated in FiatCurrencyCode. (length 1-38; pattern `^[+]?([.]\d+\|\d+[.]?\d*)$`) |
| `FeeConfig.Percentage` | string | No | The percentage fee charged for using the channel, expressed as a percent value (e.g. "0.5" means 0.5%). (length 1-38; pattern `^[+]?([.]\d+\|\d+[.]?\d*)$`) |
| `FeeConfig.FiatCurrency` | string | No | Supported fiat ISO_4217 3 letter currency codes. |
| `Limits` | object | Yes | Limits for the channel in requested currency. |
| `Limits.MinLimit` | string | Yes | The minimum amount that can be sent through the channel (length 1-38; pattern `^[+]?([.]\d+\|\d+[.]?\d*)$`) |
| `Limits.MaxLimit` | string | No | The maximum amount that can be sent through the channel (length 1-38; pattern `^[+]?([.]\d+\|\d+[.]?\d*)$`) |
| `Rate` | string | Yes | Rate used for the cryptocurrency being exchanged against the channel fiat currency. Does not include fees. It is not a quoted price and is subject to market fluctuations. (length 1-38; pattern `^[+]?([.]\d+\|\d+[.]?\d*)$`) |
| `PaymentMethods` | object[] | No | Recent payment methods for the channel. Only returned if `CustomerID` was provided in the query. |
| `PaymentMethods[].ID` | string | Yes |  |
| `PaymentMethods[].PaymentMethodType` | string | Yes | Specific type of payment method: * BankAch * BankFedNow * BankFedwire * BankLocal * BankSepa * BankSortCode * BankSwift * IdentifierAlias * IdentifierMerchantID * IdentifierMobileMoney * IdentifierPix * IdentifierQr * TokenizedCard |
| `PaymentMethods[].Details` | FiatPaymentMethodBankDisplay \| FiatPaymentMethodCardDisplay \| FiatPaymentMethodIdentifierDisplay | Yes | Contains information to display each payment method, with fields tailored to the specific type (e.g., last four digits or account number) to help identify the payment method. (discriminated by `Type`) |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay]` | object | No |  |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].Type` | `FiatPaymentMethodBankDisplay` | Yes |  |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].AccountNumber` | string | No |  |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].BankCode` | string | No |  |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].RoutingNumber` | string | No | The routing number of the sender's financial institution (e.g., ODFI routing number for ACH deposits). |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].SwiftCode` | string | No |  |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].BankingSystems` | string[] | No |  |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].BankName` | string | No |  |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].BankAddress` | object | No | Physical postal address. All string fields must be printable ASCII. State and PostCode are required for every country. See [Address Validation](/api-concepts/address-validation) for country-specific rules and payment-form differences. |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].BankAddress.Street` | string | Yes | Street: the primary name of an address's street. Printable ASCII only. (length 2-200) |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].BankAddress.Street2` | string | No | Street2: the secondary name of an address's street. Optional. Printable ASCII only. (length 0-200) |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].BankAddress.City` | string | Yes | City: name of an address's city or town. Printable ASCII only. (length 1-100) |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].BankAddress.PostCode` | string | Yes | PostCode: the address's postcode or ZIP code. Required for all countries (1-20 characters). Use the format from the customer's official documents. Placeholder values such as 00000 or NA are not accepted. (length 1-20) |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].BankAddress.State` | string | Yes | State: the address's state, province, or county. Required for all countries (1-100 characters). For USA and Canada, use the ISO 3166-2 subdivision code as two uppercase letters (e.g. CA). For other countries, use the local administrative division name. Placeholders such as NA or None are not accepted. (length 1-100) |
| `PaymentMethods[].Details[FiatPaymentMethodBankDisplay].BankAddress.Country` | string | Yes | ISO 3166-1 alpha-2 country code. |
| `PaymentMethods[].Details[FiatPaymentMethodCardDisplay]` | object | No |  |
| `PaymentMethods[].Details[FiatPaymentMethodCardDisplay].Type` | `FiatPaymentMethodCardDisplay` | Yes |  |
| `PaymentMethods[].Details[FiatPaymentMethodCardDisplay].Last4` | string | Yes |  |
| `PaymentMethods[].Details[FiatPaymentMethodCardDisplay].Scheme` | string | Yes | The card scheme: * Mastercard * Visa |
| `PaymentMethods[].Details[FiatPaymentMethodIdentifierDisplay]` | object | No |  |
| `PaymentMethods[].Details[FiatPaymentMethodIdentifierDisplay].Type` | `FiatPaymentMethodIdentifierDisplay` | Yes |  |
| `PaymentMethods[].Details[FiatPaymentMethodIdentifierDisplay].IdentifierType` | string | Yes | Identifier type: * PhoneNumber * Email * TaxID |
| `PaymentMethods[].Details[FiatPaymentMethodIdentifierDisplay].Identifier` | string | Yes |  |
| `PaymentMethods[].AccountHolderDetails` | object | No | Details of the account holder associated with the payment method. |
| `PaymentMethods[].AccountHolderDetails.Type` | `Individual` \| `Business` | No | Type of account holder. |
| `PaymentMethods[].AccountHolderDetails.Name` | object | No | Name of the individual account holder. Used when Type is Individual. |
| `PaymentMethods[].AccountHolderDetails.Name.FirstName` | string | Yes | user's first name (length 1-50) |
| `PaymentMethods[].AccountHolderDetails.Name.LastName` | string | Yes | user's last name (family name) (length 1-50) |
| `PaymentMethods[].AccountHolderDetails.Name.MiddleName` | string | No | user's middle name (length 1-50) |
| `PaymentMethods[].AccountHolderDetails.BusinessName` | string | No | Name of the business account holder. Used when Type is Business. |
| `PaymentMethods[].IssuerDetails` | object | No | Details of the issuer of the payment method (e.g. the bank for bank transfers). |
| `PaymentMethods[].IssuerDetails.Name` | string | No | Name of the issuer (e.g. the bank or financial institution). |
| `ProcessingSeconds` | integer | Yes | The time it takes to process a transaction through the channel (range 1-unbounded) |
| `ProcessingTier` | `Standard` \| `Priority` | No | Processing tier for a payment method, this may affect the settlement time of the transaction. * Standard: it's the payment processor method standard option, for BankACH it means ACH next day settlement. * Priority: it's the payment processor method priority option, for BankACH it means ACH same day settlement. |
| `FormSchema` | object | No | Form schema which needs to be filled by the customer. If a PaymentMethodID was provided, only the missing fields are displayed in the schema. |
| `FormSchema.$schema` | string | Yes |  |
| `FormSchema.type` | string | Yes |  |
| `FormSchema.title` | string | No |  |
| `FormSchema.description` | string | No |  |
| `FormSchema.properties` | object | Yes | (additional properties allowed) |
| `FormSchema.required` | string[] | No |  |
| `FormSchema.allOf` | object[] | No |  |
| `FormMetadata` | object | No | Metadata about a form schema. The ContentHash matches the contentHash in pre-compiled static form schemas, enabling correlation between dynamic and static forms. |
| `FormMetadata.ContentHash` | string | Yes | SHA256 hash of the form schema content. Matches the contentHash field in published static form schema metadata. |
| `Issuer` | string | No |  |

### 400 — Bad request

### 401 — Client is not authorized to perform this action

### 404 — Channel not found

### 500 — Internal server error

Error responses share one `Error` envelope across the whole API. See https://docs.noah.com/api-concepts/errors.md for its fields, the `Type` values, and the field-level validation details in `RequestExtension` and `DenyExtension`.

## See also

- Rendered reference: https://docs.noah.com/api-reference/get-channel-by-id
- OpenAPI document: https://docs.noah.com/files/oas-schema.generated.json