Channels config

GET https://api.fire.rest/api/v1/fire/external/channels/config
x-api-key: <your_api_key>

{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "countries": [
    {
      "countryCode": "EC",
      "vendors": [
        {
          "vendorId": "100.1.10",
          "vendorName": "Sandbox Ecuador",
          "channels": [
            {
              "uuid": "9f3a-...-e1",
              "code": "APP",
              "name": "Mobile App",
              "description": "Mobile-app sales channel",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Kiosk",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Access denied"
  }
}

GET

api

fire

external

channels

config

GET https://api.fire.rest/api/v1/fire/external/channels/config
x-api-key: <your_api_key>

{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "countries": [
    {
      "countryCode": "EC",
      "vendors": [
        {
          "vendorId": "100.1.10",
          "vendorName": "Sandbox Ecuador",
          "channels": [
            {
              "uuid": "9f3a-...-e1",
              "code": "APP",
              "name": "Mobile App",
              "description": "Mobile-app sales channel",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Kiosk",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Access denied"
  }
}

Returns the full sales-channel configuration for your vendor, enriched with global catalog data (uuid, name, description) and the fulfillment types configured for each channel. The endpoint takes no query parameters. Only channels with enabled !== false are returned. Channels that have no match in the catalog are excluded from the response.

Authentication

string

required

Your Fire API key with the channels:read scope. The key must be vendor-scoped (account + vendor binding) — keys without a vendorId are rejected with 403. The account and vendor are resolved from the key, so no account header or query param is needed.

Request

GET https://api.fire.rest/api/v1/fire/external/channels/config
x-api-key: <your_api_key>

Response

string

UUID of the account the API key belongs to.

object[]

Show country

string

ISO 3166-1 alpha-2 (e.g. BR, EC, CO).

object[]

Show vendor

string

Vendor identifier.

string

Human-readable vendor name.

object[]

Show channel

string

UUID from the global channels catalog.

string

Channel code (e.g. APP, KIOSK, WEB).

string

Display name.

string | null

Optional description.

boolean

Always true for returned rows.

object[]

Show fulfillmentType

string

UUID from the global fulfillment_types catalog.

string

Fulfillment code (e.g. DELIVERY, PICKUP).

string

Display name.

string

Internal reference name.

string | null

Optional description.

boolean

Always true for returned rows.

{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "countries": [
    {
      "countryCode": "EC",
      "vendors": [
        {
          "vendorId": "100.1.10",
          "vendorName": "Sandbox Ecuador",
          "channels": [
            {
              "uuid": "9f3a-...-e1",
              "code": "APP",
              "name": "Mobile App",
              "description": "Mobile-app sales channel",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Kiosk",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Access denied"
  }
}

Notes

uuid comes from the global channels catalog, not from the per-account JSONB.
fulfillmentTypes only includes types configured for that channel in the vendor. Types without a catalog match are excluded.
countries groups by country code from the JSONB. A vendor may appear in multiple countries if it is configured per-country.

Payment methods config

Companion endpoint to read configured payment methods.

Authentication

How vendor-scoped API keys and scopes work.

API

Partner APIs

PayBridge

Authentication

Request

Response

Notes

Payment methods config

Authentication

​Authentication

​Request

​Response

​Notes

​Related

Payment methods config

Authentication

Authentication

Request

Response

Notes

Related