Desenvolvedores

Feita para times que entregam.

A Tokeflow oferece uma API limpa e bem estruturada para todo o ciclo de vida da orquestração — merchants, conectores, roteamento, transações, webhooks e consultas operacionais. Padrões previsíveis, versionamento explícito, sem mágica — apenas uma API que faz o que diz.

Fale conoscoVer integrações →
curl
curl -X POST https://api.tokeflow.com/v1/payments \
  -H "Authorization: Bearer tkf_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 9900,
    "currency": "BRL",
    "method": "credit_card",
    "merchant_id": "merch_abc123",
    "routing": {
      "profile_id": "rp_smart_brl",
      "fallback": true
    },
    "customer": {
      "id": "cust_xyz789"
    },
    "payment_method": {
      "token": "tok_card_..."
    }
  }'

Uma API sobre a qual você consegue raciocinar.

Recursos consistentes, retentativas seguras, erros acionáveis e versões estáveis — para que as integrações não apodreçam quando lançamos recursos.

Estrutura previsível

Todo recurso segue o mesmo padrão: criar, recuperar, atualizar, listar. Os formatos de requisição e resposta permanecem consistentes entre os endpoints.

Idempotente por padrão

As operações de escrita suportam idempotency keys — repita com segurança sem duplicar transações, merchants ou entregas de webhook.

Erros significativos

Um code legível por máquina, uma message humana e um objeto details apontando para o campo e a correção exatos — não 500s opacos.

Versionada e estável

As versões ficam na URL. Mudanças incompatíveis chegam em novas versões — sua integração não quebra no lançamento de um recurso.

Desenvolvedores

Superfície da API

Uma única API autenticada e versionada, do onboarding às operações — os mesmos padrões em todo lugar.

Merchants

Crie e gerencie merchants dentro da sua organização — credenciais, perfis de roteamento e webhooks independentes por merchant.

merchants.ts
const merchant = await tokeflow.merchants.create({)
  name: 'Acme Store',
  reference_id: 'acme-001'
});
  • POST /v1/merchants — Criar
  • GET /v1/merchants/:id — Recuperar
  • PATCH /v1/merchants/:id — Atualizar
  • GET /v1/merchants — Listar

Conectores

Vincule credenciais de PSP a um merchant — métodos suportados, moedas e flags de 3DS por conexão.

connectors.ts
const connector = await tokeflow.connectors.create({
  merchant_id: 'merch_abc123', provider: 'stripe' ... }
});
  • POST /v1/connectors, GET/PATCH/DELETE /v1/connectors/:id
  • GET /v1/merchants/:id/connectors — Listar por merchant

Perfis de roteamento

Defina regras de cascata, tratamento de recusas recuperáveis e encerramento — executados automaticamente em cada pagamento.

routing.ts
await tokeflow.routing_profiles.create({ rules: { ... } });
  • POST /v1/routing-profiles, GET /v1/routing-profiles/:id
  • PUT /v1/routing-profiles/:id — Substituir perfil
  • GET /v1/merchants/:id/routing-profiles — Listar

Pagamentos

Crie, capture, cancele e estorne. Roteamento e fallback rodam a partir do perfil — com trace completo na leitura.

payments.ts
await tokeflow.payments.create({ idempotency_key: 'order_12345' ... });
  • POST /v1/payments, POST .../capture|void|refund
  • GET /v1/payments/:id — Pagamento + trace de roteamento
  • GET /v1/payments — Lista filtrada

Webhooks

Endpoints por merchant, payloads assinados, tipos de evento normalizados e retentativa de entrega com backoff.

webhooks.ts
await tokeflow.webhooks.create({ events: ['payment.captured'] ... });
  • POST /v1/webhooks, GET/PATCH/DELETE /v1/webhooks/:id
  • GET /v1/webhooks/:id/deliveries — Tentativas de entrega

Operações e consultas

