Atenção: Proposta provisória de contrato
Documentação
Construa sobre a API da KrokoPay
Um contrato REST para cobranças, checkout hospedado, clientes, assinaturas e webhooks. Leia de ponta a ponta, percorra os fluxos no ambiente de teste e integre quando os endpoints entrarem em operação.
Comece pelo guia rápido
De uma chave de teste a uma cobrança de teste paga em cinco passos, só com cURL ou fetch. Nada para instalar.
- Pegue suas chaves de teste
- Guarde a chave secreta
- Crie uma cobrança
- Pague no checkout de teste
- Confirme o pagamento
Resumo
- URL base
- https://api.krokopay.app/v1
- Versão da proposta
- 2026-11-01
- Autenticação
- Authorization: Bearer kp_test_sk_…
- Formato
- JSON sobre HTTPS, campos em snake_case, valores em centavos
- Ambiente
- Somente teste
Navegue por tema
Primeiros passos
5 páginasO que é a plataforma, sua primeira cobrança de teste, as chaves e o ambiente de teste.
- IntroduçãoA KrokoPay é uma plataforma de pagamentos com checkout próprio. Esta página explica os objetos com que você trabalha, os ambientes e as convenções que todo endpoint segue.
- Guia rápidoDe uma chave de teste a uma cobrança de teste paga em cinco passos, só com cURL ou fetch. Nada para instalar.
- AutenticaçãoToda requisição é autenticada com a sua chave secreta, enviada como token Bearer sobre HTTPS. Esta página mostra o cabeçalho, os dois tipos de chave e os erros que você recebe quando algo está errado.
- Chaves de APIAs chaves que identificam a sua conta: para que serve cada uma, como reconhecê-las pelo prefixo e como guardar, trocar e substituir com segurança.
- Ambiente de testeTudo o que você pode testar hoje sem dinheiro de verdade: chaves de teste, cartões de teste para cada resultado, um pagamento Pix simulado e webhooks simulados, além do que ainda não está disponível.
Pagamentos
4 páginasCobranças, checkout hospedado, clientes e cobrança recorrente.
- Criando cobrançasUma cobrança é um pedido de pagamento feito a um comprador. Crie no seu servidor, envie o comprador para o checkout_url e acompanhe o status até ela ser paga, recusada ou expirar.
- CheckoutA KrokoPay hospeda a página de pagamento de cada cobrança e de cada link de pagamento. Envie o comprador para uma URL; o checkout cuida do Pix, do cartão, da sua marca e de todos os resultados.
- ClientesUm cliente é a pessoa ou empresa que paga você. Vincule clientes a cobranças e assinaturas para ter o histórico de pagamentos de cada comprador.
- AssinaturasCobre um cliente todo mês ou todo ano a partir de um preço recorrente. Comece assinaturas por um link de pagamento ou pela API e acompanhe renovações, falhas, pausas e cancelamentos pelos eventos.
Confiabilidade
3 páginasEventos, novas tentativas seguras e como os erros são informados.
- WebhooksA KrokoPay envia um POST HTTPS para o seu servidor quando algo acontece com uma cobrança, assinatura ou saque. Verifique a assinatura, responda 2xx rápido e processe cada evento uma única vez.
- IdempotênciaRepita requisições POST com segurança. Envie o cabeçalho Idempotency-Key e a KrokoPay executa a operação uma única vez, respondendo cada repetição com a resposta original.
- ErrosComo a API informa problemas: um único objeto de erro, poucos status HTTP e códigos de erro estáveis para você tomar decisões, incluindo os motivos de recusa de um pagamento com cartão.
Veja os fluxos funcionando
O painel de demonstração cria cobranças, links de pagamento e entregas de webhook com os mesmos objetos descritos aqui.
Abrir a área de desenvolvedoresSentiu falta de algo?
O contrato ainda está aberto. Conte para a gente quais recursos ou campos a sua integração precisa.
Fale com a gente