Configuración de canales

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": "App Móvil",
              "description": "Canal de venta por aplicación móvil",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Kiosco",
              "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": "App Móvil",
              "description": "Canal de venta por aplicación móvil",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Kiosco",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}

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

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

Devuelve la configuración completa de canales de venta para tu vendor, enriquecida con datos del catálogo global (uuid, name, description) y los tipos de fulfillment configurados para cada canal. El endpoint no acepta query params. Solo retorna canales con enabled !== false. Los canales que no tengan match en el catálogo se excluyen de la respuesta.

Autenticación

string

requerido

Tu API key de Fire con el scope channels:read. La key debe ser vendor-scoped (account + vendor binding) — las keys sin vendorId son rechazadas con 403. El account y el vendor se resuelven desde la key, así que no hace falta header account ni query param.

Petición

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

Respuesta

string

UUID del account al que pertenece la API key.

object[]

Mostrar country

string

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

object[]

Mostrar vendor

string

Identificador del vendor.

string

Nombre legible del vendor.

object[]

Mostrar channel

string

UUID del catálogo global de channels.

string

Código del canal (ej. APP, KIOSK, WEB).

string

Nombre display.

string | null

Descripción opcional.

boolean

Siempre true en las filas devueltas.

object[]

Mostrar fulfillmentType

string

UUID del catálogo global de fulfillment_types.

string

Código (ej. DELIVERY, PICKUP).

string

Nombre display.

string

Nombre interno de referencia.

string | null

Descripción opcional.

boolean

Siempre true en las filas devueltas.

{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "countries": [
    {
      "countryCode": "EC",
      "vendors": [
        {
          "vendorId": "100.1.10",
          "vendorName": "Sandbox Ecuador",
          "channels": [
            {
              "uuid": "9f3a-...-e1",
              "code": "APP",
              "name": "App Móvil",
              "description": "Canal de venta por aplicación móvil",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Kiosco",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}

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

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

Notas

uuid viene del catálogo global de channels, no del JSONB por account.
fulfillmentTypes solo incluye los tipos configurados para ese canal en el vendor. Tipos sin match en el catálogo se excluyen.
countries agrupa por código de país del JSONB. Un vendor puede aparecer en múltiples países si tiene configuración por país.

API

APIs de partner

PayBridge

Configuración de canales

Autenticación

Petición

Respuesta

Notas

Relacionado

Configuración de métodos de pago

Autenticación

​Autenticación

​Petición

​Respuesta

​Notas

​Relacionado

Configuración de métodos de pago

Autenticación

Autenticación

Petición

Respuesta

Notas

Relacionado