Trace decisões de roteamento, filtre pagamentos e liste eventos normalizados para suporte e conciliação.

trace.ts
const trace = await tokeflow.payments.getTrace('pay_x7k9m2...');
  • GET /v1/payments/:id/trace — Trace completo de roteamento
  • GET /v1/events, GET /v1/events/:id

Autenticação e chaves de API

Toda requisição usa um Bearer token. As chaves têm escopo na organização, com permissões para merchants e operações.

Authorization
Authorization: Bearer tkf_live_...
Tipo de chavePrefixoEscopoCaso de uso
Secret de produçãotkf_live_Completo, produçãoApenas no servidor
Secret de sandboxtkf_sandbox_Completo, sandboxDev e staging
Publishabletkf_pub_Limitado, seguro para o clienteSDK / tokenização

Chaves secretas nunca devem ir para código no lado do cliente, apps mobile ou controle de versão — use variáveis de ambiente e um gerenciador de segredos.

SDKs e pacotes de integração

Wrappers finos em torno da API REST — sem lógica oculta. Se você consegue ler a documentação da API, consegue ler o código-fonte do SDK.

Node.js / TypeScript

install
npm install @tokeflow/node
client.ts
import { Tokeflow } from '@tokeflow/node';
const tokeflow = new Tokeflow('tkf_live_...');

Python

install
pip install tokeflow
client.py
from tokeflow import Tokeflow
tokeflow = Tokeflow('tkf_live_...')

Go

install
go get github.com/tokeflow/tokeflow-go
client.go
client := tokeflow.NewClient("tkf_live_...")

cURL / HTTP

Nenhum SDK necessário. Use qualquer cliente HTTP — os exemplos na documentação incluem equivalentes em cURL.

Os nomes dos pacotes e os materiais de onboarding são fornecidos com o provisionamento do sandbox.

SDK embarcável (lado do cliente)

Tokenize no cliente. Processe no servidor. Os dados de cartão ficam fora do seu escopo PCI.

Carregue o SDK em JS, monte os campos de cartão em iframes isolados e troque um token de uso único com o seu backend por payments.create. Funciona com React, Vue ou HTML puro — a estilização combina com a sua marca.

  • Os dados de cartão nunca tocam nos seus servidores.
  • Tokens de uso único e com tempo limitado.
checkout.html
<script src="https://js.tokeflow.com/v1/tokeflow.js"></script>
<script>
  const tf = Tokeflow('tkf_pub_...');
  const card = tf.elements.create('card', { ... });
  card.mount('#card-container');
  const { token } = await tf.tokens.create(card);
</script>

Verificação de webhooks

Verifique as assinaturas em toda requisição. Responda com 2xx após o processamento para que as retentativas permaneçam previsíveis.

server.ts
app.post('/webhooks/tokeflow', (req, res) => {
  const ok = Tokeflow.webhooks.verify({ ... });
  if (!ok) return res.status(401);
  // switch (req.body.type) { ... }
  res.status(200).send('OK');
});

Respostas diferentes de 2xx disparam retentativas com backoff exponencial — responda 200 OK depois de ter tratado o evento com segurança.

Documentação

Guias de referência completos, exports em OpenAPI e exemplos interativos viverão no portal público de documentação. Até lá, a documentação técnica vem junto com o acesso ao sandbox e o onboarding de demonstração.

Em breve

Solicitar acesso à documentação

Pronto para começar a construir?

Obtenha acesso ao sandbox, explore a API e construa sua primeira integração. Nosso time de engenharia apoia o onboarding técnico.

Solicitar acesso ao sandboxAgendar uma demo técnica

Prefere explorar as integrações primeiro? Ver provedores suportados.

Começar

Veja a Tokeflow dentro do seu produto.

Compartilhe alguns detalhes sobre o seu caso de uso e agendaremos uma demo técnica sob medida para a sua stack. Acesso ao sandbox incluído.