Skip to main content

List Channels

GET/rest/channels

Retrieve a list of all channels belonging to the authenticated merchant. This endpoint returns channel configuration details including type, currency, company information, and platform fee settings.

Request​

Example Request
GET /rest/channels
Authorization: Basic <base64(api_key:api_password)>

Response​

channelsArray
Array of channel objects. See Channel object below.
errorString
Error details
messageString
Message details
Example Response
{
"error": null,
"message": null,
"channels": [
  {
    "id": 123,
    "name": "My Shop",
    "channel_type": "debt_claim",
    "url_name": "my-shop",
    "product_name": "My Shop Payments",
    "currency": "EUR",
    "active": "active",
    "company_information": {
      "company_name": "My Company GmbH",
      "street": "Teststr 5",
      "postal_code": "10178",
      "city": "Berlin",
      "country": "Germany",
      "contact_email": "info@mycompany.de"
    },
    "platform_fee_enabled": false,
    "platform_fee_disabled_for_one_time_payments": false,
    "platform_fee": null,
    "platform_percentage_fee": null,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-08-14T07:50:20Z"
  },
  {
    "id": 456,
    "name": "Donation Page",
    "channel_type": "donation",
    "url_name": "donation-page",
    "product_name": "Donations",
    "currency": "EUR",
    "active": "active",
    "company_information": {
      "company_name": "My Company GmbH",
      "street": "Teststr 5",
      "postal_code": "10178",
      "city": "Berlin",
      "country": "Germany",
      "contact_email": "info@mycompany.de"
    },
    "platform_fee_enabled": true,
    "platform_fee_disabled_for_one_time_payments": false,
    "platform_fee": "1.50",
    "platform_percentage_fee": "2.5",
    "created_at": "2024-03-20T14:00:00Z",
    "updated_at": "2024-08-10T12:30:00Z"
  }
]
}

Channel object​

idInteger
Unique identifier for the channel
nameString
Display name of the channel
channel_typeString
Type of channel: debt_claim, free_payment, free_payment_v2, donation, direct_checkout
url_nameString
URL-friendly name used in subdomains (e.g., my-shop)
product_nameString
Product or service name displayed on the payment page
currencyString
Default currency code for the channel (e.g., EUR, USD)
activeString
Current status of the channel
company_informationObject
Object containing merchant company details (company_name, street, postal_code, city, country, contact_email)
platform_fee_enabledBoolean
Whether platform fees are enabled for this channel (boolean)
platform_fee_disabled_for_one_time_paymentsBoolean
Whether platform fees are disabled for one-time payments (boolean)
platform_feeString
Fixed platform fee amount (null if not set)
platform_percentage_feeString
Percentage-based platform fee (null if not set)
created_atString
When the channel was created (ISO 8601)
updated_atString
When the channel was last updated (ISO 8601)
Channel Object
{
"id": 123,
"name": "My Shop",
"channel_type": "debt_claim",
"url_name": "my-shop",
"product_name": "My Shop Payments",
"currency": "EUR",
"active": "active",
"company_information": {
  "company_name": "My Company GmbH",
  "street": "Teststr 5",
  "postal_code": "10178",
  "city": "Berlin",
  "country": "Germany",
  "contact_email": "info@mycompany.de"
},
"platform_fee_enabled": false,
"platform_fee_disabled_for_one_time_payments": false,
"platform_fee": null,
"platform_percentage_fee": null,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-08-14T07:50:20Z"
}
Last updated on