API da sua operação

Sim, a sua operação white label tem API própria. Ela responde no seu domínio, a documentação sai com a sua marca e cada lojista gera as próprias chaves de acesso no painel. Você não precisa construir nem manter essa API: a XF TECH desenvolve, hospeda e atualiza. Os seus lojistas integram com a sua marca, e não com a de um fornecedor.

O que a API faz

• Cobranças Pix: criação com QR Code e copia e cola prontos para mostrar ao pagador, consulta por id e listagem com filtros e paginação.
• Dados de conciliação: quem de fato pagou e o identificador da transação Pix, para conferir com o extrato.
• Estorno: devolução total de uma cobrança paga, com confirmação por webhook.
• Saldo e dados da conta: saldo disponível e reservado, taxas e status do cadastro.
• Saques via Pix: por chave Pix ou por QR Code, com consulta e listagem.
• Split: divisão do valor da cobrança entre lojistas da sua operação. Veja split e subcontas.
• Webhooks: endpoints gerenciados pelo painel ou pela própria API.

Os valores trafegam em centavos, como número inteiro, o que evita erro de arredondamento.

Segurança e controle de acesso

• Autenticação com chave pública e segredo. O segredo aparece uma única vez, na criação.
• Revogação imediata de chaves comprometidas.
• Lista de IPs permitidos, opcional, por conta.
• Controle de acesso por empresa: a chave identifica o lojista, e cada cobrança é criada para a conta dele.
• Limite de requisições por conta, informado nos cabeçalhos de cada resposta.

Idempotência

Toda criação de cobrança e todo pedido de saque aceitam uma chave de idempotência. Se a conexão cair e o sistema do lojista repetir o pedido, a API devolve a mesma cobrança ou o mesmo saque, em vez de gerar outro Pix ou debitar o saldo duas vezes.

Ambiente de testes

Com chaves de teste, o lojista usa os mesmos endpoints e recebe as mesmas respostas, sem mover dinheiro. As cobranças de teste ficam separadas do saldo e dos relatórios reais. Um endpoint de simulação marca a cobrança como paga, calcula a taxa com as taxas reais da conta e dispara o webhook. A chave de teste pode ser criada antes da aprovação do cadastro, então o lojista integra enquanto o KYC/KYB está em análise.

Webhooks e logs

A plataforma avisa o sistema do lojista por webhook quando uma cobrança é criada, paga ou estornada, quando um saque muda de status e quando uma disputa do Pix é aberta ou decidida. Cada envio leva uma assinatura que o lojista confere com o segredo do endpoint, e a plataforma reenvia quando não recebe confirmação.

Toda resposta traz um identificador da requisição. Com ele, o lojista encontra a chamada na tela de logs da API do painel, com status, duração e código de erro. Isso reduz chamados para o seu suporte.

Um exemplo

Criar uma cobrança Pix de R$ 19,90 na API da sua operação:

curl -X POST https://SEU-DOMINIO/api/v1/charges \
  -u "pk_live_...:sk_live_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: pedido-1234" \
  -d '{"amountCents":1990,"customer":{"name":"Cliente","email":"cliente@exemplo.com","document":"00000000000"}}'

A resposta traz o status da cobrança e os dados do Pix para mostrar ao pagador.

Como um lojista começa a integrar

1. Cria uma chave de teste no painel, mesmo com o cadastro em análise.
2. Integra a criação de cobranças e cadastra o endpoint de webhook.
3. Simula pagamentos e confere se o sistema dá baixa nos pedidos.
4. Depois da aprovação do cadastro, cria a chave de produção e troca a credencial.

Documentação com a sua marca

A documentação da API é publicada no domínio da sua operação, com o nome da sua marca. Ela também sai em formato de texto para assistentes de IA, o que ajuda o lojista a integrar mais rápido com a ajuda de um assistente. Para ver como fica uma documentação real nessa tecnologia, abra a documentação da xFlow Payments, uma operação que roda na plataforma da XF TECH.

O que a API não faz hoje

Cartão e checkout hospedado ainda não estão na API. Cartão depende do provedor, da integração e da homologação correspondentes. Os links de pagamento e o checkout estão disponíveis pelo painel do lojista.