Roteamento da Organization
Veja o roteamento inteligente entre os Merchants da Organization a partir do Dashboard.
Esses endpoints dão à Organization uma visão entre Merchants dos perfis de roteamento — os conjuntos de regras que decidem qual conector tenta cada cobrança. Use-os para revisar como o roteamento está configurado entre os Merchants a partir de um único lugar.
Um perfil de roteamento ainda pertence a um único Merchant; edite seus nós na tela de roteamento desse Merchant. Consulte Como a Tokeflow funciona para o modelo de orquestração.
Esses endpoints alimentam a interface do Tokeflow Dashboard no nível da Organization. Eles são autenticados por sessão (JWT bearer) — o token vem do login no Dashboard, não de uma chave de API sk_/pk_. As solicitações também carregam o header x-organization-id, e o usuário autenticado deve ser membro dessa Organization.
O objeto de perfil de roteamento
Retornado pelos endpoints de listagem e obtenção desta página.
| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID do perfil de roteamento. |
merchant_id | string | ID do Merchant. |
name | string | Nome do perfil de roteamento. |
created_at | string | Timestamp de criação do perfil de roteamento. (ISO 8601 UTC). |
updated_at | string | Timestamp da última atualização do perfil de roteamento. (ISO 8601 UTC). |
is_active | boolean | Se o perfil de roteamento está ativo. |
version | number | Versão do perfil de roteamento. |
payment_method | string | Escopo do método de pagamento. |
default_merchant_connector_id | string | null | ID do conector padrão usado quando nenhum nó de regra corresponde. |
Endpoints
GET/api/v1/org/routing/profiles
Auth: Dashboard session (JWT bearer). É necessário ser membro da Organization.
Lista os perfis de roteamento do Merchant.
Parâmetros de consulta
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page | number | Não | Número da página (indexado a partir de 1). Padrão 1, mín. 1. |
limit | number | Não | Número de itens por página. Padrão 20, mín. 1, máx. 100. |
Exemplo de solicitação
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"Exemplo de resposta — 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
Auth: Dashboard session (JWT bearer). É necessário ser membro da Organization.
Cria um novo perfil de roteamento.
Campos da solicitação
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do perfil de roteamento. |
is_active | boolean | Não | Se o perfil de roteamento está ativo. |
payment_method | string | Não | Escopo do método de pagamento. * = curinga. Um dos valores credit_card, debit_card, pix, boleto, wallet, *. |
default_merchant_connector_id | string | Sim | Conector padrão usado quando nenhum nó de regra corresponde. Não pode ser nulo. |
Exemplo de solicitação
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"
}'Exemplo de resposta — 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
Auth: Dashboard session (JWT bearer). É necessário ser membro da Organization.
Exclui um perfil de roteamento.
Parâmetros de caminho
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
profile_id | string | Sim | — |
Exemplo de solicitação
curl -X DELETE https://api.tokeflow.com/api/v1/org/routing/profiles/rpf_5f6a7b8c \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
-H "x-organization-id: org_4b21e7c3"Exemplo de resposta — 204 No Content
Um corpo vazio é retornado em caso de sucesso.
GET/api/v1/org/routing/profiles/:profile_id
Auth: Dashboard session (JWT bearer). É necessário ser membro da Organization.
Obtém o perfil de roteamento pelo ID.
Parâmetros de caminho
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
profile_id | string | Sim | — |
Exemplo de solicitação
curl https://api.tokeflow.com/api/v1/org/routing/profiles/rpf_5f6a7b8c \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
-H "x-organization-id: org_4b21e7c3"Exemplo de resposta — 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"
}Erros
Os erros usam o envelope padrão. Os casos mais comuns aqui:
| HTTP | Significado |
|---|---|
400 | Parâmetros inválidos ou um estado que não permite esta operação. |
401 | Token de sessão do Dashboard ausente, expirado ou inválido. |
403 | Autenticado, mas o usuário autenticado não tem acesso a esta entidade. |
404 | O registro não existe ou não é visível para esta entidade. |