Enrutamiento de la Organization

Consulta el enrutamiento inteligente entre los Merchants de la Organization desde el Dashboard.

Estos endpoints le dan a la Organization una vista entre Merchants de los perfiles de enrutamiento — los conjuntos de reglas que deciden qué conector intenta cada cobro. Úsalos para revisar cómo está configurado el enrutamiento entre los Merchants desde un solo lugar.

Un perfil de enrutamiento sigue perteneciendo a un único Merchant; edita sus nodos en la pantalla de enrutamiento de ese Merchant. Consulta Cómo funciona Tokeflow para conocer el modelo de orquestación.

Estos endpoints impulsan la interfaz del Tokeflow Dashboard a nivel de la Organization. Están autenticados por sesión (JWT bearer) — el token proviene de iniciar sesión en el Dashboard, no de una clave de API sk_/pk_. Las solicitudes también incluyen el header x-organization-id, y el usuario que inició sesión debe ser miembro de esa Organization.

El objeto de perfil de enrutamiento

Devuelto por los endpoints de listado y obtención de esta página.

CampoTipoDescripción
idstringID del perfil de enrutamiento.
merchant_idstringID del Merchant.
namestringNombre del perfil de enrutamiento.
created_atstringMarca de tiempo de creación del perfil de enrutamiento. (ISO 8601 UTC).
updated_atstringMarca de tiempo de la última actualización del perfil de enrutamiento. (ISO 8601 UTC).
is_activebooleanSi el perfil de enrutamiento está activo.
versionnumberVersión del perfil de enrutamiento.
payment_methodstringAlcance del método de pago.
default_merchant_connector_idstring | nullID del conector predeterminado usado cuando ningún nodo de regla coincide.

Endpoints

GET/api/v1/org/routing/profiles

Org

Auth: Dashboard session (JWT bearer). Se requiere membresía de la Organization.

Lista los perfiles de enrutamiento del Merchant.

Parámetros de consulta

CampoTipoObligatorioDescripción
pagenumberNoNúmero de página (indexado desde 1). Predeterminado 1, mín. 1.
limitnumberNoNúmero de elementos por página. Predeterminado 20, mín. 1, máx. 100.

Ejemplo de solicitud

curl -G https://api.tokeflow.com/api/v1/org/routing/profiles \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-organization-id: org_4b21e7c3" \
  --data-urlencode "page=1" \
  --data-urlencode "limit=20"

Ejemplo de respuesta — 200

{
  "data": [
    {
      "id": "rp_123abc...",
      "merchant_id": "mrc_123",
      "name": "Primary Routing Profile",
      "created_at": "2025-11-20T10:00:00Z",
      "updated_at": "2025-11-21T10:00:00Z",
      "is_active": true,
      "version": 1,
      "payment_method": "*",
      "default_merchant_connector_id": "string"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 42,
    "total_pages": 3,
    "has_next": true,
    "has_prev": false
  }
}

POST/api/v1/org/routing/profiles

Org

Auth: Dashboard session (JWT bearer). Se requiere membresía de la Organization.

Crea un nuevo perfil de enrutamiento.

Campos de la solicitud

CampoTipoObligatorioDescripción
namestringSíNombre del perfil de enrutamiento.
is_activebooleanNoSi el perfil de enrutamiento está activo.
payment_methodstringNoAlcance del método de pago. * = comodín. Uno de credit_card, debit_card, pix, boleto, wallet, *.
default_merchant_connector_idstringSíConector predeterminado usado cuando ningún nodo de regla coincide. No puede ser nulo.

Ejemplo de solicitud

curl -X POST https://api.tokeflow.com/api/v1/org/routing/profiles \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-organization-id: org_4b21e7c3" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Default Card Profile",
    "is_active": true,
    "payment_method": "*",
    "default_merchant_connector_id": "mc_6d7b9a0e1f2c3d4e5f6a7b8c9d0e1f2a"
  }'

Ejemplo de respuesta — 201

{
  "id": "rp_123abc...",
  "merchant_id": "mrc_123",
  "name": "Primary Routing Profile",
  "created_at": "2025-11-20T10:00:00Z",
  "updated_at": "2025-11-21T10:00:00Z",
  "is_active": true,
  "version": 1,
  "payment_method": "*",
  "default_merchant_connector_id": "string"
}

DELETE/api/v1/org/routing/profiles/:profile_id

Org

Auth: Dashboard session (JWT bearer). Se requiere membresía de la Organization.

Elimina un perfil de enrutamiento.

Parámetros de ruta

CampoTipoObligatorioDescripción
profile_idstringSí—

Ejemplo de solicitud

curl -X DELETE https://api.tokeflow.com/api/v1/org/routing/profiles/rpf_5f6a7b8c \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-organization-id: org_4b21e7c3"

Ejemplo de respuesta — 204 No Content

Se devuelve un cuerpo vacío cuando la operación se realiza correctamente.


GET/api/v1/org/routing/profiles/:profile_id

Org

Auth: Dashboard session (JWT bearer). Se requiere membresía de la Organization.

Obtiene el perfil de enrutamiento por ID.

Parámetros de ruta

CampoTipoObligatorioDescripción
profile_idstringSí—

Ejemplo de solicitud

curl https://api.tokeflow.com/api/v1/org/routing/profiles/rpf_5f6a7b8c \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-organization-id: org_4b21e7c3"

Ejemplo de respuesta — 200

{
  "id": "rp_123abc...",
  "merchant_id": "mrc_123",
  "name": "Primary Routing Profile",
  "created_at": "2025-11-20T10:00:00Z",
  "updated_at": "2025-11-21T10:00:00Z",
  "is_active": true,
  "version": 1,
  "payment_method": "*",
  "default_merchant_connector_id": "string"
}

Errores

Los errores usan el envoltorio estándar. Los casos más comunes aquí:

HTTPSignificado
400Parámetros inválidos o un estado que no permite esta operación.
401Token de sesión del Dashboard ausente, expirado o inválido.
403Autenticado, pero el usuario que inició sesión no tiene acceso a esta entidad.
404El registro no existe o no es visible para esta entidad.

Relacionados

En esta página