• API: gerar credenciais, escopos e testar a chaveSuas chaves ficam em Integrações › API. Cada credencial tem nome, escopos (dados, transações, saques, checkout) e validade; a chave secreta aparece uma vez. Criar, trocar e revogar pede o 2FA. Dados da conta e saldo, Saques e o acesso total só o dono da conta ou o financeiro dão, e a chave vale pelo cargo atual de quem a criou: se a pessoa deixar de ser dono ou financeiro, a chave perde saldo, dados e saques (o resto continua).
• API: criar cobrança Pix, boleto e cartãoPOST /gateway/pix/receive cria o Pix com identifier, valor, cliente e produtos e devolve o copia-e-cola, a imagem do QR e os links do pedido. Boleto e cartão têm rotas próprias; a análise de segurança da compra pode recusar.
• API: cartão parcelado — o amount já inclui os jurosNo POST /gateway/card/receive parcelado, mande em amount o total que o comprador vai pagar, com os juros. A plataforma calcula a base (Tabela Price inversa), cobra a sua taxa sobre ela e o comprador paga exatamente o amount. À vista, amount é o preço.
• API: consultar e listar transações sem pollingConsulte uma transação por id ou pelo seu identifier e liste com filtros e paginação. Consultas repetidas em sequência são barradas: o caminho é o webhook, e a consulta fica para conferência.
• API: saque Pix, IPs autorizados e resposta 504POST /gateway/transfers faz o saque Pix para a chave do mesmo titular, só de IPs autorizados na tela da API. Um 504 não é falha: espere o webhook e consulte antes de repetir com identifier novo.
• API: criar checkout, pedir reembolso e depósito simplesPOST /gateway/checkout cria (ou reaproveita) produto e oferta e devolve o link do checkout, quando a plataforma libera. POST /gateway/producer/refunds pede o reembolso de uma venda sua; o depósito Pix simples cobra só um valor.
• API: assinaturas por Pix e cartãoAs rotas de assinatura criam a recorrência (tipo, intervalo e primeira cobrança em N dias). Cada ciclo é uma transação com o objeto subscription no webhook; o webhook é a fonte da verdade para liberar e cortar o acesso.
• Webhooks de assinatura: teste grátis, início, renovação, atraso, inativa e canceladaSete eventos acompanham a assinatura: SUBSCRIPTION_TRIAL_STARTED, SUBSCRIPTION_STARTED (1º pagamento), SUBSCRIPTION_RENEWAL_PENDING (link de renovação enviado, uma vez por ciclo, com o renewalUrl), SUBSCRIPTION_RENEWED, SUBSCRIPTION_LATE, SUBSCRIPTION_EXPIRED (acesso suspenso) e SUBSCRIPTION_CANCELED. Todos trazem subscription.cycle, os dados do cliente e o reason. Só recebe quem marca os eventos no webhook; o callbackUrl da venda recebe só o atraso e o cancelamento.
• Webhooks: eventos de transação, saque, disputa e sessãoOs eventos cobrem transação (criada, paga, cancelada, reembolsada, contestada, Pix expirado), saque (criado, concluído, falhou), disputa (MED e chargeback) e sessão do checkout (inclusive carrinho abandonado) e, se você assinar, um ORDER_BUMP_PAID por order bump pago. Todo aviso traz o token e o identifier.
• API: formato de erro, códigos e limitesTodo erro volta como statusCode, errorCode (GATEWAY_*), message e details. Há limite de vendas pendentes por método e janela (cada venda pendente com cobrança viva ocupa uma vaga; paga, cancelada, expirada ou recusada libera) e de consultas repetidas (TOO_MANY_REQUESTS); a análise de segurança da compra recusa com GATEWAY_TRANSACTION_DENIED.
• Modo de teste: chaves de teste, saldo de teste e receptor de webhooksCom a chave de teste, as mesmas rotas funcionam sem dinheiro de verdade: você simula pagamento, reembolso e contestação, recebe os webhooks com o cabeçalho X-Korvex-Mode: test e confere no receptor de teste da Korvex.
• API: meus dados, meu saldo, divisão da venda e ganho com parcelamentoGET /gateway/producer devolve os dados da conta e GET /gateway/producer/balance o disponível, a liberar e o retido. Na cobrança, a divisão com parceiros vai em valores (não em %); a transação traz o modo e o ganho com parcelamento. A API não guarda cartão (1 clique só no checkout).
• API: formato do endereço do compradorNo boleto e no cartão o endereço é obrigatório: country em ISO 3166-1 alfa-2 (BR), state como UF (aceitamos BR-SP), zipCode com ou sem hífen (volta com hífen) e complement opcional. Em GET /gateway/producer, o endereço de PJ é o da empresa.
• API: reportar bug, chave vazada e erro de IP no saqueEm Fale com o suporte, os tipos "Bug na API", "Minha chave da API vazou" e "IP não autorizado no saque" pedem os dados certos: endpoint, resposta com o requestId, passos e horário; no erro de IP, também o IP cadastrado e o IP de saída. Chaves e cartão colados são mascarados.
• API bloqueada por localização (403 GATEWAY_GEO_BLOCKED)A API aceita chamadas de servidores no Brasil, nos EUA e em Portugal, sem exceção por IP. De outro país, a resposta é 403 GATEWAY_GEO_BLOCKED em JSON, com o país detectado. Webhooks recebidos, status e documentação nunca são bloqueados.
• Portal da documentação: buscar, perguntas frequentes e versãoAberta no navegador, a documentação da API tem busca, as seções agrupadas, perguntas frequentes e o seletor de versão. Ferramentas e IAs continuam recebendo o Markdown (ou use ?formato=md).
• API: dividir o pagamento entre contas no Pix, no boleto e no cartãoEnvie splits com producerId e amount (em reais, até 2 casas) no Pix, no boleto ou no cartão. A soma não passa do valor nem do líquido depois da taxa; a divisão acontece quando o pagamento é confirmado. Não há divisão por percentual.
• Segurança das chaves: checksum, chave em lugar público e chave paradaAs chaves secretas novas têm um checksum no fim: erro de digitação é recusado e scanners de código acham a chave sem falso positivo. Chave encontrada em lugar público é revogada na hora, com aviso; a de produção parada há 90 dias também.
• Eventos da Isa no webhookAssine ISA_SHOWN, ISA_ACCEPTED e ISA_CONVERTED para saber quando a Isa mostrou uma ajuda ou oferta no checkout, quando o comprador aceitou e quando a venda saiu depois dela. O corpo não tem dado pessoal; checkoutSessionGuid liga ao SESSION_* e transactionId à venda.
• Evento QUIZ_ANSWERED (quiz respondido) no webhookAssine QUIZ_ANSWERED para receber cada resposta concluída de um quiz: quiz e versão, pontuação, faixa de resultado, destino, as respostas com o título de cada pergunta, o contato mapeado (com a data da autorização) e as UTMs. Assinado como os outros eventos; só quem assina recebe.
• Eventos de reembolso pedido e da jornada do aluno no webhookAssine REFUND_REQUESTED e REFUND_WITHDRAWN para saber quando o comprador pede reembolso (com o motivo que ele escreveu e o prazo para você falar com ele) e quando desiste. Assine MEMBER_FIRST_ACCESS, MEMBER_COURSE_COMPLETED e MEMBER_INACTIVE_7D para acompanhar o aluno: 1º acesso à área de membros, curso concluído e parado há 7 dias. Só quem marca recebe; o webhook da venda (callbackUrl) não recebe.
• Copiar a documentação para o seu assistente de IANo portal da documentação, cada seção (rota ou evento) tem o botão Copiar para IA: ele copia a seção em Markdown com o contexto da API (base, autenticação e onde está o resto) para colar no seu assistente ou editor com IA.
• API: saque Pix para a chave de outra pessoaCom o saque para terceiros liberado na sua conta, POST /gateway/transfers com o nome e o documento de OUTRA pessoa manda o Pix para a chave dela. Vale o limite por vez e o diário de terceiros, sai só do saldo do Pix e, por padrão, passa pela análise da equipe (PENDING até sair).
• API: criar e editar produtos e ofertasCom uma credencial de acesso total você lista, cria, edita e oculta produtos e cria, edita, pausa e exclui ofertas, com as mesmas regras do painel (página de vendas, WhatsApp de suporte, limites de preço e análise do produto). Preço em reais; cada oferta volta com o checkoutUrl. Envie o supportEmail: sem ele (e sem o e-mail de suporte padrão da conta), o produto é criado do mesmo jeito e a resposta traz warnings com SUPPORT_EMAIL_MISSING.
• API: a Korvex não manda e-mail ao seu compradorNas cobranças criadas pela API (Pix, cartão, boleto e assinaturas, inclusive as renovações), nenhum e-mail sai para o comprador: nem compra aprovada, nem Pix gerado, lembretes, reembolso, acesso à área de membros, aviso de acesso novo ou cobrança da assinatura: nenhuma confirmação de entrega. A comunicação é do seu sistema, pelos webhooks. O checkout hospedado criado pela API continua com os e-mails, porque o comprador paga na página da Korvex.