Início Rápido
Comece a integrar com nossa API e SDK em poucos minutos.
Bem-vindo à documentação oficial! Nossa plataforma oferece uma solução completa de sub-adquirência e Banking as a Service (BaaS) para facilitar a integração de transações financeiras.
Nossos Serviços
Nossa API oferece suporte completo para diversos métodos de pagamento e operações financeiras:
PIX
Gere cobranças instantâneas via PIX com QR Code e links de pagamento.
Cartão de Crédito
Processe pagamentos com cartão de crédito com tokenização segura.
Boleto Bancário
Emita boletos bancários para pagamentos parcelados ou à vista.
Saque
Realize saques para chaves PIX de forma rápida e segura.
Consulta de Saldo
Consulte saldo disponível e pendente em tempo real (BaaS).
Guia de Início Rápido
Siga este passo a passo para começar a integrar nossa API em poucos minutos:
Obter a Chave de Cash-In
Dentro da plataforma, acesse a seção de desenvolvedores e copie a Chave de Cash-In. Esta chave permite criar e consultar pedidos, além de tokenizar cartões.
A Chave de Cash-In pode ser usado no client-side, pois permite apenas criar e consultar pedidos.
Configurar o Webhook
Na plataforma, configure a URL do webhook que receberá notificações de confirmação de pagamento. O webhook será enviado no seguinte formato:
{
"event": "order.paid",
"data": {
"affiliate_id": null,
"amount": "12",
"buyer": null,
"created_at": "2026-02-03T22:43:36.306Z",
"external_id": null,
"fees": { "fixed": "1", "variable": "0.12" },
"id": "2763cf1a-2263-4125-b151-72f88ffa108c",
"net_amount": "10.88",
"offer": null,
"payment_method": "pix",
"product": null,
"seller_id": "ad5c4916-79e6-4c98-b9d0-3462118b4cb3",
"shipping_amount": "0",
"splits": [
{
"fixedFee": "6",
"sourceSellerId": "ad5c4916-79e6-4c98-b9d0-3462118b4cb3",
"sourceSubAccountId": null,
"splitAmount": "6",
"targetSellerId": null,
"targetSubAccountId": "sb_01kg68ckswecy8txkyjf8h1w48",
"variableFee": "0"
}
],
"status": {
"detail": "00020101021226830014br.gov.bcb.pix2561qrcode.a55scd.com.br/pix/7101de04-1c55-49e5-8969-eff466f9cb655204000053039865802BR591455.202.855LTDA6008SaoPaulo62070503***63045CAF",
"name": "pending"
},
"subAccountId": null,
"tracking": {
"ref": null,
"sck": null,
"src": null,
"utm_campaign": null,
"utm_content": null,
"utm_id": null,
"utm_medium": null,
"utm_source": null,
"utm_term": null
},
"type": "sale"
}
}Gerar o Primeiro Pedido
Use o endpoint de criação de pedidos passando a chave no header Authorization no formato Bearer:
curl -X POST https://api.intake.finance/v1/orders \
-H "Authorization: Bearer SUA_CHAVE_DE_CASH_IN" \
-H "Content-Type: application/json" \
-d '{
"external_id": "12345",
"payment_method": "PIX",
"amount": 1400
}'A resposta conterá os dados do pedido:
{
"data": {
"id": "order-123",
"status": "pending",
"payment_method": "pix",
"pix": {
"code": "00020126580014br.gov.bcb.pix...",
"qrcode_base64": "iVBORw0KGgoAAAANSUhEUg..."
},
"total_amount": 1400,
"net_amount": 1300,
"created_at": "2024-01-15T10:30:00Z"
}
}Exibir o PIX
Você pode exibir o PIX usando o campo pix.qrcode_base64 para exibir o QRCode.
Realizar um Saque
Para realizar um saque, você precisará da Chave de Cash-out (diferente da chave de cash-in). Use o endpoint de saque:
curl -X POST https://api.intake.finance/v1/withdraws \
-H "Authorization: Bearer SUA_CHAVE_DE_CASH_OUT" \
-H "Content-Type: application/json" \
-d '{
"external_id": "saque-12345",
"amount": 5000,
"pix_key": "usuario@exemplo.com",
"pix_key_type": "email"
}'IMPORTANTE: A Chave de Cash-Out nunca deve ser exposto no client-side. Sempre use-o apenas no backend para garantir a segurança das operações.
Próximos Passos
Agora que você já conhece o básico, explore nossa documentação completa:
Autenticação
Entenda em detalhes os tipos de chaves e como usá-las corretamente.
Como Gerar Pedido
Guia completo para criar pedidos com PIX, Cartão ou Boleto.
Como Fazer Saque
Aprenda a realizar saques e consultar saldo de forma segura.
Referência de API
Explore todos os endpoints disponíveis com exemplos interativos.
Precisa de Ajuda?
Se tiver qualquer dúvida durante a integração, entre em contato com nosso suporte técnico.